GET /managed-services/instances/{instanceId}
Read one managed service instance, its lifecycle revision and its connection metadata.
Syntax
GET https://grid-lab.zyxio.xyz/managed-services/instances/<instanceId>
x-api-key: <key>Request
| Name | Where | Required | Meaning |
|---|---|---|---|
x-api-key | header | yes, or Authorization | Your API key, or Authorization: Bearer <token> from Zyxio sign-in. |
instanceId | path | yes | The UUID returned as id when provisioning, or in the instance list. |
No body or query parameters are needed. The instance must belong to the authenticated account.
Response
200 OK, the instance record directly, without an envelope or schemaVersion.
| Field | Meaning |
|---|---|
id, accountId | The instance UUID and its owning account UUID. |
service | postgres, mlflow, litellm or redis. |
name | The instance's display name. |
profile | Its placement profile: the private platform or awow-azure. |
state | requested, provisioning, ready, blocked, suspended or retired. |
revision | A positive integer. Send the latest value when requesting a lifecycle action. |
requestedAction | none, provision, rotate, resize, restore, suspend, resume or retire. A value other than none means a change is pending. |
requestNote, statusNote | The latest request note and recorded status explanation. |
binding | Connection and verification metadata, or null before it is available. Contains no password or private token. |
createdAt, updatedAt | ISO 8601 timestamps for creation and last update. |
readyAt | ISO 8601 timestamp of the recorded ready transition, or null. |
Binding fields
| Field | Meaning |
|---|---|
endpoint | The service connection address, without embedded credentials. |
profile, accessBindingProfile | Placement and qualified service profile. |
accessBindingId, accessBindingRevision | The access grant's binding UUID and revision; distinct from the instance's id and revision. |
version, release | Service version and immutable release digest. |
isolation | dedicated-account or shared-internal; read the instance's isolation and limitations together. |
network, authentication, instructions, limitations | How to connect and the supported configuration's limits. |
evidence, verifiedAt | Recorded verification reference and ISO 8601 verification time. |
database, username, poolMode, backendLimit | PostgreSQL database, login, pool mode and backend connection budget. Present for PostgreSQL bindings. |
keyPrefix, aclUsername, maxMemoryPolicy | Redis key/channel prefix, ACL username and memory policy when provided. |
workloads | Observed workloads, each with cluster, namespace, name, uid and kind. |
resources | Attributed resources, each with kind: "pod" and an immutable id. |
A retained binding is not proof of current access. Check that state is ready and requestedAction is none before downloading credentials. Changed access bindings can make the instance appear blocked; statusNote explains what needs verification. Polling reads state without executing pending actions.
Errors
| Status | Body | When | What to do |
|---|---|---|---|
401 | {"error": "unauthorized"} | Missing, revoked, expired or invalid API key. | Send a valid key. |
403 | {"error": "forbidden"} | A sign-in token has no usable account. | Use an invited account or its API key. |
403 | {"error": "managed_service_account_required"} | The caller has no active, allocated account. | Check the account used by your credential. |
503 | {"error": "accounting_unavailable"} | Authentication could not check the account database. | Retry shortly. |
404 | {"error": "managed_service_not_found"} | Invalid UUID, missing instance or an instance of another account. | Check the ID and account. |
503 | {"error": "managed_service_unavailable"} | A service dependency failed or did not answer. | Retry shortly; read current status before repeating a change. |
Example
Use INSTANCE_ID saved from the provisioning response, or select an ID from GET /managed-services/instances.
curl -fsS "https://grid-lab.zyxio.xyz/managed-services/instances/$INSTANCE_ID" \
-H "x-api-key: $BROWSERGRID_API_KEY"Selected fields while setup is pending:
{
"id": "7be7d0d2-4eb8-4f38-9490-3fd25b8eb5bd",
"service": "postgres",
"name": "example-postgres",
"state": "requested",
"revision": 1,
"requestedAction": "provision",
"binding": null,
"readyAt": null
}Billing
Free. Polling does not change plan accrual; only completed lifecycle changes stop or resume active time. See Credit and billing.
See also
GET /managed-services/instances, POST /managed-services/instances/{instanceId}/credentials, POST /managed-services/instances/{instanceId}/actions.