SparQDocs
GuidesAPI referencesparqhq.ai
API referenceModels

Get Registry Change

GET
/v1/admin/registry-changes/{registry_change_id}

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.

Path Parameters

registry_change_id*Registry Change Id
Formatuuid

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

A proposed registry change. The author cannot approve it (maker != checker).

registry_change_id*Registry Change Id
Formatuuid
title*Title
reason*Reason
items*array<||>
status*RegistryChangeStatus
Value in"open""approved""rejected""applied""withdrawn"
created_by*Created By
credential_id*Credential Id
Formatuuid
approvals*array<>
created_at*Created At
Formatdate-time
applied_at*|null
Example Request
curl -X GET 'http://dev-sparq.centralindia.cloudapp.azure.com:8000/v1/admin/registry-changes/497f6eca-6276-4993-bfeb-53cbbbba6f08'
Example Response
{  "registry_change_id": "dfd97f41-5dc5-439c-8a35-070cb5e03dae",  "title": "string",  "reason": "string",  "items": [    {      "kind": "deployment",      "operation": "create",      "deployment_id": "6ef0ac85-9892-4664-a2a5-58bf2af5a8a6",      "spec": {        "provider": "string",        "deployment": "string",        "model_class": "fast",        "region": "eu",        "retention": "zero_retention_required",        "capabilities": [          "string"        ],        "context_window": 1,        "deprecates_at": "2019-08-24T14:15:22Z"      },      "connection": {        "adapter": "azure_openai",        "model": "string",        "endpoint": "string",        "api_version": "string",        "secret_ref": "string",        "max_classification": "public",        "self_hosted": false      }    }  ],  "status": "open",  "created_by": "string",  "credential_id": "13c40afa-2996-4a0c-b2e9-68fba9462242",  "approvals": [    {      "approver": "string",      "credential_id": "13c40afa-2996-4a0c-b2e9-68fba9462242",      "decision": "approve",      "comment": "string",      "decided_at": "2019-08-24T14:15:22Z"    }  ],  "created_at": "2019-08-24T14:15:22Z",  "applied_at": "2019-08-24T14:15:22Z"}

Decide Registry Change 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. Approve or reject. The author cannot approve their own change.

List Deployments GET

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