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

# Join machine



## OpenAPI

````yaml /api-reference/openapi/controlplane.openapi.json post /machines/join
openapi: 3.0.0
info:
  title: levers9 controlplane API
  version: 1.0.0
  description: >-
    REST view of the levers9 controlplane gRPC service, served by the
    controlplane on port 1994. Authenticate with `Authorization: Bearer
    <token>`.
servers:
  - url: https://levers9.uselevers.com
    description: local controlplane
  - url: https://api.uselevers.com
    description: hosted
security:
  - bearer: []
tags:
  - name: ControlPlaneService
paths:
  /machines/join:
    post:
      tags:
        - ControlPlaneService
      summary: Join machine
      operationId: ControlPlaneService_JoinMachine
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/controlplaneJoinMachineRequest'
        required: true
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/controlplaneJoinMachineResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rpcStatus'
components:
  schemas:
    controlplaneJoinMachineRequest:
      type: object
      properties:
        joinToken:
          type: string
        machineFingerprint:
          type: string
        hostname:
          type: string
        os:
          type: string
        arch:
          type: string
        cpuCount:
          type: integer
          format: int64
        memoryMb:
          type: string
          format: uint64
        gpu:
          type: array
          items:
            type: string
        gpuCount:
          type: integer
          format: int64
        preflight:
          type: array
          items:
            $ref: '#/components/schemas/controlplaneMachinePreflightCheck'
        schedulable:
          type: boolean
        executor:
          type: string
        cpuMillicores:
          type: string
          format: int64
        gpuIds:
          type: array
          items:
            type: string
        networkSlotPoolSize:
          type: integer
          format: int64
        containerStartConcurrency:
          type: integer
          format: int64
        workerImage:
          type: string
          description: >-
            Optional per-machine worker image override. The controlplane
            remembers the

            generated value as a baseline so untouched installs continue to
            follow

            future image tag changes while manually edited values remain pinned.
        capabilities:
          type: array
          items:
            type: string
    controlplaneJoinMachineResponse:
      type: object
      properties:
        ok:
          type: boolean
        errMsg:
          type: string
        workspaceId:
          type: string
        poolName:
          type: string
        machineId:
          type: string
        machineToken:
          type: string
        bootstrap:
          $ref: '#/components/schemas/controlplaneMachineBootstrapConfig'
    rpcStatus:
      type: object
      properties:
        code:
          type: integer
          format: int32
        message:
          type: string
        details:
          type: array
          items:
            $ref: '#/components/schemas/protobufAny'
    controlplaneMachinePreflightCheck:
      type: object
      properties:
        name:
          type: string
        ok:
          type: boolean
        message:
          type: string
        severity:
          type: string
    controlplaneMachineBootstrapConfig:
      type: object
      properties:
        controlplaneHttpUrl:
          type: string
        controlplaneGrpcHost:
          type: string
        controlplaneGrpcPort:
          type: integer
          format: int32
        controlplaneGrpcTls:
          type: boolean
        workspaceId:
          type: string
        poolName:
          type: string
        transport:
          type: string
        executor:
          type: string
        fallback:
          type: string
        disabledServices:
          type: array
          items:
            type: string
        imageRegistryStore:
          type: string
        imageClipVersion:
          type: integer
          format: int64
        imageLocalCacheEnabled:
          type: boolean
        telemetry:
          $ref: '#/components/schemas/controlplaneMachineTelemetryConfig'
        billing:
          $ref: '#/components/schemas/controlplaneMachineBillingConfig'
    protobufAny:
      type: object
      properties:
        '@type':
          type: string
      additionalProperties: {}
    controlplaneMachineTelemetryConfig:
      type: object
      properties:
        enabled:
          type: boolean
        streamPrefix:
          type: string
        logs:
          $ref: '#/components/schemas/controlplaneMachineTelemetrySinkConfig'
        events:
          $ref: '#/components/schemas/controlplaneMachineTelemetrySinkConfig'
    controlplaneMachineBillingConfig:
      type: object
      properties:
        usageEndpoint:
          type: string
        usageToken:
          type: string
        costHookEndpoint:
          type: string
        costHookToken:
          type: string
        billableMarginPct:
          type: number
          format: double
    controlplaneMachineTelemetrySinkConfig:
      type: object
      properties:
        destination:
          type: string
        credential:
          type: string
        streamPrefix:
          type: string
  securitySchemes:
    bearer:
      type: http
      scheme: bearer

````

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