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

# Pause, resume, or withdraw your listing

> Changes the state of a listing your organization owns. On a relist only state can change: capacity, hardware specifications, and dates are fixed and any change to them returns 409 listing_reserved. Moving a listing to draft or delisted is refused while a non-Spot reservation on it is active. Taking a listing off sale stops new sales and ends running Spot VMs on it; windows already sold stay sold.

The console and CLI do not provide this operation. To withdraw a listing, you can also call [Delist your listing](/api-reference/relist/delist), which `ornn capacity-offers delist` uses.


## OpenAPI

````yaml openapi.yaml PATCH /commerce/v2/listings/{listingId}
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:
  /commerce/v2/listings/{listingId}:
    patch:
      tags:
        - Relist
      summary: Pause, resume, or withdraw your listing
      description: >-
        Changes the state of a listing your organization owns. On a relist only
        state can change: capacity, hardware specifications, and dates are fixed
        and any change to them returns 409 listing_reserved. Moving a listing to
        draft or delisted is refused while a non-Spot reservation on it is
        active. Taking a listing off sale stops new sales and ends running Spot
        VMs on it; windows already sold stay sold.
      operationId: capacityUpdateListing
      parameters:
        - name: listingId
          in: path
          required: true
          description: Listing ID (capacityListingId or listingId).
          schema:
            type: string
            format: uuid
          example: 77777777-7777-4777-8777-777777777777
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CapacityListingUpdate'
            example:
              state: draft
      responses:
        '200':
          description: The updated listing.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CapacityListing'
              example:
                capacityListingId: eeeeeeee-eeee-4eee-8eee-eeeeeeeeeeee
                listingNumber: 1188
                parentReservationId: 11111111-1111-4111-8111-111111111111
                kind: secondary
                state: draft
                gpuSlug: nvidia_h100_sxm
                gpusPerNode: 8
                capacityNodeCount: 2
                facilityId: cccccccc-cccc-4ccc-8ccc-cccccccccccc
                provisioningType: virtual-machine
                availableAt: '2026-10-20T00:00:00Z'
                availableUntil: '2026-11-03T00:00:00Z'
                daysToRfs: null
                cpu: 2x 56-core x86
                ram: 2 TB
                storage: 8x 3.84 TB NVMe
                fabricType: InfiniBand 3.2 Tbps
                internet: 10 Gbps
                createdAt: '2026-10-14T18:30:00Z'
                updatedAt: '2026-10-14T18:30:00Z'
        '400':
          description: Malformed body, unknown field, or invalid ID.
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/Error'
                  - $ref: '#/components/schemas/CapacityRequestBodyError'
              example:
                detail:
                  code: invalid_id
                  message: That capacity or financial term ID is not valid.
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          description: Your organization does not own the listing.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                detail:
                  code: forbidden
                  message: Your account cannot make this change.
        '409':
          description: A non-Spot reservation is active, or a fixed field changed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                detail:
                  code: listing_has_active_reservations
                  message: >-
                    This listing cannot be withdrawn while a non-Spot
                    reservation is active. Wait until it ends and try again.
        '422':
          description: Unknown state.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                detail:
                  code: invalid_state
                  message: Choose draft, available, or delisted.
        default:
          $ref: '#/components/responses/Error'
components:
  schemas:
    CapacityListingUpdate:
      type: object
      required:
        - state
      properties:
        state:
          type: string
          enum:
            - draft
            - available
            - delisted
          description: >-
            draft takes the listing off sale without delisting it; available
            puts it back on sale; delisted withdraws it, like the delist
            operation.
    CapacityListing:
      type: object
      description: >-
        A capacity listing's hardware, size, and availability. Read prices from
        its terms.
      required:
        - capacityListingId
        - kind
        - state
        - gpuSlug
        - gpusPerNode
        - capacityNodeCount
      properties:
        capacityListingId:
          type: string
          format: uuid
        listingNumber:
          type: integer
          description: A short reference number. Use capacityListingId in API paths.
        parentReservationId:
          type:
            - string
            - 'null'
          format: uuid
          description: 'Set on relisted capacity: the reservation it was relisted from.'
        kind:
          type: string
          enum:
            - primary
            - secondary
            - on_demand
          description: primary for Reserve listings; secondary for relisted capacity.
        state:
          type: string
          description: >-
            draft, available, held, sold, or delisted. Handle unrecognized
            values.
        gpuSlug:
          type: string
        gpusPerNode:
          type: integer
        capacityNodeCount:
          type: integer
        facilityId:
          type: string
          format: uuid
        provisioningType:
          type: string
          enum:
            - bare-metal
            - virtual-machine
        availableAt:
          type:
            - string
            - 'null'
          format: date-time
        availableUntil:
          type:
            - string
            - 'null'
          format: date-time
        daysToRfs:
          type:
            - integer
            - 'null'
          description: Readiness lead time in days when the listing has no fixed dates.
        cpu:
          type:
            - string
            - 'null'
        ram:
          type:
            - string
            - 'null'
        storage:
          type:
            - string
            - 'null'
        fabricType:
          type:
            - string
            - 'null'
          description: GPU interconnect.
        internet:
          type:
            - string
            - 'null'
          description: Internet bandwidth.
        createdAt:
          type: string
          format: date-time
        updatedAt:
          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
    CapacityRequestBodyError:
      type: object
      description: Returned for a malformed JSON body or an unknown field.
      properties:
        error:
          type: string
      example:
        error: invalid request body
  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'
    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.