Create Deployment
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/vaultvariant 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/initiateinstead - 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 the caller belongs to. A personal organisation is rejected even though the caller is trivially a member of their own: billing to org_id= targets a ledger bucket nothing ever credits (top-ups and grants land on the personal balance, which the ledger identifies as org_id IS NULL), leaving the deployment at a permanent zero balance that rejects all usage with no error explaining why. "Bill me personally" is org_id=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 In: header
Query Parameters
trueRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
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" ], "credentials": [], "tokens": []}{ "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ]}