Oracle Rover Node API

The roverNode API from Oracle — 7 operation(s) for rovernode.

Documentation

📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/access-governance-cp/20220518/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/adm/20220421/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/advisor/20200606/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/ai-data-platform/20240831/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/analytics/20190331/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/announcements/0.0.1/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/api-gateway/20190501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/apm-config/20210201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/apm-control-plane/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/apm-synthetic-monitoring/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/apm-trace-explorer/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/audit/20190901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/autoscaling/20181001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/bastion/20210331/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/batch/20251031/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/bigdata/20190531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/blockchain/20191010/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/budgets/20190111/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/certificates/20210224/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/certificatesmgmt/20210224/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/cloud-guard/20200131/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/clusterplacementgroups/20230801/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/compute-cloud-at-customer/20221208/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/container-instances/20210415/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/container-registry/20180419/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/containerengine/20180222/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/cost-anomaly/20190111/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/dashboard/20210731/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-catalog/20190325/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-flow/20200129/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-integration/20200430/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-safe/20181201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-science/20190101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-management/20201101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-migration/20230518/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-multicloud-integrations/20240501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-tools/20201005/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-tools-runtime/20230222/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/datacc/20251101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/datalabeling-dp/20211001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/datalabeling/20211001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/delegate-access-control/20230801/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/devops/20210630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/digital-assistant/20190506/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/disaster-recovery/20220125/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/dms/20211101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/dns/20180115/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/document-understanding/20221109/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/edsfu/20220528/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/emaildelivery/20170907/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/emaildeliverysubmission/20220926/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/events/20181201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/filestorage/20171215/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/fleet-management/20250228/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/functions/20181201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/functionsdocgenpbf/1.0/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/fusion-applications/20211201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai-agents-client/20240531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai-agents/20240531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai-inference/20231130/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai-nl2sql/20260325/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai/20231130/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generic/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/globally-distributed-database/20250101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/goldengate/20200407/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/healthchecks/20180501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/iaas/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/identity-domains/v1/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/identity-dp/v1/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/identity/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/incidentmanagement/20181231/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/instanceagent/20180530/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/integration/20190131/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/iot/20250531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/itas/v1/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/jms-java-download/20230601/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/jms/20210610/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/jms-utils/20250521/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/kafka/20240901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/key/release/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/language/20221001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/licensemanager/20220430/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/limits-increase/20251101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/limits/20181025/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/loadbalancer/20170115/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/logan-api-spec/20200601/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/logging-dataplane/20200831/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/logging-management/20200531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/logging-search/20190909/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/lustre/20250228/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/managed-access/20220126/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/management-agent/20200202/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/managementdashboard/20200901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/marketplace/20181001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/mngdmac/20250320/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/monitoring/20180401/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/multicloud-omhub-cp/20180828/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/mysql/20190415/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/NetMonitor/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/network-firewall/20211001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/network-firewall/20230501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/networkloadbalancer/20200501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/nosql-database/20190828/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/notification/20181201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/objectstorage/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/OCB/20220509/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/occ/20230515/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/occds/20240430/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/occm/20231107/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/ocicache/20220315/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/ocm/20220919/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/opa/20210621/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/opensearch/20180828/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/operations-insights/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/operatoraccesscontrol/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/oracle-api-access-control/20241130/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/organizations/20230401/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/organizations/20200801/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/osmh/20220901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/postgresql/20220915/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/psasvc/20240301/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/publisher/20241201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/queue/20210201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/recovery-service/20210216/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/registry/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/resource-analytics/20241031/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/resource-discovery-monitoring-control-api/20210330/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/resource-scheduler/20240430/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/resourcemanager/20180917/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/rover/20201210/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/s3objectstorage/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/scanning/20210215/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/search/20180409/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/secretmgmt/20180608/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/secretretrieval/20190301/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/secure-desktops/20220618/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/security-attribute/20240815/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/self/20260129/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/service-catalog/20210527/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/serviceconnectors/20200909/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/smp/20210914/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/speech/20220101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/stack-monitoring/20210330/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/streaming/20180418/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/threat-intel/20220901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/usage/20200107/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/usage-proxy/20190111/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/vision/20220125/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/visual-builder/20210601/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/visual-builder-studio/20180828/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/vmware/20200501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/vmware/20230701/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/waa/20211230/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/waas/20181116/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/waf/20210930/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/wlms/20241101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/workrequests/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/zero-trust-packet-routing/20240301/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/zero-trust-packet-routing-tools/20240301/

