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: string
        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
        deliveryTrackingInfo:
          description: Tracking information for device shipping.
          type: string
        displayName:
          description: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
          type: string
        enclosureType:
          description: The type of enclosure rover node is 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
        id:
          description: The OCID of RoverNode.
          type: string
        imageExportPar:
          description: The link to pre-authenticated request for a bucket where image workloads are moved.
          type: string
        importCompartmentId:
          description: An OCID of a compartment where data will be imported to upon Rover node return.
          type: string
        importFileBucket:
          description: Name of a bucket where files from NFS share will be imported to upon Rover node return.
          type: string
        isImportRequested:
          description: The flag indicating that customer requests data to be imported to OCI upon Rover node return.
          type: boolean
        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
        nodeType:
          description: The type of node indicating if it belongs to a cluster
          enum:
          - STANDALONE
          - CLUSTERED
          - STATION
          type: string
          x-obmcs-top-level-enum: '#/definitions/NodeType'
        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 RoverNode.
          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
        returnShippingLabelUri:
          description: Uri to download return shipping label.
          format: uri
          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
        tags:
          description: 'The tags associated with tagSlug.

            '
          type: string
        timeCreated:
          description: The time the the RoverNode was created. An RFC3339 formatted datetime string
          format: date-time
          type: string
        timeCustomerReceieved:
          description: Date and time when customer received tne node.
          format: date-time
          type: string
        timeCustomerReturned:
          description: Date and time when customer returned the node.
          format: date-time
          type: string
        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
      required:
      - id
      - compartmentId
      - lifecycleState
      - displayName
      type: object
    RoverNodeSummary:
      description: Summary of the 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
        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.
          type: string
        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
        id:
          description: The OCID of the RoverNode.
          type: string
        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
        nodeType:
          description: The type of node indicating if it belongs to a cluster
          enum:
          - STANDALONE
          - CLUSTERED
          - STATION
          type: string
          x-obmcs-top-level-enum: '#/definitions/NodeType'
        serialNumber:
          description: Serial number of the node.
          type: string
        shape:
          description: The shape of the 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
        timeCreated:
          description: The time the the RoverNode was created. An RFC3339 formatted datetime string
          format: date-time
          type: string
      required:
      - id
      - compartmentId
      - lifecycleState
      type: object
    RoverNodeSetKey:
      description: Information about the success of setting a rover node's resource principal public key.
      properties:
        isSuccessful:
          description: Whether the node's resource principal public key was set correctly
          type: boolean
      required:
      - isSuccessful
      type: object
    RoverNodeCollection:
      description: Results of a roverNode search. Contains both RoverNodeSummary items and other data.
      properties:
        items:
          description: List of roverNodes.
          items:
            $ref: '#/components/schemas/RoverNodeSummary'
          type: array
      required:
      - items
      type: object
    ShippingAddress:
      description: Shipping address for rover devices.
      properties:
        address1:
          description: Address line 1.
          maxLength: 128
          minLength: 1
          type: string
        address2:
          description: Address line 2.
          maxLength: 128
          minLength: 1
          type: string
        address3:
          description: Address line 3.
          maxLength: 128
          minLength: 1
          type: string
        address4:
          description: Address line 4.
          maxLength: 128
          minLength: 1
          type: string
        addressee:
          description: Addressee in shipping address.
          maxLength: 64
          minLength: 1
          type: string
        careOf:
          description: CareOf for shipping address.
          maxLength: 64
          minLength: 1
          type: string
        cityOrLocality:
          description: city or locality for shipping address.
          maxLength: 64
          minLength: 1
          type: string
        country:
          description: country for shipping address.
          maxLength: 64
          minLength: 1
          type: string
        email:
          description: recipient email address.
          format: email
          type: string
        phoneNumber:
          description: recipient phone number.
          type: string
        stateOrRegion:
          description: state or region for shipping address.
          maxLength: 64
          minLength: 1
          type: string
        zipcode:
          description: zipcode for shipping address.
          maxLength: 64
          minLength: 1
          type: string
      required:
      - addressee
      - address1
      - cityOrLocality
      - stateOrRegion
      - zipcode
      - country
      - phoneNumber
      type: object
    ChangeRoverNodeCompartmentDetails:
      description: Object for moving a node to a different compartment.
      properties:
        compartmentId:
          description: 'The [OCID] (/Content/General/Concepts/identifiers.htm) of the compartment into which the resources should be moved.

            '
          maxLength: 255
          minLength: 1
          type: string
      required:
      - compartmentId
      type: object
  parameters:
    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
    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
    RoverNodeIdentifierPathParam:
      description: Unique RoverNode identifier
      in: path
      name: roverNodeId
      required: true
      schema:
        type: string
    GetRoverNodeRptToken:
      description: 'The Java Web Token which is a signature of the request that is signed with the resource''s private key

        This is meant solely in the context of getRpt

        '
      in: header
      name: jwt
      required: true
      schema:
        type: string
    NodeTypeQueryParam:
      description: A filter to return only Nodes of type matched with the given node type.
      in: query
      name: nodeType
      required: false
      x-default-description: 'null'
      x-obmcs-top-level-enum: '#/definitions/NodeType'
      schema:
        type: string
        enum:
        - STANDALONE
        - CLUSTERED
        - STATION
    IfMatchHeader:
      description: 'For optimistic concurrency control. In the PUT or DELETE call

        for a resource, set the `if-match` parameter to the value of the

        etag from a previous GET or POST response for that resource.

        The resource will be updated or deleted only if the etag you

        provide matches the resource''s current etag value.

        '
      in: header
      name: if-match
      required: false
      schema:
        type: string
    CompartmentIdQueryParam:
      description: The OCID of the compartment in which to list resources.
      in: query
      name: compartmentId
      required: true
      schema:
        type: string
    PaginationLimitQueryParam:
      description: The maximum number of items to return.
      in: query
      name: limit
      schema:
        type: integer
        default: 10
        maximum: 100
        minimum: 1
    SetRoverNodeRptToken:
      description: 'The Java Web Token which is a signature of the request that is signed with the resource''s private key

        This is meant solely in the context of getRpt

        '
      in: header
      name: jwt
      required: true
      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
    RetryTokenHeader:
      description: 'A token that uniquely identifies a request so it can be retried in case of a timeout or

        server error without risk of executing that same action again. Retry tokens expire after 24

        hours, but can be invalidated before then due to conflicting operations. For example, if a resource

        has been deleted and purged from the system, then a retry of the original creation request

        might be rejected.

        '
      in: header
      name: opc-retry-token
      required: false
      schema:
        type: string
        maxLength: 64
        minLength: 1
    DisplayNameQueryParam:
      description: A filter to return only resources that match the entire display name given.
      in: query
      name: displayName
      x-default-description: 'null'
      schema:
        type: string
        maxLength: 255
        minLength: 1
    RequestIdHeader:
      description: The client request ID for tracing.
      in: header
      name: opc-request-id
      schema:
        type: string
    ShapeQueryParam:
      description: A filter to return only Nodes of type matched with the given node shape.
      in: query
      name: shape
      required: false
      x-default-description: 'null'
      schema:
        type: string
    LifecycleStateQueryParam:
      description: A filter to return only resources their lifecycleState matches the given lifecycleState.
      in: query
      name: lifecycleState
      required: false
      x-default-description: 'null'
      x-obmcs-top-level-enum: '#/definitions/LifecycleState'
      schema:
        type: string
        enum:
        - CREATING
        - UPDATING
        - ACTIVE
        - DELETING
        - DELETED
        - FAILED
  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