> ## Documentation Index
> Fetch the complete documentation index at: https://docs.falkordb.com/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> FalkorDB is a graph database that speaks the Redis protocol. Queries are issued as OpenCypher through the GRAPH.QUERY and GRAPH.RO_QUERY commands, not over Bolt or a SQL connection.
> FalkorDB implements a subset of OpenCypher with proprietary extensions. Do not assume Neo4j-only syntax or procedures are available — check /cypher/cypher-support and /cypher/known-limitations before using a clause.
> FalkorDB is the successor to RedisGraph, but they are separate products. Do not present RedisGraph commands, versions, or limitations as current FalkorDB behavior.
> Use the official clients listed in /getting-started/clients rather than generic Redis or Neo4j drivers, and prefer the language the user is already working in.
> Configuration parameters are set with GRAPH.CONFIG SET or at startup; cite the exact parameter name from /getting-started/configuration rather than inventing one.
> This site covers four products: FalkorDB (core), FalkorDB Cloud, FalkorDB Enterprise, and the GraphRAG SDK. Name which one an answer applies to, since setup and operations differ.

# Describe instance

> Get the current configuration and status of a Pro Multi-Zone instance.

Returns the deployment metadata, connection details, and current lifecycle status of a single instance.

## Authorization

<ParamField header="Cookie" type="string" required>
  Session cookie set by [Sign in](/cloud/api-reference/authentication/signin): `omnistrate_token=<jwt>`.
  Browsers send it automatically; other clients must forward it on every request.
</ParamField>

## Path parameters

<ParamField path="id" type="string" required>
  ID of the resource instance.
</ParamField>

## Query parameters

<ParamField query="subscriptionId" type="string">
  ID of the subscription that owns the instance.
</ParamField>

## Response

<ResponseField name="cloud_provider" type="string">
  Cloud provider the instance runs on.
</ResponseField>

<ResponseField name="created_at" type="string">
  Time the instance was created.
</ResponseField>

<ResponseField name="id" type="string">
  ID of the resource instance.
</ResponseField>

<ResponseField name="last_modified" type="string">
  Time the instance was last modified.
</ResponseField>

<ResponseField name="network_type" type="string">
  Network type of the instance.
</ResponseField>

<ResponseField name="region" type="string">
  Region the instance runs in.
</ResponseField>

<ResponseField name="result_params" type="object">
  Deployment outputs, including connection endpoints and credentials.
</ResponseField>

<ResponseField name="status" type="string">
  Lifecycle status of the instance, for example `RUNNING` or `STOPPED`.
</ResponseField>

```json 200 OK theme={null}
{
  "id": "instance-abc123",
  "status": "RUNNING",
  "cloud_provider": "aws",
  "region": "us-east-1",
  "network_type": "PUBLIC",
  "created_at": "2026-01-15T10:30:00Z",
  "last_modified": "2026-01-20T08:12:00Z",
  "result_params": {
    "falkordbHostname": "abc123.instances.omnistrate.cloud",
    "falkordbPort": 6379
  }
}
```

## Errors

See [Error](/cloud/api-reference/schemas#error) for the shared error response shape.