Oracle Omhub Resource Anchor API

openapi: 3.2.0
info:
  description: Use the Oracle Multicloud API to retrieve resource anchors and network anchors, and the metadata mappings related a Cloud Service Provider. For more information, see [Oracle Multicloud Hub](/iaas/Content/multicloud-hub/home.htm).
  title: Oracle Multicloud Omhub Resource Anchor API
  version: '20180828'
  x-provenance:
    method: harvested
    first_party: true
    publisher: Oracle
    source: https://docs.oracle.com/en-us/iaas/api/specs/45dc72ed7644fee2cdc2862dbdb9940c0392e2742c304d5e7b7bac5fe9b75485.yaml
    harvested: '2026-08-04'
    note: Published by Oracle as the contract for the Oracle Multicloud 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/45dc72ed7644fee2cdc2862dbdb9940c0392e2742c304d5e7b7bac5fe9b75485.yaml
    what: the harvested document for Oracle Multicloud API
servers:
- url: http://127.0.0.1/20180828
- url: https://127.0.0.1/20180828
tags:
- name: omhubResourceAnchor
paths:
  /resourceAnchors:
    get:
      description: 'Lists resource anchors in the specified Multicloud subscription.

        Details listed for each resource anchor include name, state, and the related Multicloud compartment.

        For more information, see

        [Listing Resource Anchors](/iaas/Content/multicloud-hub/list-resource-anchors.htm).

        '
      operationId: ListResourceAnchors
      parameters:
      - $ref: '#/components/parameters/BaseAndSubCompartmentIdQueryParam'
      - $ref: '#/components/parameters/LinkedCompartmentIdQueryParam'
      - $ref: '#/components/parameters/LifecycleStateQueryParam'
      - $ref: '#/components/parameters/DisplayNameQueryParam'
      - $ref: '#/components/parameters/ResourceAnchorIdentifierQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/IsCompartmentIdInSubtreeParam'
      - $ref: '#/components/parameters/ShouldFetchCompartmentName'
      - $ref: '#/components/parameters/SubscriptionServiceNameQueryParam'
      - $ref: '#/components/parameters/SubscriptionIdQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: A page of ResourceAnchorSummary objects.
          headers:
            opc-next-page:
              description: 'For list pagination. When this header appears in the response, additional pages of results remain. For

                important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

                '
              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/ResourceAnchorCollection'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Gets a list of ResourceAnchors.
      tags:
      - omhubResourceAnchor
      x-example: 'Active resource anchors for a subscription:


        POST /20180828/ResourceAnchorCollection/ListResourceAnchors?subscriptionId=<var>&lt;subscription_OCID&gt;</var>&lifecycleState=ACTIVE

        Host: multicloud.us-ashburn-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
  /resourceAnchors/{resourceAnchorId}:
    get:
      description: 'Gets details for the specified resource anchor. The subscription OCID and service name are required.

        For more information, see

        [Getting a Resource Anchor''s Details (OCI)](/iaas/Content/multicloud-hub/get-resource-anchor.htm).

        '
      operationId: GetResourceAnchor
      parameters:
      - $ref: '#/components/parameters/ResourceAnchorIdentifierPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RequiredSubscriptionServiceNameQueryParam'
      - $ref: '#/components/parameters/RequiredSubscriptionIdQueryParam'
      - $ref: '#/components/parameters/ShouldFetchCompartmentName'
      responses:
        200:
          description: The ResourceAnchor was retrieved.
          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/ResourceAnchor'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Get ResourceAnchor
      tags:
      - omhubResourceAnchor
      x-example: 'Request for an Azure subscription:


        POST /20180828/ResourceAnchor/GetResourceAnchor?resourceAnchorId=<var>&lt;resource_anchor_OCID&gt;</var>&subscriptionServiceName=ORACLEDBATAZURE&subscriptionId=<var>&lt;subscription_OCID&gt;</var>

        Host: multicloud.us-ashburn-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
