Oracle Attributes API

The attributes API from Oracle — 8 operation(s) for attributes.

Operations 8

POST /attributes/actions/activateAttributes Activate a set of attributes for the given APM Domain. #
POST /attributes/actions/autoActivate Turn on or off autoactivation for private data key or public data key traffic in the APM Domain. #
POST /attributes/actions/deActivateAttributes DeActivate a set of attributes for the given APM Domain. #
POST /attributes/actions/pinAttributes Pin a set of attributes in the APM Domain. #
POST /attributes/actions/unPinAttributes Unpin a set of attributes in the APM Domain. #
POST /attributes/actions/updateAttributes Update a set of attribute properties in the APM Domain. #
POST /attributes/actions/updateNotes Update notes to a set of attributes in the APM Domain. #
GET /attributes/autoActivateStatus Get autoactivate status for a private data key or public data key in the APM Domain. #

Documentation

📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/access-governance-cp/20220518/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/adm/20220421/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/advisor/20200606/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/ai-data-platform/20240831/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/analytics/20190331/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/announcements/0.0.1/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/api-gateway/20190501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/apm-config/20210201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/apm-control-plane/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/apm-synthetic-monitoring/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/apm-trace-explorer/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/audit/20190901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/autoscaling/20181001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/bastion/20210331/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/batch/20251031/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/bigdata/20190531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/blockchain/20191010/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/budgets/20190111/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/certificates/20210224/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/certificatesmgmt/20210224/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/cloud-guard/20200131/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/clusterplacementgroups/20230801/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/compute-cloud-at-customer/20221208/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/container-instances/20210415/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/container-registry/20180419/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/containerengine/20180222/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/cost-anomaly/20190111/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/dashboard/20210731/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-catalog/20190325/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-flow/20200129/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-integration/20200430/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-safe/20181201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-science/20190101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-management/20201101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-migration/20230518/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-multicloud-integrations/20240501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-tools/20201005/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-tools-runtime/20230222/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/datacc/20251101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/datalabeling-dp/20211001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/datalabeling/20211001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/delegate-access-control/20230801/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/devops/20210630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/digital-assistant/20190506/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/disaster-recovery/20220125/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/dms/20211101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/dns/20180115/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/document-understanding/20221109/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/edsfu/20220528/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/emaildelivery/20170907/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/emaildeliverysubmission/20220926/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/events/20181201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/filestorage/20171215/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/fleet-management/20250228/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/functions/20181201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/functionsdocgenpbf/1.0/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/fusion-applications/20211201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai-agents-client/20240531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai-agents/20240531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai-inference/20231130/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai-nl2sql/20260325/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai/20231130/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generic/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/globally-distributed-database/20250101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/goldengate/20200407/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/healthchecks/20180501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/iaas/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/identity-domains/v1/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/identity-dp/v1/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/identity/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/incidentmanagement/20181231/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/instanceagent/20180530/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/integration/20190131/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/iot/20250531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/itas/v1/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/jms-java-download/20230601/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/jms/20210610/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/jms-utils/20250521/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/kafka/20240901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/key/release/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/language/20221001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/licensemanager/20220430/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/limits-increase/20251101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/limits/20181025/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/loadbalancer/20170115/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/logan-api-spec/20200601/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/logging-dataplane/20200831/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/logging-management/20200531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/logging-search/20190909/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/lustre/20250228/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/managed-access/20220126/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/management-agent/20200202/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/managementdashboard/20200901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/marketplace/20181001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/mngdmac/20250320/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/monitoring/20180401/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/multicloud-omhub-cp/20180828/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/mysql/20190415/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/NetMonitor/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/network-firewall/20211001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/network-firewall/20230501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/networkloadbalancer/20200501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/nosql-database/20190828/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/notification/20181201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/objectstorage/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/OCB/20220509/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/occ/20230515/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/occds/20240430/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/occm/20231107/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/ocicache/20220315/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/ocm/20220919/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/opa/20210621/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/opensearch/20180828/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/operations-insights/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/operatoraccesscontrol/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/oracle-api-access-control/20241130/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/organizations/20230401/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/organizations/20200801/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/osmh/20220901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/postgresql/20220915/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/psasvc/20240301/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/publisher/20241201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/queue/20210201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/recovery-service/20210216/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/registry/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/resource-analytics/20241031/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/resource-discovery-monitoring-control-api/20210330/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/resource-scheduler/20240430/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/resourcemanager/20180917/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/rover/20201210/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/s3objectstorage/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/scanning/20210215/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/search/20180409/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/secretmgmt/20180608/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/secretretrieval/20190301/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/secure-desktops/20220618/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/security-attribute/20240815/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/self/20260129/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/service-catalog/20210527/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/serviceconnectors/20200909/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/smp/20210914/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/speech/20220101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/stack-monitoring/20210330/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/streaming/20180418/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/threat-intel/20220901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/usage/20200107/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/usage-proxy/20190111/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/vision/20220125/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/visual-builder/20210601/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/visual-builder-studio/20180828/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/vmware/20200501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/vmware/20230701/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/waa/20211230/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/waas/20181116/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/waf/20210930/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/wlms/20241101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/workrequests/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/zero-trust-packet-routing/20240301/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/zero-trust-packet-routing-tools/20240301/

