Oracle Shape API

openapi: 3.2.0
info:
  description: A description of the RoverCloudService API.
  title: RoverCloudService Shape API
  version: '20201210'
  x-provenance:
    method: harvested
    first_party: true
    publisher: Oracle
    source: https://docs.oracle.com/en-us/iaas/api/specs/bc82a6be3188c7b03e57bdc1f0d7bc345fff101db5cc63bbd3e9a61d9baea4a3.yaml
    harvested: '2026-08-04'
    note: Published by Oracle as the contract for the RoverCloudService API OCI service and stored verbatim; API Evangelist added only this provenance block.
  x-evidence:
  - url: https://docs.oracle.com/en-us/iaas/api/specs/index.json
    what: Oracle's own index of every OCI service specification
  - url: https://docs.oracle.com/en-us/iaas/api/specs/bc82a6be3188c7b03e57bdc1f0d7bc345fff101db5cc63bbd3e9a61d9baea4a3.yaml
    what: the harvested document for RoverCloudService API
servers:
- url: https://127.0.0.1/20201210
tags:
- name: shape
paths:
  /shapes:
    get:
      description: 'Returns a list of Shapes.

        '
      operationId: ListShapes
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: A page of ShapeSummary objects.
          headers:
            opc-next-page:
              description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,

                then a partial list might have been returned. Include this value as the `page` parameter for the

                subsequent GET request to get the next batch of items.

                '
              schema:
                type: string
            opc-prev-page:
              description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,

                then a partial list might have been returned. Include this value as the `page` parameter for the

                subsequent GET request to get the previous batch of items.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShapeCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Gets a list of all Shapes in a compartment.
      tags:
      - shape
      x-obmcs-client-retries-enabled: true
      x-related-resource: '#/definitions/ShapeSummary'
components:
  schemas:
    ShapeSummary:
      description: A shape of a node on a Rover device.
      properties:
        definedTags:
          additionalProperties:
            additionalProperties:
              type: object
            type: object
          description: 'The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces.

            For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).

            Example: `{"Operations": {"CostCenter": "42"}}`

            '
          type: object
        freeformTags:
          additionalProperties:
            type: string
          description: 'The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no

            predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).

            Example: `{"Department": "Finance"}`

            '
          type: object
        gpuDescription:
          default: null
          description: A short description of the graphics processing unit (GPU) available for this shape.
          type: string
        gpus:
          description: The number of GPUs available for this shape.
          minimum: 0
          type: integer
        memoryInGBs:
          description: The default amount of memory available for this shape, in gigabytes.
          format: float
          minimum: 0
          type: number
        networkingBandwidthInGbps:
          description: The networking bandwidth available for this shape, in gigabits per second.
          format: float
          minimum: 0
          type: number
        numberOfUsbControllers:
          description: The number of USB controllers available for this shape.
          minimum: 0
          type: integer
        ocpus:
          description: The default number of OCPUs available for this shape.
          minimum: 0
          type: integer
        processorDescription:
          description: A short description of the shape's processor (CPU).
          maxLength: 255
          minLength: 1
          type: string
        shape:
          description: The name of the shape.
          maxLength: 255
          minLength: 1
          type: string
        systemTags:
          additionalProperties:
            additionalProperties:
              type: object
            type: object
          description: 'The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces.

            For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).

            Example: `{orcl-cloud: {free-tier-retain: true}}`

            '
          type: object
        tags:
          description: 'The tags associated with tagSlug.

            '
          type: string
        usbControllerDescription:
          default: 'null'
          description: A short description of the USB controller available for this shape.
          type: string
      required:
      - shape
      type: object
    Error:
      description: Error Information.
      properties:
        code:
          description: A short error code that defines the error, meant for programmatic parsing.
          type: string
        message:
          description: A human-readable error string.
          type: string
      required:
      - code
      - message
    ShapeCollection:
      description: Results of a listShape search. Contains both Shape items and other data.
      properties:
        items:
          description: List of shapeSummary objects.
          items:
            $ref: '#/components/schemas/ShapeSummary'
          type: array
      required:
      - items
      type: object
  parameters:
    RequestIdHeader:
      description: The client request ID for tracing.
      in: header
      name: opc-request-id
      schema:
        type: string
    SortOrderQueryParam:
      description: The sort order to use, either 'asc' or 'desc'.
      in: query
      name: sortOrder
      x-obmcs-top-level-enum: '#/definitions/SortOrders'
      schema:
        type: string
        enum:
        - ASC
        - DESC
        default: ASC
    SortByQueryParam:
      description: 'The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.

        '
      in: query
      name: sortBy
      schema:
        type: string
        enum:
        - timeCreated
        - displayName
        default: timeCreated
    PaginationTokenQueryParam:
      description: The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
      in: query
      name: page
      x-default-description: 'null'
      schema:
        type: string
        minLength: 1
    PaginationLimitQueryParam:
      description: The maximum number of items to return.
      in: query
      name: limit
      schema:
        type: integer
        default: 10
        maximum: 100
        minimum: 1
    CompartmentIdQueryParam:
      description: The OCID of the compartment in which to list resources.
      in: query
      name: compartmentId
      required: true
      schema:
        type: string
  responses:
    default:
      description: Unknown Error
      headers:
        opc-request-id:
          description: 'Unique Oracle-assigned identifier for the request. If you need to contact

            Oracle about a particular request, please provide the request ID.

            '
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
x-anchors:
  x-headers:
    etag:
      description: 'For optimistic concurrency control. See `if-match`.

        '
      type: string
    opc-next-page:
      description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,

        then a partial list might have been returned. Include this value as the `page` parameter for the

        subsequent GET request to get the next batch of items.

        '
      type: string
    opc-prev-page:
      description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,

        then a partial list might have been returned. Include this value as the `page` parameter for the

        subsequent GET request to get the previous batch of items.

        '
      type: string
    opc-request-id:
      description: 'Unique Oracle-assigned identifier for the request. If you need to contact

        Oracle about a particular request, please provide the request ID.

        '
      type: string
  x-properties:
    definedTags:
      additionalProperties:
        additionalProperties:
          type: object
        type: object
      description: 'The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces.

        For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).

        Example: `{"Operations": {"CostCenter": "42"}}`

        '
      type: object
    freeformTags:
      additionalProperties:
        type: string
      description: 'The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no

        predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).

        Example: `{"Department": "Finance"}`

        '
      type: object
    systemTags:
      additionalProperties:
        additionalProperties:
          type: object
        type: object
      description: 'The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces.

        For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).

        Example: `{orcl-cloud: {free-tier-retain: true}}`

        '
      type: object
    tags:
      description: 'The tags associated with tagSlug.

        '
      type: string
x-oracle-package: com.oracle.pic.rover