Update Deployment

POST

deployments

{deployment_id}

Update Deployment

curl --request POST \
  --url http://localhost:38080/v1/deployments/{deployment_id} \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --header 'anthropic-beta: <anthropic-beta>' \
  --header 'anthropic-version: <anthropic-version>' \
  --data '
{
  "name": "<string>",
  "description": "<string>"
}
'

import requests

url = "http://localhost:38080/v1/deployments/{deployment_id}"

payload = {
    "name": "<string>",
    "description": "<string>"
}
headers = {
    "anthropic-version": "<anthropic-version>",
    "anthropic-beta": "<anthropic-beta>",
    "X-Api-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'anthropic-version': '<anthropic-version>',
    'anthropic-beta': '<anthropic-beta>',
    'X-Api-Key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({name: '<string>', description: '<string>'})
};

fetch('http://localhost:38080/v1/deployments/{deployment_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:38080/v1/deployments/{deployment_id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("anthropic-version", "<anthropic-version>")
	req.Header.Add("anthropic-beta", "<anthropic-beta>")
	req.Header.Add("X-Api-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "type": "deployment",
  "id": "depl_011CZkZcDH3vPqd7xnEfwTai",
  "name": "Daily order report",
  "description": "Compiles yesterday's orders into a report every weekday morning.",
  "agent": {
    "type": "agent",
    "id": "agent_011CZkYpogX7uDKUyvBTophP",
    "version": 1
  },
  "environment_id": "env_011CZkZ9X2dpNyB7HsEFoRfW",
  "vault_ids": [
    "vlt_011CZkZDLs7fYzm1hXNPeRjv"
  ],
  "initial_events": [
    {
      "type": "user.message",
      "content": [
        {
          "type": "text",
          "text": "Compile yesterday's orders into report.md."
        }
      ]
    }
  ],
  "resources": [],
  "metadata": {},
  "schedule": {
    "type": "cron",
    "expression": "0 9 * * 1-5",
    "timezone": "America/Los_Angeles",
    "last_run_at": "2026-03-16T16:00:09Z",
    "upcoming_runs_at": [
      "2026-03-17T16:00:00Z",
      "2026-03-18T16:00:00Z"
    ]
  },
  "status": "active",
  "paused_reason": null,
  "created_at": "2026-03-15T10:00:00Z",
  "updated_at": "2026-03-15T10:00:00Z",
  "archived_at": null
}

{
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  },
  "request_id": "<string>",
  "type": "error"
}

{
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  },
  "request_id": "<string>",
  "type": "error"
}

{
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  },
  "request_id": "<string>",
  "type": "error"
}

{
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  },
  "request_id": "<string>",
  "type": "error"
}

{
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  },
  "request_id": "<string>",
  "type": "error"
}

{
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  },
  "request_id": "<string>",
  "type": "error"
}

{
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  },
  "request_id": "<string>",
  "type": "error"
}

{
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  },
  "request_id": "<string>",
  "type": "error"
}

{
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  },
  "request_id": "<string>",
  "type": "error"
}

{
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  },
  "request_id": "<string>",
  "type": "error"
}

{
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  },
  "request_id": "<string>",
  "type": "error"
}

{
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  },
  "request_id": "<string>",
  "type": "error"
}

{
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  },
  "request_id": "<string>",
  "type": "error"
}

{
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  },
  "request_id": "<string>",
  "type": "error"
}

{
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  },
  "request_id": "<string>",
  "type": "error"
}

Every request requires ?beta=true, anthropic-version: 2023-06-01, and anthropic-beta: managed-agents-2026-04-01.

Authorizations

X-Api-Key

string

header

default:sk-ant-local-default

required

OMA workspace API key.

Headers

anthropic-version

string

required

anthropic-beta

string

required

Path Parameters

deployment_id

string

required

Path parameter deployment_id

Query Parameters

beta

enum<boolean>

required

Selects the beta API contract for this endpoint. Must be true.

Available options:

true

Body

application/json

Request parameters for updating a deployment. Omit a field to preserve its current value.

name

string

Human-readable name. Must be non-empty. Omit to preserve. Cannot be cleared.

Maximum string length: 256

description

string | null

Description. Omit to preserve; send empty string or null to clear.

Maximum string length: 2048

agent