Specifications

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/oracle-attributes-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

oracle-attributes-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  description: 'Use the Application Performance Monitoring Trace Explorer API to query traces and associated spans in Trace Explorer. 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 Trace Explorer Attributes API
  version: '20200630'
  x-provenance:
    method: harvested
    first_party: true
    publisher: Oracle
    source: https://docs.oracle.com/en-us/iaas/api/specs/d1cc8021a03784e751fe54c779074681c153f47a8bd2975f098d6c8988748126.yaml
    harvested: '2026-08-04'
    note: Published by Oracle as the contract for the Application Performance Monitoring Trace Explorer 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/d1cc8021a03784e751fe54c779074681c153f47a8bd2975f098d6c8988748126.yaml
    what: the harvested document for Application Performance Monitoring Trace Explorer API
servers:
- url: http://apm-trace.{region}.oci.{secondLevelDomain}/20200630
- url: https://apm-trace.{region}.oci.{secondLevelDomain}/20200630
tags:
- name: attributes
paths:
  /attributes/actions/activateAttributes:
    post:
      description: 'Activates a set of attributes for the given APM Domain.  Attribute names are not case-sensitive.  Any duplicates present in the bulk activation

        request are deduplicated and only unique attributes are activated.  A maximum number of 700 string attributes and 100 numeric attributes

        can be activated in an APM Domain subject to the available string and numeric slots.  Once an attribute has been activated, it may take some time

        for it to be appear in searches as ingest might not have picked up the changes or any associated caches might not have refreshed.  The

        bulk activation operation is atomic, and the operation succeeds only if all the attributes in the request have been processed successfully and they

        get a success status back.  If the processing of any attribute results in a processing or validation error, then none of the attributes in the bulk

        request are activated.  Attributes that are activated are unpinned by default if they are pinned.

        '
      operationId: BulkActivateAttribute
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/ApmDomainIdQueryParam'
      responses:
        200:
          description: 'A response indicating the bulk activation status is returned.

            '
          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/BulkActivationStatus'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Activate a set of attributes for the given APM Domain.
      tags:
      - attributes
      x-related-resource: '#/definitions/BulkActivationStatus'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkActivateAttributeDetails'
        description: 'Request body containing the details about the set of attributes to be activated.

          '
        required: true
  /attributes/actions/autoActivate:
    post:
      description: 'Turn on or off autoactivate for private data key or public data key traffic a given APM Domain.

        '
      operationId: PutToggleAutoActivate
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/ApmDomainIdQueryParam'
      - $ref: '#/components/parameters/AutoActivateToggleOperationQueryParam'
      - $ref: '#/components/parameters/DataKeyTypeQueryParam'
      responses:
        200:
          description: 'A response indicating the status of the toggle autoactivation is returned.

            '
          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/AutoActivateToggleStatus'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Turn on or off autoactivation for private data key or public data key traffic in the APM Domain.
      tags:
      - attributes
      x-related-resource: '#/definitions/AutoActivateToggleStatus'
  /attributes/actions/deActivateAttributes:
    post:
      description: 'Deactivates a set of attributes for the given APM Domain.  Attribute names are not case-sensitive.  Any duplicates present in the bulk deactivation

        request are deduplicated and only unique attributes are deactivated.  A maximum number of 700 string attributes and 100 numeric attributes

        can be deactivated in an APM Domain subject to the available string and numeric slots.  Out of box attributes (Trace and Span) cannot be

        deactivated, and will result in a processing error.  Once an attribute has been deactivated, it may take some time for it to disappear in

        searches as ingest might not have picked up the changes or any associated caches might not have refreshed.  The bulk deactivation

        operation is atomic, and the operation succeeds only if all the attributes in the request have been processed successfully and they get a success

        status back.  If the processing of any attribute results in a processing or validation error, then none of the attributes in the bulk request

        are deactivated.

        '
      operationId: BulkDeActivateAttribute
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/ApmDomainIdQueryParam'
      responses:
        200:
          description: 'A response indicating the bulk deactivation status is returned.

            '
          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/BulkDeActivationStatus'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: DeActivate a set of attributes for the given APM Domain.
      tags:
      - attributes
      x-related-resource: '#/definitions/BulkDeActivationStatus'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkDeActivateAttributeDetails'
        description: 'Request body containing the details about the set of attributes to be deactivated.

          '
        required: true
  /attributes/actions/pinAttributes:
    post:
      description: 'Pin a set of attributes in the APM Domain.  Attributes that are marked pinned are not autoactivated by ingest.

        Attributes that are deactivated are pinned by default.

        '
      operationId: BulkPinAttribute
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/ApmDomainIdQueryParam'
      responses:
        200:
          description: 'A response indicating the bulk pin status is returned.

            '
          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/BulkPinStatus'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Pin a set of attributes in the APM Domain.
      tags:
      - attributes
      x-related-resource: '#/definitions/BulkPinStatus'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkPinAttributeDetails'
        description: 'Request body containing the details about the set of attributes to be pinned.

          '
        required: true
  /attributes/actions/unPinAttributes:
    post:
      description: 'Unpin a set of attributes in the APM Domain.

        '
      operationId: BulkUnpinAttribute
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/ApmDomainIdQueryParam'
      responses:
        200:
          description: 'A response indicating the bulk unpin status is returned.

            '
          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/BulkUnpinStatus'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Unpin a set of attributes in the APM Domain.
      tags:
      - attributes
      x-related-resource: '#/definitions/BulkUnpinStatus'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkUnpinAttributeDetails'
        description: 'Request body containing the details about the set of attributes to be unpinned.

          '
        required: true
  /attributes/actions/updateAttributes:
    post:
      description: 'Update a set of attribute properties in the APM Domain.

        '
      operationId: BulkUpdateAttribute
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/ApmDomainIdQueryParam'
      responses:
        200:
          description: 'A response indicating the bulk update attribute status is returned.

            '
          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/BulkUpdateAttributeStatus'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Update a set of attribute properties in the APM Domain.
      tags:
      - attributes
      x-related-resource: '#/definitions/BulkUpdateAttributeStatus'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkUpdateAttributeDetails'
        description: 'Request body containing the details about the set of attributes for which properties are to be updated.

          '
        required: true
  /attributes/actions/updateNotes:
    post:
      description: 'Add or edit notes to a set of attributes in the APM Domain.  Notes can be added to either an active or an inactive attribute.  The

        notes will be preserved even if the attribute changes state (when an active attribute is deactivated or when an inactive attribute

        is activated).

        '
      operationId: BulkUpdateAttributeNotes
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/ApmDomainIdQueryParam'
      responses:
        200:
          description: 'A response indicating the bulk update notes status is returned.

            '
          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/BulkUpdateNotesStatus'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Update notes to a set of attributes in the APM Domain.
      tags:
      - attributes
      x-related-resource: '#/definitions/BulkUpdateNotesStatus'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkUpdateAttributeNotesDetails'
        description: 'Request body containing the details about the set of attributes for which notes are to be updated.

          '
        required: true
  /attributes/autoActivateStatus:
    get:
      description: 'Get autoactivation status for a private data key or public data key in the APM Domain.

        '
      operationId: GetStatusAutoActivate
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/ApmDomainIdQueryParam'
      - $ref: '#/components/parameters/DataKeyTypeQueryParam'
      responses:
        200:
          description: 'A response indicating the status of autoactivate for the data key is returned.

            '
          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/AutoActivateStatus'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Get autoactivate status for a private data key or public data key in the APM Domain.
      tags:
      - attributes
      x-related-resource: '#/definitions/AutoActivateStatus'
