Update a stack resource

Error

A valid request URL is required to generate request examples

{
  "outputs": [
    {
      "name": "name",
      "sensitive": true,
      "type": "string"
    },
    {
      "name": "name",
      "sensitive": true,
      "type": "string"
    }
  ],
  "depends_on": [
    "depends_on",
    "depends_on"
  ],
  "replicas": 0,
  "annotations": [
    {
      "value": "value",
      "key": "key"
    },
    {
      "value": "value",
      "key": "key"
    }
  ],
  "init_spec": {
    "args": [
      "args",
      "args"
    ],
    "command": [
      "command",
      "command"
    ]
  },
  "execution_config": {
    "args": [
      "args",
      "args"
    ],
    "environment_variables": [
      {
        "name": "name",
        "self_output": "self_output",
        "value": "value"
      },
      {
        "name": "name",
        "self_output": "self_output",
        "value": "value"
      }
    ],
    "command": [
      "command",
      "command"
    ]
  },
  "volume_mounts": [
    {
      "stack_resource_id": "stack_resource_id",
      "source_volume_name": "source_volume_name",
      "source_volume_type": null,
      "source_sub_path": "source_sub_path",
      "target_path": "target_path"
    },
    {
      "stack_resource_id": "stack_resource_id",
      "source_volume_name": "source_volume_name",
      "source_volume_type": null,
      "source_sub_path": "source_sub_path",
      "target_path": "target_path"
    }
  ],
  "source": {
    "volume": {
      "volume_id": "volume_id",
      "current_volume_hash": "current_volume_hash",
      "volume_name": "volume_name",
      "build_context": ".",
      "dockerfile_path": "Dockerfile"
    },
    "image": {
      "ref": "ref",
      "registry_credentials_id": "registry_credentials_id"
    },
    "git": {
      "repo_url": "repo_url",
      "integration_id": "integration_id",
      "commit": "commit",
      "build_context": ".",
      "tag": "tag",
      "dockerfile_path": "Dockerfile",
      "branch": "branch",
      "push": {
        "registry_credentials_id": "registry_credentials_id",
        "repository": "repository"
      }
    }
  },
  "ports": [
    {
      "number": 0,
      "protocol": "protocol",
      "exposed_to_public": true,
      "name": "name",
      "subdomain_prefix": "subdomain_prefix"
    },
    {
      "number": 0,
      "protocol": "protocol",
      "exposed_to_public": true,
      "name": "name",
      "subdomain_prefix": "subdomain_prefix"
    }
  ],
  "workload_type": "Service",
  "labels": [
    {
      "value": "value",
      "key": "key"
    },
    {
      "value": "value",
      "key": "key"
    }
  ],
  "revision": "revision",
  "schedule": "schedule",
  "stack_id": "stack_id",
  "name": "name",
  "lifecycle_config": {
    "restart_request_time": "2000-01-23T04:56:07.000Z"
  },
  "id": "id"
}

{
  "id": "<string>",
  "kind": "<string>",
  "href": "<string>",
  "code": "<string>",
  "reason": "<string>",
  "operation_id": "<string>",
  "details": {}
}

{
  "id": "<string>",
  "kind": "<string>",
  "href": "<string>",
  "code": "<string>",
  "reason": "<string>",
  "operation_id": "<string>",
  "details": {}
}

PUT

api

organizations

{org_id}

projects

{project_name}

stacks

{id}

resources

{resource_name}

Error

A valid request URL is required to generate request examples

{
  "outputs": [
    {
      "name": "name",
      "sensitive": true,
      "type": "string"
    },
    {
      "name": "name",
      "sensitive": true,
      "type": "string"
    }
  ],
  "depends_on": [
    "depends_on",
    "depends_on"
  ],
  "replicas": 0,
  "annotations": [
    {
      "value": "value",
      "key": "key"
    },
    {
      "value": "value",
      "key": "key"
    }
  ],
  "init_spec": {
    "args": [
      "args",
      "args"
    ],
    "command": [
      "command",
      "command"
    ]
  },
  "execution_config": {
    "args": [
      "args",
      "args"
    ],
    "environment_variables": [
      {
        "name": "name",
        "self_output": "self_output",
        "value": "value"
      },
      {
        "name": "name",
        "self_output": "self_output",
        "value": "value"
      }
    ],
    "command": [
      "command",
      "command"
    ]
  },
  "volume_mounts": [
    {
      "stack_resource_id": "stack_resource_id",
      "source_volume_name": "source_volume_name",
      "source_volume_type": null,
      "source_sub_path": "source_sub_path",
      "target_path": "target_path"
    },
    {
      "stack_resource_id": "stack_resource_id",
      "source_volume_name": "source_volume_name",
      "source_volume_type": null,
      "source_sub_path": "source_sub_path",
      "target_path": "target_path"
    }
  ],
  "source": {
    "volume": {
      "volume_id": "volume_id",
      "current_volume_hash": "current_volume_hash",
      "volume_name": "volume_name",
      "build_context": ".",
      "dockerfile_path": "Dockerfile"
    },
    "image": {
      "ref": "ref",
      "registry_credentials_id": "registry_credentials_id"
    },
    "git": {
      "repo_url": "repo_url",
      "integration_id": "integration_id",
      "commit": "commit",
      "build_context": ".",
      "tag": "tag",
      "dockerfile_path": "Dockerfile",
      "branch": "branch",
      "push": {
        "registry_credentials_id": "registry_credentials_id",
        "repository": "repository"
      }
    }
  },
  "ports": [
    {
      "number": 0,
      "protocol": "protocol",
      "exposed_to_public": true,
      "name": "name",
      "subdomain_prefix": "subdomain_prefix"
    },
    {
      "number": 0,
      "protocol": "protocol",
      "exposed_to_public": true,
      "name": "name",
      "subdomain_prefix": "subdomain_prefix"
    }
  ],
  "workload_type": "Service",
  "labels": [
    {
      "value": "value",
      "key": "key"
    },
    {
      "value": "value",
      "key": "key"
    }
  ],
  "revision": "revision",
  "schedule": "schedule",
  "stack_id": "stack_id",
  "name": "name",
  "lifecycle_config": {
    "restart_request_time": "2000-01-23T04:56:07.000Z"
  },
  "id": "id"
}

