List Deployments

GET
/v1/admin/deployments

Every deployment, including disabled ones, with its status. Connection details (endpoint, key reference) are not part of the contract and are not returned.

Authorization

HTTPBearer
headerAuthorizationBearer <token>

Bearer credential. API keys look like sqk_<geo>_<key_id>_<secret>: treat them as opaque and never put one in a browser. Older keys without the geo part stay valid until rotated. Find a geo's endpoints through GET /.well-known/sparq-discovery before sending a key.

Query Parameters

limit?Limit

Items per page (default 50, at most 200).

Range1 <= value <= 200
Default50
cursor?|

Opaque next_cursor from the previous page.

sort?|

Field to sort by; '-' for descending. Ties break on the id.

Header Parameters

Sparq-Workspace?string

For a person signed in to a console with several workspaces: the workspace this call is for, one of their memberships (listMyMemberships). Without it such a person gets workspace_required (400); a workspace they are not a member of is forbidden. It never grants anything, and other callers' credentials ignore it.

Formatuuid

Response Body

Successful Response

application/json
  1. response
next_cursor*|

Pass as cursor for the next page; empty at the end.

total?|

Number of matching items, only when cheap to count.

items*array<>
Example Request
curl -X GET 'http://dev-sparq.centralindia.cloudapp.azure.com:8000/v1/admin/deployments'
Example Response
{  "next_cursor": "string",  "total": 0,  "items": [    {      "deployment_id": "6ef0ac85-9892-4664-a2a5-58bf2af5a8a6",      "provider": "string",      "deployment": "string",      "model_class": "fast",      "region": "eu",      "retention": "zero_retention_required",      "capabilities": [        "string"      ],      "context_window": 0,      "deprecates_at": "2019-08-24T14:15:22Z",      "status": "active"    }  ]}