components:
  schemas:
    BulkActivationMetadata:
      description: 'Metadata about the bulk activation operation.  The bulk activation operation is atomic and binary.  If the processing of any of the attributes in the bulk

        activation request results in a processing or validation error, then none of the attributes in the request are activated.  The bulk activation request succeeds

        only when all the attributes in the bulk activation request are processed and they get a successful attributeStatus back.

        '
      properties:
        availableNumericAttributes:
          description: 'Total number of free slots available to activate numeric attributes in the TRACES namespace in the APM Domain.  Note that if a bulk request has succeeded, this

            number reflects the total number of free slots available for activation of additional numeric attributes in the TRACES namespace in the APM Domain.

            '
          type: integer
        availableStringAttributes:
          description: 'Total number of free slots available to activate string attributes in the TRACES namespace in the APM Domain.  Note that if a bulk request has succeeded, this

            number reflects the total number of free slots available for activation of additional string attributes in the TRACES namespace in the APM Domain.

            '
          type: integer
        availableSyntheticNumericAttributes:
          description: 'Total number of free slots available to activate numeric attributes in the SYNTHETIC namespace in the APM Domain.  Note that if a bulk request has succeeded, this

            number reflects the total number of free synthetic slots available for activation of additional numeric attributes in the SYNTHETIC namespace in the APM Domain.

            '
          type: integer
        availableSyntheticStringAttributes:
          description: 'Total number of free slots available to activate string attributes in the SYNTHETIC namespace in the APM Domain.  Note that if a bulk request has succeeded, this

            number reflects the total number of free synthetic slots available for activation of additional string attributes in the SYNTHETIC namespace in the APM Domain.

            '
          type: integer
        numericAttributesActivated:
          description: 'Total number of numeric attributes in TRACES namespace that were activated.

            '
          type: integer
        operationStatus:
          description: 'Operation status of the bulk activation operation.  The bulk  activation operation could have either a success or an error status as defined below.

            The following is a success status for the bulk activation operation.

            SUCCESS - The bulk activation operation has succeeded and all the attributes in the bulk activation request have been activated by this operation or activated earlier.

            The following are error statuses for the bulk activation operation.  Note that none of the attributes (string or numeric) in the bulk request have been activated by this bulk

            activation operation if any of the below statuses.

            EMPTY_ATTRIBUTE_LIST - The bulk activation request object was empty and did not contain any attributes to be activated.

            NUMERIC_ATTRIBUTE_LIMIT_EXCEEDED - The number of numeric attributes in the bulk request exceeded the maximum limit (100) of numeric attributes that could be activated in the APM Domain.

            STRING_ATTRIBUTE_LIMIT_EXCEEDED - The number of string attributes in the bulk request exceeded the maximum limit (700) of string attributes that could be activated in the APM Domain.

            INSUFFICIENT_STRING_SPACE - There are not enough free slots available in the APM Domain to activate the string attributes present in the bulk request.

            INSUFFICIENT_NUMERIC_SPACE - There are not enough free slots available in the APM Domain to activate the numeric attributes present in the bulk request.

            INVALID_BULK_REQUEST - The bulk request contains invalid attribute(s), or attribute(s) that resulted in a validation error, or an attribute that resulted

            in a processing error.

            '
          enum:
          - SUCCESS
          - EMPTY_ATTRIBUTE_LIST
          - NUMERIC_ATTRIBUTE_LIMIT_EXCEEDED
          - STRING_ATTRIBUTE_LIMIT_EXCEEDED
          - INSUFFICIENT_STRING_SPACE
          - INSUFFICIENT_NUMERIC_SPACE
          - INVALID_BULK_REQUEST
          type: string
        operationType:
          description: 'Type of operation.

            '
          enum:
          - ACTIVATE
          type: string
        stringAttributesActivated:
          description: 'Total number of string attributes in TRACES namespace that were activated.

            '
          type: integer
        syntheticNumericAttributesActivated:
          description: 'Total number of numeric attributes in SYNTHETIC namespace that were activated.

            '
          type: integer
        syntheticStringAttributesActivated:
          description: 'Total number of string attributes in SYNTHETIC namespace that were activated.

            '
          type: integer
      required:
      - operationType
      - operationStatus
      type: object
    BulkActivateAttributeDetails:
      description: 'Bulk request object containing the details of the attributes to be activated.

        '
      properties:
        attributeDetails:
          description: 'Collection of objects containing the details about individual attribute to be activated.

            '
          items:
            $ref: '#/components/schemas/BulkActivateAttributeDetail'
          type: array
      type: object
    AutoActivateStatus:
      description: 'Status of autoactivation for the given data key in the APM Domain.

        '
      properties:
        dataKey:
          description: 'Data key type for which auto-activate needs needs to be turned on or off.

            '
          enum:
          - PRIVATE_DATA_KEY
          - PUBLIC_DATA_KEY
          type: string
        state:
          description: 'State of autoactivation in this APM Domain.  If "ON" auto-activate is set to true, if "OFF" auto-activate is set to false.

            '
          enum:
          - true
          - false
          type: string
      required:
      - state
      - dataKey
      type: object
    BulkUpdateNotesStatus:
      description: 'Response of a bulk update notes operation.

        '
      properties:
        attributeStatuses:
          description: 'We preserve the order of the attribute items from the bulk update notes request in this collection.  The ith object in this collection represents the

            bulk update notes operation status of the ith object in the BulkUpdateAttributeNotesDetails object in the Bulk update notes request.  If the

            bulk update notes operation results in a processing error or a validation error, the operationStatus property in the  BulkUpdateNotesMetadata object will

            contain the appropriate bulk error status for the bulk operation.

            '
          items:
            $ref: '#/components/schemas/AttributeUpdateNotesResponse'
          type: array
        bulkUpdateNotesMetadata:
          $ref: '#/components/schemas/BulkUpdateNotesMetadata'
      required:
      - attributeStatuses
      - bulkUpdateNotesMetadata
      type: object
    BulkUpdateAttributeNotesDetails:
      description: 'Bulk request object containing the details of the attributes for which notes are to be updated.

        '
      properties:
        attributeDetails:
          description: 'Collection of objects containing the details about individual attribute for which notes are to be updated.

            '
          items:
            $ref: '#/components/schemas/BulkUpdateAttributeNotesDetail'
          type: array
      type: object
    BulkUnpinStatus:
      description: 'Response of a bulk attribute unpin operation.

        '
      properties:
        attributeStatuses:
          description: 'We preserve the order of the attribute items from the bulk unpin request in this collection.  The ith object in this collection represents the

            bulk unpin operation status of the ith object in the BulkUnpinAttributeDetails object in the Bulk unpin request.  If the

            bulk unpin operation results in a processing error or a validation error, the operationStatus property in the  BulkUnpinMetadata object will

            contain the appropriate bulk error status for the bulk operation.

            '
          items:
            $ref: '#/components/schemas/AttributeUnpinResponse'
          type: array
        bulkUnpinMetadata:
          $ref: '#/components/schemas/BulkUnpinMetadata'
      required:
      - attributeStatuses
      - bulkUnpinMetadata
      type: object
    BulkDeActivateAttributeDetail:
      description: 'Object that contains the details about a single attribute to be deactivated.

        '
      properties:
        attributeName:
          description: 'Name of the attribute to be deactivated.

            '
          maxLength: 255
          minLength: 1
          type: string
        attributeNameSpace:
          default: TRACES
          description: "Namespace of the attribute to be deactivated.  The attributeNameSpace will default to TRACES if it is \nnot passed in.\n"
          enum:
          - TRACES
          - SYNTHETIC
          type: string
      required:
      - attributeName
      type: object
    BulkUnpinAttributeDetail:
      description: 'Object that contains the details about a single attribute in the bulk request to be unpinned.

        '
      properties:
        attributeName:
          description: 'Name of the attribute to be unpinned.

            '
          maxLength: 255
          minLength: 1
          type: string
        attributeNameSpace:
          default: TRACES
          description: "Namespace of the attribute to be unpinned.  The attributeNameSpace will default to TRACES if it is \nnot passed in.\n"
          enum:
          - TRACES
          - SYNTHETIC
          type: string
      required:
      - attributeName
      type: object
    BulkUpdateAttributeStatus:
      description: 'Response of a bulk update attribute operation.

        '
      properties:
        attributeStatuses:
          description: 'We preserve the order of the attribute items from the bulk update attribute request in this collection.  The ith object in this collection represents the

            bulk update attribute operation status of the ith object in the BulkUpdateAttributeDetails object in the Bulk update attribute request.  If the

            bulk update attribute operation results in a processing error or a validation error, the operationStatus property in the  BulkUpdateAttributeMetadata object will

            contain the appropriate bulk error status for the bulk operation.

            '
          items:
            $ref: '#/components/schemas/AttributeUpdateResponse'
          type: array
        bulkUpdateAttributeMetadata:
          $ref: '#/components/schemas/BulkUpdateAttributeMetadata'
      required:
      - attributeStatuses
      - bulkUpdateAttributeMetadata
      type: object
    AttributePinResponse:
      description: 'Response of an individual attribute item in the bulk pin operation.

        '
      properties:
        attributeName:
          description: 'Attribute that was pinned by this bulk operation.

            '
          maxLength: 255
          minLength: 1
          type: string
        attributeNameSpace:
          default: TRACES
          description: "Namespace of the attribute whose properties were updated.  The attributeNameSpace will default to TRACES if it is \nnot passed in.\n"
          enum:
          - TRACES
          - SYNTHETIC
          type: string
        attributeStatus:
          description: 'Status of the attribute after this operation.  The attribute can have one of the following statuses after the pin operation.  The attribute

            can have either a success status or an error status.  The status of the attribute must be correlated with the operation status property in the bulk operation metadata

            object.  The bulk operation will be successful only when all attributes in the bulk request are processed successfully and they get a success status back.

            The following are successful status values of individual attribute items in a bulk attribute pin operation.

            ATTRIBUTE_PINNED - The attribute is marked pinned and associated notes have been added.

            ATTRIBUTE_ALREADY_PINNED - The caller is trying to pin an attribute that has already been pinned.

            DUPLICATE_ATTRIBUTE - The attribute is a duplicate of an attribute that was present in this bulk request.  Note that we deduplicate the attribute collection, process only unique attributes,

            and call out duplicates.  A duplicate attribute in a bulk request will not prevent the processing of further attributes in the bulk operation.

            The following values are error statuses and the bulk processing is stopped when the first error is encountered.

            PIN_NOT_ALLOWED - The caller has asked to pin an active attribute which is not allowed.

            INVALID_ATTRIBUTE - The attribute is invalid.

            ATTRIBUTE_NOT_PROCESSED - The attribute was not processed, as there was another attribute in this bulk request collection that resulted in a processing error.

            '
          enum:
          - ATTRIBUTE_ALREADY_PINNED
          - ATTRIBUTE_PINNED
          - PIN_NOT_ALLOWED
          - DUPLICATE_ATTRIBUTE
          - INVALID_ATTRIBUTE
          - ATTRIBUTE_NOT_PROCESSED
          type: string
        notes:
          description: 'Notes added to this attribute.

            '
          type: string
        operationType:
          description: 'Type of operation - pin.

            '
          enum:
          - PIN
          type: string
        timeUpdated:
          description: 'Time when the attribute was activated or deactivated.  Note that ingest might not have picked up the changes even if this time has elapsed.

            '
          format: date-time
          type: string
      required:
      - attributeName
      - notes
      - operationType
      - attributeStatus
      - timeUpdated
      - attributeNameSpace
      type: object
    BulkActivateAttributeDetail:
      description: 'Object that contains the details about a single attribute in the bulk request to be activated.  The attributeNameSpace and

        unit are optional parameters, and the attributeNameSpace will default to TRACES if it is not passed in.

        '
      properties:
        attributeName:
          description: 'Name of the attribute to be activated.

            '
          maxLength: 255
          minLength: 1
          type: string
        attributeNameSpace:
          default: TRACES
          description: "Namespace of the attribute to be activated.  The attributeNameSpace will default to TRACES if it is \nnot passed in.\n"
          enum:
          - TRACES
          - SYNTHETIC
          type: string
        attributeType:
          description: 'Type of the attribute to be activated.

            '
          enum:
          - NUMERIC
          - STRING
          type: string
        unit:
          description: 'Unit of the attribute to be updated.  If unit is not specified, it defaults to NONE.

            '
          enum:
          - NONE
      

# --- truncated at 32 KB (72 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/oracle/refs/heads/main/openapi/oracle-attributes-api-openapi.yml