List Kill Switches

GET
/v1/admin/kill-switches

Not available yet. This operation is part of the published contract and answers 501 not_implemented until it is built. The request and response shapes below are final for this contract version.

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.

target_type?|null
active?boolean|null

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/kill-switches'
Example Response
{  "next_cursor": "string",  "total": 0,  "items": [    {      "kill_switch_id": "a4722600-1a5a-4538-be3e-0d58f18ed790",      "target_type": "agent",      "target_id": "string",      "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",      "active": true,      "reason": "string",      "set_by_credential_id": "aa04de38-abd9-4592-a7d5-71fc56046449",      "set_at": "2019-08-24T14:15:22Z",      "expires_at": "2019-08-24T14:15:22Z",      "cleared_at": "2019-08-24T14:15:22Z"    }  ]}