List Deployments
List the deployments the caller may read.
Visibility is enforced by bundle_deployment_provider.search via the
security context: the deployments of every organisation where the
caller holds deployments:read (teammates' included), plus the
caller's own deployments that belong to no organisation. A platform
admin's global access bypasses that filter, so the unscoped listing
adds an explicit owner filter to stay the admin's own.
org_id bounds the listing to one workspace after asserting
deployments:read there: the caller's personal workspace maps to
their deployments billed to no organisation, a team workspace to every
deployment billed to that team. An agent only binds to a deployment of
its own organisation, so this is also the set a workspace's agents can
use. Omitting org_id lists every workspace the caller can read.
Returns a lightweight summary (health, active token count) rather
than the full detail payload returned by get_deployment.
Args:
org_id: Optional workspace organisation bounding the listing.
bundle_id: Optional filter to deployments of one specific bundle.
name: Optional prefix-match filter on deployment name.
created_at: Optional FHIR-style prefixed datetime filters on
creation time.
updated_at: Optional FHIR-style prefixed datetime filters on
last-updated time.
_sort: Optional sort field (name, created_at, or
updated_at), with a leading "-" for descending.
Authorization
OAuth2AuthorizationCodeBearer In: header
Query Parameters
Restrict to the deployments of one organisation's workspace
Filter to deployments of a specific bundle
Filter by deployment name (prefix match)
Filter by creation time, FHIR-style prefixed datetime search
Filter by last-updated time, FHIR-style prefixed datetime search
Sort field with optional - prefix for descending. Supported: name, created_at, updated_at
true1 <= value <= 1001001 <= value1Response Body
application/json
application/json
curl -X GET "https://example.com/v1/deployments"{ "page": 0, "page_size": 0, "has_next": true, "has_previous": true, "total_pages": 0, "items": [ { "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 } ]}{ "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ]}