> ## 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. # Add a network WireGuard config > Registers your WireGuard public key on a network you created and returns a config with a placeholder for your private key. The network must be active. Retrying with the same public key returns the existing config. ## OpenAPI ````yaml openapi.yaml POST /v1/orchestrator/networks/{network_id}/peers 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/{network_id}/peers: parameters: - $ref: '#/components/parameters/PlatformNetworkId' post: tags: - Networks summary: Add a network WireGuard config description: >- Registers your WireGuard public key on a network you created and returns a config with a placeholder for your private key. The network must be active. Retrying with the same public key returns the existing config. operationId: platformCreateNetworkPeer requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PlatformCreateWireGuardPeer' example: public_key: exampleClientPublicKeyBase64AAAAAAAAAAAAAA= responses: '201': description: The config. content: application/json: schema: $ref: '#/components/schemas/PlatformWireGuardPeerConfig' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': description: The network is not visible, or its gateway is not ready yet. content: application/json: schema: $ref: '#/components/schemas/Error' '409': description: The key is used by someone else, or you reached the config limit. content: application/json: schema: $ref: '#/components/schemas/Error' '422': description: The public key is not a valid WireGuard key. content: application/json: schema: $ref: '#/components/schemas/Error' example: detail: code: invalid_wireguard_public_key message: >- That is not a valid WireGuard public key. Paste the 44 character key from your WireGuard client. default: $ref: '#/components/responses/Error' components: parameters: PlatformNetworkId: name: network_id in: path required: true description: Private network ID. schema: type: string format: uuid example: 88888888-8888-4888-8888-888888888888 schemas: PlatformCreateWireGuardPeer: type: object required: - public_key properties: public_key: type: string description: >- Your WireGuard public key, 44 characters of base64. Never send the private key. PlatformWireGuardPeerConfig: type: object properties: peer: $ref: '#/components/schemas/PlatformWireGuardPeer' network: $ref: '#/components/schemas/PlatformWireGuardNetwork' config: type: string description: >- WireGuard configuration. Replace the PrivateKey placeholder with your private key locally and store the file with owner-only permissions. Error: type: object properties: code: type: string detail: oneOf: - type: string - type: object required: - code - message properties: code: type: string message: type: string PlatformWireGuardPeer: type: object properties: id: type: string format: uuid kind: type: string public_key: type: string assigned_ip: type: string description: Your address inside the private network. status: type: string description: >- active when the gateway applied it, pending_gateway, failed, or revoked. created_at: type: string format: date-time revoked_at: type: - string - 'null' format: date-time PlatformWireGuardNetwork: type: object properties: id: type: - string - 'null' format: uuid description: Network ID, or null for the organization default network. cidr: type: string gateway_ip: type: string status: type: string gateway: type: object properties: public_endpoint: type: string public_key: type: - string - 'null' udp_port: type: integer status: type: string 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.