> ## 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.

# Get agent readiness

> **Auth:** organization API key (`read` scope or higher) or a signed-in user.

What stands between the agent and serving traffic: `can_activate`, each blocker with its fix, and what is already in place.



## OpenAPI

````yaml https://cp.xenovia.io/openapi.json get /api/v1/agents/{agent_id}/readiness
openapi: 3.1.0
info:
  title: Xenovia Control Plane API
  version: 1.0.0
  description: >-
    Management API for agents, providers, policies, telemetry, alerts and
    organization settings.
servers:
  - url: https://cp.xenovia.io
    description: Production
security:
  - BearerAuth: []
paths:
  /api/v1/agents/{agent_id}/readiness:
    get:
      tags:
        - agents
      summary: Get agent readiness
      description: >-
        **Auth:** organization API key (`read` scope or higher) or a signed-in
        user.


        What stands between the agent and serving traffic: `can_activate`, each
        blocker with its fix, and what is already in place.
      operationId: get_readiness_route_api_v1_agents__agent_id__readiness_get
      parameters:
        - name: agent_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Agent Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Readiness'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    Readiness:
      properties:
        status:
          type: string
          title: Status
        can_activate:
          type: boolean
          title: Can Activate
        protection:
          $ref: '#/components/schemas/ReadinessProtection'
        blockers:
          items:
            $ref: '#/components/schemas/ReadinessBlocker'
          type: array
          title: Blockers
        satisfied:
          items:
            type: string
          type: array
          title: Satisfied
        pending:
          items:
            type: string
          type: array
          title: Pending
      type: object
      required:
        - status
        - can_activate
        - protection
        - blockers
        - satisfied
        - pending
      title: Readiness
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ReadinessProtection:
      properties:
        enabled:
          type: integer
          title: Enabled
        enforced:
          type: integer
          title: Enforced
        label:
          type: string
          enum:
            - not_configured
            - monitoring_configured
            - configured
          title: Label
        operational_availability:
          type: string
          const: not_checked
          title: Operational Availability
          default: not_checked
      type: object
      required:
        - enabled
        - enforced
        - label
      title: ReadinessProtection
      description: >-
        Saved protection configuration; this does not probe runtime
        availability.
    ReadinessBlocker:
      properties:
        code:
          type: string
          title: Code
        fix:
          $ref: '#/components/schemas/ReadinessFix'
        blocks_activation:
          type: boolean
          title: Blocks Activation
          default: true
      type: object
      required:
        - code
        - fix
      title: ReadinessBlocker
    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
    ReadinessFix:
      properties:
        action:
          type: string
          title: Action
        provider_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Provider Id
      type: object
      required:
        - action
      title: ReadinessFix
  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. Agent keys (`xe_…`) are not
        accepted here. Endpoints marked as user-only in their description reject
        organization keys with `403`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.