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 Network 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: omhubNetworkAnchor
paths:
  /networkAnchors:
    get:
      description: 'Lists network anchors in the specified Multicloud subscription, Multicloud compartment, and partner cloud region.

        Details listed for each resource include name, state, VCN, and ODB network ID.

        For more information, see

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

        '
      operationId: ListNetworkAnchors
      parameters:
      - $ref: '#/components/parameters/BaseAndSubCompartmentIdQueryParam'
      - $ref: '#/components/parameters/SubscriptionIdQueryParam'
      - $ref: '#/components/parameters/SubscriptionServiceNameQueryParam'
      - $ref: '#/components/parameters/NetworkAnchorLifecycleStateQueryParam'
      - $ref: '#/components/parameters/DisplayNameQueryParam'
      - $ref: '#/components/parameters/ExternalLocationNameQueryParam'
      - $ref: '#/components/parameters/NetworkAnchorOciSubnetIdQueryParam'
      - $ref: '#/components/parameters/NetworkAnchorCompartmentIdInSubtreeQueryParam'
      - $ref: '#/components/parameters/NetworkAnchorOciVcnIdQueryParam'
      - $ref: '#/components/parameters/NetworkAnchorIdentifierQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/ShouldFetchVcnName'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: A page of NetworkAnchorSummary 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/NetworkAnchorCollection'
        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 NetworkAnchors.
      tags:
      - omhubNetworkAnchor
      x-example: 'Active network anchors for a subscription:


        POST /20180828/NetworkAnchorCollection/ListNetworkAnchors?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>

        '
  /networkAnchors/{networkAnchorId}:
    get:
      description: 'Gets details for the specified network anchor. The subscription OCID and service name are required.

        For more information, see

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

        '
      operationId: GetNetworkAnchor
      parameters:
      - $ref: '#/components/parameters/NetworkAnchorIdentifierPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RequiredSubscriptionServiceNameQueryParam'
      - $ref: '#/components/parameters/RequiredSubscriptionIdQueryParam'
      - $ref: '#/components/parameters/ExternalLocationNameQueryParam'
      - $ref: '#/components/parameters/ShouldFetchVcnName'
      responses:
        200:
          description: The NetworkAnchor 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/NetworkAnchor'
        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 NetworkAnchor.
      tags:
      - omhubNetworkAnchor
      x-example: 'Request for an Azure subscription:


        POST /20180828/NetworkAnchor/GetNetworkAnchor?networkAnchorId=<var>&lt;network_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:
    NetworkAnchorIdentifierQueryParam:
      description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the NetworkAnchor.
      in: query
      name: id
      x-default-description: 'null'
      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
    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
    NetworkAnchorOciSubnetIdQueryParam:
      description: A filter to return only NetworkAnchor resources that match the given OCI subnet Id.
      in: query
      name: networkAnchorOciSubnetId
      x-default-description: 'null'
      schema:
        type: string
    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
    ExternalLocationNameQueryParam:
      description: The cloud service provider region.
      in: query
      name: externalLocation
      required: false
      x-default-description: 'null'
      schema:
        type: string
        maxLength: 255
        minLength: 1
    NetworkAnchorOciVcnIdQueryParam:
      description: A filter to return only NetworkAnchor resources that match the given OCI Vcn Id.
      in: query
      name: networkAnchorOciVcnId
      x-default-description: 'null'
      schema:
        type: string
    NetworkAnchorLifecycleStateQueryParam:
      description: 'A filter to return only resources that match the given lifecycle state. The

        state value is case-insensitive.

        '
      in: query
      name: networkAnchorLifecycleState
      required: false
      x-default-description: 'null'
      x-obmcs-enumref: '#/definitions/NetworkAnchor/networkAnchorLifecycleState'
      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
    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
    NetworkAnchorCompartmentIdInSubtreeQueryParam:
      description: If set to true, a list operation will return NetworkAnchors from all child compartments in the provided compartmentId parameter.
      in: query
      name: compartmentIdInSubtree
      required: false
      schema:
        type: boolean
        default: false
    NetworkAnchorIdentifierPathParam:
      description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the NetworkAnchor.
      in: path
      name: networkAnchorId
      required: true
      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
    ShouldFetchVcnName:
      description: Whether to fetch and include the vcn display name, which may introduce additional latency.
      in: query
      name: shouldFetchVcnName
      required: false
      schema:
        type: boolean
        default: false
    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
    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
  schemas:
    NetworkAnchor:
      description: 'A NetworkAnchor is a description of a NetworkAnchor.


        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/CloudServiceProviderNetworkMetadataItem'
        clusterPlacementGroupId:
          description: The CPG ID in which Network Anchor will be created.
          maxLength: 255
          minLength: 1
          type: string
        compartmentId:
          description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
          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 NetworkAnchor.
          type: string
        lifecycleDetails:
          description: 'A message that describes the current state of the NetworkAnchor in more detail. For example,

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

            '
          type: string
        networkAnchorLifecycleState:
          description: The current state of the NetworkAnchor.
          enum:
          - CREATING
          - UPDATING
          - ACTIVE
          - DELETING
          - DELETED
          - FAILED
          type: string
        ociMetadataItem:
          $ref: '#/components/schemas/OciNetworkMetadata'
        resourceAnchorId:
          description: OCI resource anchor Id (OCID).
          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
        subscriptionType:
          description: Oracle Cloud Infrastructure 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 NetworkAnchor 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 NetworkAnchor 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
      - resourceAnchorId
      - networkAnchorLifecycleState
      - timeCreated
      - displayName
      - freeformTags
      - definedTags
      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
    OciVcn:
      description: Oracle Cloud Infrastructure VCN basic information object. It is optional and planned to used for future for network anchor
      properties:
        backupCidrBlocks:
          description: 'Oracle Cloud Infrastructure backup cidr block. CSP can set this property

            It''s optional only if disconnect anchor is allowed.

            IPv4 CIDR blocks for the VCN that meet the following criteria

            Type: [string (length: 1–32), ...]

            The CIDR blocks must be valid.

            They must not overlap with each other or with the on-premises network CIDR block.

            '
          items:
            type: string
          type: array
        cidrBlocks:
          description: 'Oracle Cloud Infrastructure primary cidr block. CSP can set this property

            It''s optional only if disconnect anchor is allowed

            IPv4 CIDR blocks for the VCN that meet the following criteria

            Type: [string (length: 1–32), ...]

            The CIDR blocks must be valid.

            They must not overlap with each other or with the on-premises network CIDR block.

            '
          items:
            type: string
          type: array
        dnsLabel:
          description: Oracle Cloud Infrastructure DNS label. This is optional if DNS config is provided.
          type: string
        vcnId:
          description: Oracle Cloud Infrastructure VCN OCID. CSP can not set this property.
          type: string
        vcnName:
          description: Name of the VCN associated to the Network Anchor.
          type: string
      type: object
    NetworkAnchorCollection:
      description: Results of a networkAnchor search. Contains both NetworkAnchorSummary items and other information, such as metadata.
      properties:
        items:
          description: List of networkAnchors.
          items:
            $ref: '#/components/schemas/NetworkAnchorSummary'
          type: array
      required:
      - items
      type: object
    NetworkAnchorSummary:
      description: Summary information about a NetworkAnchor.
      properties:
        clusterPlacementGroupId:
          description: The CPG ID in which Network Anchor will be created.
          maxLength: 255
          minLength: 1
          type: string
        compartmentId:
          description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
          type: string
        cspAdditionalProperties:
          additionalProperties:
            type: string
          description: CSP Specific Additional Properties, AzureSubnetId for Azure
          type: object
        cspNetworkAnchorId:
          description: Network Anchor Id 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 NetworkAnchor.
          type: string
        lifecycleDetails:
          description: 'A message that describes the current state of the NetworkAnchor in more detail. For example,

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

            '
          type: string
        networkAnchorConnectionStatus:
          description: Defines status of the Network Anchor.
          enum:
          - CONNECTED
          - DISCONNECTED
          - CONNECTING
          - ACTIVE
          - ERROR
          - UPDATING
          - NEEDS_ATTENTION
          - FAILED
          - DELETING
          - DELETED
          type: string
          x-obmcs-top-level-enum: '#/definitions/NetworkAnchorConnectionStatus'
        networkAnchorLifecycleState:
          description: The current state of the NetworkAnchor.
          type: string
          x-obmcs-enumref: '#/definitions/NetworkAnchor/networkAnchorLifecycleState'
        networkAnchorUri:
          description: CSP network anchor Uri
          type: string
        resourceAnchorId:
          description: OCI resource anchor Id (OCID).
          type: string
        subscriptionType:
          description: Oracle Cloud Infrastructure 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 NetworkAnchor 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 NetworkAnchor 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
        vcnId:
          description: OCI resource Id of VCN.
          type: string
        vcnName:
          description: Name of the VCN associated to the Network Anchor.
          type: string
      required:
      - id
      - compartmentId
      - resourceAnchorId
      - networkAnchorLifecycleState
      - networkAnchorConnectionStatus
      - timeCreated
      - displayName
      - freeformTags
      - definedTags
      type: object
    OciNetworkMetadata:
      description: Oracle Cloud Infrastructure network anchor related meta data items
      properties:
        dns:
          $ref: '#/components/schemas/OciDns'
        dnsForwardingConfig:
          description: DNS forward configuration
          items:
            additionalProperties:
              type: string
            type: object
          type: array
        dnsForwardingEndpointIpAddress:
          description: The DNS Listener Forwarding Address.
          type: string
        dnsListeningEndpointIpAddress:
          description: The DNS Listener Endpoint Address.
          type: string
        networkAnchorConnectionStatus:
          description: Defines status of the Network Anchor.
          enum:
          - CONNECTED
          - DISCONNECTED
          - CONNECTING
          - ACTIVE
          - ERROR
          - UPDATING
          - NEEDS_ATTENTION
          - FAILED
          - DELETING
          - DELETED
          type: string
          x-obmcs-top-level-enum: '#/definitions/NetworkAnchorConnectionStatus'
        subnets:
          description: Network subnets
          items:
            $ref: '#/components/schemas/OciNetworkSubnet'
          type: array
        vcn:
          $ref: '#/components/schemas/OciVcn'
      required:
      - networkAnchorConnectionStatus
      type: object
    OciNetworkSubnet:
      description: Oracle Cloud Infrastructure network subnet object.
      properties:
        label:
          description: Subnet label. CSP can set this property
          type: string
        subnetId:
          description: OCID for existing the subnet. CSP can not set this property.
          type: string
        type:
          description: Defines if the subnet is the primary or backup for the network
          enum:
          - CLIENT
          - BACKUP
          type: string
      required:
      - type
      type: object
    OciDns:
      description: Oracle Cloud Infrastructure network anchor related meta data items
      properties:
        customDomainName:
          description: Full custom domain name. If this field is passed dnsLabel will be ignored
          type: string
      type: object
    CloudServiceProviderNetworkMetadataItem:
      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"
      properties:
        cidrBlocks:
          description: An Azure/GCP/AWS cidrBlocks
          items:
            type: string
          type: array
        cspAdditionalProperties:
          additionalProperties:
            type: string
          description: CSP Specific Additional Properties, AzureSubnetId for Azure
          type: object
        dnsForwardingConfig:
          description: DNS domain ip mapping forwarding configuration
          items:
            additionalProperties:
              type: string
            type: object
          type: array
        networkAnchorUri:
          description: CSP network anchor Uri
          type: string
        odbNetworkId:
          description: CSP oracle database network anchor unique ID/name
          type: string
        region:
          description: Azure/GCP/AWS region
          type: string
      required:
      - region
      - odbNetworkId
      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