> ## 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. # Create a private network > Creates a named organization network and starts provisioning its gateway. The network is usable when status is active; poll Get a private network. Omit cidr to have Ornn choose a free /16 range. Names are unique within the organization, ignoring case. This request is not idempotent; after a timeout, list networks by name before retrying. CLI equivalent: `ornn private-networks create --name research --cidr 10.20.0.0/16 --yes --idempotency-key --format json`. ## OpenAPI ````yaml openapi.yaml POST /v1/orchestrator/networks 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/networks: post: tags: - Networks summary: Create a private network description: >- Creates a named organization network and starts provisioning its gateway. The network is usable when status is active; poll Get a private network. Omit cidr to have Ornn choose a free /16 range. Names are unique within the organization, ignoring case. This request is not idempotent; after a timeout, list networks by name before retrying. operationId: platformCreateNetwork requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PlatformCreateNetwork' example: name: research cidr: 10.20.0.0/16 responses: '201': description: Network created; provisioning continues in the background. content: application/json: schema: $ref: '#/components/schemas/PlatformNetworkEnvelope' example: network: id: 88888888-8888-4888-8888-888888888888 name: research cidr: 10.20.0.0/16 status: pending endpoint: null public_key: null attached_reservation_count: 0 gateway: status: pending endpoint: null public_key: null compartments: - network_id: 88888888-8888-4888-8888-888888888888 compartment_id: provision_key status: pending error: null created_at: '2026-10-14T12:00:00Z' updated_at: '2026-10-14T12:00:00Z' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '409': description: >- The name or CIDR range is already in use, or no automatic range is free. content: application/json: schema: $ref: '#/components/schemas/Error' example: detail: code: network_cidr_overlap message: That CIDR range overlaps an existing or reserved network. '422': description: >- Missing name, or a CIDR that is invalid, not private, or outside /16 to /24. content: application/json: schema: $ref: '#/components/schemas/Error' example: detail: code: invalid_network_cidr message: Enter a valid CIDR block, like 10.0.0.0/16. default: $ref: '#/components/responses/Error' components: schemas: PlatformCreateNetwork: type: object required: - name properties: name: type: string cidr: type: string description: >- Private IPv4 range from /16 to /24 that overlaps no other network. Omit for an automatic /16. PlatformNetworkEnvelope: type: object required: - network properties: network: $ref: '#/components/schemas/PlatformNetwork' Error: type: object properties: code: type: string detail: oneOf: - type: string - type: object required: - code - message properties: code: type: string message: type: string PlatformNetwork: type: object required: - id - name - cidr - status properties: id: type: string format: uuid name: type: string cidr: type: string description: Private IPv4 range of the network. status: type: string description: >- pending, active, degraded, or deleting. Use the network only when active. endpoint: type: - string - 'null' description: Gateway public address once provisioned. public_key: type: - string - 'null' description: Gateway WireGuard public key once provisioned. attached_reservation_count: type: integer description: >- Peers connected to the network, including WireGuard configs and machines. Deletion requires 0. gateway: type: object properties: status: type: string endpoint: type: - string - 'null' public_key: type: - string - 'null' compartments: type: array description: Provisioning or teardown steps for the current operation. items: $ref: '#/components/schemas/PlatformNetworkStep' created_at: type: string format: date-time updated_at: type: string format: date-time PlatformNetworkStep: type: object properties: network_id: type: string format: uuid compartment_id: type: string description: The step, such as provision_key. status: type: string description: pending, running, completed, or failed. error: type: - string - 'null' 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.