Skip to content
MCP Gateway

Move a connector through explicit lifecycle transitions without patching raw fields.

POST
/v1/connectors/{connector_id}/lifecycle

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

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

Request Body required

Section titled “Request Body required ”
object
tenant_id
required
string
>= 1 characters
environment_id
required
string
>= 1 characters
to_state
required
Allowed values: active disabled revoked archived
reason_code
required
string
/^[a-z0-9_]+$/
reason
required
string
>= 1 characters
expected_version
required
string
>= 1 characters

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Connector lifecycle transition applied and audited.

object
schemaVersion
required
connector
required
object
schemaVersion
required
summary
required
object
connectorId
required
string
>= 1 characters
tenantId
required
string
>= 1 characters
environmentId
required
string
>= 1 characters
lifecycleState
required
Allowed values: submitted under_review active disabled revoked archived
approvalStatus
required
string
Allowed values: submitted under_review approved rejected disabled archived
healthStatus
required
Allowed values: healthy degraded unhealthy unknown
routeAvailable
required
boolean
routeAvailabilityReason
required
string
/^[a-z0-9_]+$/
owner
required
object
team
required
string
>= 1 characters
userId
required
string
>= 1 characters
escalationContact
required
string
>= 1 characters
region
required
string
>= 1 characters
deploymentLocation
required
string
>= 1 characters
connectedBackendCount
required
integer
connectedMcpServerCount
required
integer
connectedApiSourceCount
required
integer
lastHeartbeatAt
required
string format: date-time
latencyMs
required
integer
revocationStatus
required
Allowed values: none disabled revoked
revocationReasonCode
string
/^[a-z0-9_]+$/
version
required
string
>= 1 characters
etag
required
string
>= 1 characters
permissions
required
object
allowedActions
required
Array
Allowed values: connector.view connector.view_impact connector.disable connector.reenable connector.revoke connector.archive
auth
required
object
mtlsStatus
required
Allowed values: configured not_configured unknown
workloadIdentityStatus
required
Allowed values: configured not_configured unknown
authMethod
required
Allowed values: mtls spiffe equivalent
redactionStatus
required
Allowed values: redacted disabled
allowedBackends
required
Array<object>
object
backendId
required
string
>= 1 characters
endpointRef
required
string
/^connector://[^/]+/[^/]+$/
targetType
required
Allowed values: mcp_server api_source
environmentId
required
string
>= 1 characters
mcpServerId
string
>= 1 characters
apiSourceId
string
>= 1 characters
operationId
string
>= 1 characters
toolId
required
string
>= 1 characters
connectedMcpServers
required
Array<object>
object
serverId
required
string
>= 1 characters
toolId
required
string
>= 1 characters
backendRef
required
string
/^connector://[^/]+/[^/]+$/
connectedApiSources
required
Array<object>
object
apiSourceId
required
string
>= 1 characters
operationId
required
string
>= 1 characters
toolId
required
string
>= 1 characters
backendRef
required
string
/^connector://[^/]+/[^/]+$/
healthHistory
required
object
window
required
Allowed values: 24h
samples
required
Array<object>
object
checkedAt
required
string format: date-time
status
required
Allowed values: healthy degraded unhealthy unknown
routeAvailable
required
boolean
latencyMs
required
integer
checkedBy
required
string
>= 1 characters
reasonCode
string
/^[a-z0-9_]+$/
degradedCount
required
integer
unhealthyCount
required
integer
lastFailureReason
string
/^[a-z0-9_]+$/
recentRoutingFailures
required
Array<object>
object
failedAt
required
string format: date-time
backendId
required
string
>= 1 characters
reasonCode
required
string
/^[a-z0-9_]+$/
routeAvailable
required
boolean
upstreamAttempted
required
boolean
audit
required
object
createdEventId
required
string
>= 1 characters
lastEventId
required
string
>= 1 characters
lastTransition
required
Allowed values: submitted under_review active disabled revoked archived
lastTransitionAt
required
string format: date-time
affectedSessions
required
Array<object>
object
id
required
string
>= 1 characters
href
required
string
/^/operate//
affectedRoutes
required
Array<object>
object
id
required
string
>= 1 characters
href
required
string
/^/operate//
auditEventId
required
string
>= 1 characters
version
required
string
>= 1 characters
etag
required
string
>= 1 characters

403

Section titled “403 ”

Caller lacks the connector lifecycle permission for the current state.

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 ”

Connector not found in 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

409

Section titled “409 ”

Stale connector version or invalid lifecycle transition.

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

422

Section titled “422 ”

Invalid reason code, missing expected_version, blank reason, or unsafe connector 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

500

Section titled “500 ”

Connector repository or audit store is unavailable.

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.