Create stack connection

{ "mappings": [ { "value": { "output": "output", "template": "template", "values": { "key": { "output": "output" } } }, "target": { "path": "path", "name": "name", "type": "env" } }, { "value": { "output": "output", "template": "template", "values": { "key": { "output": "output" } } }, "target": { "path": "path", "name": "name", "type": "env" } } ], "kind": "env", "from": { "name": "name", "id": "id", "type": "stack_resource" }, "id": "id", "to": { "name": "name", "id": "id", "type": "stack_resource" }, "config": null }

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

org_id

string

required

The ID of the organization

project_name

string

required

The name of the project

string

required

The id of record

Body

application/json

A user-authored topology edge between two nodes in a stack.

kind

enum<string>

required

The relationship type. env injects values into environment variables, volume_mount mounts a volume into a resource, and build_artifact_source seeds a volume from build output.

Available options:

env,

volume_mount,

build_artifact_source

from

object

required

Identifies a topology node within the stack graph.

Show child attributes

Example:

{
  "name": "name",
  "id": "id",
  "type": "stack_resource"
}

object

required

Identifies a topology node within the stack graph.

Show child attributes

Example:

{
  "name": "name",
  "id": "id",
  "type": "stack_resource"
}

string

Stable connection identifier. Generated when omitted.

mappings

object[]

Target/value mappings for kinds that move values, such as env.

Show child attributes

config

object

Kind-specific connection configuration. The shape depends on the connection kind and source type: use PostgresEnvConfig when kind is env and from.type is addon/postgres, VolumeMountConfig when kind is volume_mount, and BuildArtifactSourceConfig when kind is build_artifact_source. Omit config entirely for env connections from stack_resource or secret sources.

Option 1
Option 2
Option 3

Show child attributes

Response

Stack connection created successfully

A user-authored topology edge between two nodes in a stack.

kind

enum<string>

required

The relationship type. env injects values into environment variables, volume_mount mounts a volume into a resource, and build_artifact_source seeds a volume from build output.

Available options:

env,

volume_mount,

build_artifact_source

from

object

required

Identifies a topology node within the stack graph.

Show child attributes

Example:

{
  "name": "name",
  "id": "id",
  "type": "stack_resource"
}

object

required

Identifies a topology node within the stack graph.

Show child attributes

Example:

{
  "name": "name",
  "id": "id",
  "type": "stack_resource"
}

string

Stable connection identifier. Generated when omitted.

mappings

object[]

Target/value mappings for kinds that move values, such as env.

Show child attributes

config

object

Option 1
Option 2
Option 3

Show child attributes

Authentication and users

Organizations, projects, and access

Source and registry integrations

Stacks and resources

Releases

Builds, logs, and metrics

Secrets, volumes, and object stores

PostgreSQL addons

Preview environments

Compute administration

Create stack connection

Authorizations

Path Parameters

Body

Response