Skip to content
MCP Gateway

Inspect one data plane with topology, health, sync, sessions, drain, upgrade, backup, and trust-boundary metadata.

GET
/v1/data-planes/{data_plane_id}

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
data_plane_id
required
string
>= 1 characters

Query Parameters

Section titled “Query Parameters ”
tenant_id
required
string
>= 1 characters
environment_id
required
string
>= 1 characters

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Data-plane detail with safe metadata only and no private payloads or secrets.

object
schemaVersion
required
requestId
required
string
>= 1 characters
dataPlane
required
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
connectedConnectors
required
Array<object>
object
connectorId
required
string
>= 1 characters
displayName
required
string
>= 1 characters
healthStatus
required
string
Allowed values: healthy degraded unhealthy unknown
routeAvailable
required
boolean
reasonCode
required
string
/^[a-z0-9_]+$/
connectedRoutes
required
Array<object>
object
routeId
required
string
>= 1 characters
targetType
required
Allowed values: mcp_server api_operation connector
targetRef
required
string
>= 1 characters
healthStatus
required
string
Allowed values: healthy degraded unhealthy unknown
reasonCode
required
string
/^[a-z0-9_]+$/
telemetry
required
object
mode
required
Allowed values: disabled customer_local managed_metadata_only
status
required
string
Allowed values: healthy degraded unhealthy unknown
reasonCode
required
string
/^[a-z0-9_]+$/
license
required
object
status
required
Allowed values: valid expiring missing unknown
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 data-plane metadata.

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

404

Section titled “404 ”

Data plane metadata was not found for the requested tenant and environment 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.