A deployment is a running instance of a bundle, bound to the caller. The full lifecycle spans several endpoints:

POST /deployments - snapshot the bundle's current entries into a new deployment. No credentials or tokens exist yet.
PUT /deployments/{deployment_id}/credentials/{entry_id} (or the /vault variant to link a reusable org/personal vault entry instead) - supply auth for each entry that needs it.
For entries backed by OAuth2 rather than a static credential, use POST /oauth2/initiate instead - see that endpoint's docs for the flow.
POST /deployments/{deployment_id}/tokens - issue a bearer token an agent uses to actually connect through the bundler.

Deleting the deployment does not delete the underlying bundle.

Create a deployment binding the caller to a bundle.

Authorization: the target bundle must be public, or owned by the caller; otherwise this returns 404 (existence of a private bundle owned by someone else is not disclosed).

An org_id, when given, must name a team organisation where the caller holds deployments:create (404 without a grant there, 403 without the permission); a personal organisation's id is rejected (400) - omit org_id to deploy and bill personally. A member deploying a team bundle chooses between the team (org_id) and themselves (None).

The bundle's current entries are snapshotted into the deployment at creation time via the provider; no credentials or tokens exist yet.

Authorization

OAuth2AuthorizationCodeBearer

AuthorizationBearer <token>

In: header

Query Parameters

verify_locally?Verify Locally

Defaulttrue

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

`application/json`

curl -X POST "https://example.com/v1/deployments" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "bundle_id": "fc6f5a67-caa1-4339-9c14-a67826143b60"  }'

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string",  "bundle_id": "fc6f5a67-caa1-4339-9c14-a67826143b60",  "bundle_name": "string",  "org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b",  "created_at": "2019-08-24T14:15:22Z",  "health": "grey",  "token_count": 0,  "router_enabled": false,  "router_key_id": "1c1c460b-a98a-4785-9c9d-f5e0af128ea5",  "router_key_name": "",  "loading_strategy": "eager",  "router_set_context": true,  "router_rolling_window": false,  "router_tool_granularity": false,  "entry_snapshot_ids": [    "10534ae3-c1b4-4bd7-83a7-a1b919bc924a"  ],  "can_modify": false,  "credentials": [],  "tokens": []}

{  "detail": [    {      "loc": [        "string"      ],      "msg": "string",      "type": "string"    }  ]}

A deployment is a running instance of a bundle, bound to the caller. The full lifecycle spans several endpoints:

POST /deployments - snapshot the bundle's current entries into a new deployment. No credentials or tokens exist yet.
PUT /deployments/{deployment_id}/credentials/{entry_id} (or the /vault variant to link a reusable org/personal vault entry instead) - supply auth for each entry that needs it.
For entries backed by OAuth2 rather than a static credential, use POST /oauth2/initiate instead - see that endpoint's docs for the flow.
POST /deployments/{deployment_id}/tokens - issue a bearer token an agent uses to actually connect through the bundler.

Deleting the deployment does not delete the underlying bundle.

Create a deployment binding the caller to a bundle.

Authorization: the target bundle must be public, or owned by the caller; otherwise this returns 404 (existence of a private bundle owned by someone else is not disclosed).

The bundle's current entries are snapshotted into the deployment at creation time via the provider; no credentials or tokens exist yet.

Authorization

OAuth2AuthorizationCodeBearer

AuthorizationBearer <token>

In: header

Query Parameters

verify_locally?Verify Locally

Defaulttrue

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*Name

Length1 <= length <= 128

bundle_id*Bundle Id

Formatuuid

org_id?|null

router_enabled?Router Enabled

Defaultfalse

router_key_id?|null

loading_strategy?Loading Strategy

Default"eager"

router_set_context?Router Set Context

Defaulttrue

router_rolling_window?Router Rolling Window

Defaultfalse

router_tool_granularity?Router Tool Granularity

Defaultfalse

entry_snapshot_ids?array<>

Response Body

`application/json`

curl -X POST "https://example.com/v1/deployments" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "bundle_id": "fc6f5a67-caa1-4339-9c14-a67826143b60"  }'

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string",  "bundle_id": "fc6f5a67-caa1-4339-9c14-a67826143b60",  "bundle_name": "string",  "org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b",  "created_at": "2019-08-24T14:15:22Z",  "health": "grey",  "token_count": 0,  "router_enabled": false,  "router_key_id": "1c1c460b-a98a-4785-9c9d-f5e0af128ea5",  "router_key_name": "",  "loading_strategy": "eager",  "router_set_context": true,  "router_rolling_window": false,  "router_tool_granularity": false,  "entry_snapshot_ids": [    "10534ae3-c1b4-4bd7-83a7-a1b919bc924a"  ],  "can_modify": false,  "credentials": [],  "tokens": []}

{  "detail": [    {      "loc": [        "string"      ],      "msg": "string",      "type": "string"    }  ]}

Create Deployment

Authorization

Query Parameters

Request Body

Response Body

`application/json`

`application/json`

Create Deployment

Authorization

Query Parameters

Request Body

Response Body

`application/json`

`application/json`

Create Deployment

201application/json

422application/json

Create Deployment

201application/json

422application/json

`application/json`

`application/json`

`application/json`

`application/json`