{
  "id": "<string>",
  "kind": "<string>",
  "href": "<string>",
  "code": "<string>",
  "reason": "<string>",
  "operation_id": "<string>",
  "details": {}
}

{
  "id": "<string>",
  "kind": "<string>",
  "href": "<string>",
  "code": "<string>",
  "reason": "<string>",
  "operation_id": "<string>",
  "details": {}
}

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

resource_name

string

required

The name of the stack resource

Body

application/json

name

string

required

labels

object[]

Show child attributes

annotations

object[]

Show child attributes

source

object

Where a stack resource's runtime image comes from. Exactly one of git, image, or volume must be set (enforced server-side).

Show child attributes

Example:

{
  "volume": {
    "volume_id": "volume_id",
    "current_volume_hash": "current_volume_hash",
    "volume_name": "volume_name",
    "build_context": ".",
    "dockerfile_path": "Dockerfile"
  },
  "image": {
    "ref": "ref",
    "registry_credentials_id": "registry_credentials_id"
  },
  "git": {
    "repo_url": "repo_url",
    "integration_id": "integration_id",
    "commit": "commit",
    "build_context": ".",
    "tag": "tag",
    "dockerfile_path": "Dockerfile",
    "branch": "branch",
    "push": {
      "registry_credentials_id": "registry_credentials_id",
      "repository": "repository"
    }
  }
}

init_spec

object

Show child attributes

Example:

{
  "args": ["args", "args"],
  "command": ["command", "command"]
}

execution_config

object

Show child attributes

Example:

{
  "args": ["args", "args"],
  "environment_variables": [
    {
      "name": "name",
      "self_output": "self_output",
      "value": "value"
    },
    {
      "name": "name",
      "self_output": "self_output",
      "value": "value"
    }
  ],
  "command": ["command", "command"]
}

volume_mounts

object[]

Show child attributes

depends_on

string[]

lifecycle_config

object

Show child attributes

Example:

{
  "restart_request_time": "2000-01-23T04:56:07.000Z"
}

ports

object[]

Show child attributes

workload_type

enum<string>

default:Service

Available options:

Service,

StatefulService,

Worker,

Job,

CronJob

schedule

string

replicas

integer<int32>

Required range: x >= 0

Response

Stack resource updated successfully

name

string

required

string

read-only

stack_id

string

read-only

labels

object[]

Show child attributes

annotations

object[]

Show child attributes

revision

string

read-only

source

object

Where a stack resource's runtime image comes from. Exactly one of git, image, or volume must be set (enforced server-side).

Show child attributes

Example:

{
  "volume": {
    "volume_id": "volume_id",
    "current_volume_hash": "current_volume_hash",
    "volume_name": "volume_name",
    "build_context": ".",
    "dockerfile_path": "Dockerfile"
  },
  "image": {
    "ref": "ref",
    "registry_credentials_id": "registry_credentials_id"
  },
  "git": {
    "repo_url": "repo_url",
    "integration_id": "integration_id",
    "commit": "commit",
    "build_context": ".",
    "tag": "tag",
    "dockerfile_path": "Dockerfile",
    "branch": "branch",
    "push": {
      "registry_credentials_id": "registry_credentials_id",
      "repository": "repository"
    }
  }
}

init_spec

object

Show child attributes

Example:

{
  "args": ["args", "args"],
  "command": ["command", "command"]
}

execution_config

object

Show child attributes

Example:

{
  "args": ["args", "args"],
  "environment_variables": [
    {
      "name": "name",
      "self_output": "self_output",
      "value": "value"
    },
    {
      "name": "name",
      "self_output": "self_output",
      "value": "value"
    }
  ],
  "command": ["command", "command"]
}

volume_mounts

object[]

Show child attributes

depends_on

string[]

lifecycle_config

object

Show child attributes

Example:

{
  "restart_request_time": "2000-01-23T04:56:07.000Z"
}

ports

object[]

Show child attributes

outputs

object[]

read-only

Show child attributes

workload_type

enum<string>

default:Service

Available options:

Service,

StatefulService,

Worker,

Job,

CronJob

schedule

string

replicas

integer<int32>

Required range: x >= 0

⌘I

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

Update a stack resource

Authorizations

Path Parameters

Body

Response