openapi: 3.2.0 info: description: 'Use the Logging Management API to create, read, list, update, move and delete log groups, log objects, log saved searches, and agent configurations. For more information, see [Logging Overview](/iaas/Content/Logging/Concepts/loggingoverview.htm). ' license: name: Oracle Corporation title: Logging Management API version: '20200531' x-provenance: method: harvested first_party: true publisher: Oracle source: https://docs.oracle.com/en-us/iaas/api/specs/699280e1cc4012b0c9035cbada18968fbd16c7e9a42d2630584de8c1d568772d.yaml harvested: '2026-08-04' note: Published by Oracle as the contract for the Logging Management 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/699280e1cc4012b0c9035cbada18968fbd16c7e9a42d2630584de8c1d568772d.yaml what: the harvested document for Logging Management API servers: - url: https://localhost:7875/20200531 tags: - name: loggingManagement paths: /logGroups: get: description: Lists all log groups for the specified compartment or tenancy. operationId: ListLogGroups parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The list is being retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-previous-page: description: 'For list pagination. When this header appears in the response, previous pages of results exist. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' 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: description: The list of log groups. items: $ref: '#/components/schemas/LogGroupSummary' type: array 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: Lists all log groups in the specified compartment. tags: - loggingManagement post: description: 'Create a new log group with a unique display name. This call fails if the log group is already created with the same displayName in the compartment. ' operationId: CreateLogGroup parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: $ref: '#/components/responses/202' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Creates new log group. tags: - loggingManagement x-related-resource: '#/definitions/LogGroup' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateLogGroupDetails' description: Details to create log group. required: true /logGroups/{logGroupId}: delete: description: Deletes the specified log group. operationId: DeleteLogGroup parameters: - $ref: '#/components/parameters/LogGroupIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: $ref: '#/components/responses/202' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Deletes the log group configuration with the log group OCID. tags: - loggingManagement x-related-resource: '#/definitions/LogGroup' get: description: Get the specified log group's information. operationId: GetLogGroup parameters: - $ref: '#/components/parameters/LogGroupIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Log group was retrieved. 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/LogGroup' 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: Gets the log group's configuration for the log group OCID. tags: - loggingManagement put: description: "Updates the existing log group with the associated configuration. This call\n fails if the log group does not exist.\n" operationId: UpdateLogGroup parameters: - $ref: '#/components/parameters/LogGroupIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: $ref: '#/components/responses/202' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Updates the existing log group configuration. tags: - loggingManagement x-related-resource: '#/definitions/LogGroup' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateLogGroupDetails' description: LogGroup config parameters to update. required: true /logGroups/{logGroupId}/actions/changeCompartment: post: description: 'Moves a log group into a different compartment within the same tenancy. When provided, the If-Match is checked against the resource ETag values. For information about moving resources between compartments, see [Moving Resources Between Compartments](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). ' operationId: ChangeLogGroupCompartment parameters: - $ref: '#/components/parameters/LogGroupIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: $ref: '#/components/responses/202' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Change the compartment to which this LogGroup belongs. tags: - loggingManagement x-example: "POST /20190909/logGroups/<id>/actions/changeCompartment\nHost: filestorage.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\": \"ocid1.compartment.oc1..examplea4ssrz2joq66nyomcvb4ydlbfmn2qg7wow5neo2ytcdznohhsyca\"\n}\n" x-related-resource: '#/definitions/LogGroup' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeLogGroupCompartmentDetails' description: Request to change the compartment of a given resource. required: true /logGroups/{logGroupId}/logs: get: description: Lists the specified log group's log objects. operationId: ListLogs parameters: - $ref: '#/components/parameters/LogGroupIdPathParam' - $ref: '#/components/parameters/LogTypeQueryParam' - $ref: '#/components/parameters/ServiceQueryParam' - $ref: '#/components/parameters/ResourceQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/LogLifecycleStateQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The list is being retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-previous-page: description: 'For list pagination. When this header appears in the response, previous pages of results exist. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' 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: description: Logs stored in the log group. items: $ref: '#/components/schemas/LogSummary' type: array 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: Lists all log objects for the specified log group OCID belonging to a compartment or tenancy. tags: - loggingManagement post: description: 'Creates a log within the specified log group. This call fails if a log group has already been created with the same displayName or (service, resource, category) triplet. ' operationId: CreateLog parameters: - $ref: '#/components/parameters/LogGroupIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: $ref: '#/components/responses/202' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Creates a new log object. tags: - loggingManagement x-related-resource: '#/definitions/Log' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateLogDetails' description: Log object configuration details. required: true /logGroups/{logGroupId}/logs/{logId}: delete: description: Deletes the log object in a log group. operationId: DeleteLog parameters: - $ref: '#/components/parameters/LogGroupIdPathParam' - $ref: '#/components/parameters/LogIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: $ref: '#/components/responses/202' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Deletes the log object in a log group. tags: - loggingManagement x-related-resource: '#/definitions/Log' get: description: 'Gets the log object configuration for the log object OCID. ' operationId: GetLog parameters: - $ref: '#/components/parameters/LogGroupIdPathParam' - $ref: '#/components/parameters/LogIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The log object was retrieved. 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/Log' 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: Gets the log object configuration for the log object OCID. tags: - loggingManagement put: description: "Updates the existing log object with the associated configuration. This call\n fails if the log object does not exist.\n" operationId: UpdateLog parameters: - $ref: '#/components/parameters/LogGroupIdPathParam' - $ref: '#/components/parameters/LogIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: $ref: '#/components/responses/202' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Updates the existing log object configuration. tags: - loggingManagement x-related-resource: '#/definitions/Log' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateLogDetails' description: Log config parameters to update. required: true /logGroups/{logGroupId}/logs/{logId}/actions/changeLogGroup: post: description: '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. ' operationId: ChangeLogLogGroup parameters: - $ref: '#/components/parameters/LogGroupIdPathParam' - $ref: '#/components/parameters/LogIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: $ref: '#/components/responses/202' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Change the LogGroup to which this log belongs to. tags: - loggingManagement x-related-resource: '#/definitions/Log' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeLogLogGroupDetails' description: Request to change the log group of a given log. required: true /logSavedSearches: get: description: 'Lists LogSavedSearches for this compartment. ' operationId: ListLogSavedSearches parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/LogSavedSearchIdQueryParam' - $ref: '#/components/parameters/NameQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Successfully retrieved list of LogSavedSearch summary entities. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-previous-page: description: 'For list pagination. When this header appears in the response, previous pages of results exist. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' 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/LogSavedSearchSummaryCollection' 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: Lists LogSavedSearches for this compartment. tags: - loggingManagement x-related-resource: '#/definitions/LogSavedSearch' post: description: 'Creates a new LogSavedSearch. ' operationId: CreateLogSavedSearch parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Successfully created LogSavedSearch. 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/LogSavedSearch' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Creates a new LogSavedSearch. tags: - loggingManagement x-related-resource: '#/definitions/LogSavedSearch' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateLogSavedSearchDetails' description: Specification of the saved search to create. required: true /logSavedSearches/{logSavedSearchId}: delete: description: Deletes the specified LogSavedSearch. operationId: DeleteLogSavedSearch parameters: - $ref: '#/components/parameters/LogSavedSearchIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: The LogSavedSearch was deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Deletes a LogSavedSearch. tags: - loggingManagement x-related-resource: '#/definitions/LogSavedSearch' get: description: Retrieves a LogSavedSearch. operationId: GetLogSavedSearch parameters: - $ref: '#/components/parameters/LogSavedSearchIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Successfully retrieved LogSavedSearch. 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/LogSavedSearch' 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: Retrieves a LogSavedSearch. tags: - loggingManagement put: description: 'Updates an existing LogSavedSearch. ' operationId: UpdateLogSavedSearch parameters: - $ref: '#/components/parameters/LogSavedSearchIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The saved search with updates applied. 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/LogSavedSearch' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Updates a LogSavedSearch. tags: - loggingManagement x-related-resource: '#/definitions/LogSavedSearch' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateLogSavedSearchDetails' description: Updates to the saved search. required: true /logSavedSearches/{logSavedSearchId}/actions/changeCompartment: post: description: 'Moves a saved search into a different compartment within the same tenancy. For information about moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). ' operationId: ChangeLogSavedSearchCompartment parameters: - $ref: '#/components/parameters/LogSavedSearchIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: The provided SavedSearch compartment changed successfully. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Moves a LogSavedSearch into a different compartment. When provided, the If-Match is checked against the ETag values of the resource. tags: - loggingManagement x-related-resource: '#/definitions/LogSavedSearch' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeLogSavedSearchCompartmentDetails' description: Contains details indicating which compartment the resource should move to. required: true /unifiedAgentConfigurations: get: description: Lists all unified agent configurations in the specified compartment. operationId: ListUnifiedAgentConfigurations parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/LogIdQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/UnifiedAgentConfigGroupIdQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/LogLifecycleStateQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The list is being retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-previous-page: description: 'For list pagination. When this header appears in the response, previous pages of results exist. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' 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/UnifiedAgentConfigurationCollection' 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: Lists all unified agent configurations in the specified compartment. tags: - loggingManagement x-related-resource: '#/definitions/UnifiedAgentConfiguration' post: description: Create unified agent configuration registration. operationId: CreateUnifiedAgentConfiguration parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: $ref: '#/components/responses/202' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Post unified agent configuration. tags: - loggingManagement x-related-resource: '#/definitions/UnifiedAgentConfiguration' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateUnifiedAgentConfigurationDetails' description: Unified agent configuration creation object. required: true /unifiedAgentConfigurations/{unifiedAgentConfigurationId}: delete: description: Delete unified agent configuration. operationId: DeleteUnifiedAgentConfiguration parameters: - $ref: '#/components/parameters/UnifiedAgentConfigurationIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: $ref: '#/components/responses/202' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Delete unified agent configuration. tags: - loggingManagement x-related-resource: '#/definitions/UnifiedAgentConfiguration' get: description: Get the unified agent configuration for an ID. operationId: GetUnifiedAgentConfiguration parameters: - $ref: '#/components/parameters/UnifiedAgentConfigurationIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Unified agent configuration. 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/UnifiedAgentConfiguration' 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 the unified agent configuration. tags: - loggingManagement put: description: "Update an existing unified agent configuration. This call\n fails if the log group does not exist.\n" operationId: UpdateUnifiedAgentConfiguration parameters: - $ref: '#/components/parameters/UnifiedAgentConfigurationIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: $ref: '#/components/responses/202' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Updates an existing unified agent configuration. tags: - loggingManagement x-related-resource: '#/definitions/UnifiedAgentConfiguration' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateUnifiedAgentConfigurationDetails' description: 'Unified agent configuration to update. Empty group associations list doesn''t modify the list, null value for group association clears all the previous associations. ' required: true /unifiedAgentConfigurations/{unifiedAgentConfigurationId}/actions/changeCompartment: post: description: '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. For information about moving resources between compartments, see [Moving Resources Between Compartments](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). ' operationId: ChangeUnifiedAgentConfigurationCompartment parameters: - $ref: '#/components/parameters/UnifiedAgentConfigurationIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: $ref: '#/components/responses/202' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Change the unified agent configuration compartment. tags: - loggingManagement x-related-resource: '#/definitions/UnifiedAgentConfiguration' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeUnifiedAgentConfigurationCompartmentDetails' description: Request to change the compartment of a given resource. required: true /v2/registry/services: get: description: Lists all services that support logging. operationId: ListServices parameters: - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: success headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-previous-page: description: 'For list pagination. When this header appears in the response, previous pages of results exist. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' 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: description: The list of services. items: $ref: '#/components/schemas/ServiceSummary' type: array 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: Lists all services that support logging. tags: - loggingManagement /workRequests: get: description: 'Lists the work requests in a compartment. ' operationId: ListWorkRequests parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/WorkRequestStatusFilterQueryParam' - $ref: '#/components/parameters/OcidQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/WorkRequestSortByQueryParam' responses: 200: description: List of work requests headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-previous-page: description: 'For list pagination. When this header appears in the response, previous pages of results exist. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' 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: description: The list of work requests. items: $ref: '#/components/schemas/WorkRequestSummary' type: array 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: List the work requests. tags: - loggingManagement x-related-resource: '#/definitions/WorkRequest' /workRequests/{workRequestId}: delete: description: 'Cancel a work request that has not started yet. ' operationId: DeleteWorkRequest parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: $ref: '#/components/responses/202' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Cancel a work request. tags: - loggingManagement x-related-resource: '#/definitions/WorkRequest' 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: 200: description: The work request details. 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: integer content: application/json: schema: $ref: '#/components/schemas/WorkRequest' 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 the Work Request Details. tags: - loggingManagement x-related-resource: '#/definitions/WorkRequest' /workRequests/{workRequestId}/errors: get: description: 'Return a 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: 200: description: List of work request errors. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' 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 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: Lists work request errors. tags: - loggingManagement x-related-resource: '#/definitions/WorkRequestError' /workRequests/{workRequestId}/logs: get: description: 'Return a 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: 200: description: List of work request logs. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' 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/WorkRequestLog' type: array 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: Lists work request logs. tags: - loggingManagement x-related-resource: '#/definitions/WorkRequestLog' components: schemas: UpdateUnifiedAgentConfigurationDetails: description: Update Object for the Unified Agent configuration. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: Description for this resource. maxLength: 400 minLength: 1 type: string displayName: description: 'The user-friendly display name. This must be unique within the enclosing resource, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object groupAssociation: $ref: '#/components/schemas/GroupAssociationDetails' isEnabled: default: true description: Whether or not this resource is currently enabled. type: boolean serviceConfiguration: $ref: '#/components/schemas/UnifiedAgentServiceConfigurationDetails' required: - displayName - isEnabled - serviceConfiguration type: object LogSavedSearchSummaryCollection: description: 'A collection of LogSavedSearchSummary items. ' properties: items: description: The Saved Seach Summaries items: $ref: '#/components/schemas/LogSavedSearchSummary' type: array required: - items type: object Log: description: Represents a log object. properties: compartmentId: description: The OCID of the compartment that the resource belongs to. maxLength: 255 minLength: 1 type: string configuration: $ref: '#/components/schemas/Configuration' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'The user-friendly display name. This must be unique within the enclosing resource, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the resource. maxLength: 255 minLength: 1 type: string isEnabled: default: true description: Whether or not this resource is currently enabled. type: boolean lifecycleState: description: The pipeline state. enum: - CREATING - ACTIVE - UPDATING - INACTIVE - DELETING - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LogLifecycleState' logGroupId: description: Log group OCID. maxLength: 255 minLength: 1 type: string logType: default: CUSTOM description: The logType that the log object is for, whether custom or service. enum: - CUSTOM - SERVICE type: string retentionDuration: description: Log retention duration in 30-day increments (30, 60, 90 and so on until 180). format: int32 type: integer tenancyId: description: The OCID of the tenancy. maxLength: 255 minLength: 1 type: string timeCreated: description: Time the resource was created. format: date-time readOnly: true type: string timeLastModified: description: Time the resource was last modified. format: date-time readOnly: true type: string required: - id - logGroupId - displayName - logType - lifecycleState type: object Configuration: description: Log object configuration. properties: archiving: $ref: '#/components/schemas/Archiving' compartmentId: description: The OCID of the compartment that the resource belongs to. maxLength: 255 minLength: 1 type: string source: $ref: '#/components/schemas/Source' required: - source type: object UpdateConfigurationDetails: description: The updatable configuration properties. properties: archiving: $ref: '#/components/schemas/Archiving' source: $ref: '#/components/schemas/SourceUpdateDetails' required: - source type: object ChangeLogSavedSearchCompartmentDetails: description: Contains details indicating which compartment the resource should move to. properties: compartmentId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment into which the resource should be moved. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object Error: description: An error has 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 type: object CreateLogDetails: description: The details to create a log object. properties: configuration: $ref: '#/components/schemas/Configuration' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'The user-friendly display name. This must be unique within the enclosing resource, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object isEnabled: default: true description: Whether or not this resource is currently enabled. type: boolean logType: default: CUSTOM description: The logType that the log object is for, whether custom or service. enum: - CUSTOM - SERVICE type: string retentionDuration: description: Log retention duration in 30-day increments (30, 60, 90 and so on until 180). format: int32 type: integer required: - displayName - logType type: object UnifiedAgentConfigurationSummary: description: Unified Agent configuration summary object returned by the list API. properties: compartmentId: description: The OCID of the compartment that the resource belongs to. maxLength: 255 minLength: 1 type: string configurationState: description: State of unified agent service configuration. enum: - VALID - INVALID type: string x-obmcs-top-level-enum: '#/definitions/UnifiedAgentServiceConfigurationStates' configurationType: description: Type of Unified Agent service configuration. enum: - LOGGING type: string x-obmcs-top-level-enum: '#/definitions/UnifiedAgentServiceConfigurationTypes' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: Description for this resource. maxLength: 400 minLength: 1 type: string displayName: description: 'The user-friendly display name. This must be unique within the enclosing resource, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the resource. maxLength: 255 minLength: 1 type: string isEnabled: default: true description: Whether or not this resource is currently enabled. type: boolean lifecycleState: description: The pipeline state. enum: - CREATING - ACTIVE - UPDATING - INACTIVE - DELETING - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LogLifecycleState' timeCreated: description: Time the resource was created. format: date-time readOnly: true type: string timeLastModified: description: Time the resource was last modified. format: date-time readOnly: true type: string required: - id - compartmentId - displayName - configurationType - lifecycleState - isEnabled - configurationState type: object UnifiedAgentConfigurationCollection: description: Results of a UnifiedAgentConfiguration search. Contains UnifiedAgentConfigurationSummary items. properties: items: description: List of UnifiedAgentConfigurationSummary. items: $ref: '#/components/schemas/UnifiedAgentConfigurationSummary' type: array required: - items type: object LogSavedSearch: description: 'A LogSavedSearch that can be used to save and share a given search result. ' properties: compartmentId: description: The OCID of the compartment that the resource belongs to. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: Description for this resource. maxLength: 400 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the resource. maxLength: 255 minLength: 1 type: string lifecycleState: description: 'The state of the LogSavedSearch ' enum: - CREATING - ACTIVE - UPDATING - INACTIVE - DELETING - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LogSavedSearchLifecycleState' name: description: 'The user-friendly display name. This must be unique within the enclosing resource, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string query: description: 'The search query that is saved. ' maxLength: 4096 minLength: 1 type: string timeCreated: description: Time the resource was created. format: date-time readOnly: true type: string timeLastModified: description: Time the resource was last modified. format: date-time readOnly: true type: string required: - id - compartmentId - name - query type: object UpdateLogDetails: description: Update log object properties. properties: configuration: $ref: '#/components/schemas/UpdateConfigurationDetails' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'The user-friendly display name. This must be unique within the enclosing resource, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object isEnabled: default: true description: Whether or not this resource is currently enabled. type: boolean retentionDuration: description: Log retention duration in 30-day increments (30, 60, 90 and so on until 180). format: int32 type: integer type: object UpdateLogSavedSearchDetails: description: 'The update details to update a LogSavedSearch. ' properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: Description for this resource. maxLength: 400 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object name: description: 'The user-friendly display name. This must be unique within the enclosing resource, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string query: description: 'The search query that is saved. ' maxLength: 4096 minLength: 1 type: string type: object ChangeLogGroupCompartmentDetails: description: Contains details indicating which compartment the resource should move to. properties: compartmentId: description: The compartment into which the resource should be moved. maxLength: 255 minLength: 1 type: string type: object ServiceSummary: description: Summary of services that are integrated with public logging. properties: endpoint: description: Service endpoint. maxLength: 255 minLength: 1 type: string id: description: Service ID. maxLength: 64 minLength: 1 type: string name: description: User-friendly service name. maxLength: 64 minLength: 1 type: string namespace: description: Apollo project namespace, if any. maxLength: 64 minLength: 1 type: string resourceTypes: description: Type of resource that a service provides. items: $ref: '#/components/schemas/ResourceType' type: array servicePrincipalName: description: Service ID as set in Service Principal. maxLength: 64 minLength: 1 type: string tenantId: description: Tenant OCID. maxLength: 255 minLength: 1 type: string required: - tenantId - servicePrincipalName - endpoint - name - resourceTypes type: object UpdateLogGroupDetails: description: The details to update a log group. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: Description for this resource. maxLength: 400 minLength: 1 type: string displayName: description: 'The user-friendly display name. This must be unique within the enclosing resource, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object type: object Parameter: description: Parameters that a resource category supports. properties: name: description: Parameter name. maxLength: 64 minLength: 1 type: string pattern: description: Java regex pattern to validate a parameter value. maxLength: 255 minLength: 1 type: string rqsType: description: Parameter rqsType if applicable. maxLength: 255 minLength: 1 type: string type: description: Parameter type. enum: - integer - string - boolean - ENUM_STRING - RQS_FILTER type: string required: - name - type type: object WorkRequestResource: description: A resource created or operated on by a work request. 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 resource identifier the work request affects. type: string required: - actionType - entityType - identifier Archiving: description: Log archiving configuration. properties: isEnabled: default: false description: True if archiving enabled. This field is now deprecated, you should use Service Connector Hub to enable archiving. type: boolean type: object SourceUpdateDetails: description: Source updated configuration. properties: parameters: additionalProperties: type: string description: Log category parameters are stored here. The resource for a service log can't be updated. type: object type: object WorkRequestLog: 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 log message was written. An RFC3339-formatted date and time string. format: date-time type: string required: - message - timestamp ResourceType: description: Type of resource that a service provides. properties: categories: description: Categories for resources. items: $ref: '#/components/schemas/Category' type: array name: description: Resource type name. maxLength: 255 minLength: 1 type: string type: object GroupAssociationDetails: description: Groups using the configuration. properties: groupList: description: list of group/dynamic group ids associated with this configuration. items: maxLength: 255 minLength: 1 type: string type: array type: object ChangeUnifiedAgentConfigurationCompartmentDetails: description: Contains details indicating which compartment the resource should move to. properties: compartmentId: description: The OCID the compartment into which the resource should be moved. maxLength: 255 minLength: 1 type: string type: object UnifiedAgentServiceConfigurationDetails: description: Top level Unified Agent service configuration object. discriminator: propertyName: configurationType properties: configurationType: description: Type of Unified Agent service configuration. enum: - LOGGING type: string x-obmcs-top-level-enum: '#/definitions/UnifiedAgentServiceConfigurationTypes' required: - configurationType type: object WorkRequestSummary: description: A summary of a work request. properties: compartmentId: description: The OCID of the work request's compartment. example: ocid1.compartment.oc1..exampleuniqueID type: string id: description: The OCID of the work request. example: ocid1.publicloggingworkrequest.oc1.iad.exampleuniqueID type: string operationType: description: The type of work the work request is doing. enum: - CREATE_LOG - UPDATE_LOG - DELETE_LOG - MOVE_LOG - CREATE_LOG_GROUP - UPDATE_LOG_GROUP - DELETE_LOG_GROUP - MOVE_LOG_GROUP - CREATE_CONFIGURATION - UPDATE_CONFIGURATION - DELETE_CONFIGURATION - MOVE_CONFIGURATION example: LOG_CREATE type: string x-obmcs-top-level-enum: '#/definitions/OperationTypes' percentComplete: description: Percentage of the request completed. example: 100.0 format: float type: number resources: description: The resources this work request affects. items: $ref: '#/components/schemas/WorkRequestResource' type: array status: description: The current status of the work request. enum: - ACCEPTED - IN_PROGRESS - FAILED - SUCCEEDED - CANCELLING - CANCELED example: SUCCEEDED type: string x-obmcs-top-level-enum: '#/definitions/OperationStatus' timeAccepted: description: The time the work request was accepted. example: '2017-07-21T16:11:29Z' format: date-time type: string timeFinished: description: The time the work request was finished. example: '2017-07-21T16:11:29Z' format: date-time type: string timeStarted: description: The time the work request was started. example: '2017-07-21T16:11:29Z' format: date-time type: string type: object UnifiedAgentConfiguration: description: Top Unified Agent configuration object. properties: compartmentId: description: The OCID of the compartment that the resource belongs to. maxLength: 255 minLength: 1 type: string configurationState: description: State of unified agent service configuration. enum: - VALID - INVALID type: string x-obmcs-top-level-enum: '#/definitions/UnifiedAgentServiceConfigurationStates' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: Description for this resource. maxLength: 400 minLength: 1 type: string displayName: description: 'The user-friendly display name. This must be unique within the enclosing resource, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object groupAssociation: $ref: '#/components/schemas/GroupAssociationDetails' id: description: The OCID of the resource. maxLength: 255 minLength: 1 type: string isEnabled: default: true description: Whether or not this resource is currently enabled. type: boolean lifecycleState: description: The pipeline state. enum: - CREATING - ACTIVE - UPDATING - INACTIVE - DELETING - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LogLifecycleState' serviceConfiguration: $ref: '#/components/schemas/UnifiedAgentServiceConfigurationDetails' timeCreated: description: Time the resource was created. format: date-time readOnly: true type: string timeLastModified: description: Time the resource was last modified. format: date-time readOnly: true type: string required: - serviceConfiguration - id - compartmentId - displayName - lifecycleState - groupAssociation - isEnabled - configurationState type: object Category: description: Categories for resources. properties: displayName: description: Category display name. Avoid entering confidential information. maxLength: 64 minLength: 0 type: string name: description: Category name. maxLength: 64 minLength: 1 type: string parameters: description: Parameters the category supports. items: $ref: '#/components/schemas/Parameter' type: array type: object Source: description: The source the log object comes from. discriminator: propertyName: sourceType properties: sourceType: description: 'The log source. * **OCISERVICE:** Oracle Service. ' enum: - OCISERVICE type: string required: - sourceType type: object WorkRequestError: description: An error encountered while executing a work request. properties: code: description: 'A machine-usable code for the error that occured. Error codes are listed at https://docs.us-phoenix-1.oraclecloud.com/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 occured. An RFC3339-formatted date and time string. format: date-time type: string required: - code - message - timestamp CreateUnifiedAgentConfigurationDetails: description: Unified Agent configuration creation object. properties: compartmentId: description: The OCID of the compartment that the resource belongs to. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: Description for this resource. maxLength: 400 minLength: 1 type: string displayName: description: 'The user-friendly display name. This must be unique within the enclosing resource, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object groupAssociation: $ref: '#/components/schemas/GroupAssociationDetails' isEnabled: default: true description: Whether or not this resource is currently enabled. type: boolean serviceConfiguration: $ref: '#/components/schemas/UnifiedAgentServiceConfigurationDetails' required: - isEnabled - compartmentId - serviceConfiguration type: object CreateLogGroupDetails: description: The details to create a log group. properties: compartmentId: description: The OCID of the compartment that the resource belongs to. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: Description for this resource. maxLength: 400 minLength: 1 type: string displayName: description: 'The user-friendly display name. This must be unique within the enclosing resource, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object required: - compartmentId - displayName type: object ChangeLogLogGroupDetails: description: Contains details indicating which log group the log should move to. properties: targetLogGroupId: description: Log group OCID. maxLength: 255 minLength: 1 type: string type: object LogSummary: description: Log object configuration summary. properties: compartmentId: description: The OCID of the compartment that the resource belongs to. maxLength: 255 minLength: 1 type: string configuration: $ref: '#/components/schemas/Configuration' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'The user-friendly display name. This must be unique within the enclosing resource, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the resource. maxLength: 255 minLength: 1 type: string isEnabled: default: true description: Whether or not this resource is currently enabled. type: boolean lifecycleState: description: The pipeline state. enum: - CREATING - ACTIVE - UPDATING - INACTIVE - DELETING - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LogLifecycleState' logGroupId: description: Log group OCID. maxLength: 255 minLength: 1 type: string logType: default: CUSTOM description: The logType that the log object is for, whether custom or service. enum: - CUSTOM - SERVICE type: string retentionDuration: description: Log retention duration in 30-day increments (30, 60, 90 and so on until 180). format: int32 type: integer timeCreated: description: Time the resource was created. format: date-time readOnly: true type: string timeLastModified: description: Time the resource was last modified. format: date-time readOnly: true type: string required: - id - logGroupId - displayName - logType - lifecycleState type: object LogSavedSearchSummary: description: 'A summary of a LogSavedSearch that can be used to save and share a given search result. ' properties: compartmentId: description: The OCID of the compartment that the resource belongs to. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: Description for this resource. maxLength: 400 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the resource. maxLength: 255 minLength: 1 type: string lifecycleState: description: 'The state of the LogSavedSearch ' enum: - CREATING - ACTIVE - UPDATING - INACTIVE - DELETING - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LogSavedSearchLifecycleState' name: description: 'The user-friendly display name. This must be unique within the enclosing resource, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string query: description: 'The search query that is saved. ' maxLength: 4096 minLength: 1 type: string timeCreated: description: Time the resource was created. format: date-time readOnly: true type: string timeLastModified: description: Time the resource was last modified. format: date-time readOnly: true type: string required: - id - compartmentId - name type: object LogGroup: description: Represents a LogGroup object. properties: compartmentId: description: The OCID of the compartment that the resource belongs to. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: Description for this resource. maxLength: 400 minLength: 1 type: string displayName: description: 'The user-friendly display name. This must be unique within the enclosing resource, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the resource. maxLength: 255 minLength: 1 type: string lifecycleState: description: The log group object state. enum: - CREATING - ACTIVE - UPDATING - INACTIVE - DELETING - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LogGroupLifecycleState' timeCreated: description: Time the resource was created. format: date-time readOnly: true type: string timeLastModified: description: Time the resource was last modified. format: date-time readOnly: true type: string required: - id - compartmentId - displayName type: object CreateLogSavedSearchDetails: description: 'A LogSavedSearch that can be used to save and share a given search result. ' properties: compartmentId: description: The OCID of the compartment that the resource belongs to. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: Description for this resource. maxLength: 400 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object name: description: 'The user-friendly display name. This must be unique within the enclosing resource, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string query: description: 'The search query that is saved. ' maxLength: 4096 minLength: 1 type: string required: - compartmentId - name - query type: object WorkRequest: description: A work request. properties: compartmentId: description: The work request's compartment OCID. example: ocid1.compartment.oc1..exampleuniqueID type: string id: description: The work request OCID. example: ocid1.publicloggingworkrequest.oc1.iad.exampleuniqueID type: string operationType: description: The type of work the work request is doing. enum: - CREATE_LOG - UPDATE_LOG - DELETE_LOG - MOVE_LOG - CREATE_LOG_GROUP - UPDATE_LOG_GROUP - DELETE_LOG_GROUP - MOVE_LOG_GROUP - CREATE_CONFIGURATION - UPDATE_CONFIGURATION - DELETE_CONFIGURATION - MOVE_CONFIGURATION example: LOG_CREATE type: string x-obmcs-top-level-enum: '#/definitions/OperationTypes' percentComplete: description: Percentage of the request completed. example: 100.0 format: float type: number resources: description: The resources this work request affects. items: $ref: '#/components/schemas/WorkRequestResource' type: array status: description: The current status of the work request. enum: - ACCEPTED - IN_PROGRESS - FAILED - SUCCEEDED - CANCELLING - CANCELED example: SUCCEEDED type: string x-obmcs-top-level-enum: '#/definitions/OperationStatus' timeAccepted: description: The time the work request was accepted. example: '2017-07-21T16:11:29Z' format: date-time type: string timeFinished: description: The time the work request was finished. example: '2017-07-21T16:11:29Z' format: date-time type: string timeStarted: description: The time the work request was started. example: '2017-07-21T16:11:29Z' format: date-time type: string required: - operationType - status - id - compartmentId - percentComplete - resources - timeAccepted type: object x-example: "{\n \"operationType\":\"CREATE_LOG\",\n \"status\":\"SUCCEEDED\",\n \"id\":\"ocid1.publicloggingworkrequest.oc1.phx.exampleunique_ID\",\n \"compartmentId\":\"ocid1.tenancy.oc1..exampleuniqueID\",\n \"percentComplete\":100.0,\n \"reources\":[],\n \"timeAccepted\":\"2019-05-07T00:50:03.248Z\",\n \"timeStarted\":\"2019-05-07T00:50:03.374Z\",\n \"timeFinished\":\"2019-05-07T00:52:05.704Z\"\n}\n" LogGroupSummary: description: Log group configuration summary. properties: compartmentId: description: The OCID of the compartment that the resource belongs to. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: Description for this resource. maxLength: 400 minLength: 1 type: string displayName: description: 'The user-friendly display name. This must be unique within the enclosing resource, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the resource. maxLength: 255 minLength: 1 type: string lifecycleState: description: The log group object state. enum: - CREATING - ACTIVE - UPDATING - INACTIVE - DELETING - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LogGroupLifecycleState' timeCreated: description: Time the resource was created. format: date-time readOnly: true type: string timeLastModified: description: Time the resource was last modified. format: date-time readOnly: true type: string required: - id - compartmentId - displayName type: object parameters: LogIdPathParam: description: OCID of a log to work with. in: path name: logId required: true schema: type: string maxLength: 255 minLength: 1 ResourceQueryParam: description: Log object resource, which is a field of LogSummary.Configuration.Source. in: query name: sourceResource required: false x-default-description: 'null' schema: type: string SortByQueryParam: description: 'The field to sort by (one column only). Default sort order is ascending exception of `timeCreated` and `timeLastModified` columns (descending). ' in: query name: sortBy required: false x-default-description: 'null' schema: type: string enum: - timeCreated - displayName PaginationTokenQueryParam: description: 'For list pagination. The value of the `opc-next-page` or `opc-previous-page` response header from the previous "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' in: query name: page x-default-description: 'null' schema: type: string maxLength: 512 minLength: 1 NameQueryParam: description: Resource name. in: query name: name required: false x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 OcidQueryParam: description: 'Filter results by [OCID](/iaas/Content/API/Concepts/identifiers.htm). Must be an OCID of the correct type for the resource type. ' in: query name: id required: false x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 IfMatchHeader: description: 'For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource''s current etag value. ' in: header name: if-match required: false schema: type: string CompartmentIdQueryParam: description: "Compartment OCID to list resources in. See compartmentIdInSubtree\n for nested compartments traversal.\n" in: query name: compartmentId required: true schema: type: string maxLength: 255 minLength: 1 LogTypeQueryParam: description: The logType that the log object is for, whether custom or service. in: query name: logType required: false x-default-description: 'null' schema: type: string enum: - CUSTOM - SERVICE LogIdQueryParam: description: 'Custom log OCID to list resources with the log as destination. ' in: query name: logId required: false schema: type: string maxLength: 255 minLength: 1 LogSavedSearchIdPathParam: description: 'OCID of the logSavedSearch. ' in: path name: logSavedSearchId required: true schema: type: string maxLength: 255 minLength: 1 PaginationLimitQueryParam: 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. ' in: query name: limit schema: type: integer default: 100 maximum: 1000 minimum: 1 ServiceQueryParam: description: Service that created the log object, which is a field of LogSummary.Configuration.Source. in: query name: sourceService required: false x-default-description: 'null' schema: type: string WorkRequestIdPathParam: description: The asynchronous request ID. in: path name: workRequestId required: true schema: type: string SortOrderQueryParam: description: 'The sort order to use, whether ''asc'' or ''desc''. ' in: query name: sortOrder required: false x-default-description: 'null' schema: type: string enum: - ASC - DESC WorkRequestStatusFilterQueryParam: description: Filter results by work request status. in: query name: status required: false x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/OperationStatus' schema: type: string enum: - ACCEPTED - IN_PROGRESS - FAILED - SUCCEEDED - CANCELLING - CANCELED UnifiedAgentConfigurationIdPathParam: description: The OCID of the Unified Agent configuration. in: path name: unifiedAgentConfigurationId required: true schema: type: string maxLength: 255 minLength: 1 LogSavedSearchIdQueryParam: description: 'OCID of the LogSavedSearch. ' in: query name: logSavedSearchId required: false x-default-description: 'null' schema: type: string default: null maxLength: 255 minLength: 1 LogGroupIdPathParam: description: OCID of a log group to work with. in: path name: logGroupId required: true schema: type: string maxLength: 255 minLength: 1 RetryTokenHeader: description: 'A token that uniquely identifies a request so it can be retried in case of a timeout or server error, without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). ' in: header name: opc-retry-token required: false schema: type: string maxLength: 64 minLength: 1 LogLifecycleStateQueryParam: description: Lifecycle state of the log object in: query name: lifecycleState x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/LogLifecycleState' schema: type: string enum: - CREATING - ACTIVE - UPDATING - INACTIVE - DELETING - FAILED UnifiedAgentConfigGroupIdQueryParam: description: The OCID of a group or a dynamic group. in: query name: groupId required: false x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 DisplayNameQueryParam: description: Resource name. in: query name: displayName required: false x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 WorkRequestSortByQueryParam: 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. ' in: query name: sortBy required: false x-default-description: 'null' schema: type: string enum: - operationType - status - timeAccepted RequestIdHeader: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' in: header name: opc-request-id required: false schema: type: string CompartmentIdInSubtreeQueryParam: description: Specifies whether or not nested compartments should be traversed. Defaults to false. in: query name: isCompartmentIdInSubtree schema: type: boolean default: false responses: DefaultError: description: An error has occurred. 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-headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' type: string opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' type: string opc-previous-page: description: 'For list pagination. When this header appears in the response, previous pages of results exist. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' 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: 'The OCID of the work request. ' type: string retry-after: description: A decimal number representing the number of seconds the client should wait before polling this endpoint again. format: integer type: number x-properties: compartmentId: description: The OCID of the compartment that the resource belongs to. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: Description for this resource. maxLength: 400 minLength: 1 type: string displayName: description: 'The user-friendly display name. This must be unique within the enclosing resource, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the resource. maxLength: 255 minLength: 1 type: string isEnabled: default: true description: Whether or not this resource is currently enabled. type: boolean logSavedSearchQuery: description: 'The search query that is saved. ' maxLength: 4096 minLength: 1 type: string name: description: 'The unique name of the resource and is not changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string retentionDuration: description: Log retention duration in 30-day increments (30, 60, 90 and so on until 180). format: int32 type: integer 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 tenancyId: description: The OCID of the tenancy. maxLength: 255 minLength: 1 type: string timeCreated: description: Time the resource was created. format: date-time readOnly: true type: string timeLastModified: description: Time the resource was last modified. format: date-time readOnly: true type: string x-oracle-package: com.oracle.bmc.loggingManagement