openapi: 3.2.0 info: description: 'Use the Application Performance Monitoring Control Plane API to perform operations such as creating, updating, deleting and listing APM domains and monitoring the progress of these operations using the work request APIs. For more information, see [Application Performance Monitoring](/iaas/application-performance-monitoring/index.html). ' title: Application Performance Monitoring Control Plane Apm Domain API version: '20200630' x-provenance: method: harvested first_party: true publisher: Oracle source: https://docs.oracle.com/en-us/iaas/api/specs/76a4b8f135a2d13624cfab19a134abf66128741edfa5bea238dd52ef01f8126b.yaml harvested: '2026-08-04' note: Published by Oracle as the contract for the Application Performance Monitoring Control Plane 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/76a4b8f135a2d13624cfab19a134abf66128741edfa5bea238dd52ef01f8126b.yaml what: the harvested document for Application Performance Monitoring Control Plane API servers: - url: /20200630 tags: - name: apmDomain paths: /apmDomains: get: description: 'Lists all APM domains for the specified tenant compartment. ' operationId: ListApmDomains parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/LifecycleStateQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' 429: $ref: '#/components/responses/429' 200: description: A page of ApmDomainSummary objects. 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: items: $ref: '#/components/schemas/ApmDomainSummary' type: array summary: Gets a list of all APM domains in a compartment tags: - apmDomain post: description: 'Creates a new APM domain. ' operationId: CreateApmDomain parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 409: $ref: '#/components/responses/409' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' 429: $ref: '#/components/responses/429' 202: description: Creates the APM domain. The Create operation is an asynchronous process and the status can be tracked using the work request ID. 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 opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string summary: Creates a new APM domain tags: - apmDomain x-related-resource: '#/definitions/ApmDomain' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateApmDomainDetails' description: Details for the new APM domain. required: true /apmDomains/{apmDomainId}: delete: description: 'Deletes the specified APM domain asynchronously. The APM domain is placed in the ''Deleting'' state and will stop accepting any operation requests. All resources associated with the APM domain are eventually recovered. Use the returned work request ID to track the progress of the background activity to complete deleting the APM domain. ' operationId: DeleteApmDomain parameters: - $ref: '#/components/parameters/ApmDomainIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 412: $ref: '#/components/responses/412' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' 429: $ref: '#/components/responses/429' 202: description: Deletes the APM domain. The Delete operation is an asynchronous process and the status can be tracked using the work request ID. 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 opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string summary: Deletes the APM domain identified by id. tags: - apmDomain x-related-resource: '#/definitions/ApmDomain' get: description: Gets the details of the APM domain specified by OCID. operationId: GetApmDomain parameters: - $ref: '#/components/parameters/ApmDomainIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' 429: $ref: '#/components/responses/429' 200: description: Retrieves the APM domain with the given OCID. 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/ApmDomain' summary: Get APM domain tags: - apmDomain put: description: Updates the APM domain. operationId: UpdateApmDomain parameters: - $ref: '#/components/parameters/ApmDomainIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 412: $ref: '#/components/responses/412' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' 429: $ref: '#/components/responses/429' 202: description: Updates the APM domain. The Update operation is an asynchronous process and the status can be tracked using the work request ID. 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 opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string summary: Update the APM domain identified by the id tags: - apmDomain x-related-resource: '#/definitions/ApmDomain' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateApmDomainDetails' description: The information to be updated for the APM domain. required: true /apmDomains/{apmDomainId}/actions/changeCompartment: post: description: Moves an APM domain into a different compartment. When provided, If-Match is checked against ETag values of the APM domain. operationId: ChangeApmDomainCompartment parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/ApmDomainIdentifierPathParam' responses: 412: $ref: '#/components/responses/412' 409: $ref: '#/components/responses/409' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' 429: $ref: '#/components/responses/429' 202: description: Moves the APM domain to a new compartment. The Change compartment operation is an asynchronous process and the status can be tracked using the work request ID. 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 opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string summary: Moves an APM domain into a different compartment tags: - apmDomain x-related-resource: '#/definitions/ApmDomain' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeApmDomainCompartmentDetails' description: The information to be used in changing compartment. required: true /apmDomains/{apmDomainId}/actions/generateDataKeys: post: description: 'Generates a set of new Data Keys for the specified APM domain with the specified names and types. These will be added to the existing set of Data Keys for the specified APM domain. ' operationId: GenerateDataKeys parameters: - $ref: '#/components/parameters/ApmDomainIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 412: $ref: '#/components/responses/412' 409: $ref: '#/components/responses/409' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' 429: $ref: '#/components/responses/429' 202: description: Request for Data Key generation was accepted. 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 opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string summary: Generates a set of new Data Keys for the specified APM domain. tags: - apmDomain x-related-resource: '#/definitions/DataKey' requestBody: content: application/json: schema: items: $ref: '#/components/schemas/GenerateDataKeyDetails' type: array description: List of new Data Keys to be generated. required: true /apmDomains/{apmDomainId}/actions/removeDataKeys: post: description: 'Removes the set of specified Data Keys from the specified APM domain. Agents would no longer be able to use these data keys to upload to the APM domain once this operation is completed. ' operationId: RemoveDataKeys parameters: - $ref: '#/components/parameters/ApmDomainIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 412: $ref: '#/components/responses/412' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' 429: $ref: '#/components/responses/429' 202: description: Request for Data Key removal was accepted. 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 opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string summary: Removes the set of specified Data Keys from the specified APM domain. tags: - apmDomain x-related-resource: '#/definitions/DataKey' requestBody: content: application/json: schema: items: $ref: '#/components/schemas/RemoveDataKeyDetails' type: array description: List of Data Keys to be removed. required: true /apmDomains/{apmDomainId}/dataKeys: get: description: 'Lists all Data Keys for the specified APM domain. The caller may filter the list by specifying the ''dataKeyType'' query parameter. ' operationId: ListDataKeys parameters: - $ref: '#/components/parameters/ApmDomainIdentifierPathParam' - $ref: '#/components/parameters/DataKeyTypeQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' 429: $ref: '#/components/responses/429' 200: description: A list of DataKeySummary objects. 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: items: $ref: '#/components/schemas/DataKeySummary' type: array summary: Gets a list of all Data Keys for a given APM domain. tags: - apmDomain /apmDomains/{apmDomainId}/workRequests: get: description: 'Returns a (paginated) list of work requests related to a specific APM domain. ' operationId: ListApmDomainWorkRequests parameters: - $ref: '#/components/parameters/ApmDomainIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' responses: 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' 429: $ref: '#/components/responses/429' 200: description: The list of work requests that are related to the specified APM domain. 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: items: $ref: '#/components/schemas/WorkRequest' type: array summary: List Work Requests related to a specific APM domain tags: - apmDomain x-related-resource: '#/definitions/WorkRequest' /workRequests: get: description: 'Returns a (paginated) list of work requests in a given compartment. ' operationId: ListWorkRequests parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' responses: 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' 429: $ref: '#/components/responses/429' 200: description: A list of work requests. 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: items: $ref: '#/components/schemas/WorkRequest' type: array summary: List all Work Requests in the specified compartment tags: - apmDomain x-related-resource: '#/definitions/WorkRequest' /workRequests/{workRequestId}: get: description: Gets the details of the work request with the given ID. operationId: GetWorkRequest parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' 429: $ref: '#/components/responses/429' 200: description: The details of the work request. 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 retry-after: description: A decimal number representing the number of seconds the client should wait before polling this endpoint again. schema: type: number format: float content: application/json: schema: $ref: '#/components/schemas/WorkRequest' summary: GET Work Request Status tags: - apmDomain x-related-resource: '#/definitions/WorkRequest' /workRequests/{workRequestId}/errors: get: description: 'Returns a (paginated) list of errors for a given work request. ' operationId: ListWorkRequestErrors parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' responses: 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' 429: $ref: '#/components/responses/429' 200: description: List of work request errors. 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: items: $ref: '#/components/schemas/WorkRequestError' type: array summary: Lists work request errors tags: - apmDomain x-related-resource: '#/definitions/WorkRequestError' /workRequests/{workRequestId}/logs: get: description: 'Returns a (paginated) list of logs for a given work request. ' operationId: ListWorkRequestLogs parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' responses: 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' 429: $ref: '#/components/responses/429' 200: description: List of work request logs. 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: items: $ref: '#/components/schemas/WorkRequestLogEntry' type: array summary: Lists work request logs tags: - apmDomain x-related-resource: '#/definitions/WorkRequestLogEntry' components: schemas: DataKeySummary: allOf: - $ref: '#/components/schemas/BaseKeyDetails' - properties: value: description: Value of the Data Key. maxLength: 255 minLength: 1 type: string type: object description: Summary of Data Key. ChangeApmDomainCompartmentDetails: description: The information needed for the change compartment operation. properties: compartmentId: description: The OCID of the destination compartment for the APM domain. maxLength: 255 minLength: 1 type: string required: - compartmentId type: object CreateApmDomainDetails: description: The information about the new APM domain. properties: compartmentId: description: The OCID of the compartment corresponding to the APM domain. 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"}}` ' type: object description: description: Description of the APM domain. maxLength: 400 minLength: 1 type: string displayName: description: Display name of the APM domain. maxLength: 255 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"}` ' type: object isFreeTier: default: false description: Indicates whether this is an "Always Free" resource. The default value is false. type: boolean logGroupId: description: The OCID of the Log Analytics log group to which the data uploaded to this APM domain will be mapped to. maxLength: 255 minLength: 1 type: string required: - displayName - compartmentId type: object Error: description: The details of an error that occurred. 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 ApmDomainSummary: allOf: - $ref: '#/components/schemas/BaseDomainDetails' - type: object description: Summary of an APM domain. BaseKeyDetails: description: The information about a Data Key. properties: name: description: 'Name of the Data Key. The name uniquely identifies a Data Key within an APM domain. ' maxLength: 100 minLength: 1 pattern: ^[a-zA-Z_][a-zA-Z_0-9]*$ type: string type: description: Type of the Data Key. enum: - PRIVATE - PUBLIC type: string x-obmcs-top-level-enum: '#/definitions/DataKeyTypes' required: - name - type type: object UpdateApmDomainDetails: description: The information that can be updated by update APM domain operation. properties: 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"}}` ' type: object description: description: Description of the APM domain. maxLength: 400 minLength: 1 type: string displayName: description: Display name of the APM domain. maxLength: 255 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"}` ' type: object logGroupId: description: The OCID of the Log Analytics log group to which the data uploaded to this APM domain will be mapped to. maxLength: 255 minLength: 1 type: string type: object ApmDomain: allOf: - $ref: '#/components/schemas/BaseDomainDetails' - properties: dataUploadEndpoint: description: The endpoint where the APM agents upload their observations and metrics. type: string type: object description: Details of an APM domain. GenerateDataKeyDetails: allOf: - $ref: '#/components/schemas/BaseKeyDetails' - type: object description: Details of the Data Key to be generated. WorkRequestResource: description: The details of the resource that the work request affects. properties: actionType: description: 'The way in which this resource is affected by the work tracked in the work request. A resource being created, updated, or deleted will remain in the IN_PROGRESS state until work is complete for that resource at which point it will transition to CREATED, UPDATED, or DELETED, respectively. ' enum: - CREATED - UPDATED - DELETED - IN_PROGRESS - RELATED type: string x-obmcs-top-level-enum: '#/definitions/ActionTypes' entityType: description: The resource type the work request affects. type: string entityUri: description: The URI path that the user can do a GET on to access the resource metadata. type: string identifier: description: The identifier of the resource the work request affects. type: string required: - actionType - entityType - identifier BaseDomainDetails: description: Details for an APM domain. properties: compartmentId: description: The OCID of the compartment corresponding to the APM domain. 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"}}` ' type: object description: description: Description of the APM domain. type: string displayName: description: Display name of the APM domain, which can be updated. 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"}` ' type: object id: description: Unique identifier that is immutable on creation. type: string isFreeTier: description: Indicates if this is an Always Free resource. type: boolean lifecycleState: description: The current lifecycle state of the APM domain. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleStates' logGroupId: description: The OCID of the Log Analytics log group to which the data uploaded to this APM domain will be mapped to. 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 APM domain was created, expressed in RFC 3339 timestamp format. format: date-time type: string timeUpdated: description: The time the APM domain was updated, expressed in RFC 3339 timestamp format. format: date-time type: string required: - id - compartmentId - displayName type: object RemoveDataKeyDetails: description: Details of the Data Key to be removed. properties: name: description: 'Name of the Data Key. The name uniquely identifies a Data Key within an APM domain. ' maxLength: 100 minLength: 1 pattern: ^[a-zA-Z_][a-zA-Z_0-9]*$ type: string required: - name type: object WorkRequestError: description: An error encountered while executing a work request. properties: code: description: 'A machine-usable code for the error that occurred. Error codes are listed at [API Errors](/iaas/Content/API/References/apierrors.htm) ' type: string message: description: A human readable description of the issue encountered. type: string timestamp: description: The time the error occurred, expressed in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. format: date-time type: string required: - code - message - timestamp WorkRequestLogEntry: description: A log message from the execution of a work request. properties: message: description: Human-readable log message. type: string timestamp: description: The time the error occurred, expressed in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. format: date-time type: string required: - message - timestamp WorkRequest: description: A description of work request. properties: compartmentId: description: 'The OCID of the compartment that contains the work request. ' type: string id: description: The ID of the work request. type: string operationType: description: The type of the work request. enum: - CREATE_APM_DOMAIN - UPDATE_APM_DOMAIN - DELETE_APM_DOMAIN - GENERATE_DATA_KEYS - REMOVE_DATA_KEYS type: string x-obmcs-top-level-enum: '#/definitions/OperationTypes' percentComplete: description: Percentage of the request completed. format: float type: number resources: description: The resources affected by the work request. items: $ref: '#/components/schemas/WorkRequestResource' type: array status: description: Status of current work request. enum: - ACCEPTED - IN_PROGRESS - FAILED - SUCCEEDED - CANCELING - CANCELED type: string x-obmcs-top-level-enum: '#/definitions/OperationStatus' timeAccepted: description: 'The date and time the request was created, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. ' format: date-time type: string timeFinished: description: 'The date and time the object was finished, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. ' format: date-time type: string timeStarted: description: 'The date and time the request was started, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. ' format: date-time type: string required: - operationType - status - id - compartmentId - resources - percentComplete - timeAccepted parameters: PaginationTokenQueryParam: description: The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. in: query name: page schema: type: string minLength: 1 SortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified, timeCreated is default. ' in: query name: sortBy schema: type: string enum: - timeCreated - displayName default: timeCreated ApmDomainIdentifierPathParam: description: The OCID of the APM domain. in: path name: apmDomainId required: true schema: type: string CompartmentIdQueryParam: description: The ID of the compartment in which to list resources. in: query name: compartmentId required: true schema: type: string IfMatchHeader: description: 'For optimistic concurrency control. 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 DataKeyTypeQueryParam: description: Data key type. in: query name: dataKeyType required: false x-default-description: When not specified, all Data Key types are included. x-obmcs-top-level-enum: '#/definitions/DataKeyTypes' schema: type: string enum: - PRIVATE - PUBLIC PaginationLimitQueryParam: description: The maximum number of items to return. in: query name: limit schema: type: integer default: 100 maximum: 1000 minimum: 1 LifecycleStateQueryParam: description: A filter to return only resources that match the given life-cycle state. in: query name: lifecycleState required: false x-obmcs-top-level-enum: '#/definitions/LifecycleStates' schema: type: string enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED WorkRequestIdPathParam: description: The ID of the asynchronous request. in: path name: workRequestId required: true schema: type: string SortOrderQueryParam: description: The sort order to use, either 'asc' or 'desc'. in: query name: sortOrder x-obmcs-top-level-enum: '#/definitions/SortOrders' schema: type: string enum: - ASC - DESC default: ASC RetryTokenHeader: description: 'A token that uniquely identifies a request therefore 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 DisplayNameQueryParam: description: A filter to return only resources that match the entire display name given. in: query name: displayName x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 RequestIdHeader: description: The client request ID for tracing. in: header name: opc-request-id schema: 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: - maximumAttemptCount: 3 routing: strategy: route-to-any-ad throttling: perTenantLimit: rpmLimit: 1000 rpsLimit: 100 perUserLimit: rpmLimit: 50 rpsLimit: 10 - listingEnhancements: false maximumAttemptCount: 3 routing: strategy: route-to-any-ad throttling: perTenantLimit: rpmLimit: 1000 rpsLimit: 100 perUserLimit: rpmLimit: 50 rpsLimit: 10 - search: mode: automated operationResourceName: apmDomain - search: mode: automated operationResourceName: apmDomainTarget - - APM-PROD-CP - - APM-PROD-CP - ignore: false maximumAttemptCount: 3 restriction: allowedServicePrincipals: - logging routing: strategy: route-to-any-ad serviceList: - APM-PROD-CP throttling: perTenantLimit: rpmLimit: 1000 rpsLimit: 100 perUserLimit: rpmLimit: 50 rpsLimit: 10 - asyncEndAudit: mode: automated workRequestIdExpression: response.headers['opc-work-request-id'] - tagStore: mode: automated - allowCrossTenancy: true mode: automated nbacMode: '##NBAC_MODE##' - authorization: allowCrossTenancy: true check: resources['apmDomain'].grantedPermissions.contains('APM_DOMAIN_READ') mode: automated nbacMode: '##NBAC_MODE##' - permissions: - APM_DOMAIN_READ serviceResourceName: ApmDomain targetCompartmentId: downstream.fetcher().pathParams(request.resourceId).fetch(request.serviceName, 'GetWorkRequest').compartmentId x-downstream-splat-expressions: - downstream.fetcher().pathParams(request.resourceId).fetch(request.serviceName, 'GetApmDomain').compartmentId - downstream.fetcher().pathParams(request.resourceId).fetch(request.serviceName, 'GetApmDomain').displayName - downstream.fetcher().pathParams(request.resourceId).fetch(request.serviceName, 'GetApmDomain').freeformTags['.splatAuthorizedTagSlug'] - downstream.fetcher().pathParams(request.resourceId).fetch(request.serviceName, 'GetWorkRequest').compartmentId - downstream.fetcher().pathParams(response.headers['opc-work-request-id']).fetch(request.serviceName, 'GetWorkRequest').resources[0].identifier - downstream.fetcher().pathParams(request.body.resource).fetch(request.serviceName, 'GetApmDomain') - downstream.fetcher().pathParams(request.body.resource).fetch(request.serviceName, 'GetApmDomain').compartmentId - request.resourceId - response.headers['opc-work-request-id'] - splat.getTenancyId(request.body.compartmentId) 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 opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' type: string retry-after: description: A decimal number representing the number of seconds the client should wait before polling this endpoint again. format: float type: number x-nbac: - '##NBAC_MODE##' x-properties: apm-domain-compartment-id: description: The OCID of the compartment corresponding to the APM domain. maxLength: 255 minLength: 1 type: string apm-domain-description: description: Description of the APM domain. maxLength: 400 minLength: 1 type: string apm-domain-displayname: description: Display name of the APM domain. maxLength: 255 minLength: 1 type: string datakey-name: description: 'Name of the Data Key. The name uniquely identifies a Data Key within an APM domain. ' maxLength: 100 minLength: 1 pattern: ^[a-zA-Z_][a-zA-Z_0-9]*$ 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"}}` ' 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"}` ' type: object log-group-id: description: The OCID of the Log Analytics log group to which the data uploaded to this APM domain will be mapped to. 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 x-responses: - 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. ' type: string schema: $ref: '#/components/schemas/Error' - 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' - 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' 429: $ref: '#/components/responses/429' - 412: $ref: '#/components/responses/412' - 409: $ref: '#/components/responses/409' - 409: $ref: '#/components/responses/409' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' 429: $ref: '#/components/responses/429' - 412: $ref: '#/components/responses/412' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' 429: $ref: '#/components/responses/429' - 409: $ref: '#/components/responses/409' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' 429: $ref: '#/components/responses/429' x-obmcs-client-circuit-breaker-enabled: true x-obmcs-client-retries-enabled: true x-oracle-package: com.oracle.apm.controller