Agent to deploy. Accepts the agent ID string, which re-pins to the latest version, or an agent object with both id and version specified. Omit to preserve. Cannot be cleared.

environment_id

string

ID of the environment where sessions run. Omit to preserve. Cannot be cleared.

Maximum string length: 128

vault_ids

string[] | null

Vault IDs. Full replacement. Omit to preserve; send empty array or null to clear. Maximum 50.

initial_events

object[]

Initial events. Full replacement. Omit to preserve. Cannot be cleared. At least 1, maximum 50.

Parameters for sending a user message to the session.

Option 1
Option 2
Option 3

Show child attributes

Example:

{
  "type": "user.message",
  "content": [
    {
      "type": "text",
      "text": "Where is my order #1234?"
    }
  ]
}

resources

object[] | null

Session resources. Full replacement. Omit to preserve; send empty array or null to clear. Maximum 500.

Mount a GitHub repository into the session's container.

Option 1
Option 2
Option 3

Show child attributes

Example:

{
  "type": "file",
  "url": "https://github.com/example-org/example-repo",
  "authorization_token": "ghp_exampletoken",
  "mount_path": "/uploads/receipt.pdf"
}

metadata

object | null

Metadata patch. Set a key to a string to upsert it, or to null to delete it. Omit the field to preserve. The stored bag is limited to 16 keys (up to 64 chars each) with values up to 512 chars.

Show child attributes

schedule

object | null

Cron schedule. Full replacement. Omit to preserve; send null to clear (revert to manual-only).

Show child attributes

Example:

{
  "type": "cron",
  "expression": "0 9 * * 1-5",
  "timezone": "America/Los_Angeles"
}

budget

object | null

Spend ceiling for future sessions. Full replacement. Omit to preserve; send null to clear (sessions created afterwards are uncapped). The deployment agent's model must have a public list price, or the request is rejected; a multiagent roster is re-validated in full when each fire copies the cap, which fails closed the same way.

Show child attributes

Response

Successful response (OK)

A deployment is a configured instance of an agent — it binds the agent to everything needed to run it autonomously: an environment, credentials, initial events, and an optional schedule.

type

enum<string>

required

Available options:

deployment

Example:

"deployment"

string

required

Unique identifier for this deployment.

Example:

"depl_011CZkZcDH3vPqd7xnEfwTai"

name

string

required

Human-readable name.

Example:

"Daily order report"

description

string | null

required

Description of what the deployment does.

Example:

"Compiles yesterday's orders into a report every weekday morning."

agent

object

required

Reference to the agent this deployment runs, resolved to a concrete version.

Show child attributes

Example:

{
  "type": "agent",
  "id": "agent_011CZkYpogX7uDKUyvBTophP",
  "version": 1
}

environment_id

string

required

ID of the environment where sessions run.

Example:

"env_011CZkZ9X2dpNyB7HsEFoRfW"

vault_ids

string[]

required

Vault IDs supplying stored credentials for sessions created from this deployment.

Example:

["vlt_011CZkZDLs7fYzm1hXNPeRjv"]

initial_events

object[]

required

Events sent to each session immediately after creation.

A user message sent to the session.

Option 1
Option 2
Option 3

Show child attributes

Example:

[
  {
    "type": "user.message",
    "content": [
      {
        "type": "text",
        "text": "Compile yesterday's orders into report.md."
      }
    ]
  }
]

resources

object[]

required

Resources attached to sessions created from this deployment. Echoes the input minus write-only credentials.

A GitHub repository mounted into each session's container. The authorization token is write-only and never returned.

Option 1
Option 2
Option 3

Show child attributes

Example:

[]

metadata

object

required

Arbitrary key-value metadata. Maximum 16 pairs.

Show child attributes

Example:

{}

schedule

object | null

required

Recurring cron schedule. Presence enables scheduled execution; null means manual-only. Includes computed timestamps (next fire times, last run) on the cron variant.

Show child attributes

Example:

{
  "type": "cron",
  "expression": "0 9 * * 1-5",
  "timezone": "America/Los_Angeles",
  "last_run_at": "2026-03-16T16:00:09Z",
  "upcoming_runs_at": [
    "2026-03-17T16:00:00Z",
    "2026-03-18T16:00:00Z"
  ]
}

status

enum<string>

