Skip to content
MCP Gateway

List data-plane topology and health metadata for a tenant/environment scope.

GET
/v1/data-planes

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
tenant_id
required
string
>= 1 characters
environment_id
required
string
>= 1 characters
status
Allowed values: healthy degraded unhealthy unknown
deployment_mode
Allowed values: hybrid self_hosted
region
string
>= 1 characters
policy_sync_status
Allowed values: current propagating stale unknown
page_size
integer
default: 50 >= 1 <= 100
page_token
string
sort
Allowed values: data_plane_id status region last_heartbeat_at -last_heartbeat_at

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Data-plane list with safe metadata only; no private runtime data, credentials, prompts, request bodies, or response bodies.

object
schemaVersion
required
requestId
required
string
>= 1 characters
tenantId
required
string
>= 1 characters
environmentId
required
string
>= 1 characters
generatedAt
required
string format: date-time
filters
required
object
key
additional properties
string
sort
required
Allowed values: data_plane_id status region last_heartbeat_at -last_heartbeat_at
pagination
required
object
pageSize
required
integer
>= 1 <= 100
nextPageToken
string
totalCount
required
integer
items
required
Array<object>
object
dataPlaneId
required
string
>= 1 characters
displayName
required
string
>= 1 characters
tenantId
required
string
>= 1 characters
environmentId
required
string
>= 1 characters
deploymentMode
required
string
Allowed values: hybrid self_hosted
location
required
object
region
required
string
>= 1 characters
zone
required
string
>= 1 characters
cluster
required
string
>= 1 characters
namespace
required
string
>= 1 characters
deploymentRef
required
string
>= 1 characters
customerLocation
required
string
>= 1 characters
version
required
object
controlPlane
required
string
>= 1 characters
dataPlane
required
string
>= 1 characters
helmChart
required
string
>= 1 characters
config
required
string
>= 1 characters
policy
required
string
>= 1 characters
heartbeat
required
object
status
required
string
Allowed values: healthy degraded unhealthy unknown
lastSeenAt
required
string
>= 1 characters
secondsSinceLast
required
integer
reasonCode
required
string
/^[a-z0-9_]+$/
readiness
required
object
status
required
string
Allowed values: healthy degraded unhealthy unknown
serving
required
boolean
reasonCodes
required
Array<string>
>= 1 items
checkedAt
required
string format: date-time
policySync
required
object
status
required
string
Allowed values: current propagating stale unknown
desiredVersion
required
string
>= 1 characters
observedVersion
required
string
>= 1 characters
lastAppliedAt
required
string
>= 1 characters
staleSeconds
required
integer
reasonCode
required
string
/^[a-z0-9_]+$/
configPropagation
required
object
status
required
string
Allowed values: current propagating stale unknown
desiredVersion
required
string
>= 1 characters
observedVersion
required
string
>= 1 characters
lastAppliedAt
required
string
>= 1 characters
staleSeconds
required
integer
reasonCode
required
string
/^[a-z0-9_]+$/
activeSessions
required
object
total
required
integer
stateful
required
integer
draining
required
integer
reconnectable
required
integer
drain
required
object
ready
required
boolean
state
required
Allowed values: safe blocked draining unknown
reasonCodes
required
Array<string>
>= 1 items
upgrade
required
object
ready
required
boolean
state
required
Allowed values: safe blocked draining unknown
reasonCodes
required
Array<string>
>= 1 items
backupRestore
required
object
relevant
required
boolean
coverageStatus
required
Allowed values: covered needs_attention not_applicable unknown
lastBackupAt
string
restoreTestedAt
string
reasonCode
required
string
/^[a-z0-9_]+$/
trustBoundary
required
object
mode
required
string
Allowed values: hybrid self_hosted
controlPlaneBoundary
required
Allowed values: managed_control_plane_metadata_channel self_hosted_control_plane
runtimeTrafficBoundary
required
runtimeDataBoundary
required
privateRuntimeDataLeavesBoundary
required
boolean
secretMaterialReturned
required
boolean
redactedMetadataMode
required
boolean
noRequiredOutboundRuntime
required
boolean
allowedActions
required
Array<object>
>= 1 items
object
action
required
Allowed values: view drain upgrade
allowed
required
boolean
reasonCode
required
string
/^[a-z0-9_]+$/
healthReasonCodes
required
Array<string>
>= 1 items
kpis
required

Summary counts computed over the filtered (pre-paginated) set, for the UI KPI strip.

object
total
required
integer
healthy
required
integer
degraded
required
integer
unhealthy
required
integer
unknown
required
integer
policyStale
required
integer
activeSessions
required
integer
regions
required
integer
facets
required

Filterable-dimension value→count maps over the filtered set, for UI filter chips.

object
status
required
object
key
additional properties
integer
region
required
object
key
additional properties
integer
deploymentMode
required
object
key
additional properties
integer
policySyncStatus
required
object
key
additional properties
integer
allowedActions
required
Array<object>
>= 1 items
object
action
required
Allowed values: view drain upgrade
allowed
required
boolean
reasonCode
required
string
/^[a-z0-9_]+$/
metadataBoundary
required
object
metadataOnly
required
boolean
privateRuntimeDataLeavesBoundary
required
boolean
secretsReturned
required
boolean
forbiddenMaterial
required
Array
>= 1 items
Allowed values: secrets credential_material prompts request_bodies response_bodies tool_results
customerContentInspectionUnsupported
required
boolean

403

Section titled “403 ”

Caller is not allowed to read this tenant/environment topology scope.

object
schemaVersion
required
requestId
required
string
>= 1 characters
status
required
integer
>= 400 <= 599
reasonCode
required
string
/^[a-z0-9_]+$/
message
required
string
>= 1 characters
retryable
required
boolean
machineSafe
required
boolean
redactionStatus
required
Allowed values: redacted metadata_only
field

Optional metadata-only field identifier for validation errors.

string
details

Optional metadata-only diagnostic details. Never include secret material, payloads, prompts, raw endpoint URLs, or customer data.

object
requiredAction
string
>= 1 characters
resourceRef
string
>= 1 characters
key
additional properties
One of:
string

Type set in Geist, Source Serif 4, and Departure Mono.