{ "opencollection": "1.0.0", "info": { "name": "Application Performance Monitoring Control Plane Apm Domain API", "version": "20200630" }, "items": [ { "info": { "name": "apmDomain", "type": "folder" }, "items": [ { "info": { "name": "Gets a list of all APM domains in a compartment", "type": "http" }, "http": { "method": "GET", "url": "/20200630/apmDomains", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list resources." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the given life-cycle state." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'." }, { "name": "sortBy", "value": "", "type": "query", "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.\n" } ] }, "docs": "Lists all APM domains for the specified tenant compartment.\n" }, { "info": { "name": "Creates a new APM domain", "type": "http" }, "http": { "method": "POST", "url": "/20200630/apmDomains", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new APM domain.\n" }, { "info": { "name": "Get APM domain", "type": "http" }, "http": { "method": "GET", "url": "/20200630/apmDomains/:apmDomainId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "apmDomainId", "value": "", "type": "path", "description": "The OCID of the APM domain." } ] }, "docs": "Gets the details of the APM domain specified by OCID." }, { "info": { "name": "Update the APM domain identified by the id", "type": "http" }, "http": { "method": "PUT", "url": "/20200630/apmDomains/:apmDomainId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "apmDomainId", "value": "", "type": "path", "description": "The OCID of the APM domain." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the APM domain." }, { "info": { "name": "Deletes the APM domain identified by id.", "type": "http" }, "http": { "method": "DELETE", "url": "/20200630/apmDomains/:apmDomainId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "apmDomainId", "value": "", "type": "path", "description": "The OCID of the APM domain." } ] }, "docs": "Deletes the specified APM domain asynchronously. The APM domain is placed in the 'Deleting' state and will stop\naccepting any operation requests. All resources associated with the APM domain are eventually recovered. Use the\nreturned work request ID to track the progress of the background activity to complete deleting the APM domain.\n" }, { "info": { "name": "Moves an APM domain into a different compartment", "type": "http" }, "http": { "method": "POST", "url": "/20200630/apmDomains/:apmDomainId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "apmDomainId", "value": "", "type": "path", "description": "The OCID of the APM domain." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves an APM domain into a different compartment. When provided, If-Match is checked against ETag values of the APM domain." }, { "info": { "name": "Generates a set of new Data Keys for the specified APM domain.", "type": "http" }, "http": { "method": "POST", "url": "/20200630/apmDomains/:apmDomainId/actions/generateDataKeys", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "apmDomainId", "value": "", "type": "path", "description": "The OCID of the APM domain." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Generates a set of new Data Keys for the specified APM domain with the specified names and\ntypes. These will be added to the existing set of Data Keys for the specified APM domain.\n" }, { "info": { "name": "Removes the set of specified Data Keys from the specified APM domain.", "type": "http" }, "http": { "method": "POST", "url": "/20200630/apmDomains/:apmDomainId/actions/removeDataKeys", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "apmDomainId", "value": "", "type": "path", "description": "The OCID of the APM domain." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Removes the set of specified Data Keys from the specified APM domain. Agents would no longer\nbe able to use these data keys to upload to the APM domain once this operation is completed.\n" }, { "info": { "name": "Gets a list of all Data Keys for a given APM domain.", "type": "http" }, "http": { "method": "GET", "url": "/20200630/apmDomains/:apmDomainId/dataKeys", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "apmDomainId", "value": "", "type": "path", "description": "The OCID of the APM domain." }, { "name": "dataKeyType", "value": "", "type": "query", "description": "Data key type." } ] }, "docs": "Lists all Data Keys for the specified APM domain. The caller may filter the list by specifying the 'dataKeyType'\nquery parameter.\n" }, { "info": { "name": "List Work Requests related to a specific APM domain", "type": "http" }, "http": { "method": "GET", "url": "/20200630/apmDomains/:apmDomainId/workRequests", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "apmDomainId", "value": "", "type": "path", "description": "The OCID of the APM domain." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." } ] }, "docs": "Returns a (paginated) list of work requests related to a specific APM domain.\n" }, { "info": { "name": "List all Work Requests in the specified compartment", "type": "http" }, "http": { "method": "GET", "url": "/20200630/workRequests", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list resources." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." } ] }, "docs": "Returns a (paginated) list of work requests in a given compartment.\n" }, { "info": { "name": "GET Work Request Status", "type": "http" }, "http": { "method": "GET", "url": "/20200630/workRequests/:workRequestId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The ID of the asynchronous request." } ] }, "docs": "Gets the details of the work request with the given ID." }, { "info": { "name": "Lists work request errors", "type": "http" }, "http": { "method": "GET", "url": "/20200630/workRequests/:workRequestId/errors", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The ID of the asynchronous request." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." } ] }, "docs": "Returns a (paginated) list of errors for a given work request.\n" }, { "info": { "name": "Lists work request logs", "type": "http" }, "http": { "method": "GET", "url": "/20200630/workRequests/:workRequestId/logs", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The ID of the asynchronous request." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." } ] }, "docs": "Returns a (paginated) list of logs for a given work request.\n" } ] } ], "bundled": true }