Specifications

OpenAPI Specification

oracle-rovernode-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  description: A description of the RoverCloudService API.
  title: RoverCloudService Rover Node 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: roverNode
paths:
  /roverNodes:
    get:
      description: 'Returns a list of RoverNodes.

        '
      operationId: ListRoverNodes
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/DisplayNameQueryParam'
      - $ref: '#/components/parameters/NodeTypeQueryParam'
      - $ref: '#/components/parameters/ShapeQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/LifecycleStateQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: A page of RoverNodeSummary 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/RoverNodeCollection'
        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 RoverNodes in a compartment.
      tags:
      - roverNode
      x-obmcs-client-retries-enabled: true
      x-related-resource: '#/definitions/RoverNode'
    post:
      description: 'Creates a new RoverNode.

        '
      operationId: CreateRoverNode
      parameters:
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The RoverNode was successfully created.
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              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/RoverNode'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Creates a new RoverNode.
      tags:
      - roverNode
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateRoverNodeDetails'
        description: Details for the new RoverNode.
        required: true
  /roverNodes/{roverNodeId}:
    delete:
      description: Deletes a RoverNode resource by identifier
      operationId: DeleteRoverNode
      parameters:
      - $ref: '#/components/parameters/RoverNodeIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        204:
          description: The RoverNode was successfully deleted.
          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
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Delete a provisioned RoverNode
      tags:
      - roverNode
      x-obmcs-client-retries-enabled: true
      x-related-resource: '#/definitions/RoverNode'
    get:
      description: Gets a RoverNode by identifier.
      operationId: GetRoverNode
      parameters:
      - $ref: '#/components/parameters/RoverNodeIdentifierPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Retrieves the RoverNode with the given id
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              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/RoverNode'
        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: Get RoverNode
      tags:
      - roverNode
      x-obmcs-client-retries-enabled: true
    put:
      description: Updates the RoverNode
      operationId: UpdateRoverNode
      parameters:
      - $ref: '#/components/parameters/RoverNodeIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The RoverNode was successfully updated.
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              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/RoverNode'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Update the RoverNode identified by the id
      tags:
      - roverNode
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateRoverNodeDetails'
        description: The information to be updated.
        required: true
  /roverNodes/{roverNodeId}/actions/changeCompartment:
    post:
      description: Moves a rover node into a different compartment.
      operationId: ChangeRoverNodeCompartment
      parameters:
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/RoverNodeIdentifierPathParam'
      responses:
        204:
          description: Moves the node resource to new compartment
          headers:
            opc-request-id:
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
      summary: Move a rover node into a different compartment. When provided, if-Match is matched against ETag values of the resource.
      tags:
      - roverNode
      x-related-resource: '#/definitions/RoverNode'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangeRoverNodeCompartmentDetails'
        description: CompartmentId of the destination compartment
        required: true
  /roverNodes/{roverNodeId}/actions/setKey:
    post:
      description: Get the resource principal public key for a rover node
      operationId: RoverNodeActionSetKey
      parameters:
      - $ref: '#/components/parameters/RoverNodeIdentifierPathParam'
      - $ref: '#/components/parameters/SetRoverNodeRptToken'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        200:
          description: Result of setting the resource principal public key for the rover node
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              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/RoverNodeSetKey'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Set the resource principal public key for a rover node
      tags:
      - roverNode
      x-related-resource: '#/definitions/RoverNodeSetKey'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RoverNodeActionSetKeyDetails'
        description: The information to be updated.
        required: true
  /roverNodes/{roverNodeId}/certificate:
    get:
      description: Get the certificate for a rover node
      operationId: GetRoverNodeCertificate
      parameters:
      - $ref: '#/components/parameters/RoverNodeIdentifierPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Retrieves the certificate for the rover node
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              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/RoverNodeCertificate'
        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: Get the certificate for a rover node
      tags:
      - roverNode
      x-obmcs-client-retries-enabled: true
  /roverNodes/{roverNodeId}/encryptionKey:
    get:
      description: Get the data encryption key for a rover node.
      operationId: GetRoverNodeEncryptionKey
      parameters:
      - description: Serial number of the rover node.
        in: path
        name: roverNodeId
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Retrieves the data encryption key for rover node.
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              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/RoverNodeEncryptionKey'
        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: Get the data encryption key for a rover node.
      tags:
      - roverNode
      x-obmcs-client-retries-enabled: true
  /roverNodes/{roverNodeId}/getRpt:
    get:
      description: Get the resource principal token for a rover node
      operationId: GetRoverNodeGetRpt
      parameters:
      - $ref: '#/components/parameters/RoverNodeIdentifierPathParam'
      - $ref: '#/components/parameters/GetRoverNodeRptToken'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Retrieves the resource principal token for the rover node
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              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/RoverNodeGetRpt'
        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: Get the resource principal token for a rover node
      tags:
      - roverNode
      x-obmcs-client-retries-enabled: true
