Skip to main content
GET
Describe instance
Returns the deployment metadata, connection details, and current lifecycle status of a single instance.

Authorization

Session cookie set by Sign in: omnistrate_token=<jwt>. Browsers send it automatically; other clients must forward it on every request.

Path parameters

string
required
ID of the resource instance.

Query parameters

string
ID of the subscription that owns the instance.

Response

string
Cloud provider the instance runs on.
string
Time the instance was created.
string
ID of the resource instance.
string
Time the instance was last modified.
string
Network type of the instance.
string
Region the instance runs in.
object
Deployment outputs, including connection endpoints and credentials.
string
Lifecycle status of the instance, for example RUNNING or STOPPED.
200 OK

Errors

See Error for the shared error response shape.