SparQDocs
GuidesAPI referencesparqhq.ai
API referenceModels

List Routing Rules

GET
/v1/admin/routing-rules

The rules in force, in the order the gateway applies them.

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.

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/routing-rules'
Example Response
{  "next_cursor": "string",  "total": 0,  "items": [    {      "routing_rule_id": "0beced3b-b5bd-4943-a12f-3781c69b6d65",      "version": 1,      "order": 0,      "match": {        "model_class": "fast",        "region": "eu",        "classification": "public"      },      "action": "allow",      "deployments": [        "string"      ],      "note": "string"    }  ]}

List Registry Changes GET

> **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.

Add Trace Destination POST

> **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.