components:
  schemas:
    RoverNodeEncryptionKey:
      description: The response containing encryption key for a rover node.
      properties:
        encryptionKey:
          description: The encryption key key for a rover node.
          type: string
      required:
      - encryptionKey
      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
    RoverWorkload:
      description: Information about a RoverWorkload.
      properties:
        compartmentId:
          description: The OCID of the compartment containing the workload.
          type: string
        id:
          description: The Unique Oracle ID (OCID) that is immutable on creation.
          type: string
        name:
          description: Name of the Rover Workload
          type: string
        objectCount:
          description: Number of objects in a workload.
          type: string
        prefix:
          description: Prefix to filter objects in case it is a bucket.
          type: string
        rangeEnd:
          description: End of the range in a bucket.
          type: string
        rangeStart:
          description: Start of the range in a bucket.
          type: string
        size:
          description: Size of the workload.
          type: string
        workRequestId:
          description: The compute work request id to track progress of custom image exports.
          type: string
        workloadType:
          description: The type of workload
          type: string
      required:
      - id
      - compartmentId
      - workloadType
      type: object
    RoverNodeGetRpt:
      description: The resource principal token response.
      properties:
        resourcePrincipalToken:
          description: The resource principal token blob that contains claims about the resource.
          type: string
        servicePrincipalSessionToken:
          description: The service principal session token
          type: string
      required:
      - resourcePrincipalToken
      type: object
    RoverNodeCertificate:
      description: The certificate response
      properties:
        certificate:
          description: The certificate that can be installed on a client to do TLS communication to the node
          type: string
      required:
      - certificate
      type: object
    RoverNodeActionSetKeyDetails:
      description: The information required to update a rover node's set key details.
      properties:
        publicKey:
          description: The public key of the resource principal
          type: string
      type: object
    UpdateRoverNodeDetails:
      description: The information required to update a RoverNode.
      properties:
        customerShippingAddress:
          $ref: '#/components/schemas/ShippingAddress'
        dataValidationCode:
          description: Validation code returned by data validation tool. Required for return shipping label generation if data import was requested.
          type: string
          x-default-description: 'null'
        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
        displayName:
          description: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
          maxLength: 255
          minLength: 1
          type: string
        enclosureType:
          description: The type of enclosure rover nodes in this cluster are shipped in.
          enum:
          - RUGGADIZED
          - NON_RUGGADIZED
          type: string
          x-obmcs-top-level-enum: '#/definitions/EnclosureType'
        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
        importCompartmentId:
          description: An OCID of a compartment where data will be imported to upon Rover node return.
          type: string
          x-default-description: 'null'
        importFileBucket:
          description: Name of a bucket where files from NFS share will be imported to upon Rover node return.
          type: string
          x-default-description: 'null'
        isImportRequested:
          description: The flag indicating that customer requests data to be imported to OCI upon Rover node return.
          type: boolean
          x-default-description: 'null'
        lifecycleState:
          description: The current state of the RoverNode.
          enum:
          - CREATING
          - UPDATING
          - ACTIVE
          - DELETING
          - DELETED
          - FAILED
          type: string
          x-obmcs-top-level-enum: '#/definitions/LifecycleState'
        lifecycleStateDetails:
          description: A property that can contain details on the lifecycle.
          type: string
        nodeWorkloads:
          description: List of existing workloads that should be provisioned on the node.
          items:
            $ref: '#/components/schemas/RoverWorkload'
          type: array
        oracleShippingTrackingUrl:
          description: Tracking Url for the shipped FmsRoverNode.
          format: uri
          type: string
        pointOfContact:
          description: Name of point of contact for this order if customer is picking up.
          type: string
        pointOfContactPhoneNumber:
          description: Phone number of point of contact for this order if customer is picking up.
          type: string
        publicKey:
          description: The public key of the resource principal
          type: string
        serialNumber:
          description: Serial number of the node.
          type: string
        shape:
          description: The shape of workloads in the node.
          type: string
        shippingPreference:
          default: ORACLE_SHIPPED
          description: Preference for device delivery.
          enum:
          - ORACLE_SHIPPED
          - CUSTOMER_PICKUP
          type: string
        shippingVendor:
          description: Shipping vendor of choice for orace to customer shipping.
          type: string
        superUserPassword:
          description: Root password for the rover node.
          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
        timePickupExpected:
          description: Expected date when customer wants to pickup the device if they chose customer pickup.
          format: date-time
          type: string
        timeReturnWindowEnds:
          description: End time for the window to pickup the device from customer.
          format: date-time
          type: string
        timeReturnWindowStarts:
          description: Start time for the window to pickup the device from customer.
          format: date-time
          type: string
        unlockPassphrase:
          description: Password to unlock the rover node.
          type: string
      type: object
    CreateRoverNodeDetails:
      description: The information required to create a RoverNode.
      properties:
        compartmentId:
          description: The OCID of the compartment containing the RoverNode.
          maxLength: 255
          minLength: 1
          type: string
        customerShippingAddress:
          $ref: '#/components/schemas/ShippingAddress'
        dataValidationCode:
          description: Validation code returned by data validation tool. Required for return shipping label generation if data import was requested.
          type: string
          x-default-description: 'null'
        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
        displayName:
          description: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
          maxLength: 255
          minLength: 1
          type: string
        enclosureType:
          description: The type of enclosure rover nodes in this cluster are shipped in.
          enum:
          - RUGGADIZED
          - NON_RUGGADIZED
          type: string
          x-obmcs-top-level-enum: '#/definitions/EnclosureType'
        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
        importCompartmentId:
          description: An OCID of a compartment where data will be imported to upon Rover node return.
          type: string
          x-default-description: 'null'
        importFileBucket:
          description: Name of a bucket where files from NFS share will be imported to upon Rover node return.
          type: string
          x-default-description: 'null'
        isImportRequested:
          description: The flag indicating that customer requests data to be imported to OCI upon Rover node return.
          type: boolean
          x-default-description: 'null'
        lifecycleState:
          description: The current state of the RoverNode.
          enum:
          - CREATING
          - UPDATING
          - ACTIVE
          - DELETING
          - DELETED
          - FAILED
          type: string
          x-obmcs-top-level-enum: '#/definitions/LifecycleState'
        lifecycleStateDetails:
          description: A property that can contain details on the lifecycle.
          type: string
        nodeWorkloads:
          description: List of existing workloads that should be provisioned on the node.
          items:
            $ref: '#/components/schemas/RoverWorkload'
          type: array
        oracleShippingTrackingUrl:
          description: Tracking Url for the shipped FmsRoverNode.
          format: uri
          type: string
        pointOfContact:
          description: Name of point of contact for this order if customer is picking up.
          type: string
        pointOfContactPhoneNumber:
          description: Phone number of point of contact for this order if customer is picking up.
          type: string
        publicKey:
          description: The public key of the resource principal
          type: string
        serialNumber:
          description: Serial number of the node.
          type: string
        shape:
          description: The shape of the node.
          type: string
        shippingPreference:
          default: ORACLE_SHIPPED
          description: Preference for device delivery.
          enum:
          - ORACLE_SHIPPED
          - CUSTOMER_PICKUP
          type: string
        shippingVendor:
          description: Shipping vendor of choice for orace to customer shipping.
          type: string
        superUserPassword:
          description: Root password for the rover node.
          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
        timePickupExpected:
          description: Expected date when customer wants to pickup the device if they chose customer pickup.
          format: date-time
          type: string
        timeReturnWindowEnds:
          description: End time for the window to pickup the device from customer.
          format: date-time
          type: string
        timeReturnWindowStarts:
          description: Start time for the window to pickup the device from customer.
          format: date-time
          type: string
        unlockPassphrase:
          description: Passphrase to unlock the rover node.
          type: string
      required:
      - displayName
      - compartmentId
      type: object
    RoverNode:
      description: Information about a RoverNode.
      properties:
        clusterId:
          description: The cluster ID if the node is part of a cluster.
          type: string
        compartmentId:
          description: The OCID of the compartment containing the RoverNode.
          type: string
        customerShippingAddress:
          $ref: '#/components/schemas/ShippingAddress'
        dataValidationCode:
          description: Validation code returned by data validation tool. Required for return shipping label generation if data import was requested.
          type: s

# --- truncated at 32 KB (51 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/oracle/refs/heads/main/openapi/oracle-rovernode-api-openapi.yml