Oracle Rover Entitlement API

openapi: 3.2.0
info:
  description: A description of the RoverCloudService API.
  title: RoverCloudService Rover Entitlement 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: roverEntitlement
paths:
  /roverEntitlements:
    get:
      description: Returns a list of RoverEntitlements.
      operationId: ListRoverEntitlements
      parameters:
      - description: filtering by Rover Device Entitlement id
        in: query
        name: id
        required: false
        schema:
          type: string
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/DisplayNameQueryParam'
      - $ref: '#/components/parameters/LifecycleStateQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: List of Rover Device Entitlements
          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:
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoverEntitlementCollection'
        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'
      summary: Gets a list of all RoverEntitlements in a compartment.
      tags:
      - roverEntitlement
      x-obmcs-client-retries-enabled: true
      x-related-resource: '#/definitions/RoverEntitlementCollection'
    post:
      description: Create the Entitlement to use a Rover Device. It requires some offline process of review and signatures before request is granted.
      operationId: CreateRoverEntitlement
      parameters:
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Creates a New Rover Device Entitlement
          headers:
            etag:
              schema:
                type: string
            opc-request-id:
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoverEntitlement'
        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:
          description: Internal error while creating Rover Device Entitlement
          headers:
            opc-request-id:
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        default:
          $ref: '#/components/responses/default'
      summary: Create the Rover Device Entitlement
      tags:
      - roverEntitlement
      x-related-resource: '#/definitions/RoverEntitlement'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateRoverEntitlementDetails'
        description: Creates a Rover Device Entitlement
        required: true
  /roverEntitlements/{roverEntitlementId}:
    delete:
      description: Deletes a rover entitlement
      operationId: DeleteRoverEntitlement
      parameters:
      - $ref: '#/components/parameters/RoverEntitlementIdPathParam'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      responses:
        204:
          description: Rover entitlement 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'
        500:
          $ref: '#/components/responses/500'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        default:
          $ref: '#/components/responses/default'
      summary: Deletes a rover entitlement
      tags:
      - roverEntitlement
      x-obmcs-client-retries-enabled: true
      x-related-resource: '#/definitions/RoverEntitlement'
    get:
      description: Describes the Rover Device Entitlement in detail
      operationId: GetRoverEntitlement
      parameters:
      - $ref: '#/components/parameters/RoverEntitlementIdPathParam'
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Rover Device Entitlement
          headers:
            etag:
              schema:
                type: string
            opc-request-id:
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoverEntitlement'
        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: Describes the Rover Device Entitlement in detail
      tags:
      - roverEntitlement
      x-obmcs-client-retries-enabled: true
      x-related-resource: '#/definitions/RoverEntitlement'
    put:
      description: Updates the RoverEntitlement
      operationId: UpdateRoverEntitlement
      parameters:
      - $ref: '#/components/parameters/RoverEntitlementIdPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The Rover Entitlement 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/RoverEntitlement'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Update the Rover Entitlement identified by the id
      tags:
      - roverEntitlement
      x-related-resource: '#/definitions/RoverEntitlement'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateRoverEntitlementDetails'
        description: The information to be updated.
        required: true
  /roverEntitlements/{roverEntitlementId}/actions/changeCompartment:
    post:
      description: Moves an entitlement into a different compartment.
      operationId: ChangeRoverEntitlementCompartment
      parameters:
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/RoverEntitlementIdPathParam'
      responses:
        204:
          description: Moves the entitlement 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 an entitlement into a different compartment. When provided, if-Match is matched against ETag values of the resource.
      tags:
      - roverEntitlement
      x-related-resource: '#/definitions/RoverEntitlement'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangeRoverEntitlementCompartmentDetails'
        description: CompartmentId of the destination compartment
        required: true
components:
  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
    RoverEntitlementIdPathParam:
      description: ID of the rover node or cluster entitlement
      in: path
      name: roverEntitlementId
      required: true
      schema:
        type: string
    CompartmentIdQueryParam:
      description: The OCID of the compartment in which to list resources.
      in: query
      name: compartmentId
      required: true
      schema:
        type: string
    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
    PaginationLimitQueryParam:
      description: The maximum number of items to return.
      in: query
      name: limit
      schema:
        type: integer
        default: 10
        maximum: 100
        minimum: 1
    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
    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
  schemas:
    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
    CreateRoverEntitlementDetails:
      description: Information required to create a RoverEntitlement.
      properties:
        compartmentId:
          description: The OCID of the compartment containing the RoverEntitlement.
          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
        entitlementDetails:
          description: Details about the entitlement.
          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
        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
        requestorEmail:
          description: Requestor email for the entitlement.
          type: string
        requestorName:
          description: Requestor name for the entitlement.
          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
        tenantId:
          description: tenant Id.
          type: string
      required:
      - compartmentId
      - requestorName
      - requestorEmail
      type: object
    UpdateRoverEntitlementDetails:
      description: Information required to update a RoverEntitlement.
      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
        displayName:
          description: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
          type: string
        entitlementDetails:
          description: Details about the entitlement.
          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
        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
        requestorEmail:
          description: Requestor email for the entitlement.
          type: string
        requestorName:
          description: Requestor name for the entitlement.
          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
        tenantId:
          description: tenant Id.
          type: string
      type: object
    RoverEntitlementCollection:
      description: Results of a roverEntitlement search. Contains RoverEntitlementSummary.
      properties:
        items:
          description: List of RoverEntitlementSummary.
          items:
            $ref: '#/components/schemas/RoverEntitlementSummary'
          type: array
      required:
      - items
      type: object
    RoverEntitlement:
      description: Information about a RoverEntitlement.
      properties:
        compartmentId:
          description: The compartment Id for the entitlement.
          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
        entitlementDetails:
          description: Details about the entitlement.
          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: A property that can uniquely identify the rover entitlement.
          type: string
        lifecycleState:
          description: Lifecyclestate for the entitlement.
          enum:
          - CREATING
          - ACTIVE
          - INACTIVE
          - DELETED
          type: string
        lifecycleStateDetails:
          description: A property that can contain details on the lifecycle.
          type: string
        requestorEmail:
          description: Requestor email for the entitlement.
          type: string
        requestorName:
          description: Requestor name for the entitlement.
          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
        tenantId:
          description: tenant Id.
          type: string
        timeCreated:
          description: Time of creation for the entitlement.
          format: date-time
          type: string
        timeUpdated:
          description: Time when the entitlement was last updated.
          format: date-time
          type: string
      required:
      - compartmentId
      - lifecycleState
      - requestorName
      - requestorEmail
      - id
      type: object
    RoverEntitlementSummary:
      description: Rover entitlement summary.
      properties:
        compartmentId:
          description: The compartment Id.
          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: Id of the entitlement.
          type: string
        lifecycleState:
          description: Lifecyclestate for the entitlement.
          type: string
          x-obmcs-enumref: '#/definitions/RoverEntitlement/lifecycleState'
        lifecycleStateDetails:
          description: A property that can contain details on the lifecycle.
          type: string
        requestorEmail:
          description: Email id of the requestor for entitlement.
          type: string
        requestorName:
          description: Requestor name for the entitlement.
          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
      required:
      - compartmentId
      - lifecycleState
      type: object
    ChangeRoverEntitlementCompartmentDetails:
      description: Object for moving an entitlement 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
  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