required

Computed status of the deployment: active or paused. Archived deployments report active with archived_at set.

Available options:

active,

paused

Example:

"active"

paused_reason

object

required

Why the deployment is paused. Non-null exactly when status is paused; null otherwise.

Option 1
Option 2

Show child attributes

Example:

null

created_at

string<date-time>

required

Time the deployment was created.

Example:

"2026-03-15T10:00:00Z"

updated_at

string<date-time>

required

Time the deployment was last updated.

Example:

"2026-03-15T10:00:00Z"

archived_at

string<date-time> | null

required

Time the deployment was archived. Null if not archived.

Example:

null

budget

object | null

Spend ceiling stamped onto each session created from this deployment. Absent when no budget is set.

Show child attributes

Update Deployment

curl --request POST \
  --url http://localhost:38080/v1/deployments/{deployment_id} \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --header 'anthropic-beta: <anthropic-beta>' \
  --header 'anthropic-version: <anthropic-version>' \
  --data '
{
  "name": "<string>",
  "description": "<string>"
}
'

import requests

url = "http://localhost:38080/v1/deployments/{deployment_id}"

payload = {
    "name": "<string>",
    "description": "<string>"
}
headers = {
    "anthropic-version": "<anthropic-version>",
    "anthropic-beta": "<anthropic-beta>",
    "X-Api-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'anthropic-version': '<anthropic-version>',
    'anthropic-beta': '<anthropic-beta>',
    'X-Api-Key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({name: '<string>', description: '<string>'})
};

fetch('http://localhost:38080/v1/deployments/{deployment_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:38080/v1/deployments/{deployment_id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("anthropic-version", "<anthropic-version>")
	req.Header.Add("anthropic-beta", "<anthropic-beta>")
	req.Header.Add("X-Api-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "type": "deployment",
  "id": "depl_011CZkZcDH3vPqd7xnEfwTai",
  "name": "Daily order report",
  "description": "Compiles yesterday's orders into a report every weekday morning.",
  "agent": {
    "type": "agent",
    "id": "agent_011CZkYpogX7uDKUyvBTophP",
    "version": 1
  },
  "environment_id": "env_011CZkZ9X2dpNyB7HsEFoRfW",
  "vault_ids": [
    "vlt_011CZkZDLs7fYzm1hXNPeRjv"
  ],
  "initial_events": [
    {
      "type": "user.message",
      "content": [
        {
          "type": "text",
          "text": "Compile yesterday's orders into report.md."
        }
      ]
    }
  ],
  "resources": [],
  "metadata": {},
  "schedule": {
    "type": "cron",
    "expression": "0 9 * * 1-5",
    "timezone": "America/Los_Angeles",
    "last_run_at": "2026-03-16T16:00:09Z",
    "upcoming_runs_at": [
      "2026-03-17T16:00:00Z",
      "2026-03-18T16:00:00Z"
    ]
  },
  "status": "active",
  "paused_reason": null,
  "created_at": "2026-03-15T10:00:00Z",
  "updated_at": "2026-03-15T10:00:00Z",
  "archived_at": null
}

{
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  },
  "request_id": "<string>",
  "type": "error"
}

{
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  },
  "request_id": "<string>",
  "type": "error"
}

{
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  },
  "request_id": "<string>",
  "type": "error"
}

{
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  },
  "request_id": "<string>",
  "type": "error"
}

{
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  },
  "request_id": "<string>",
  "type": "error"
}

{
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  },
  "request_id": "<string>",
  "type": "error"
}

{
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  },
  "request_id": "<string>",
  "type": "error"
}

{
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  },
  "request_id": "<string>",
  "type": "error"
}

{
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  },
  "request_id": "<string>",
  "type": "error"
}

{
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  },
  "request_id": "<string>",
  "type": "error"
}

{
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  },
  "request_id": "<string>",
  "type": "error"
}

{
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  },
  "request_id": "<string>",
  "type": "error"
}

{
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  },
  "request_id": "<string>",
  "type": "error"
}

{
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  },
  "request_id": "<string>",
  "type": "error"
}

{
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  },
  "request_id": "<string>",
  "type": "error"
}

Get started

Core API

Managed Agents

Webhooks

Authorizations

Headers

Path Parameters

Query Parameters

Body

Response