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

# Revoke deployment

> **Auth:** signed-in organization admin only. Organization API keys are rejected with `403`.

Permanent.



## OpenAPI

````yaml https://cp.xenovia.io/openapi.json post /api/v1/deployments/{deployment_id}/revoke
openapi: 3.1.0
info:
  title: Xenovia Control Plane API
  version: 1.0.0
  description: >-
    Management API for proxies, providers, policies, telemetry, alerts and
    organization settings.
servers:
  - url: https://cp.xenovia.io
    description: Production
security:
  - BearerAuth: []
paths:
  /api/v1/deployments/{deployment_id}/revoke:
    post:
      tags:
        - deployments
      summary: Revoke deployment
      description: >-
        **Auth:** signed-in organization admin only. Organization API keys are
        rejected with `403`.


        Permanent.
      operationId: revoke_deployment_route_api_v1_deployments__deployment_id__revoke_post
      parameters:
        - name: deployment_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Deployment Id
        - name: X-Request-ID
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: X-Request-Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeploymentRead'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    DeploymentRead:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        created_at:
          type: string
          format: date-time
          title: Created At
        updated_at:
          type: string
          format: date-time
          title: Updated At
        org_id:
          type: string
          format: uuid
          title: Org Id
        name:
          type: string
          title: Name
        status:
          $ref: '#/components/schemas/DeploymentStatus'
        ingress_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Ingress Url
        data_plane_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Data Plane Url
        bootstrap_expires_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Bootstrap Expires At
        last_seen_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Last Seen At
        agent_version:
          anyOf:
            - type: string
            - type: 'null'
          title: Agent Version
        runtime_versions:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Runtime Versions
        spool_depth:
          anyOf:
            - type: integer
            - type: 'null'
          title: Spool Depth
        ch_schema_version:
          anyOf:
            - type: integer
            - type: 'null'
          title: Ch Schema Version
        sync_lag_seconds:
          anyOf:
            - type: integer
            - type: 'null'
          title: Sync Lag Seconds
      type: object
      required:
        - id
        - created_at
        - updated_at
        - org_id
        - name
        - status
        - ingress_url
        - data_plane_url
        - bootstrap_expires_at
        - last_seen_at
        - agent_version
        - runtime_versions
        - spool_depth
        - ch_schema_version
        - sync_lag_seconds
      title: DeploymentRead
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    DeploymentStatus:
      type: string
      enum:
        - pending
        - active
        - revoked
      title: DeploymentStatus
      description: |-
        Lifecycle of a hybrid data-plane deployment.

        pending  — created; bootstrap token issued but not yet redeemed
        active   — agent bootstrapped; deployment credential valid
        revoked  — credential invalidated; the agent can no longer sync
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        Bearer token: an organization API key (`ak_…`) created under Settings →
        API Keys, or a dashboard user session token. Proxy keys (`xe_…`) are not
        accepted here. Endpoints marked as user-only in their description reject
        organization keys with `403`.

````