openapi: 3.2.0
info:
  description: 'Use the Application Performance Monitoring Configuration API to query and set Application Performance Monitoring

    configuration. For more information, see [Application Performance Monitoring](https://docs.oracle.com/iaas/application-performance-monitoring/index.html).

    '
  license:
    name: Oracle Corporation
  title: Application Performance Monitoring Configuration Config API
  version: '20210201'
  x-provenance:
    method: harvested
    first_party: true
    publisher: Oracle
    source: https://docs.oracle.com/en-us/iaas/api/specs/42166576f1e5ff54f09f5720889809a704216efb7c095b6116285a45b2ad2b6f.yaml
    harvested: '2026-08-04'
    note: Published by Oracle as the contract for the Application Performance Monitoring Configuration 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/42166576f1e5ff54f09f5720889809a704216efb7c095b6116285a45b2ad2b6f.yaml
    what: the harvested document for Application Performance Monitoring Configuration API
servers:
- url: http://apm-config.{region}.oci.{secondLevelDomain}/20210201
- url: https://apm-config.{region}.oci.{secondLevelDomain}/20210201
tags:
- name: config
paths:
  /actions/copyConfiguration:
    post:
      description: Fast importing configuration items to a destination APM domain ID.
      operationId: CopyConfiguration
      parameters:
      - $ref: '#/components/parameters/ApmDomainIdQueryParam'
      - $ref: '#/components/parameters/ApmTargetDomainIdQueryParam'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: A list describing which items, if any, couldn't be copied by the service. Each entry contains the OCID of the failed item, as well as an error message describing the reason why it couldn't not be copied.
          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/ImportConfigurationFailedItemsCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        403:
          $ref: '#/components/responses/403'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        422:
          $ref: '#/components/responses/422'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Export and Import an array of configurations to a destination domain.
      tags:
      - config
      x-related-resource: '#/definitions/ExportConfigurationDetails'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CopyConfigurationDetails'
        description: JSON metadata for fast Export/Import configurations domain.
        required: true
  /actions/exportConfiguration:
    post:
      description: Exports configurations for the whole domain by domainId.
      operationId: ExportConfiguration
      parameters:
      - $ref: '#/components/parameters/ApmDomainIdQueryParam'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Array of configurations and dependencies to be exported.
          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/ExportConfigurationResponseDetails'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        403:
          $ref: '#/components/responses/403'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        422:
          $ref: '#/components/responses/422'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Exports an array of configurations.
      tags:
      - config
      x-related-resource: '#/definitions/ExportConfigurationDetails'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExportConfigurationDetails'
        description: JSON metadata for exporting configurations domain.
        required: true
  /actions/importConfiguration:
    post:
      description: Import configurations Item(s) with its dependencies into a destination domain.
      operationId: ImportConfiguration
      parameters:
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/ApmDomainIdQueryParam'
      responses:
        200:
          description: A list describing which items, if any, couldn't be imported by the service. Each entry contains the OCID of the failed item, as well as an error message describing the reason why it couldn't not be imported.
          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/ImportConfigurationFailedItemsCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        403:
          $ref: '#/components/responses/403'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        422:
          $ref: '#/components/responses/422'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Import configurations Item(s) and dependencies to a domain.
      tags:
      - config
      x-related-resource: '#/definitions/ImportConfigurationDetails'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ImportConfigurationDetails'
        description: JSON metadata for importing configurations domain.
        required: true
  /actions/retrieveNamespaceMetrics:
    post:
      description: Returns all metrics associated with the specified namespace.
      operationId: RetrieveNamespaceMetrics
      parameters:
      - $ref: '#/components/parameters/ApmDomainIdQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The list of namespace metrics was returned successfully.
          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/NamespaceMetricCollection'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Retrieve all namespace metrics.
      tags:
      - config
      x-example: "POST /20210201/actions/retrieveNamespaceMetrics\nHost: apm-config.us-phoenix-1.oci.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"name\": \"oracle_apm_rum\"\n}\n"
      x-related-resource: '#/definitions/MetricGroup'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RetrieveNamespaceMetricsDetails'
        description: The namespace to get the metrics for.
        required: true
  /actions/retrieveNamespaces:
    post:
      description: Returns all namespaces available in APM.
      operationId: RetrieveNamespaces
      parameters:
      - $ref: '#/components/parameters/ApmDomainIdQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The list of namespaces was returned successfully.
          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/NamespaceCollection'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Retrieve all APM namespaces.
      tags:
      - config
      x-example: 'POST /20210201/actions/retrieveNamespaces

        Host: apm-config.us-phoenix-1.oci.oraclecloud.com

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

        '
      x-related-resource: '#/definitions/MetricGroup'
  /actions/test:
    post:
      description: 'Tests a data processing operation on the provided input, returning the potentially modified

        input as output. Returns 200 on success, 422 when the input can not be processed.

        '
      operationId: Test
      parameters:
      - $ref: '#/components/parameters/ApmDomainIdQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The result of running the test.
          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/TestOutput'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        422:
          $ref: '#/components/responses/422'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Test a data processing operation against the provided input.
      tags:
      - config
      x-example: "POST /20210201/actions/test\nHost: apm-config.us-phoenix-1.oci.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"test\": \"span-enrichment\",\n  \"input\": {\n    \"options\": {\n      \"type\": \"data-manipulation.spans\",\n      <var>&lt;span enrichment rule&gt;</var>\n    }\n    \"span\": {\n      \"attributes\": {\n        \"key1\": \"value1\"\n      }\n    }\n  }\n}\n"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TestDetails'
        description: The test input.
        required: true
  /actions/validateSpanFilterPattern:
    post:
      description: 'Validates the Span Filter pattern (filterText) for syntactic correctness.

        Returns 204 on success, 422 when validation fails.

        '
      operationId: ValidateSpanFilterPattern
      parameters:
      - $ref: '#/components/parameters/ApmDomainIdQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        204:
          description: The Span Filter pattern passed validation.
          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
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        422:
          $ref: '#/components/responses/422'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Validate Span Filter pattern (filterText).
      tags:
      - config
      x-example: "POST /20210201/actions/validateSpanFilterPattern\nHost: apm-config.us-phoenix-1.oci.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"filterText\": \"page-url like '%login%'\"\n}\n"
      x-related-resource: '#/definitions/SpanFilter'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ValidateSpanFilterPatternDetails'
        description: The Span Filter pattern to validate.
        required: true
  /configs:
    get:
      description: Returns all configuration items, which can optionally be filtered by configuration type.
      operationId: ListConfigs
      parameters:
      - $ref: '#/components/parameters/ApmDomainIdQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/ConfigTypeQueryParam'
      - $ref: '#/components/parameters/DisplayNameQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/OptionsGroupQueryParam'
      - $ref: '#/components/parameters/FilterByDefinedTagEqualsQueryParam'
      - $ref: '#/components/parameters/FilterByFreeformTagEqualsQueryParam'
      - $ref: '#/components/parameters/FilterByDefinedTagExistsQueryParam'
      - $ref: '#/components/parameters/FilterByFreeformTagExistsQueryParam'
      responses:
        200:
          description: A collection of configuration items was returned successfully.
          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-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/ConfigCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        403:
          $ref: '#/components/responses/403'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Returns a collection of configuration items
      tags:
      - config
      x-related-resource: '#/definitions/ConfigCollection'
    post:
      description: Creates a new configuration item.
      operationId: CreateConfig
      parameters:
      - $ref: '#/components/parameters/ApmDomainIdQueryParam'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/DryRunHeader'
      responses:
        200:
          description: The configuration item was created successfully.
          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/Config'
        204:
          description: The dry run for creating the configuration item completed successfully.
          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'
        403:
          $ref: '#/components/responses/403'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        422:
          $ref: '#/components/responses/422'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Creates a new configuration item in the given Apm Domain.
      tags:
      - config
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateConfigDetails'
        description: The configuration details of the new item.
        required: true
  /configs/{configId}:
    delete:
      description: Deletes the configuration item identified by the OCID.
      operationId: DeleteConfig
      parameters:
      - $ref: '#/components/parameters/ApmDomainIdQueryParam'
      - $ref: '#/components/parameters/ConfigIdPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        204:
          description: The configuration item identified by the OCID was deleted successfully.
          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'
        403:
          $ref: '#/components/responses/403'
        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: Deletes the configuration item identified by the OCID.
      tags:
      - config
      x-related-resource: '#/definitions/Config'
    get:
      description: Gets the configuration item identified by the OCID.
      operationId: GetConfig
      parameters:
      - $ref: '#/components/parameters/ApmDomainIdQueryParam'
      - $ref: '#/components/parameters/ConfigIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The configuration item identified by the OCID was retrieved successfully.
          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/Config'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        403:
          $ref: '#/components/responses/403'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Gets the configuration item identified by the OCID.
      tags:
      - config
    put:
      description: Updates the details of the configuration item identified by the OCID.
      operationId: UpdateConfig
      parameters:
      - $ref: '#/components/parameters/ApmDomainIdQueryParam'
      - $ref: '#/components/parameters/ConfigIdPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/DryRunHeader'
      responses:
        200:
          description: The configuration item identified by the OCID was updated successfully.
          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/Config'
        204:
          description: The dry run for updating the configuration item completed successfully.
          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'
        403:
          $ref: '#/components/responses/403'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        422:
          $ref: '#/components/responses/422'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Updates the details of the configuration item identified by the OCID.
      tags:
      - config
      x-related-resource: '#/definitions/Config'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateConfigDetails'
        description: The configuration details to be updated.
        required: true
components:
  schemas:
    ImportConfigurationFailedItemsCollection:
      description: List of configuration items that failed to be imported.
      properties:
        items:
          description: A list of duplicated configuration items
          items:
            $ref: '#/components/schemas/ImportConfigurationFailedItemSummary'
          type: array
      required:
      - items
      type: object
    ImportConfigurationFailedItemSummary:
      description: A configuration item that failed to be imported.
      properties:
        configType:
          description: The type of configuration item.
          enum:
          - SPAN_FILTER
          - METRIC_GROUP
          - APDEX
          - OPTIONS
          example: SPAN_FILTER
          type: string
          x-obmcs-top-level-enum: '#/definitions/ConfigTypes'
        displayName:
          description: The name by which a configuration entity is displayed to the end user.
          example:
          - Rules to Match All Login Pages
          maxLength: 255
          minLength: 1
          type: string
        errorMessage:
          description: The configuration item wasn't imported due to it being a duplicate.
          type: string
        id:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the configuration item. An OCID is generated

            when the item is created.

            '
          example: ocid1.config.oc1.phx.aaaaaaaaztadasdfaoiiulhykjsd45kjhlkjhlkhsdpksdkakjdsfasdfg
          maxLength: 255
          minLength: 1
          type: string
    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
    ExportConfigurationDetails:
      description: Array of configuration items with its dependencies to export.
      properties:
        configurationMap:
          additionalProperties:
            type: string
          description: 'Simple key-value pair that has parameters related to the export process (ConfigurationId, Skip, …) and more.

            Example: `{"parameter-key": "parameter-value"}`

            Supported parameters:

            — List of the Configuration Type or Groups to Export to a destination domain.

            '
          example:
            bar-key: value
          type: object
      required:
      - configurationMap
      type: object
    ConfigSummary:
      description: 'A description of a configuration item. It specifies all the properties that define the configuration item.

        '
      discriminator:
        propertyName: configType
      properties:
        configType:
          description: The type of configuration item.
          enum:
          - SPAN_FILTER
          - METRIC_GROUP
          - APDEX
          - OPTIONS
          example: SPAN_FILTER
          type: string
          x-obmcs-top-level-enum: '#/definitions/ConfigTypes'
        createdBy:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of a user.

            '
          example: ocid1.user.oc1.phx.aaaaaaaaztadasdfaoiiulhykjsd45kjhlkjhlkhsdpksdkakjdsfasdfg
          maxLength: 255
          minLength: 1
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer and boolean types are supported.

                '
              type: object
            description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.

              Example: `{"bar-key": "value"}`

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

            Example: `{"foo-namespace": {"bar-key": "value"}}`

            '
          example:
            foo-namespace:
              bar-key: value
          type: object
        etag:
          description: 'For optimistic concurrency control. See `if-match`.

            '
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.

            Example: `{"bar-key": "value"}`

            '
          example:
            bar-key: value
          type: object
        id:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the configuration item. An OCID is generated

            when the item is created.

            '
          example: ocid1.config.oc1.phx.aaaaaaaaztadasdfaoiiulhykjsd45kjhlkjhlkhsdpksdkakjdsfasdfg
          maxLength: 255
          minLength: 1
          type: string
        systemTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer and boolean types are supported.

                '
              type: object
            description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.

              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.

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

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

            timestamp format.

            Example: `2020-02-12T22:47:12.613Z`

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

            timestamp format.

            Example: `2020-02-13T22:47:12.613Z`

            '
          format: date-time
          type: string
        updatedBy:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of a user.

            '
          example: ocid1.user.oc1.phx.aaaaaaaaztadasdfaoiiulhykjsd45kjhlkjhlkhsdpksdkakjdsfasdfg
          maxLength: 255
          minLength: 1
          type: string
      required:
      - configType
      type: object
    ValidateSpanFilterPatternDetails:
      description: The request body used to validate a Span Filter pattern.
      properties:
        filterText:
          description: 'The string that defines the Span Filter expression.

            '
          example: page-url like '%login%'
          maxLength: 65536
          minLength: 1
          type: string
      required:
      - filterText
      type: object
    ExportImportConfigSummary:
      description: 'A description of a configuration item or dependency. It specifies all the properties that define the configuration item or dependency that will be exported.

        '
      discriminator:
        propertyName: configType
      properties:
        configType:
          description: The type of configuration item.
          enum:
          - SPAN_FILTER
          - METRIC_GROUP
          - APDEX
          - OPTIONS
          example: SPAN_FILTER
          type: string
          x-obmcs-top-level-enum: '#/definitions/ConfigTypes'
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer and boolean types are supported.

                '
              type: object
            description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.

              Example: `{"bar-key": "value"}`

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

            Example: `{"foo-namespace": {"bar-key": "value"}}`

            '
          example:
            foo-namespace:
              bar-key: value
          type: object
        freeformTags:
          additionalProperties:
            type: string
          description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.

            Example: `{"bar-key": "value"}`

            '
          example:
            bar-key: value
          type: object
        id:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the configuration item. An OCID is generated

            when the item is created.

            '
          example: ocid1.config.oc1.phx.aaaaaaaaztadasdfaoiiulhykjsd45kjhlkjhlkhsdpksdkakjdsfasdfg
          maxLength: 255
          minLength: 1
          type: string
      required:
      - configType
      type: object
    TestDetails:
      description: The request body used to execute a test.
      discriminator:
        propertyName: testType
      properties:
        testType:
          description: The kind of test to run.
          enum:
          - SPAN_ENRICHMENT
          example: SPAN_ENRICHMENT
          type: string
          x-obmcs-top-level-enum: '#/definitions/TestTypes'
      required:
      - testType
      type: object
    NamespaceMetric:
      description: Metric associated with a namespace.
      properties:
        name:
          description: Name of the metric.
          maxLength: 255
          minLength: 1
          type: string
        type:
          description: Type of metric.
          enum:
          - COUNTER
          - GAUGE
          type: string
          x-obmcs-top-level-enum: '#/definitions/MetricTypes'
        unit:
          description: Unit of the metric.
          example: kb, ms
          maxLength: 255
          minLength: 1
          type: string
      required:
      - name
      - type
    CreateConfigDetails:
      description: 'The request body used to create new configuration items. It must specify the configuration type of the item,

        as well as the actual data to populate the item with.

        '
      discriminator:
        propertyName: configType
      properties:
        configType:
          description: The type of configuration item.
          enum:
          - SPAN_FILTER
          - METRIC_GROUP
          - APDEX
          - OPTIONS
          example: SPAN_FILTER
          type: string
          x-obmcs-top-level-enum: '#/definitions/ConfigTypes'
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer and boolean types are supported.

                '
              type: object
            description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.

              Example: `{"bar-key": "value"}`

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

            Example: `{"foo-namespace": {"bar-key": "value"}}`

            '
          example:
            foo-namespace:
              bar-key: value
          type: object
        freeformTags:
          additionalProperties:
            type: string
          description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.

            Example: `{"bar-key": "value"}`

            '
          example:
            bar-key: value
          type: object
      required:
      - configType
      type: object
    CopyConfigurationDetails:
      description: Array of configuration items with dependencies to copy to a destination domain.
      properties:
        configurationMap:
          additionalProperties:
            type: string
          description: "Simple key-value pair that has parameters related to the import process (EnableOcidSubstitution, DestinationDomainID, …) and more.\nExample: `{\"parameter-key\": \"parameter-value\"}`\nSupported parameters: \n— Enable the OCIDs in instructions to be replaced, if set to \"true\" The Config Service replace any OCIDs it finds \nin the instructions.\n— Destination APM Domain ID where the configuration Item(s) will be fast imported to.\n— List of Configuration Type or Groups to be fast imported.\n— the compartment Id we will fast import to, \nif the compartment Id is not provided it will be the default destination domain compartmentId.\n"
          example:
            bar-key: value
          type: object
      required:
      - configurationMap
      type: object
    ConfigCollection:
      description: A collection of configuration items.
      properties:
        items:
          items:
            $ref: '#/components/schemas/ConfigSummary'
          type: array
      required:
      - items
      type: object
    TestOutput:
      description: The result of running a test.
      discriminator:
        propertyName: testType
      properties:
        testType:
          description: The kind of test output.
          enum:
          - SPAN_ENRICHMENT
          example: SPAN_ENRICHMENT
          type: string
          x-obmcs-top-level-enum: '#/definitions/TestTypes'
      required:
      - testType
      type: object
    NamespaceCollection:
      description: Collection of available namespaces.
      properties:
        items:
          description: The list of available namespaces.
          items:
            $ref: '#/components/schemas/Namespace'
          type: array
          uniqueItems: true
      required:
      - items
    RetrieveNamespaceMetricsDetails:
      description: The request body used to retrieve metrics for the specified namespace.
      properties:
        name:
          description: Name of the namespace.
          type: string
      required:
      - name
      type: object
    Config:
      description: 'A configuration item, which has a number of mutually exclusive properties that can be used to set specific

        portions of the configuration.

        '
      discriminator:
        propertyName: configType
      properties:
        configType:
          description: The type of configuration item.
          enum:
          - SPAN_FILTER
          - METRIC_GROUP
          - APDEX
          - OPTIONS
          example: SPAN_FILTER
          type: string
          x-obmcs-top-level-enum: '#/definitions/ConfigTypes'
        createdBy:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of a user.

            '
          example: ocid1.user.oc1.phx.aaaaaaaaztadasdfaoiiulhykjsd45kjhlkjhlkhsdpksdkakjdsfasdfg
          maxLength: 255
          minLength: 1
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer and boolean types are supported.

                '
              type: object
            description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.

              Example: `{"bar-key": "value"}`

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

            Example: `{"foo-namespace": {"bar-key": "value"}}`

            '
          example:
            foo-namespace:
              bar-key: value
          type: object
        etag:
          description: 'For optimistic concurrency control. See `if-match`.

            '
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.

            Example: `{"bar-key": "value"}`

            '
          example:
            bar-key: value
          type: object
        id:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the configuration item. An OCID is generated

            when the item is created.

            '
          example: ocid1.config.oc1.phx.aaaaaaaaztadasdfaoiiulhykjsd45kjhlkjhlkhsdpksdkakjdsfasdfg
          maxLength: 255
          minLength: 1
          type: string
        timeCreated:
          description: 'The time the resource was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339)

            timestamp format.

            Example: `2020-02-12T22:47:12.613Z`

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

            timestamp format.

            Example: `2020-02-13T22:47:12.613Z`

            '
          format: date-time
          type: string
        updatedBy:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of a user.

            '
          example: ocid1.user.oc1.phx.aaaaaaaaztadasdfaoiiulhykjsd45kjhlkjhlkhsdpksdkakjdsfasdfg
          maxLength: 255
          minLength: 1
          type: string
      required:
      - configType
      type: object
    ImportConfigurationDetails:
      description: Array of configuration items with dependencies to import.
      properties:
        configurationItems:
          description: A list of Configurations Details .
          items:
            $ref: '#/components/schemas/ExportImportConfigSummary'
          type: array
        configurationMap:
          additionalProperties:
            type: string
          description: "Simple key-value pair that has parameters related to the import process (EnableOcidSubstitution, Skip, …) and more.\nExample: `{\"parameter-key\": \"parameter-value\"}`\nSupported parameters: \n— Enable the OCIDs in instructions to be replaced, if set to \"true\" The Config Service replace any OCIDs it finds \nin the instructions, if set to true the Config Service will replace.\n— Compartment Id we want to import the configuration Items,\nif the compartment Id is not provided it will be the default destination domain compartmentId.\n"
          example:
            bar-key: value
          type: object
      required:
      - configurationItems
      - configurationMap
      type: object
    NamespaceMetricCollection:
      description: Collection of available namespace metrics.
      properties:
        items:
          description: The list of available namespace metrics.
          items:
            $ref: '#/components/schemas/NamespaceMetric'
          type: array
          uniqueItems: true
      required:
      - items
    UpdateConfigDetails:
      description: 'The request body used to update the configuration item. It must specify the data to update the item with.

        '
      discriminator:
        propertyName: configType
      properties:
        configType:
          description: The type of configuration item.
          enum:
          - SPAN_FILTER
          - METRIC_GROUP
          - APDEX
          - OPTIONS
          example: SPAN_FILTER
          type: string
          x-obmcs-top-level-enum: '#/definitions/ConfigTypes'
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer and boolean types are supported.

                '
              type: object
            description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.

              Example: `{"bar-key": "value"}`

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

            Example: `{"foo-namespace": {"bar-key": "value"}}`

            '
          example:
            foo-namespace:
              bar-key: value
          type: object
        freeformTags:
          additionalProperties:
            type: string
          description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.

            Example: `{"bar-key": "value"}`

            '
          example:
            bar-key: value
          type: object
      required:
      - configType
      type: object
    Namespace:
      description: Namespaces represent a product level subdivision by name.
      properties:
        name:
          description: Name of the namespace.
          type: string
      required:
      - name
    ExportConfigurationResponseDetails:
      description: Array of configuration items with its dependencies to export.
      properties:
        configurationItems:
          description: A list of Configurations Details .
          items:
            $ref: '#/components/schemas/ExportImportConfigSummary'
          type: array
      required:
      - configurationItems
      type: object
  parameters:
    PaginationTokenQueryParam:
      description: 'The maximum number of results per page, or items to return in a paginated "List" call. For information on

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

        Example: `50`

        '
      in: query
      name: page
      schema:
        type: string
        default: '50'
        maxLength: 1024
    SortByQueryParam:
      description: 'The field to sort by. You can provide one "sortBy" value. The default order for displayName, timeCreated

        and timeUpdated is ascending. The displayName sort by is case-sensitive.

        '
      in: query
      name: sortBy
      schema:
        type: string
        enum:
        - displayName
        - timeCreated
        - timeUpdated
        default: displayName
    FilterByDefinedTagEqualsQueryParam:
      description: 'A list of tag filters to apply.  Only resources with a defined tag matching the value will be returned.

        Each item in the list has the format "{namespace}.{tagName}.{value}".  All inputs are case-insensitive.

        Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR".

        Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".

        '
      in: query
      name: definedTagEquals
      required: false
      x-default-description: 'null'
      schema:
        type: array
        items:
          maxLength: 458
          type: string
    DryRunHeader:
      description: 'Indicates that the request is a dry run, if set to "true". A dry run request does not modify the

        configuration item details and is used only to perform validation on the submitted data.

        '
      in: header
      name: opc-dry-run
      required: false
      schema:
        type: string
        default: 'false'
    ApmDomainIdQueryParam:
      description: 'The APM Domain ID the request is intended for.

        '
      in: query
      name: apmDomainId
      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
    FilterByFreeformTagExistsQueryParam:
      description: 'A list of tag existence filters to apply.  Only resources for which the specified freeform tags exist the value will be returned.

        The key for each tag is "{tagName}.true".  All inputs are case-insensitive.

        Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported.

        Multiple values for different tag names are interpreted as "AND".

        '
      in: query
      name: freeformTagExists
      required: false
      x-default-description: 'null'
      schema:
        type: array
        items:
          maxLength: 106
          type: string
    PaginationLimitQueryParam:
      description: The maximum number of items to return.
      in: query
      name: limit
      schema:
        type: integer
        default: 100
        maximum: 1000
        minimum: 1
    OptionsGroupQueryParam:
      description: A filter to return OPTIONS resources that match the given group.
      in: query
      name: optionsGroup
      required: false
      x-default-description: 'null'
      schema:
        type: string
        maxLength: 128
        minLength: 1
    SortOrderQueryParam:
      description: 'The sort order to use, either ascending (`ASC`) or descending (`DESC`). The displayName sort order

        is case-sensitive.

        '
      in: query
      name: sortOrder
      x-obmcs-top-level-enum: '#/definitions/SortOrders'
      schema:
        type: string
        enum:
        - ASC
        - DESC
        default: ASC
    ApmTargetDomainIdQueryParam:
      description: The Target APM Domain ID the request is intended for.
      in: query
      name: apmTargetDomainId
      required: true
      schema:
        type: string
    FilterByDefinedTagExistsQueryParam:
      description: 'A list of tag existence filters to apply.  Only resources for which the specified defined tags exist will be returned.

        Each item in the list has the format "{namespace}.{tagName}.true" (for checking existence of a defined tag)

        or "{namespace}.true".  All inputs are case-insensitive.

        Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported.

        Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR".

        Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".

        '
      in: query
      name: definedTagExists
      required: false
      x-default-description: 'null'
      schema:
        type: array
        items:
          maxLength: 207
          type: string
    ConfigTypeQueryParam:
      description: 'A filter to match configuration items of a given type.

        Supported values are SPAN_FILTER, METRIC_GROUP, APDEX, AGENT and MACS_APM_EXTENSION.

        '
      in: query
      name: configType
      x-default-description: 'null'
      schema:
        type: string
        maxLength: 64
        minLength: 1
    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
    ConfigIdPathParam:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the configuration item.

        '
      in: path
      name: configId
      required: true
      schema:
        type: string
        maxLength: 255
    DisplayNameQueryParam:
      description: A filter to return resources that match the given display name.
      in: query
      name: displayName
      x-default-description: 'null'
      schema:
        type: string
        maxLength: 255
        minLength: 1
    RequestIdHeader:
      description: 'Unique identifier for the request.

        If you need to contact Oracle about a particular request, please provide the request ID.

        '
      in: header
      name: opc-request-id
      schema:
        type: string
    FilterByFreeformTagEqualsQueryParam:
      description: 'A list of tag filters to apply.  Only resources with a freeform tag matching the value will be returned.

        The key for each tag is "{tagName}.{value}".  All inputs are case-insensitive.

        Multiple values for the same tag name are interpreted as "OR".  Values for different tag names are interpreted as "AND".

        '
      in: query
      name: freeformTagEquals
      required: false
      x-default-description: 'null'
      schema:
        type: array
        items:
          maxLength: 357
          type: string
  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-common-splat-settings:
  - allowCrossTenancy: true
    mode: automated
    nbacMode: '##NBAC_MODE##'
  - allowCrossTenancy: true
    crossTenancyAssociations: []
    mode: automated
    nbacMode: '##NBAC_MODE##'
    sameTenancyResources:
    - apmDomain
    - apmConfig
  - throttling:
      enableRegionalThrottling: true
      mode: default
      perTenantLimit:
        rpsLimit: 300
      perUserLimit:
        rpmLimit: 600
        rpsLimit: 50
  x-downstream-splat-expressions:
  - downstream.getOr404('APM-DIS','GetApmDomainInfoCompartmentId',request.parameter.apmDomainId)
  - downstream.getOr404('APM-DIS','GetApmDomainInfoCompartmentId',request.parameter.apmTargetDomainId)
  - 'downstream.invoke(''APM-CONFIG'',''GetConfig'',request.resourceId,[apmDomainId: request.parameter.apmDomainId]).configType'
  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-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-nbac:
  - '##NBAC_MODE##'
  x-permission-checks:
  - resources['apmDomain'].grantedPermissions.contains('APM_DOMAIN_READ')
  - resources['apmDomain'].grantedPermissions.contains('APM_DOMAIN_UPDATE')
  - resources['apmDomain'].grantedPermissions.contains('APM_DOMAIN_UPDATE') || (resources['apmDomain'].grantedPermissions.contains('APM_DOMAIN_READ') && resources['apmConfig'].grantedPermissions.contains('APM_CONFIGURATION_CREATE'))
  - resources['apmDomain'].grantedPermissions.contains('APM_DOMAIN_UPDATE') || (resources['apmDomain'].grantedPermissions.contains('APM_DOMAIN_READ') && resources['apmConfig'].grantedPermissions.contains('APM_CONFIGURATION_UPDATE'))
  - resources['apmDomain'].grantedPermissions.contains('APM_DOMAIN_UPDATE') || (resources['apmDomain'].grantedPermissions.contains('APM_DOMAIN_READ') && resources['apmConfig'].grantedPermissions.contains('APM_CONFIGURATION_DELETE'))
  x-properties:
    configId:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the configuration item. An OCID is generated

        when the item is created.

        '
      example: ocid1.config.oc1.phx.aaaaaaaaztadasdfaoiiulhykjsd45kjhlkjhlkhsdpksdkakjdsfasdfg
      maxLength: 255
      minLength: 1
      type: string
    definedTags:
      additionalProperties:
        additionalProperties:
          description: 'The value of the tag. Only string, integer and boolean types are supported.

            '
          type: object
        description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.

          Example: `{"bar-key": "value"}`

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

        Example: `{"foo-namespace": {"bar-key": "value"}}`

        '
      example:
        foo-namespace:
          bar-key: value
      type: object
    displayName:
      description: The name by which a configuration entity is displayed to the end user.
      example:
      - Rules to Match All Login Pages
      maxLength: 255
      minLength: 1
      type: string
    filterId:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of a Span Filter. The filterId is mandatory for the creation

        of MetricGroups. A filterId is generated when a Span Filter is created.

        '
      example: ocid1.config.oc1.phx.aaaaaaaaztadasdfaoiiulhykjsd45kjhlkjhlkhsdpksdkakjdsfasdfg
      maxLength: 255
      minLength: 1
      type: string
    filterText:
      description: 'The string that defines the Span Filter expression.

        '
      example: page-url like '%login%'
      maxLength: 65536
      minLength: 1
      type: string
    freeformTags:
      additionalProperties:
        type: string
      description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.

        Example: `{"bar-key": "value"}`

        '
      example:
        bar-key: value
      type: object
    inUseBy:
      description: The list of configuration items that reference the span filter.
      items:
        $ref: '#/components/schemas/SpanFilterReference'
      maxItems: 100
      type: array
    optionsGroup:
      description: 'A string that specifies the group that an OPTIONS item belongs to.

        '
      example: agent
      maxLength: 128
      minLength: 1
      type: string
    timeCreated:
      description: 'The time the resource was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339)

        timestamp format.

        Example: `2020-02-12T22:47:12.613Z`

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

        timestamp format.

        Example: `2020-02-13T22:47:12.613Z`

        '
      format: date-time
      type: string
    userId:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of a user.

        '
      example: ocid1.user.oc1.phx.aaaaaaaaztadasdfaoiiulhykjsd45kjhlkjhlkhsdpksdkakjdsfasdfg
      maxLength: 255
      minLength: 1
      type: string
x-obmcs-client-circuit-breaker-enabled: true
x-obmcs-client-retries-enabled: true
x-oracle-package: com.oracle.apm.service.config