components:
  parameters:
    PaginationTokenQueryParam:
      description: 'For list pagination. The value of the opc-next-page response header from the previous

        "List" call. For important details about how pagination works, see

        [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

        '
      in: query
      name: page
      schema:
        type: string
        minLength: 1
    SortByQueryParam:
      description: 'The field to sort by. You can provide only one sort order. Default order for `timeCreated`

        is descending. Default order for `displayName` is ascending.

        '
      in: query
      name: sortBy
      schema:
        type: string
        enum:
        - timeCreated
        - displayName
        default: timeCreated
    SubscriptionServiceNameQueryParam:
      description: The cloud service provider.
      in: query
      name: subscriptionServiceName
      x-default-description: 'null'
      x-obmcs-top-level-enum: '#/definitions/SubscriptionType'
      schema:
        type: string
        enum:
        - ORACLEDBATAZURE
        - ORACLEDBATGOOGLE
        - ORACLEDBATAWS
    ShouldFetchCompartmentName:
      description: 'Whether to fetch and include the compartment name.

        Setting this field to `true` might introduce additional latency.

        '
      in: query
      name: shouldFetchCompartmentName
      required: false
      schema:
        type: boolean
        default: false
    PaginationLimitQueryParam:
      description: 'For list pagination. The maximum number of results per page, or items to return in a

        paginated "List" call. For important details about how pagination works, see

        [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

        '
      in: query
      name: limit
      schema:
        type: integer
        default: 10
        maximum: 1000
        minimum: 1
    RequiredSubscriptionServiceNameQueryParam:
      description: The cloud service provider.
      in: query
      name: subscriptionServiceName
      required: true
      x-obmcs-top-level-enum: '#/definitions/SubscriptionType'
      schema:
        type: string
        enum:
        - ORACLEDBATAZURE
        - ORACLEDBATGOOGLE
        - ORACLEDBATAWS
    RequiredSubscriptionIdQueryParam:
      description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Multicloud subscription in which to list resources.
      in: query
      name: subscriptionId
      required: true
      schema:
        type: string
    SubscriptionIdQueryParam:
      description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Multicloud subscription in which to list resources.
      in: query
      name: subscriptionId
      x-default-description: 'null'
      schema:
        type: string
    SortOrderQueryParam:
      description: 'The sort order to use, either ascending (`ASC`) or descending (`DESC`).

        In general, the sort order is `DESC` when sorting by time and `ASC` otherwise.

        '
      in: query
      name: sortOrder
      x-default-description: 'The default value depends on `sortBy`.

        '
      x-obmcs-top-level-enum: '#/definitions/SortOrder'
      schema:
        type: string
        enum:
        - ASC
        - DESC
    ResourceAnchorIdentifierQueryParam:
      description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the resource anchor.
      in: query
      name: id
      x-default-description: 'null'
      schema:
        type: string
    LinkedCompartmentIdQueryParam:
      description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment linked to the resource.
      in: query
      name: linkedCompartmentId
      schema:
        type: string
    BaseAndSubCompartmentIdQueryParam:
      description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Multicloud base compartment or sub-compartment in which to list resources.

        A Multicloud base compartment is an OCI compartment that maps to a subscription in a cloud service provider (such as Azure or AWS).

        '
      in: query
      name: compartmentId
      required: false
      schema:
        type: string
    ResourceAnchorIdentifierPathParam:
      description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the resource anchor.
      in: path
      name: resourceAnchorId
      required: true
      schema:
        type: string
    DisplayNameQueryParam:
      description: A filter to return only resources that match the given display name exactly.
      in: query
      name: displayName
      x-default-description: 'null'
      schema:
        type: string
        maxLength: 255
        minLength: 1
    IsCompartmentIdInSubtreeParam:
      description: Check the sub-compartments of a given `compartmentId`.
      in: query
      name: isCompartmentIdInSubtree
      required: false
      schema:
        type: boolean
        default: true
    RequestIdHeader:
      description: 'Unique Oracle-assigned identifier for the request. If you need to contact

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

        The only valid characters for request IDs are letters, numbers,

        underscore, and dash.

        '
      in: header
      name: opc-request-id
      schema:
        type: string
    LifecycleStateQueryParam:
      description: 'A filter to return only resources that match the given lifecycle state. The

        state value is case-insensitive.

        '
      in: query
      name: lifecycleState
      required: false
      x-default-description: 'null'
      x-obmcs-enumref: '#/definitions/ResourceAnchor/lifecycleState'
      schema:
        type: string
  schemas:
    Error:
      description: Error response information.
      properties:
        code:
          description: 'A short error code that defines the error, meant for programmatic parsing. See

            [API Errors](/Content/API/References/apierrors.htm).

            '
          type: string
        message:
          description: A human-readable error string.
          type: string
      required:
      - code
      - message
    ResourceAnchorSummary:
      description: The properties that define a resource anchor.
      properties:
        compartmentId:
          description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
          type: string
        compartmentName:
          description: The name assigned to the compartment during creation.
          type: string
        cspAdditionalProperties:
          additionalProperties:
            type: string
          description: Cloud service provider-specific properties, such as AzureSubnetId for Azure.
          type: object
        cspResourceAnchorId:
          description: Resource anchor ID in the cloud service provider.
          type: string
        cspResourceAnchorName:
          description: Resource anchor name in the cloud service provider.
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only the String type is supported.

                '
              type: object
            description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.


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

              '
            type: object
          description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

            For more information, see [Resource Tags](/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.
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.

            For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).


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

            '
          type: object
        id:
          description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the resource anchor.
          type: string
        lifecycleDetails:
          description: 'A message that describes the current state of the resource anchor in more detail. For example,

            can be used to provide actionable information for a resource in the Failed state.

            '
          type: string
        lifecycleState:
          description: The current state of the resource anchor.
          type: string
          x-obmcs-enumref: '#/definitions/ResourceAnchor/lifecycleState'
        linkedCompartmentId:
          description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the optional OCI compartment that was created or linked with the resource anchor.

            This compartment is different from the compartment that contains the resource anchor.

            '
          type: string
        linkedCompartmentName:
          description: 'The name of the optional OCI compartment that was created or linked with the resource anchor.

            This compartment is different from the compartment that contains the resource anchor.

            '
          type: string
        partnerCloudAccountIdentifier:
          description: Partner cloud account identifier of the cloud service provider.
          type: string
        resourceAnchorUri:
          description: URI for the cloud service provider's resource anchor.
          type: string
        subscriptionId:
          description: Oracle Cloud Infrastructure Subscription Id
          type: string
        systemTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only the String type is supported.

                '
              type: object
            description: 'Key-value pair representing a system tag key and value, scoped to a namespace.


              Example: `{"free-tier-retained": "true"}`

              '
            type: object
          description: 'System tags for this resource. Each key is predefined and scoped to a namespace.


            Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

            '
          type: object
        timeCreated:
          description: 'The date and time the resource anchor was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339).


            Example: `2016-08-25T21:10:29.600Z`

            '
          format: date-time
          type: string
        timeUpdated:
          description: 'The date and time the resource anchor was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339).


            Example: `2016-08-25T21:10:29.600Z`

            '
          format: date-time
          type: string
      required:
      - id
      - compartmentId
      - lifecycleState
      - timeCreated
      - displayName
      - freeformTags
      - definedTags
      - subscriptionId
      type: object
    ResourceAnchor:
      description: 'A resource anchor.


        To use any of the API operations, you must be authorized in an IAM policy. If you''re not authorized, talk to

        an administrator. If you''re an administrator who needs to write policies to give users access, see

        [Getting Started with Policies](/iaas/Content/Identity/policiesgs/get-started-with-policies.htm).

        '
      properties:
        cloudServiceProviderMetadataItem:
          $ref: '#/components/schemas/CloudServiceProviderMetadataItem'
        compartmentId:
          description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
          type: string
        compartmentName:
          description: The name assigned to the compartment during creation.
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only the String type is supported.

                '
              type: object
            description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.


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

              '
            type: object
          description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

            For more information, see [Resource Tags](/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.
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.

            For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).


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

            '
          type: object
        id:
          description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the resource anchor.
          type: string
        lifecycleDetails:
          description: 'A message that describes the current state of the resource anchor in more detail. For example,

            can be used to provide actionable information for a resource in the Failed state.

            '
          type: string
        lifecycleState:
          description: The current state of the resource anchor.
          enum:
          - CREATING
          - UPDATING
          - ACTIVE
          - DELETING
          - DELETED
          - FAILED
          type: string
        linkedCompartmentId:
          description: "Optional - Oracle Cloud Infrastructure compartment Id (OCID) which was created or linked by customer with resource anchor. \nThis compartmentId is different from where resource Anchor live.\n"
          type: string
        linkedCompartmentName:
          description: The name assigned to the compartment which was created or linked by customer with resource anchor. This compartment is different from where resource Anchor live.
          type: string
        region:
          description: OCI Region that resource is created.
          type: string
        setupMode:
          description: "AUTO_BIND - when passed compartment will be created on-behalf of customer and bind to this resource anchor\nNO_AUTO_BIND - compartment will not be created and later customer can bind existing compartment. \nto this resource anchor. This is for future use only\n"
          enum:
          - AUTO_BIND
          - NO_AUTO_BIND
          type: string
        subscriptionId:
          description: Oracle Cloud Infrastructure Subscription Id
          type: string
        subscriptionType:
          description: subscription type
          enum:
          - ORACLEDBATAZURE
          - ORACLEDBATGOOGLE
          - ORACLEDBATAWS
          type: string
          x-obmcs-top-level-enum: '#/definitions/SubscriptionType'
        systemTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only the String type is supported.

                '
              type: object
            description: 'Key-value pair representing a system tag key and value, scoped to a namespace.


              Example: `{"free-tier-retained": "true"}`

              '
            type: object
          description: 'System tags for this resource. Each key is predefined and scoped to a namespace.


            Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

            '
          type: object
        timeCreated:
          description: 'The date and time the resource anchor was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339).


            Example: `2016-08-25T21:10:29.600Z`

            '
          format: date-time
          type: string
        timeUpdated:
          description: 'The date and time the resource anchor was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339).


            Example: `2016-08-25T21:10:29.600Z`

            '
          format: date-time
          type: string
      required:
      - id
      - compartmentId
      - lifecycleState
      - timeCreated
      - displayName
      - freeformTags
      - systemTags
      - definedTags
      - subscriptionId
      type: object
    CloudServiceProviderMetadataItem:
      description: "Cloud Service Provider metadata item.\nWarning - In future this object can change to generic object with future Cloud Service Provider based on \nCloudServiceProvider field. This can be one of CSP provider type Azure, GCP and AWS.\n"
      discriminator:
        propertyName: subscriptionType
      properties:
        cspAdditionalProperties:
          additionalProperties:
            type: string
          description: CSP Specific Additional Properties, AzureSubnetId for Azure
          type: object
        cspResourceAnchorId:
          description: CSP resource anchor ID.
          type: string
        cspResourceAnchorName:
          description: CSP resource anchor name.
          type: string
        region:
          description: The Azure, AWS or GCP region.
          type: string
        resourceAnchorName:
          description: OCI resource anchor name.
          type: string
        resourceAnchorUri:
          description: CSP resource anchor Uri.
          type: string
        subscriptionType:
          description: Oracle Cloud Infrastructure Subscription Type.
          enum:
          - ORACLEDBATAZURE
          - ORACLEDBATGOOGLE
          - ORACLEDBATAWS
          type: string
          x-obmcs-top-level-enum: '#/definitions/SubscriptionType'
      required:
      - resourceAnchorName
      - subscriptionType
      type: object
    ResourceAnchorCollection:
      description: List of resource anchors in the indicated Multicloud subscription.
      properties:
        items:
          description: List of resource anchors.
          items:
            $ref: '#/components/schemas/ResourceAnchorSummary'
          type: array
      required:
      - items
      type: object
  responses:
    DefaultError:
      description: An error has occurred.
      headers:
        opc-request-id:
          description: Unique identifier for the request
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
x-anchors:
  definedTags:
    additionalProperties:
      additionalProperties:
        description: 'The value of the tag. Only the String type is supported.

          '
        type: object
      description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.


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

        '
      type: object
    description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

      For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).


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

      '
    type: object
  etag:
    description: 'For optimistic concurrency control. See `if-match`.

      '
    type: string
  freeformTags:
    additionalProperties:
      type: string
    description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.

      For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).


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

      '
    type: object
  opc-next-page:
    description: 'For list pagination. When this header appears in the response, additional pages of results remain. For

      important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

      '
    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
  opc-work-request-id:
    description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.

      Use GetWorkRequest with this ID to track the status of the request.

      '
    type: string
  retry-after:
    description: A decimal number representing the number of seconds the client should wait before polling this endpoint again.
    type: integer
  systemTags:
    additionalProperties:
      additionalProperties:
        description: 'The value of the tag. Only the String type is supported.

          '
        type: object
      description: 'Key-value pair representing a system tag key and value, scoped to a namespace.


        Example: `{"free-tier-retained": "true"}`

        '
      type: object
    description: 'System tags for this resource. Each key is predefined and scoped to a namespace.


      Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

      '
    type: object
  x-headers: null
  x-properties: null
x-obmcs-client-retries-enabled: true
x-oracle-package: com.oracle.omhub.cp