{ "opencollection": "1.0.0", "info": { "name": "Logging Management API", "version": "20200531" }, "items": [ { "info": { "name": "loggingManagement", "type": "folder" }, "items": [ { "info": { "name": "Lists all log groups in the specified compartment.", "type": "http" }, "http": { "method": "GET", "url": "https://localhost:7875/20200531/logGroups", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "Compartment OCID to list resources in. See compartmentIdInSubtree\n for nested compartments traversal.\n" }, { "name": "isCompartmentIdInSubtree", "value": "", "type": "query", "description": "Specifies whether or not nested compartments should be traversed. Defaults to false." }, { "name": "displayName", "value": "", "type": "query", "description": "Resource name." }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` or `opc-previous-page` response header from the previous \"List\" call.\nFor important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "limit", "value": "", "type": "query", "description": "When setting the page limit, specifies the maximum number of unfiltered records that can be fetched from the data store in one request. Filtering happens after the records are retrieved. Subsequent pages might include results that match the query criteria.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by (one column only). Default sort order is\nascending exception of `timeCreated` and `timeLastModified` columns (descending).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, whether 'asc' or 'desc'.\n" } ] }, "docs": "Lists all log groups for the specified compartment or tenancy." }, { "info": { "name": "Creates new log group.", "type": "http" }, "http": { "method": "POST", "url": "https://localhost:7875/20200531/logGroups", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new log group with a unique display name. This call fails\nif the log group is already created with the same displayName in the compartment.\n" }, { "info": { "name": "Gets the log group's configuration for the log group OCID.", "type": "http" }, "http": { "method": "GET", "url": "https://localhost:7875/20200531/logGroups/:logGroupId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "logGroupId", "value": "", "type": "path", "description": "OCID of a log group to work with." } ] }, "docs": "Get the specified log group's information." }, { "info": { "name": "Updates the existing log group configuration.", "type": "http" }, "http": { "method": "PUT", "url": "https://localhost:7875/20200531/logGroups/:logGroupId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "logGroupId", "value": "", "type": "path", "description": "OCID of a log group to work with." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the existing log group with the associated configuration. This call\n fails if the log group does not exist.\n" }, { "info": { "name": "Deletes the log group configuration with the log group OCID.", "type": "http" }, "http": { "method": "DELETE", "url": "https://localhost:7875/20200531/logGroups/:logGroupId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "logGroupId", "value": "", "type": "path", "description": "OCID of a log group to work with." } ] }, "docs": "Deletes the specified log group." }, { "info": { "name": "Change the compartment to which this LogGroup belongs.", "type": "http" }, "http": { "method": "POST", "url": "https://localhost:7875/20200531/logGroups/:logGroupId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "logGroupId", "value": "", "type": "path", "description": "OCID of a log group to work with." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a log group into a different compartment within the same tenancy. When provided, the If-Match is checked against the resource ETag values.\nFor information about moving resources between compartments, see [Moving Resources Between Compartments](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n" }, { "info": { "name": "Lists all log objects for the specified log group OCID belonging to a compartment or tenancy.", "type": "http" }, "http": { "method": "GET", "url": "https://localhost:7875/20200531/logGroups/:logGroupId/logs", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "logGroupId", "value": "", "type": "path", "description": "OCID of a log group to work with." }, { "name": "logType", "value": "", "type": "query", "description": "The logType that the log object is for, whether custom or service." }, { "name": "sourceService", "value": "", "type": "query", "description": "Service that created the log object, which is a field of LogSummary.Configuration.Source." }, { "name": "sourceResource", "value": "", "type": "query", "description": "Log object resource, which is a field of LogSummary.Configuration.Source." }, { "name": "displayName", "value": "", "type": "query", "description": "Resource name." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "Lifecycle state of the log object" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` or `opc-previous-page` response header from the previous \"List\" call.\nFor important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "limit", "value": "", "type": "query", "description": "When setting the page limit, specifies the maximum number of unfiltered records that can be fetched from the data store in one request. Filtering happens after the records are retrieved. Subsequent pages might include results that match the query criteria.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by (one column only). Default sort order is\nascending exception of `timeCreated` and `timeLastModified` columns (descending).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, whether 'asc' or 'desc'.\n" } ] }, "docs": "Lists the specified log group's log objects." }, { "info": { "name": "Creates a new log object.", "type": "http" }, "http": { "method": "POST", "url": "https://localhost:7875/20200531/logGroups/:logGroupId/logs", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "logGroupId", "value": "", "type": "path", "description": "OCID of a log group to work with." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a log within the specified log group. This call fails if a log group has already been created\nwith the same displayName or (service, resource, category) triplet.\n" }, { "info": { "name": "Gets the log object configuration for the log object OCID.", "type": "http" }, "http": { "method": "GET", "url": "https://localhost:7875/20200531/logGroups/:logGroupId/logs/:logId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "logGroupId", "value": "", "type": "path", "description": "OCID of a log group to work with." }, { "name": "logId", "value": "", "type": "path", "description": "OCID of a log to work with." } ] }, "docs": "Gets the log object configuration for the log object OCID.\n" }, { "info": { "name": "Updates the existing log object configuration.", "type": "http" }, "http": { "method": "PUT", "url": "https://localhost:7875/20200531/logGroups/:logGroupId/logs/:logId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "logGroupId", "value": "", "type": "path", "description": "OCID of a log group to work with." }, { "name": "logId", "value": "", "type": "path", "description": "OCID of a log to work with." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the existing log object with the associated configuration. This call\n fails if the log object does not exist.\n" }, { "info": { "name": "Deletes the log object in a log group.", "type": "http" }, "http": { "method": "DELETE", "url": "https://localhost:7875/20200531/logGroups/:logGroupId/logs/:logId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "logGroupId", "value": "", "type": "path", "description": "OCID of a log group to work with." }, { "name": "logId", "value": "", "type": "path", "description": "OCID of a log to work with." } ] }, "docs": "Deletes the log object in a log group." }, { "info": { "name": "Change the LogGroup to which this log belongs to.", "type": "http" }, "http": { "method": "POST", "url": "https://localhost:7875/20200531/logGroups/:logGroupId/logs/:logId/actions/changeLogGroup", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "logGroupId", "value": "", "type": "path", "description": "OCID of a log group to work with." }, { "name": "logId", "value": "", "type": "path", "description": "OCID of a log to work with." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a log into a different log group within the same tenancy. When provided, the If-Match is checked against the ETag values of the resource.\n" }, { "info": { "name": "Lists LogSavedSearches for this compartment.", "type": "http" }, "http": { "method": "GET", "url": "https://localhost:7875/20200531/logSavedSearches", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "Compartment OCID to list resources in. See compartmentIdInSubtree\n for nested compartments traversal.\n" }, { "name": "logSavedSearchId", "value": "", "type": "query", "description": "OCID of the LogSavedSearch.\n" }, { "name": "name", "value": "", "type": "query", "description": "Resource name." }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` or `opc-previous-page` response header from the previous \"List\" call.\nFor important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "limit", "value": "", "type": "query", "description": "When setting the page limit, specifies the maximum number of unfiltered records that can be fetched from the data store in one request. Filtering happens after the records are retrieved. Subsequent pages might include results that match the query criteria.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by (one column only). Default sort order is\nascending exception of `timeCreated` and `timeLastModified` columns (descending).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, whether 'asc' or 'desc'.\n" } ] }, "docs": "Lists LogSavedSearches for this compartment.\n" }, { "info": { "name": "Creates a new LogSavedSearch.", "type": "http" }, "http": { "method": "POST", "url": "https://localhost:7875/20200531/logSavedSearches", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new LogSavedSearch.\n" }, { "info": { "name": "Retrieves a LogSavedSearch.", "type": "http" }, "http": { "method": "GET", "url": "https://localhost:7875/20200531/logSavedSearches/:logSavedSearchId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "logSavedSearchId", "value": "", "type": "path", "description": "OCID of the logSavedSearch.\n" } ] }, "docs": "Retrieves a LogSavedSearch." }, { "info": { "name": "Updates a LogSavedSearch.", "type": "http" }, "http": { "method": "PUT", "url": "https://localhost:7875/20200531/logSavedSearches/:logSavedSearchId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "logSavedSearchId", "value": "", "type": "path", "description": "OCID of the logSavedSearch.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing LogSavedSearch.\n" }, { "info": { "name": "Deletes a LogSavedSearch.", "type": "http" }, "http": { "method": "DELETE", "url": "https://localhost:7875/20200531/logSavedSearches/:logSavedSearchId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "logSavedSearchId", "value": "", "type": "path", "description": "OCID of the logSavedSearch.\n" } ] }, "docs": "Deletes the specified LogSavedSearch." }, { "info": { "name": "Moves a LogSavedSearch into a different compartment. When provided, the If-Match is checked against the ETag values of the resource.", "type": "http" }, "http": { "method": "POST", "url": "https://localhost:7875/20200531/logSavedSearches/:logSavedSearchId/actions/changeCompartment", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "logSavedSearchId", "value": "", "type": "path", "description": "OCID of the logSavedSearch.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a saved search into a different compartment within the same tenancy. For information about moving\nresources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n" }, { "info": { "name": "Lists all unified agent configurations in the specified compartment.", "type": "http" }, "http": { "method": "GET", "url": "https://localhost:7875/20200531/unifiedAgentConfigurations", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "Compartment OCID to list resources in. See compartmentIdInSubtree\n for nested compartments traversal.\n" }, { "name": "logId", "value": "", "type": "query", "description": "Custom log OCID to list resources with the log as destination.\n" }, { "name": "isCompartmentIdInSubtree", "value": "", "type": "query", "description": "Specifies whether or not nested compartments should be traversed. Defaults to false." }, { "name": "groupId", "value": "", "type": "query", "description": "The OCID of a group or a dynamic group." }, { "name": "displayName", "value": "", "type": "query", "description": "Resource name." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "Lifecycle state of the log object" }, { "name": "limit", "value": "", "type": "query", "description": "When setting the page limit, specifies the maximum number of unfiltered records that can be fetched from the data store in one request. Filtering happens after the records are retrieved. Subsequent pages might include results that match the query criteria.\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` or `opc-previous-page` response header from the previous \"List\" call.\nFor important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by (one column only). Default sort order is\nascending exception of `timeCreated` and `timeLastModified` columns (descending).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, whether 'asc' or 'desc'.\n" } ] }, "docs": "Lists all unified agent configurations in the specified compartment." }, { "info": { "name": "Post unified agent configuration.", "type": "http" }, "http": { "method": "POST", "url": "https://localhost:7875/20200531/unifiedAgentConfigurations", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create unified agent configuration registration." }, { "info": { "name": "Get the unified agent configuration.", "type": "http" }, "http": { "method": "GET", "url": "https://localhost:7875/20200531/unifiedAgentConfigurations/:unifiedAgentConfigurationId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "unifiedAgentConfigurationId", "value": "", "type": "path", "description": "The OCID of the Unified Agent configuration." } ] }, "docs": "Get the unified agent configuration for an ID." }, { "info": { "name": "Updates an existing unified agent configuration.", "type": "http" }, "http": { "method": "PUT", "url": "https://localhost:7875/20200531/unifiedAgentConfigurations/:unifiedAgentConfigurationId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "unifiedAgentConfigurationId", "value": "", "type": "path", "description": "The OCID of the Unified Agent configuration." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing unified agent configuration. This call\n fails if the log group does not exist.\n" }, { "info": { "name": "Delete unified agent configuration.", "type": "http" }, "http": { "method": "DELETE", "url": "https://localhost:7875/20200531/unifiedAgentConfigurations/:unifiedAgentConfigurationId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "unifiedAgentConfigurationId", "value": "", "type": "path", "description": "The OCID of the Unified Agent configuration." } ] }, "docs": "Delete unified agent configuration." }, { "info": { "name": "Change the unified agent configuration compartment.", "type": "http" }, "http": { "method": "POST", "url": "https://localhost:7875/20200531/unifiedAgentConfigurations/:unifiedAgentConfigurationId/actions/changeCompartment", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "unifiedAgentConfigurationId", "value": "", "type": "path", "description": "The OCID of the Unified Agent configuration." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves the unified agent configuration into a different compartment within the same tenancy. When provided, the If-Match is checked against the ETag values of the resource.\nFor information about moving resources between compartments, see [Moving Resources Between Compartments](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n" }, { "info": { "name": "Lists all services that support logging.", "type": "http" }, "http": { "method": "GET", "url": "https://localhost:7875/20200531/v2/registry/services", "headers": [ { "name": "opc-request-id", "value": "" } ] }, "docs": "Lists all services that support logging." }, { "info": { "name": "List the work requests.", "type": "http" }, "http": { "method": "GET", "url": "https://localhost:7875/20200531/workRequests", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "Compartment OCID to list resources in. See compartmentIdInSubtree\n for nested compartments traversal.\n" }, { "name": "status", "value": "", "type": "query", "description": "Filter results by work request status." }, { "name": "id", "value": "", "type": "query", "description": "Filter results by [OCID](/iaas/Content/API/Concepts/identifiers.htm). Must be an OCID of the correct type for the resource type.\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` or `opc-previous-page` response header from the previous \"List\" call.\nFor important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "limit", "value": "", "type": "query", "description": "When setting the page limit, specifies the maximum number of unfiltered records that can be fetched from the data store in one request. Filtering happens after the records are retrieved. Subsequent pages might include results that match the query criteria.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, whether 'asc' or 'desc'.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order.\n" } ] }, "docs": "Lists the work requests in a compartment.\n" }, { "info": { "name": "Get the Work Request Details.", "type": "http" }, "http": { "method": "GET", "url": "https://localhost:7875/20200531/workRequests/:workRequestId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The asynchronous request ID." } ] }, "docs": "Gets the details of the work request with the given ID." }, { "info": { "name": "Cancel a work request.", "type": "http" }, "http": { "method": "DELETE", "url": "https://localhost:7875/20200531/workRequests/:workRequestId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The asynchronous request ID." } ] }, "docs": "Cancel a work request that has not started yet.\n" }, { "info": { "name": "Lists work request errors.", "type": "http" }, "http": { "method": "GET", "url": "https://localhost:7875/20200531/workRequests/:workRequestId/errors", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The asynchronous request ID." }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` or `opc-previous-page` response header from the previous \"List\" call.\nFor important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "limit", "value": "", "type": "query", "description": "When setting the page limit, specifies the maximum number of unfiltered records that can be fetched from the data store in one request. Filtering happens after the records are retrieved. Subsequent pages might include results that match the query criteria.\n" } ] }, "docs": "Return a list of errors for a given work request.\n" }, { "info": { "name": "Lists work request logs.", "type": "http" }, "http": { "method": "GET", "url": "https://localhost:7875/20200531/workRequests/:workRequestId/logs", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The asynchronous request ID." }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` or `opc-previous-page` response header from the previous \"List\" call.\nFor important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "limit", "value": "", "type": "query", "description": "When setting the page limit, specifies the maximum number of unfiltered records that can be fetched from the data store in one request. Filtering happens after the records are retrieved. Subsequent pages might include results that match the query criteria.\n" } ] }, "docs": "Return a list of logs for a given work request.\n" } ] } ], "bundled": true }