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 Multi Clouds Metadata 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: multiCloudsMetadata
paths:
  /omHub/multiCloudsMetadata:
    get:
      description: 'Lists Multicloud metadata for Multicloud subscriptions in the specified compartment.

        Multicloud metadata for a subscription includes the Multicloud base compartment (top-level OCI compartment).

        For more information, see

        [Listing Multicloud Metadata for a Subscription](/iaas/Content/multicloud-hub/list-subscription-metadata.htm).

        '
      operationId: ListMultiCloudMetadata
      parameters:
      - $ref: '#/components/parameters/RequiredCompartmentIdQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: A page of MultiCloudMetadata 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/MultiCloudMetadataCollection'
        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 multicloud metadata across Cloud Service Providers.
      tags:
      - multiCloudsMetadata
      x-example: 'POST /20180828/MultiCloudMetadataCollection/ListMultiCloudMetadata?compartmentId=<var>&lt;compartment_OCID&gt;</var>

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

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

        '
      x-related-resource: '#/definitions/MultiCloudMetadataCollection'
  /omHub/multiCloudsMetadata/{subscriptionId}:
    get:
      description: 'Gets details for Multicloud metadata for the specified Multicloud subscription.

        Multicloud metadata for a subscription includes the Multicloud base compartment (top-level OCI compartment).

        For more information, see

        [Getting Details for Multicloud Metadata](/iaas/Content/multicloud-hub/get-subscription-metadata.htm).

        '
      operationId: GetMultiCloudMetadata
      parameters:
      - $ref: '#/components/parameters/RequiredCompartmentIdQueryParam'
      - $ref: '#/components/parameters/RequiredSubscriptionIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The Base Compartment 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/MultiCloudMetadata'
        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 the Multicloud base compartment.
      tags:
      - multiCloudsMetadata
      x-example: 'POST /20180828/MultiCloudMetadata/GetMultiCloudMetadata?compartmentId=<var>&lt;compartment_OCID&gt;</var>&subscriptionId=<var>&lt;subscription_OCID&gt;</var>

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

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

        '
      x-related-resource: '#/definitions/MultiCloudMetadata'
components:
  schemas:
    MultiCloudMetadataSummary:
      description: 'The Multicloud metadata for the indicated subscription.

        Multicloud metadata for a subscription includes the Multicloud base compartment (top-level OCI compartment).

        For more information, see

        [Getting Details for Multicloud Metadata](/iaas/Content/multicloud-hub/get-subscription-metadata.htm).

        '
      properties:
        compartmentId:
          description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Multicloud base compartment associated with the indicated subscription (`subscriptionId`).
          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
        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
        subscriptionId:
          description: The [OCID](/Content/General/Concepts/identifiers.htm) of the OCI subscription.
          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 that the Multicloud base compartment 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
      required:
      - compartmentId
      - subscriptionId
      - timeCreated
      - freeformTags
      - definedTags
      type: object
    MultiCloudMetadata:
      description: 'The Multicloud metadata for the indicated subscription.

        Multicloud metadata for a subscription includes the Multicloud base compartment (top-level OCI compartment).

        For more information, see

        [Getting Details for Multicloud Metadata](/iaas/Content/multicloud-hub/get-subscription-metadata.htm).

        '
      properties:
        compartmentId:
          description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Multicloud base compartment associated with the indicated subscription (`subscriptionId`).
          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
        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
        subscriptionId:
          description: The [OCID](/Content/General/Concepts/identifiers.htm) of the OCI subscription.
          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 that the Multicloud base compartment 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
      required:
      - compartmentId
      - subscriptionId
      - timeCreated
      - freeformTags
      - definedTags
      type: object
    MultiCloudMetadataCollection:
      description: 'Multicloud metadata for Multicloud subscriptions in the indicated compartment.

        For more information, see

        [Listing Multicloud Metadata for a Subscription](/iaas/Content/multicloud-hub/list-subscription-metadata.htm).

        '
      properties:
        items:
          description: List of MultiCloudMetadata.
          items:
            $ref: '#/components/schemas/MultiCloudMetadataSummary'
          type: array
      required:
      - items
      type: object
    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
  parameters:
    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
    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
    RequiredSubscriptionIdPathParam:
      description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the OCI subscription.
      in: path
      name: subscriptionId
      required: true
      schema:
        type: string
    RequiredCompartmentIdQueryParam:
      description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.
      in: query
      name: compartmentId
      required: true
      schema:
        type: string
    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
    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
    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
  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