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

# Launch deployment

> Starts a lab environment. Acceptance does not mean readiness. REST requires membership. SDK: `deployments.launch()`.

SDK: `deployments.launch()`.


## OpenAPI

````yaml assets/openapi.json POST /api/v2/deployments
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:
    post:
      tags:
        - Deployments
      summary: Launch deployment
      description: >-
        Starts a lab environment. Acceptance does not mean readiness. REST
        requires membership. SDK: `deployments.launch()`.
      operationId: launch_deployment
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LaunchRequest'
            example:
              labId: lab_id
              learnerId: academy:user:uuid
              membership: free
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LaunchResponse'
              example:
                deploymentId: deployment_id
                version: v2
        '400':
          description: Invalid launch input.
          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 or inactive subscription.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Lab not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: >-
            Learner launch limit or organization capacity reached. Read
            retryAfter or activeCount and limit.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: Temporary deployment capacity unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        default:
          description: Other API error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    LaunchRequest:
      type: object
      properties:
        labId:
          type: string
        learnerId:
          type: string
        membership:
          enum:
            - free
            - premium
        sourceIp:
          type: string
          description: >-
            Learner public IP from trusted server request metadata. Unsupported
            values are ignored.
      required:
        - labId
        - learnerId
        - membership
    LaunchResponse:
      type: object
      properties:
        deploymentId:
          type: string
        version:
          const: v2
          type: string
      required:
        - deploymentId
        - version
    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

````