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

> ## Agent Instructions
> These docs cover learner integrations through Hosted Lab Pages, the SDK, and the REST API. Content management is outside this integration scope.
> Read the setup page for the chosen approach before implementing it. Keep organization API keys and hosted mint secrets on the server.
> The public SDK is coming soon. Check the SDK quickstart for current availability. Do not invent installation commands or direct readers to a private package.
> Cybr provides completion tracking and CTF verification. The integrating platform decides whether to award points.

# Get deployment status

> Returns deployment readiness. Status complete does not mean learner completion. SDK: `deployments.getStatus()`.

SDK: `deployments.getStatus()`.


## OpenAPI

````yaml assets/openapi.json GET /api/v2/deployments/{deploymentId}
openapi: 3.1.0
info:
  title: Cybr Labs public integration API
  version: 0.0.15
  description: SDK and REST integration contract. Organization keys remain on the server.
  contact:
    email: support@cybr.com
servers:
  - url: https://api.cybr.com
security:
  - OrganizationKey: []
tags:
  - name: Labs
    description: Content, progress, discussions, and resource links.
  - name: Deployments
    description: Lab environments and terminal sessions.
paths:
  /api/v2/deployments/{deploymentId}:
    get:
      tags:
        - Deployments
      summary: Get deployment status
      description: >-
        Returns deployment readiness. Status complete does not mean learner
        completion. SDK: `deployments.getStatus()`.
      operationId: get_deployment
      parameters:
        - name: deploymentId
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeploymentStatus'
              example:
                status: complete
                outputs:
                  console_url:
                    value: https://example.com/console
                    sensitive: true
                    type: string
        '400':
          description: Invalid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Missing or invalid API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Access denied.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Resource not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        default:
          description: Other API error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    DeploymentStatus:
      oneOf:
        - type: object
          properties:
            status:
              const: loading
              type: string
          required:
            - status
        - type: object
          properties:
            status:
              const: failed
              type: string
          required:
            - status
        - type: object
          properties:
            status:
              const: complete
              type: string
            outputs:
              type: object
              additionalProperties: true
          required:
            - status
            - outputs
    Error:
      type: object
      properties:
        message:
          type: string
        retryAfter:
          type: number
        activeCount:
          type: integer
        limit:
          type: integer
        errors:
          type: array
          items:
            type: string
      required:
        - message
  securitySchemes:
    OrganizationKey:
      type: apiKey
      in: header
      name: X-API-Key

````