> ## Documentation Index > Fetch the complete documentation index at: https://docs.ornn.com/llms.txt > Use this file to discover all available pages before exploring further. # Pull a repository into a volume > Queues a pull of one branch into a new folder on the volume and returns the volume. The pull runs in the background. Poll Get a volume and read source.github_repositories for the folder until sync.state is ready or failed. The folder must not already contain files. A volume runs one pull or sync at a time. See [Pull a repository through the API](/guides/github-repositories#pull-a-repository-through-the-api) for the polling sequence. ## OpenAPI ````yaml openapi.yaml POST /v1/orchestrator/drives/{drive_id}/github openapi: 3.1.0 info: title: Ornn compute API version: 1.0.0 description: >- Customer HTTP API for Ornn GPU capacity. It covers reserved capacity and nodes, VM and Bare Metal access, Kubernetes and Slurm clusters, SSH keys, storage volumes and GitHub repositories, private networks, monitoring, buying and selling capacity (Reserve, Market, Spot, and Relist), and billing. API keys are scoped to one organization and act with their creator's access there; account, team, and API-key management stay in the console. Most operations require an approved organization. See https://docs.ornn.com/api-keys to create a key and https://docs.ornn.com/guides/kubernetes-api for an end-to-end Kubernetes integration. Examples use fictional IDs and credentials. The info.version field identifies the contract revision, not a shared API path version. contact: email: support@ornn.com servers: - url: https://api.ornn.com description: Production security: - OrnnApiKey: [] tags: - name: Authentication - name: Reservations - name: GPU nodes - name: Clusters - name: Workers - name: Virtual machines description: >- Choose a VM disk, launch VM access on a reservation, and read each VM's status, launch progress, and SSH connection details. - name: Bare Metal description: >- Launch Bare Metal access on a reservation, read a host's readiness and SSH connection details, and reboot or hard reset it. - name: SSH keys description: >- Register public keys for your organization, choose which keys a VM or Bare Metal reservation uses, and queue key delivery to machines. Slurm clusters take organization key IDs at launch. Kubernetes API access does not use SSH keys. - name: Reserve description: >- Browse reserved-capacity listings and their terms, and post, cancel, or accept offers. Reserve listings are visible to approved organizations. - name: Market description: >- Browse relisted capacity and buy windows at the asking price, paid up front. Open to every member of your organization. - name: Spot description: >- Hourly order books for VMs with 1, 2, 4, or 8 GPUs on one node: read books, trades, and quotes, place and cancel bids, and follow fills. - name: Relist description: >- Sell whole nodes from a reservation you hold at your asking price, and manage those listings. - name: Storage description: >- Managed volumes, their files, and GitHub repository pulls. Volumes belong to the API key's creator in the key's organization. - name: Networks description: >- Organization private networks and the WireGuard configs you use to reach private machines and clusters. - name: Monitoring description: >- Machine telemetry and console logs for capacity your organization holds. Reads are limited to your reservation window. - name: Billing description: >- Invoices, billing summary, usage cost, Ornn credits, and account statements. Saving a card and paying invoices stay in the console. externalDocs: description: REST integration walkthrough url: >- https://docs.ornn.com/guides/kubernetes-access#provision-and-manage-through-rest paths: /v1/orchestrator/drives/{drive_id}/github: parameters: - $ref: '#/components/parameters/PlatformDriveId' post: tags: - Storage summary: Pull a repository into a volume description: >- Queues a pull of one branch into a new folder on the volume and returns the volume. The pull runs in the background. Poll Get a volume and read source.github_repositories for the folder until sync.state is ready or failed. The folder must not already contain files. A volume runs one pull or sync at a time. operationId: platformPullGithubRepository requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PlatformPullRepository' example: connection_id: dddddddd-dddd-4ddd-8ddd-dddddddddddd repository_id: 123456789 full_name: example-org/training branch: main folder: training responses: '200': description: >- The pull is queued. The volume is returned with the new repository entry. content: application/json: schema: $ref: '#/components/schemas/PlatformVolume' example: id: 77777777-7777-4777-8777-777777777777 source_drive_id: null name: training-data status: active size_bytes: 0 file_count: 0 file_tree_status: ready content_epoch: 0 source: status: ready region: us-central1 read_only: false github_repositories: - folder: training full_name: example-org/training branch: main connection_id: dddddddd-dddd-4ddd-8ddd-dddddddddddd sync: state: queued requested_at: '2026-10-14T12:00:00Z' file_capabilities: state: ready can_upload: true message: null active_mount: null active_mounts: [] created_at: '2026-10-01T12:00:00Z' updated_at: '2026-10-14T12:00:00Z' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': description: The volume or GitHub connection was not found. content: application/json: schema: $ref: '#/components/schemas/Error' example: detail: code: storage_github_connection_not_found message: >- Ornn has no GitHub account linked for this. Connect GitHub in Account settings, then try again. '409': description: >- The folder already has files, or another sync, upload, or deletion is running. content: application/json: schema: $ref: '#/components/schemas/Error' example: detail: code: storage_github_folder_taken message: >- This volume already has a folder with that name. Choose another name. '422': description: Invalid repository name, branch, or folder. content: application/json: schema: $ref: '#/components/schemas/Error' default: $ref: '#/components/responses/Error' components: parameters: PlatformDriveId: name: drive_id in: path required: true description: Volume ID. schema: type: string format: uuid example: 77777777-7777-4777-8777-777777777777 schemas: PlatformPullRepository: type: object required: - connection_id - repository_id - full_name - branch - folder properties: connection_id: type: string format: uuid repository_id: type: integer format: int64 full_name: type: string description: Repository owner and name. branch: type: string folder: type: string description: >- New folder on the volume. 1 to 64 letters, digits, hyphens, underscores, or periods. maxLength: 64 PlatformVolume: type: object description: >- A volume. Responses can include additional fields; ignore fields you do not recognize. required: - id - name - status properties: id: type: string format: uuid source_drive_id: type: - string - 'null' format: uuid description: The volume this one was duplicated from. name: type: string status: type: string description: active for a usable volume. size_bytes: type: integer format: int64 description: Measured size. It can lag writes from mounted machines. file_count: type: - integer - 'null' file_tree: type: array description: >- A preview of recently updated files. Use List volume files for a complete listing. items: type: object file_tree_status: type: string content_epoch: type: integer format: int64 description: Increases whenever the volume's files change. source: type: object properties: status: type: string region: type: - string - 'null' description: Storage region. read_only: type: boolean github_repositories: type: array items: $ref: '#/components/schemas/PlatformVolumeGithubRepository' file_capabilities: type: object properties: state: type: string can_upload: type: boolean message: type: - string - 'null' active_mount: anyOf: - $ref: '#/components/schemas/PlatformVolumeMount' - type: 'null' active_mounts: type: array items: $ref: '#/components/schemas/PlatformVolumeMount' created_at: type: string format: date-time updated_at: type: string format: date-time Error: type: object properties: code: type: string detail: oneOf: - type: string - type: object required: - code - message properties: code: type: string message: type: string PlatformVolumeGithubRepository: type: object description: A repository pulled into a folder of the volume. properties: folder: type: string full_name: type: string branch: type: string connection_id: type: string format: uuid sync: type: object description: The latest pull or sync of this folder. properties: state: type: string description: queued, running, ready, or failed. step: type: string description: While running, checking, downloading, writing, or promoting. requested_at: type: string format: date-time commit_sha: type: string error: type: - string - 'null' description: A customer-readable reason when state is failed. PlatformVolumeMount: type: object description: The volume's mount on one VM or Bare Metal node. properties: id: type: string format: uuid drive_id: type: string format: uuid reservation_id: type: - string - 'null' format: uuid node_id: type: - string - 'null' format: uuid description: The Bare Metal node or the host delivering commands to the VM. virtual_machine_id: type: - string - 'null' format: uuid description: The mounted VM. Null for a Bare Metal mount. mount_path: type: string access: type: string description: read-write or read-only. state: type: string description: >- reserved, provisioning, mounted, release_pending, failed, or stale. mounted means the volume is mounted on this VM or Bare Metal node. Handle unrecognized values without assuming readiness. error: type: - string - 'null' created_at: type: string format: date-time updated_at: type: string format: date-time responses: Unauthorized: description: >- The credential is missing, invalid, revoked, or no longer belongs to a current organization member. Check the HTTP status before parsing the body. content: application/json: schema: $ref: '#/components/schemas/Error' Forbidden: description: >- The credential lacks access to this operation, or the organization requires approval. An API key does not bypass these checks. content: application/json: schema: $ref: '#/components/schemas/Error' Error: description: >- Unsuccessful request. Check HTTP status first. Errors may have detail.code/detail.message, a string detail and optional top-level code, or an empty/non-JSON body. 401: invalid credential; 403: access or approval required; 404: not visible or credentials not ready; 409: lifecycle conflict; 429: back off; 5xx: service failure. Inspect current state before retrying mutations. content: application/json: schema: $ref: '#/components/schemas/Error' securitySchemes: OrnnApiKey: type: http scheme: bearer bearerFormat: ornn_sk_... description: >- Create an organization API key in Account Settings > Developer. Do not send this key to the Kubernetes API server. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.