How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Oracle Log Analytics API

The logAnalytics API from Oracle — 169 operation(s) for loganalytics.

Oracle Log Analytics API is one of 378 APIs that Oracle publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Log Analytics. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 200 operations across 169 paths, and defines 302 schemas. It is described by OpenAPI 3.2.0, at version 20200601.

Requests are made against a single base URL, https://127.0.0.1/20200601.

200 operations 169 paths 302 schemas 16 DELETE95 GET79 POST10 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
20200601
Base URL
https://{host}:{port}/ords/
Resource Areas
1

Paths & Operations 200

Across 169 paths, the API surfaces 200 operations — 16 DELETE, 95 GET, 79 POST, 10 PUT. Each is listed below with its method, path, parameters, and response codes.

logAnalytics 200
GET
/namespaces
Given a tenancy OCID, this API returns the namespace of the tenancy if it is valid and subscribed to the region.
ListNamespaces 3 params → 200400401404429500default
GET
/namespaces/{namespaceName}
This API gets the namespace details of a tenancy already onboarded in Log Analytics Application
GetNamespace 2 params → 200400401404429500default
POST
/namespaces/{namespaceName}/actions/offboard
Off-boards a tenant from Log Analytics
OffboardNamespace 3 params → 202400401404412429500default
POST
/namespaces/{namespaceName}/actions/onboard
On-boards a tenant to Log Analytics
OnboardNamespace 3 params → 202400401404409429500default
POST
/namespaces/{namespaceName}/actions/otlp/v1/logs
API to ingest log data in OTLP JSON-encoded Protobuf format
UploadOtlpLogs 7 params body → 200400401404409429500default
POST
/namespaces/{namespaceName}/actions/setUnprocessedDataBucket
Configure Unprocessed Data Bucket
SetUnprocessedDataBucket 4 params → 200400401404429500default
POST
/namespaces/{namespaceName}/actions/uploadDiscoveryData
Upload Log Analytics Discovery Data
UploadDiscoveryData 8 params body → 200400401404409429500default
POST
/namespaces/{namespaceName}/actions/uploadLogEventsFile
Create Log Analytics Log Events Upload
UploadLogEventsFile 8 params body → 200400401404409429500default
POST
/namespaces/{namespaceName}/actions/uploadLogFile
Create Log Analytics Upload
UploadLogFile 16 params body → 200400401404409429500default
GET
/namespaces/{namespaceName}/associatedEntities
list of entities with associations
ListAssociatedEntities 11 params → 200400401404429500default
GET
/namespaces/{namespaceName}/associationSummary
association summary
GetAssociationSummary 3 params → 200400401404429500default
POST
/namespaces/{namespaceName}/associations/actions/delete
delete associations
DeleteAssociations 3 params body → 202400401404412429500default
POST
/namespaces/{namespaceName}/associations/actions/upsert
create or update associations for a source
UpsertAssociations 4 params body → 202400401404409429500default
POST
/namespaces/{namespaceName}/associations/actions/validateParameters
association parameter validation
ValidateAssociationParameters 7 params body → 200400401404409429500default
GET
/namespaces/{namespaceName}/categories
category list
ListCategories 9 params → 200400401404429500default
POST
/namespaces/{namespaceName}/categories/actions/removeResourceCategories
delete resource categories
RemoveResourceCategories 2 params body → 204400401404412429500default
POST
/namespaces/{namespaceName}/categories/actions/updateResourceCategories
update resource categories
UpdateResourceCategories 2 params body → 204400401404409429500default
GET
/namespaces/{namespaceName}/categories/resourceCategories
category resource list
ListResourceCategories 10 params → 200400401404429500default
GET
/namespaces/{namespaceName}/categories/{categoryName}
get category with specified name
GetCategory 3 params → 200400401404429500default
GET
/namespaces/{namespaceName}/configWorkRequests
association summary by source
ListConfigWorkRequests 6 params → 200400401404429500default
GET
/namespaces/{namespaceName}/configWorkRequests/{workRequestId}
association summary by source
GetConfigWorkRequest 3 params → 200400401404429500default
POST
/namespaces/{namespaceName}/contents/actions/exportCustomContent
export
ExportCustomContent 3 params body → 200400401404429500default
POST
/namespaces/{namespaceName}/contents/actions/importCustomContent
register custom content
ImportCustomContent 4 params body → 200400401404429500default
GET
/namespaces/{namespaceName}/effectiveProperties
Get a list of effective properties for the specified resource.
ListEffectiveProperties 13 params → 200400401404429500default
GET
/namespaces/{namespaceName}/entityAssociations
entity associations summary
ListEntitySourceAssociations 13 params → 200400401404429500default
GET
/namespaces/{namespaceName}/fieldSummary
get field summary
GetFieldsSummary 3 params → 200400401404429500default
GET
/namespaces/{namespaceName}/fields
get all common field with specified display name and description
ListFields 14 params → 200400401404429500default
POST
/namespaces/{namespaceName}/fields/actions/upsert
Defines or updates a field.
UpsertField 4 params body → 200400401404409412429500
DELETE
/namespaces/{namespaceName}/fields/{fieldName}
delete field with specified name
DeleteField 5 params → 204400401404412429500default
GET
/namespaces/{namespaceName}/fields/{fieldName}
get common field with specified name
GetField 3 params → 200400401404429500default
GET
/namespaces/{namespaceName}/fields/{fieldName}/usages
get usages of the common field with specified name
GetFieldUsages 3 params → 200400401404429500default
GET
/namespaces/{namespaceName}/ingestTimeRules
Gets a list of all ingest time rules in a compartment.
ListIngestTimeRules 12 params → 200400401404429500default
POST
/namespaces/{namespaceName}/ingestTimeRules
Creates a new ingest time rule.
CreateIngestTimeRule 3 params body → 200400401404409429500default
DELETE
/namespaces/{namespaceName}/ingestTimeRules/{ingestTimeRuleId}
Deletes an ingest time rule.
DeleteIngestTimeRule 4 params → 204400401404412429500default
GET
/namespaces/{namespaceName}/ingestTimeRules/{ingestTimeRuleId}
Retrieves an ingest time rule.
GetIngestTimeRule 3 params → 200400401404429500default
PUT
/namespaces/{namespaceName}/ingestTimeRules/{ingestTimeRuleId}
Updates an ingest time rule.
UpdateIngestTimeRule 4 params body → 200400401404409412429500
POST
/namespaces/{namespaceName}/ingestTimeRules/{ingestTimeRuleId}/actions/changeCompartment
Updates the compartment of an ingest time rule.
ChangeIngestTimeRuleCompartment 5 params body → 204401404409412429500default
POST
/namespaces/{namespaceName}/ingestTimeRules/{ingestTimeRuleId}/actions/disableIngestTimeRule
Disable an ingest time rule.
DisableIngestTimeRule 4 params → 202400401404409412429500
POST
/namespaces/{namespaceName}/ingestTimeRules/{ingestTimeRuleId}/actions/enableIngestTimeRule
Enable an ingest time rule.
EnableIngestTimeRule 4 params → 202400401404409412429500
GET
/namespaces/{namespaceName}/labelPriorities
get list of priorities
ListLabelPriorities 4 params → 200400401404429500default
GET
/namespaces/{namespaceName}/labelSourceDetails
get details of sources using the label
ListLabelSourceDetails 7 params → 200400401404429500default
GET
/namespaces/{namespaceName}/labelSummary
get total count
GetLabelSummary 2 params → 200400401404429500default
GET
/namespaces/{namespaceName}/labels
get labels passing specified filter
ListLabels 12 params → 200400401404429500default
POST
/namespaces/{namespaceName}/labels/actions/basicInfo
get basic information about a specified set of labels
BatchGetBasicInfo 7 params body → 200400401404429500default
POST
/namespaces/{namespaceName}/labels/actions/upsert
Define or update a label.
UpsertLabel 4 params body → 200400401404409412429500
DELETE
/namespaces/{namespaceName}/labels/{labelName}
delete label
DeleteLabel 5 params → 204400401404412429500default
GET
/namespaces/{namespaceName}/labels/{labelName}
get label with specified name
GetLabel 3 params → 200400401404429500default
GET
/namespaces/{namespaceName}/logAnalyticsEmBridges
Get a list of all log analytics enterprise manager bridges.
ListLogAnalyticsEmBridges 11 params → 200401400404429500default
POST
/namespaces/{namespaceName}/logAnalyticsEmBridges
Add configuration for enterprise manager bridge.
CreateLogAnalyticsEmBridge 3 params body → 200400401404409429500default
GET
/namespaces/{namespaceName}/logAnalyticsEmBridges/emBridgeSummary
Gets a summary report of log analytics enterpries manager bridges in a compartment.
GetLogAnalyticsEmBridgeSummary 3 params → 200400401404429500default
DELETE
/namespaces/{namespaceName}/logAnalyticsEmBridges/{logAnalyticsEmBridgeId}
Delete a log analytics enterprise manager bridge.
DeleteLogAnalyticsEmBridge 5 params → 204400401404412429500default
GET
/namespaces/{namespaceName}/logAnalyticsEmBridges/{logAnalyticsEmBridgeId}
Retrieve a log analytics enterprise manager bridge.
GetLogAnalyticsEmBridge 3 params → 200400401404429500default
PUT
/namespaces/{namespaceName}/logAnalyticsEmBridges/{logAnalyticsEmBridgeId}
Update a log analytics enterprise manager bridge.
UpdateLogAnalyticsEmBridge 4 params body → 200400401404409412429500
POST
/namespaces/{namespaceName}/logAnalyticsEmBridges/{logAnalyticsEmBridgeId}/actions/changeCompartment
Update the compartment of a log analytics enterprise manager bridge.
ChangeLogAnalyticsEmBridgeCompartment 5 params body → 204401404409412429500default
GET
/namespaces/{namespaceName}/logAnalyticsEntities
Get a list of all log analytics entities in a compartment.
ListLogAnalyticsEntities 25 params → 200400401404429500default
POST
/namespaces/{namespaceName}/logAnalyticsEntities
Create a new log analytics entity.
CreateLogAnalyticsEntity 3 params body → 200400401404409429500default
GET
/namespaces/{namespaceName}/logAnalyticsEntities/entitySummary
Gets a summary report of log analytics entities in a compartment.
GetLogAnalyticsEntitiesSummary 3 params → 200400401404429500default
DELETE
/namespaces/{namespaceName}/logAnalyticsEntities/{logAnalyticsEntityId}
Delete a log analytics entity.
DeleteLogAnalyticsEntity 5 params → 204400401404412429500default
GET
/namespaces/{namespaceName}/logAnalyticsEntities/{logAnalyticsEntityId}
Retrieve a log analytics entity.
GetLogAnalyticsEntity 4 params → 200400401404429500default
PUT
/namespaces/{namespaceName}/logAnalyticsEntities/{logAnalyticsEntityId}
Update a log analytics entity.
UpdateLogAnalyticsEntity 4 params body → 200400401404409412429500
POST
/namespaces/{namespaceName}/logAnalyticsEntities/{logAnalyticsEntityId}/actions/addEntityAssociations
Add associations for log analytics entity.
AddEntityAssociation 5 params body → 200401404409412429500default
POST
/namespaces/{namespaceName}/logAnalyticsEntities/{logAnalyticsEntityId}/actions/changeCompartment
Update the compartment of a log analytics entity.
ChangeLogAnalyticsEntityCompartment 5 params body → 204401404409412429500default
POST
/namespaces/{namespaceName}/logAnalyticsEntities/{logAnalyticsEntityId}/actions/removeEntityAssociations
Delete associations for log analytics entity.
RemoveEntityAssociations 5 params body → 200401404409412429500default
GET
/namespaces/{namespaceName}/logAnalyticsEntities/{logAnalyticsEntityId}/entityAssociations
List a collection of entities associated with input source entity.
ListEntityAssociations 8 params → 200400401404429500default
GET
/namespaces/{namespaceName}/logAnalyticsEntities/{logAnalyticsEntityId}/entityTopology
Retrieve a log analytics entity topology collection that contains a set of log analytics entities and a set of relationships between those, for the input source entity.
ListLogAnalyticsEntityTopology 10 params → 200400401404429500default
GET
/namespaces/{namespaceName}/logAnalyticsEntityTypes
Get a list of all log analytics entity types.
ListLogAnalyticsEntityTypes 10 params → 200401400404429500default
POST
/namespaces/{namespaceName}/logAnalyticsEntityTypes
Add custom log analytics entity type.
CreateLogAnalyticsEntityType 3 params body → 200401404409429500default
DELETE
/namespaces/{namespaceName}/logAnalyticsEntityTypes/{entityTypeName}
Delete a log analytics entity type.
DeleteLogAnalyticsEntityType 4 params → 204400401404412429500default
GET
/namespaces/{namespaceName}/logAnalyticsEntityTypes/{entityTypeName}
Retrieve details for log analytics entity type.
GetLogAnalyticsEntityType 3 params → 200400401404429500default
PUT
/namespaces/{namespaceName}/logAnalyticsEntityTypes/{entityTypeName}
Update custom log analytics entity type.
UpdateLogAnalyticsEntityType 4 params body → 200401404409412429500default
GET
/namespaces/{namespaceName}/logAnalyticsLogGroups
Gets a list of all Log-Analytics groups in a compartment.
ListLogAnalyticsLogGroups 8 params → 200400401404429500default
POST
/namespaces/{namespaceName}/logAnalyticsLogGroups
Creates a new Log-Analytics group.
CreateLogAnalyticsLogGroup 3 params body → 200400401404409429500default
DELETE
/namespaces/{namespaceName}/logAnalyticsLogGroups/{logAnalyticsLogGroupId}
Deletes an Log-Analytics group.
DeleteLogAnalyticsLogGroup 4 params → 204400401404412429500default
GET
/namespaces/{namespaceName}/logAnalyticsLogGroups/{logAnalyticsLogGroupId}
Retrieves an Log-Analytics group.
GetLogAnalyticsLogGroup 3 params → 200400401404429500default
PUT
/namespaces/{namespaceName}/logAnalyticsLogGroups/{logAnalyticsLogGroupId}
Updates an Log-Analytics group.
UpdateLogAnalyticsLogGroup 4 params body → 200400401404409412429500
POST
/namespaces/{namespaceName}/logAnalyticsLogGroups/{logAnalyticsLogGroupId}/actions/changeCompartment
Updates the compartment of an Log-Analytics group.
ChangeLogAnalyticsLogGroupCompartment 5 params body → 204401404409412429500default
GET
/namespaces/{namespaceName}/logAnalyticsLogGroupsSummary
Gets a count of all Log-Analytics groups in a compartment.
GetLogAnalyticsLogGroupsSummary 3 params → 200400401404429500default
GET
/namespaces/{namespaceName}/logAnalyticsObjectCollectionRules
Provides list of Log Analytics Object Collection rules.
ListLogAnalyticsObjectCollectionRules 9 params → 200400401404429500default
POST
/namespaces/{namespaceName}/logAnalyticsObjectCollectionRules
Creates a Log Analytics Object Collection Rule.
CreateLogAnalyticsObjectCollectionRule 2 params body → 200400401404409429500default
DELETE
/namespaces/{namespaceName}/logAnalyticsObjectCollectionRules/{logAnalyticsObjectCollectionRuleId}
Deletes Log Analytics Object Collection Rule
DeleteLogAnalyticsObjectCollectionRule 4 params → 204400401404409412429500
GET
/namespaces/{namespaceName}/logAnalyticsObjectCollectionRules/{logAnalyticsObjectCollectionRuleId}
Get Log Analytics Object Collection Rule
GetLogAnalyticsObjectCollectionRule 3 params → 200400401404429500default
PUT
/namespaces/{namespaceName}/logAnalyticsObjectCollectionRules/{logAnalyticsObjectCollectionRuleId}
Updates Log Analytics Object Collection Rule.
UpdateLogAnalyticsObjectCollectionRule 4 params body → 200400401404409412429500
POST
/namespaces/{namespaceName}/logAnalyticsObjectCollectionRules/{logAnalyticsObjectCollectionRuleId}/actions/changeCompartment
Move the rule from it's current compartment to the given compartment.
ChangeLogAnalyticsObjectCollectionRuleCompartment 4 params body → 204401404409412429500default
GET
/namespaces/{namespaceName}/lookupSummary
Gets a count of all lookups.
GetLookupSummary 3 params → 200400401404429500default
GET
/namespaces/{namespaceName}/lookups
Obtain a list of lookups.
ListLookups 13 params → 200400401404429500default
POST
/namespaces/{namespaceName}/lookups/actions/register
register lookup
RegisterLookup 9 params body → 200400401404409429500default
DELETE
/namespaces/{namespaceName}/lookups/{lookupName}
Delete the loookup with specified reference.
DeleteLookup 6 params → 202400401404412429500default
GET
/namespaces/{namespaceName}/lookups/{lookupName}
Obtain the lookup with the specified reference.
GetLookup 3 params → 200400401404429500default
PUT
/namespaces/{namespaceName}/lookups/{lookupName}
Update lookup metadata
UpdateLookup 5 params body → 200400401404409412429500
POST
/namespaces/{namespaceName}/lookups/{lookupName}/actions/appendData
Append information to a lookup.
AppendLookupData 7 params body → 202400401404412429500default
POST
/namespaces/{namespaceName}/lookups/{lookupName}/actions/changeCompartment
Updates the compartment of a lookup.
ChangeLookupCompartment 5 params body → 204401404409412429500default
POST
/namespaces/{namespaceName}/lookups/{lookupName}/actions/updateData
Update the lookup with the specified reference.
UpdateLookupData 7 params body → 202400401404409412429500
GET
/namespaces/{namespaceName}/parserActions
List parser actions
ListParserActions 8 params → 200400401404429500default
GET
/namespaces/{namespaceName}/parserFunctions
get pre-process plugin instance
ListParserFunctions 7 params → 200400401404429500default
GET
/namespaces/{namespaceName}/parserMetaPlugins
get pre-process Meta plugins
ListParserMetaPlugins 6 params → 200400401404429500default
GET
/namespaces/{namespaceName}/parsers
List parsers passing specified filter
ListParsers 13 params → 200400401404429500default
POST
/namespaces/{namespaceName}/parsers/actions/extractLogFieldPaths
structured log fieldpaths
ExtractStructuredLogFieldPaths 4 params body → 200400401404429500default
POST
/namespaces/{namespaceName}/parsers/actions/extractLogHeaderPaths
structured log header paths
ExtractStructuredLogHeaderPaths 4 params body → 200400401404429500default
POST
/namespaces/{namespaceName}/parsers/actions/test
test parser
TestParser 5 params body → 200400401404409429500default
POST
/namespaces/{namespaceName}/parsers/actions/upsert
Define or update parser
UpsertParser 4 params body → 200400401404409412429500
DELETE
/namespaces/{namespaceName}/parsers/{parserName}
delete parser with specified name
DeleteParser 5 params → 204400401404412429500default
GET
/namespaces/{namespaceName}/parsers/{parserName}
get parser with fields by Name
GetParser 3 params → 200400401404429500default
GET
/namespaces/{namespaceName}/parsersSummary
summary of parsers
GetParserSummary 2 params → 200400401404429500default
GET
/namespaces/{namespaceName}/preferences
get tenant preferences
GetPreferences 6 params → 200400401404429500default
POST
/namespaces/{namespaceName}/preferences/actions/removePreferences
Removes the tenant preferences
RemovePreferences 3 params body → 204400401404412429500default
POST
/namespaces/{namespaceName}/preferences/actions/updatePreferences
Updates the tenant preferences
UpdatePreferences 3 params body → 204400401404409412429500
GET
/namespaces/{namespaceName}/propertiesMetadata
Get a list of all properties and their metadata.
ListPropertiesMetadata 10 params → 200400401404429500default
GET
/namespaces/{namespaceName}/queryWorkRequests
Returns details about all active asynchronous queries.
ListQueryWorkRequests 8 params → 200400401404429500default
DELETE
/namespaces/{namespaceName}/queryWorkRequests/{workRequestId}
Deletes/Cancels the work request specified by {workRequestId}.
CancelQueryWorkRequest 4 params → 204400401404412429500default
GET
/namespaces/{namespaceName}/queryWorkRequests/{workRequestId}
Returns details about the query work request specified by {workRequestId} including its status and query details.
GetQueryWorkRequest 3 params → 200400401404429500default
PUT
/namespaces/{namespaceName}/queryWorkRequests/{workRequestId}/actions/background
Put the work request specified by {workRequestId} into the background execution mode.
PutQueryWorkRequestBackground 4 params → 200304400401412429500default
GET
/namespaces/{namespaceName}/rules
Gets a list of all ingest time rules and scheduled tasks in a compartment.
ListRules 11 params → 200400401404429500default
GET
/namespaces/{namespaceName}/rulesSummary
Gets a count of all detection rules in a compartment.
GetRulesSummary 3 params → 200400401404429500default
GET
/namespaces/{namespaceName}/scheduledTasks
List summary information about scheduled tasks.
ListScheduledTasks 13 params → 200400401404429500default
POST
/namespaces/{namespaceName}/scheduledTasks
Schedule a task as specified and return task info including the id.
CreateScheduledTask 3 params body → 200400401404409429500default
DELETE
/namespaces/{namespaceName}/scheduledTasks/{scheduledTaskId}
Delete the scheduled task specified by {scheduledTaskId}.
DeleteScheduledTask 4 params → 204400401404409412429500
GET
/namespaces/{namespaceName}/scheduledTasks/{scheduledTaskId}
Get the scheduled task specified by {scheduledTaskId}.
GetScheduledTask 3 params → 200400401404429500default
PUT
/namespaces/{namespaceName}/scheduledTasks/{scheduledTaskId}
Update the scheduled task specified by {scheduledTaskId}.
UpdateScheduledTask 5 params → 200304400401404409412429
POST
/namespaces/{namespaceName}/scheduledTasks/{scheduledTaskId}/actions/changeCompartment
Move the scheduled task specified by {scheduledTaskId} to a different compartment within the same tenancy.
ChangeScheduledTaskCompartment 6 params → 204401404409412429500default
POST
/namespaces/{namespaceName}/scheduledTasks/{scheduledTaskId}/actions/clean
Clean accumulated acceleration data stored for the accelerated saved search. Optionally specify the time range; the default is all time.
Clean 6 params → 200204400401404409429500
POST
/namespaces/{namespaceName}/scheduledTasks/{scheduledTaskId}/actions/pause
Pause the scheduled task specified by {scheduledTaskId}.
PauseScheduledTask 4 params → 200304400401404412429500
POST
/namespaces/{namespaceName}/scheduledTasks/{scheduledTaskId}/actions/resume
Resume the scheduled task specified by {scheduledTaskId}.
ResumeScheduledTask 4 params → 200304400401404412429500
POST
/namespaces/{namespaceName}/scheduledTasks/{scheduledTaskId}/actions/run
Immediately execute (in the foreground) the saved search acceleration task. Optionally specify time range (timeStart and timeEnd). The default is all time.
Run 6 params → 200204400401404409429500
POST
/namespaces/{namespaceName}/scheduledTasks/{scheduledTaskId}/actions/verify
Verify the accelerated saved search task specified by {scheduledTaskId}. Optionally specify whether to return accelerated search results; the default is false. For internal use only.
Verify 5 params → 200400401404409429500default
POST
/namespaces/{namespaceName}/search/actions/compareContent
Compares two input payloads and returns which lines are different, as well as the intraline differences.
CompareContent 2 params body → 200400401404412429500default
POST
/namespaces/{namespaceName}/search/actions/export
Performs a search and streams the query results once they become available.
ExportQueryResult 2 params body → 200400401404429500default
POST
/namespaces/{namespaceName}/search/actions/filter
Adds and/or removes one or more filters from the query string and returns updated query string.
Filter 2 params body → 200400401404429500default
POST
/namespaces/{namespaceName}/search/actions/parse
Parses a query and returns a breakdown of the commands used in the query with specific details about each command.
ParseQuery 2 params body → 200400401404429500default
GET
/namespaces/{namespaceName}/search/actions/query
Returns the results for a query that was specified to run asynchronously.
GetQueryResult 8 params → 200400401404429500default
POST
/namespaces/{namespaceName}/search/actions/query
Execute query
Query 4 params body → 200201400401404429500default
POST
/namespaces/{namespaceName}/search/actions/suggest
Provides typeahead suggestions for a given queryString.
Suggest 2 params body → 200400401404429500default
GET
/namespaces/{namespaceName}/sourceAssociations
association summary by source
ListSourceAssociations 12 params → 200400401404429500default
GET
/namespaces/{namespaceName}/sourceLabelOperators
list source label operators
ListSourceLabelOperators 6 params → 200400401404429500default
GET
/namespaces/{namespaceName}/sourceMetaFunctions
get source meta functions
ListSourceMetaFunctions 6 params → 200400401404429500default
GET
/namespaces/{namespaceName}/sourceMetaTypes
get all meta source types
ListMetaSourceTypes 6 params → 200400401404429500default
GET
/namespaces/{namespaceName}/sourceSummary
summary of sources
GetSourceSummary 2 params → 200400401404429500default
GET
/namespaces/{namespaceName}/sources
source list
ListSources 17 params → 200400401404429500default
POST
/namespaces/{namespaceName}/sources/actions/upsert
Define or update a source
UpsertSource 7 params body → 200400401404409412429500
POST
/namespaces/{namespaceName}/sources/actions/validate
Pre-define or update a source
ValidateSource 6 params body → 200400401404429500default
POST
/namespaces/{namespaceName}/sources/actions/validateEndpoint
Validate the REST endpoint configuration.
ValidateEndpoint 2 params body → 200400401404429500default
POST
/namespaces/{namespaceName}/sources/actions/validateExtendedFields
test extended fields
ValidateSourceExtendedFieldDetails 3 params body → 200400401404429500default
POST
/namespaces/{namespaceName}/sources/actions/validateLabelCondition
Validate source label condition
ValidateLabelCondition 2 params body → 200400401404429500default
GET
/namespaces/{namespaceName}/sources/sqlColumnNames
extract column names from SQL query
GetColumnNames 4 params → 200400401404429500default
DELETE
/namespaces/{namespaceName}/sources/{sourceName}
delete source with specified ID
DeleteSource 5 params → 204400401404412429500default
GET
/namespaces/{namespaceName}/sources/{sourceName}
get source with specified name
GetSource 4 params → 200400401404429500default
POST
/namespaces/{namespaceName}/sources/{sourceName}/actions/addEventTypes
Add source event types
AddSourceEventTypes 4 params body → 204400401404409412429500
POST
/namespaces/{namespaceName}/sources/{sourceName}/actions/disableAutoAssociation
Disable auto association for a log source
DisableAutoAssociation 4 params body → 202400401404409412429500
POST
/namespaces/{namespaceName}/sources/{sourceName}/actions/disableEventTypes
Disable source event types
DisableSourceEventTypes 4 params body → 204400401404409412429500
POST
/namespaces/{namespaceName}/sources/{sourceName}/actions/enableAutoAssociation
Enable auto association for a log source
EnableAutoAssociation 4 params body → 202400401404409412429500
POST
/namespaces/{namespaceName}/sources/{sourceName}/actions/enableEventTypes
Enable source event types
EnableSourceEventTypes 4 params body → 204400401404409412429500
POST
/namespaces/{namespaceName}/sources/{sourceName}/actions/removeEventTypes
Remove source event types
RemoveSourceEventTypes 4 params body → 204400401404409412429500
GET
/namespaces/{namespaceName}/sources/{sourceName}/associableEntities
List the entities which are (in)eligible for association with this source.
ListAssociableEntities 10 params → 200400401404429500default
GET
/namespaces/{namespaceName}/sources/{sourceName}/autoAssociations
Get auto association information for the source with the specified name
ListAutoAssociations 7 params → 200400401404429500default
GET
/namespaces/{namespaceName}/sources/{sourceName}/eventTypes
List source event types for source with specified name
ListSourceEventTypes 10 params → 200400401404429500default
GET
/namespaces/{namespaceName}/sources/{sourceName}/extendedFieldDefinitions
get source extended fields for source with specified Id
ListSourceExtendedFieldDefinitions 7 params → 200400401404429500default
GET
/namespaces/{namespaceName}/sources/{sourceName}/patterns
get source patterns for source with specified Id
ListSourcePatterns 8 params → 200400401404429500default
GET
/namespaces/{namespaceName}/storage
This API gets the storage configuration of a tenancy
GetStorage 2 params → 200400401404429500default
PUT
/namespaces/{namespaceName}/storage
This API updates the archiving configuration.
UpdateStorage 3 params body → 200400401404412429500default
POST
/namespaces/{namespaceName}/storage/actions/assignEncryptionKey
This API submits a work request to assign customer encryption key.
AssignEncryptionKey 4 params body → 202400401404409412429500
POST
/namespaces/{namespaceName}/storage/actions/disableArchiving
This API disables archiving.
DisableArchiving 3 params → 200400401404412429500default
POST
/namespaces/{namespaceName}/storage/actions/enableArchiving
This API enables archiving.
EnableArchiving 3 params → 200400401404412429500default
POST
/namespaces/{namespaceName}/storage/actions/estimatePurgeDataSize
This API estimates the size of data to be purged.
EstimatePurgeDataSize 4 params body → 200400401404409412429500
POST
/namespaces/{namespaceName}/storage/actions/estimateRecallDataSize
This API gives an active storage usage estimate for archived data to be recalled and the time range of such data.
EstimateRecallDataSize 2 params body → 200400401404409412429500
POST
/namespaces/{namespaceName}/storage/actions/estimateReleaseDataSize
This API gives an active storage usage estimate for recalled data to be released and the time range of such data.
EstimateReleaseDataSize 2 params body → 200400401404409412429500
POST
/namespaces/{namespaceName}/storage/actions/purgeData
This API submits a work request to purge data.
PurgeStorageData 4 params body → 202400401404409412429500
POST
/namespaces/{namespaceName}/storage/actions/recallArchivedData
This API submits a work request to recall archived data.
RecallArchivedData 4 params body → 202400401404409412429500
POST
/namespaces/{namespaceName}/storage/actions/releaseRecalledData
This API submits a work request to release recalled data.
ReleaseRecalledData 4 params body → 202400401404409412429500
GET
/namespaces/{namespaceName}/storage/encryptionKeyInfo
This API returns the list of customer owned encryption key info.
ListEncryptionKeyInfo 2 params → 200400401404429500default
GET
/namespaces/{namespaceName}/storage/logSets
This API returns a list of log sets.
ListLogSets 6 params → 200400401404429500default
GET
/namespaces/{namespaceName}/storage/logSetsCount
This API returns the count of distinct log sets.
GetLogSetsCount 2 params → 200400401404429500default
GET
/namespaces/{namespaceName}/storage/overlappingRecalls
This API gets the list of overlapping recalls made in the given timeframe.
ListOverlappingRecalls 8 params → 200400401404429500default
GET
/namespaces/{namespaceName}/storage/recallCount
This API gets the number of recalls made.
GetRecallCount 2 params → 200400401404429500default
GET
/namespaces/{namespaceName}/storage/recalledData
This API returns the list of recalled data of a tenancy.
ListRecalledData 8 params → 200400401404429500default
GET
/namespaces/{namespaceName}/storage/recalledDataSize
This API gets the datasize of recalls for a given timeframe
GetRecalledDataSize 4 params → 200400401404429500default
GET
/namespaces/{namespaceName}/storage/recalledInfoCollection
This API returns the list of recalled data of a tenancy.
ListRecalledInfo 9 params → 200400401404429500default
GET
/namespaces/{namespaceName}/storage/usage
This API gets storage usage information of a tenancy.
GetStorageUsage 2 params → 200400401404429500default
GET
/namespaces/{namespaceName}/storageWorkRequests
This API lists storage work requests.
ListStorageWorkRequests 13 params → 200400401404429500default
GET
/namespaces/{namespaceName}/storageWorkRequests/{workRequestId}
The API returns details about the storage work request .
GetStorageWorkRequest 3 params → 200400401404429500default
GET
/namespaces/{namespaceName}/storageWorkRequests/{workRequestId}/errors
This API returns the list of work request errors if any.
ListStorageWorkRequestErrors 8 params → 200400401404429500default
GET
/namespaces/{namespaceName}/supportedCharEncodings
Get supported character encodings for log files.
ListSupportedCharEncodings 4 params → 200400401404429500default
GET
/namespaces/{namespaceName}/supportedTimezones
Get supported timezones
ListSupportedTimezones 4 params → 200400401404429500default
GET
/namespaces/{namespaceName}/templates
List templates passing specified filter
ListTemplates 12 params → 200400401404429500default
GET
/namespaces/{namespaceName}/templates/{templateId}
get template by ocid
GetTemplate 3 params → 200400401404429500default
GET
/namespaces/{namespaceName}/unprocessedDataBucket
Retrieve Unprocessed Data Bucket
GetUnprocessedDataBucket 2 params → 200400401404429500default
GET
/namespaces/{namespaceName}/uploads
List Uploads
ListUploads 9 params → 200400401404429500default
POST
/namespaces/{namespaceName}/uploads/actions/validateFile
Validate File
ValidateFile 4 params → 200400401404429500default
POST
/namespaces/{namespaceName}/uploads/actions/validateSourceMapping
Validate Source Mapping
ValidateSourceMapping 5 params → 200400401404429500default
DELETE
/namespaces/{namespaceName}/uploads/{uploadReference}
Delete Upload
DeleteUpload 4 params → 204400401404409412429500
GET
/namespaces/{namespaceName}/uploads/{uploadReference}
Get Upload
GetUpload 3 params → 200400401404429500default
GET
/namespaces/{namespaceName}/uploads/{uploadReference}/files
List Upload Files
ListUploadFiles 9 params → 200400401404429500default
DELETE
/namespaces/{namespaceName}/uploads/{uploadReference}/files/{fileReference}
Delete Upload File
DeleteUploadFile 4 params → 204400401404409429500default
GET
/namespaces/{namespaceName}/uploads/{uploadReference}/warnings
List upload warnings
ListUploadWarnings 5 params → 200400401404429500default
DELETE
/namespaces/{namespaceName}/uploads/{uploadReference}/warnings/{warningReference}
Delete upload warning
DeleteUploadWarning 4 params → 204400401404409429500default
GET
/namespaces/{namespaceName}/warnings
List and sort warnings based on specified criteria.
ListWarnings 17 params → 200400401404429500default
POST
/namespaces/{namespaceName}/warnings/actions/suppress
Suppress specified warnings.
SuppressWarning 4 params body → 204400401404409429500default
POST
/namespaces/{namespaceName}/warnings/actions/unsuppress
Unsuppress specified warnings.
UnsuppressWarning 4 params body → 204400401404409429500default
GET
/namespaces/{namespaceName}/workRequests
List Work Requests
ListWorkRequests 5 params → 200400401404429500default
GET
/namespaces/{namespaceName}/workRequests/{workRequestId}
GET Work Request Status
GetWorkRequest 3 params → 200400401404429500default
GET
/namespaces/{namespaceName}/workRequests/{workRequestId}/errors
Lists work request errors
ListWorkRequestErrors 5 params → 200400401404429500default
GET
/namespaces/{namespaceName}/workRequests/{workRequestId}/logs
Lists work request logs
ListWorkRequestLogs 5 params → 200400401404429500default

Schemas 302

The contract defines 302 schemas that model the data the API accepts and returns. The most detailed are LogAnalyticsSource (40 properties), LogAnalyticsSourceSummary (38 properties), LogAnalyticsParser (36 properties), LogAnalyticsParserSummary (33 properties). Each schema is shown below with its type and property counts.

LabelPriority
object
The label priority.
1 property
QueryAggregation
object
Query results.
13 properties 1 required
ParseQueryDetails
object
Input information to submit parse query request.
2 properties 2 required
LogAnalyticsParserFilter
object
LogAnalyticsParserFilter
7 properties
UploadFileStatus
object
Upload File Status
2 properties
PropertyDefinition
object
Defines an property of a macro, variable or query.
4 properties
FilterOutput
object
Query builder api response object containing updated querystring's
3 properties 2 required
NamedCaptureValue
object
Named capture value.
3 properties
LogAnalyticsParserCollection
object
LogAnalyticsParserCollection
1 property
LogAnalyticsSourceExtendedFieldDefinition
object
LogAnalyticsSourceExtendedFieldDefinition
18 properties
LogAnalyticsConfigWorkRequestCollection
object
LogAnalyticsConfigWorkRequestCollection
1 property
MatchInfo
object
MatchInfo
3 properties
DisableAutoAssociationDetails
object
The information required to disable log source auto-association.
1 property
LogAnalyticsImportCustomContent
object
LogAnalyticsImportCustomContent
5 properties
LogAnalyticsAssociationParameterCollection
object
LogAnalytics Association Parameter Collection
1 property
LogAnalyticsLabelOperatorCollection
object
LogAnalyticsLabelOperatorCollection
1 property
LogAnalyticsSourceDataFilter
object
LogAnalyticsSourceDataFilter
14 properties
IngestTimeRuleAction
object
The action to be performed if the ingest time rule condition(s) are satisfied.
1 property 1 required
CreateScheduledTaskDetails
object
Details for creating a scheduled task.
6 properties 2 required
LogAnalyticsParser
object
LogAnalyticsParser
36 properties
LogAnalyticsMetadataSummary
object
Details of entity metadata information.
1 property
LogAnalyticsParserFunction
object
LogAnalyticsParserFunction
10 properties
EndpointResult
object
The validation status of a specified endpoint.
5 properties
RecalledDataInfo
object
This is the synchronous result of a recall of archived data
2 properties 1 required
WorkRequestErrorCollection
object
This is a list of errors for the work request.
1 property 1 required
CompareLineResult
object
The result of a comparison of two lines in the two content input strings.
5 properties
StorageWorkRequestSummary
This is the summary of a storage work request.
ParserAction
object
A parser action. Typically refers to an operation to be performed while fetching or parsing the logs. Example: Unzip.
2 properties
QueryWorkRequestCollection
object
Collection of query work requests.
1 property 1 required
ScopeFilter
object
Scope filter to reduce the scope of the query.
2 properties 2 required
LogAnalyticsEntityTopologyCollection
object
Collection of log analytics entity topologies.
1 property 1 required
ParserSummaryReport
object
ParserSummaryReport
2 properties
UploadFileCollection
object
Collection of UploadFileSummary objects.
1 property 1 required
GenericConditionBlock
object
A condition block. This could represent a single condition, or have nested condition blocks under it. To form a single condition, specify the name, operator an…
6 properties
LogAnalyticsLabelDefinition
object
LogAnalyticsLabelDefinition
4 properties
CreateLogAnalyticsObjectCollectionRuleDetails
object
The configuration details of collection rule to enable automatic log collection from an object storage bucket.
26 properties 5 required
LogAnalyticsEntity
object
Description of a log analytics entity.
24 properties 9 required
ResultColumn
object
Querylanguage result column.
3 properties
LogAnalyticsParserFunctionCollection
object
LogAnalyticsParserFunctionCollection
1 property
LogAnalyticsEmBridge
object
Configuration details for enterprise manager bridge.
16 properties 9 required
SourceValidateDetails
object
source validation details
2 properties
LogAnalyticsSourceMetric
object
LogAnalyticsSourceMetric
4 properties
ColumnName
object
Column Names from a SQL Query
1 property
UploadWarningCollection
object
Collection of UploadWarningSummary objects.
1 property 1 required
WorkRequest
object
A description of workrequest status
9 properties 7 required
RemoveEntityAssociationsDetails
object
Information about the associations to be deleted between source entity and other existing destination entities.
1 property 1 required
LogAnalyticsLabelAlias
object
Label alias mapping view
6 properties
Dependency
object
Details of a dependency an object or feature defines on another. For example, a source may depend on a parser either directly or indirectly.
5 properties
LogAnalyticsMetadata
object
Entity metadata information.
3 properties
WorkRequestLog
object
This is a log message from the execution of a work request.
2 properties 2 required
TemplateFacet
object
A facet of a template that may help in searching or filtering.
2 properties 2 required
LogAnalyticsEmBridgeSummaryReport
object
Log-Analytics EM Bridge counts summary.
6 properties 6 required
LogAnalyticsAssociatedEntity
object
LogAnalyticsAssociatedEntity
6 properties
LogSetsCount
object
total number of log sets
1 property 1 required
UpdateLookupMetadataDetails
object
UpdateLookupMetadataDetails
7 properties
ParserActionSummaryCollection
object
A collection of parser action summary objects.
1 property 1 required
LogAnalyticsPreference
object
The preference information
2 properties
Indexes
object
Indexes
2 properties
IngestTimeRule
object
An ingest time rule object.
12 properties 3 required
LogAnalyticsTemplateCollection
object
A collection of template summary objects.
1 property 1 required
UpdateLogAnalyticsLogGroupDetails
object
Information needed to update an existing log group.
4 properties
WorkRequestResource
object
A resource created or operated on by a work request.
4 properties 3 required
RuleSummaryReport
object
A summary count of detection rules.
3 properties 3 required
FieldSummaryReport
object
FieldSummaryReport
3 properties
LogAnalyticsEntityTypeSummary
object
Summary of a log analytics entity type.
8 properties 7 required
LookupField
object
LookupField
7 properties
LabelSourceCollection
object
LogAnalytics Label Source Collection
1 property
Schedule
object
Schedule for scheduled task.
5 properties 1 required
LogAnalyticsPreferenceCollection
object
A collection of preference information.
1 property
EstimatePurgeDataSizeResult
object
purge data size in bytes
1 property 1 required
CreateLogAnalyticsEmBridgeDetails
object
Details for a new enterprise manager bridge to be added.
7 properties 4 required
NamespaceSummary
The is the namespace summary of a tenancy in Log Analytics application
UpdateLogAnalyticsEmBridgeDetails
object
Log analytics entity type definition to be updated.
5 properties
StorageWorkRequest
object
This shows the storage work request details.
26 properties 3 required
LogAnalyticsMetric
object
LogAnalyticsMetric
21 properties
TestParserPayloadDetails
object
TestParserPayloadDetails
28 properties
DeleteLogAnalyticsAssociationDetails
object
The information required to delete a list of associations.
2 properties
LogAnalyticsParserFunctionParameter
object
LogAnalyticsParserFunctionParameter
7 properties
CreateIngestTimeRuleDetails
object
The information required to create an ingest time rule.
7 properties 4 required
QueryWorkRequestSummary
object
High level summary of query job work request.
10 properties 3 required
LogAnalyticsFieldSummary
A summary of a field.
EntityTypeProperty
object
Properties used in file patterns specified in log sources.
2 properties 1 required
LogAnalyticsEntityTopologySummary
object
Log Analytics Entity topology that contains a set of log analytics entities and a set of relationships between those.
2 properties 2 required
UnprocessedDataBucket
object
Configuration details of the bucket that stores unprocessed payloads.
5 properties 2 required
ChangeScheduledTaskCompartmentDetails
object
The details for changing the compartment of a scheduled task.
1 property 1 required
LogAnalyticsParameter
object
LogAnalyticsParameter
5 properties
UploadWarningSummary
object
Summary of Upload warnings.
4 properties 1 required
LogAnalyticsEntityTopologyLink
object
Log Analytics entity relationship link used in hierarchical representation of entity relationships topology.
4 properties 2 required
FieldValue
object
Field value representing and entry in a list-of-values field.
3 properties
LogAnalyticsLabelView
object
LogAnalyticsLabelView
15 properties
LogAnalyticsLogGroup
object
Summary of an Log-Analytics log group.
8 properties 2 required
AutoAssociationCollection
object
Auto association details of the source.
1 property
LogAnalyticsConfigWorkRequestSummary
object
LogAnalyticsConfigWorkRequestSummary
7 properties
LogAnalyticsSourceMetadataField
object
LogAnalyticsSourceMetadataField
5 properties
UploadSummary
object
Summary of the Upload.
7 properties 3 required
LogAnalyticsResourceCategoryDetails
object
Details of resource category assignments.
1 property
LogAnalyticsSourceLabelCondition
object
LogAnalyticsSourceLabelCondition
20 properties
LogAnalyticsConfigWorkRequestPayload
object
LogAnalyticsConfigWorkRequestPayload
4 properties
ConditionBlock
object
A condition block. This could represent a single condition, or have nested condition blocks under it. To form a single condition, specify the fieldName, labelC…
6 properties
AssociableEntity
object
Entity details including whether or not it is eligible for association with the source.
8 properties
SourceMappingResponse
object
Response object containing match status and parsed representation of log data.
1 property 1 required
WorkRequestError
object
An error encountered while executing a work request.
3 properties 3 required
LogAnalyticsObjectCollectionRule
object
The configuration details of an Object Storage based collection rule.
32 properties 13 required
LogAnalyticsMetadataCollection
object
A collection of entity metadata information.
1 property
CompareContentDetails
object
The two strings to compare.
2 properties
ChangeLogAnalyticsEntityCompartmentDetails
object
Log analytics entity compartment to be updated.
1 property 1 required
DeleteLogAnalyticsAssociation
object
DeleteLogAnalyticsAssociation
7 properties
EfdRegexResult
object
EfdRegexResult
10 properties
LogAnalyticsEntityType
object
Description of log analytics entity type.
10 properties 7 required
EstimateRecallDataSizeDetails
object
This is the input used to estimate the size of data to be recalled
5 properties 2 required
IngestTimeRuleSummaryCollection
object
A collection of Log Analytics ingest time rules.
1 property
EffectivePropertyCollection
object
A collection of effective properties.
1 property
Action
object
Action for scheduled task.
1 property 1 required
CreateLogAnalyticsLogGroupDetails
object
Information about a new log group.
5 properties 2 required
EventTypeDetails
object
The collection of event types and corresponding versions mapped to the source.
1 property
AssociationSummaryReport
object
AssociationSummaryReport
1 property
LogAnalyticsEntitySummaryReport
object
Log-Analytics entity counts summary.
4 properties 4 required
LogAnalyticsLookupFields
object
LogAnalyticsLookupFields
7 properties
AssociationProperty
object
A property represented as a name-value pair.
3 properties 1 required
LogAnalyticsResourceCategory
object
A resource and its category.
6 properties
NamespaceCollection
object
This is a list of NamespaceSummary: there is at most one item in the list.
1 property 1 required
RecallCount
object
This is the recall count statistics for a given tenant
5 properties 5 required
UploadFileSummary
object
Details of Upload File.
15 properties 2 required
AddEntityAssociationDetails
object
Information about the associations to be added between a source log analytics entity and other existing destination entities.
1 property 1 required
PatternOverride
object
Details of pattern level override for a property.
3 properties 2 required
RuleSummary
object
A generic rule summary object - represents an ingest time rule or a scheduled task.
15 properties 4 required
PurgeStorageDataDetails
object
This is the input used to purge data
5 properties 2 required
LogAnalyticsLogGroupSummaryCollection
object
A collection of Log-Analytics log groups.
1 property
LogAnalyticsPreferenceDetails
object
Preference information used to update preference settings.
1 property
SourceValidateResults
object
results of source validation
1 property
LogAnalyticsObjectCollectionRuleSummary
object
The summary of an Object Storage based collection rule.
17 properties 10 required
UpsertLogAnalyticsAssociationDetails
object
The required information to update or create a list of associations.
2 properties
Namespace
object
This is the namespace details of a tenancy in Log Analytics application
7 properties 3 required
LabelPriorityCollection
object
Label Priority Info List
1 property
LogAnalyticsSourceFunction
object
LogAnalyticsSourceFunction
16 properties
AutoLookups
object
AutoLookups
2 properties
UpsertLogAnalyticsParserDetails
object
UpsertLogAnalyticsParserDetails
27 properties
ChangeLogAnalyticsEmBridgeCompartmentDetails
object
Log analytics enterprise manager bridge compartment to be updated.
1 property 1 required
RecalledInfo
object
This is the information about data recalled
7 properties 7 required
LogAnalyticsLabelOperator
object
LogAnalyticsLabelOperator
2 properties
LogAnalyticsMetaSourceTypeCollection
object
Source Meta Type List
1 property
RecallArchivedDataDetails
object
This is the input used to recall archived data
10 properties 3 required
RecallDefinition
object
Defines a recall in a query.
2 properties
AbstractField
object
Generic field defining all attributes common to all querylanguage fields.
11 properties 1 required
RuleSummaryCollection
object
A collection of Log Analytics rules.
1 property
ExportContent
object
The content to export.
3 properties
EstimateReleaseDataSizeDetails
object
This is the input used to estimate the size of data to be released
3 properties 2 required
RecalledData
object
This is the information about recalled data
15 properties 14 required
LogAnalyticsWarning
object
LogAnalyticsWarning
26 properties
LogAnalyticsTemplate
object
A template object.
17 properties 5 required
UpdateLogAnalyticsEntityTypeDetails
object
Log analytics entity type definition to be updated.
2 properties
LogAnalyticsEmBridgeSummary
object
Enterprise manager bridge summary.
16 properties 9 required
AssociableEntityCollection
object
The collection of entities that are eligible or ineligible to be associated to the source.
1 property
UpdateLogAnalyticsObjectCollectionRuleDetails
object
Configuration of the collection rule to be updated.
17 properties
ScheduledTaskSummary
object
Summary information about a scheduled task.
16 properties 7 required
ExtractLogHeaderResults
object
log header values
3 properties
LogAnalyticsAssociation
object
LogAnalyticsAssociation
18 properties
IngestTimeRuleCondition
object
The condition(s) to evaluate for an ingest time rule.
1 property 1 required
StepInfo
object
StepInfo
3 properties
UpdateStorageDetails
object
This is the input to update storage configuration of a tenancy in Log Analytics application
1 property 1 required
LogAnalyticsLookupCollection
object
LogAnalytics Lookup Collection
1 property
Violation
object
Violation
5 properties
EncryptionKeyInfoCollection
object
This is a list of encryption key info.
1 property 1 required
LogSetCollection
object
It contains a list of log sets
1 property 1 required
RecalledDataSize
object
This is the recall related data size for the given timeframe
4 properties 4 required
AutoAssociationState
object
Auto association state of the source.
2 properties
DependentSource
object
A source that depends on or uses the resource such as a field or a parser
8 properties
ValidateLabelConditionResult
object
The result of the label condition validation
6 properties 3 required
LogAnalyticsSourceSummary
object
LogAnalyticsSourceSummary
38 properties
WorkRequestSummary
object
High level summary of control plane job work request.
7 properties 2 required
LogAnalyticsMetaFunctionCollection
object
LogAnalyticsMetaFunctionCollection
1 property
CompareContentResult
object
The intraline diff result.
1 property
StorageWorkRequestCollection
object
This is a list of work request summaries.
1 property 1 required
ValidateEndpointResult
object
The result of the endpoint configuration validation
3 properties 1 required
LogAnalyticsImportCustomChangeList
object
LogAnalyticsImportCustomChangeList
9 properties
WorkRequestCollection
object
Collection of control plane work requests.
1 property 1 required
LogAnalyticsSourceEntityType
object
LogAnalyticsSourceEntityType
4 properties
CreateLogAnalyticsEntityTypeDetails
object
Details for new log analytics entity type to be added.
3 properties 1 required
EncryptionKeyInfoSummary
object
This is the summary of an encryption key.
3 properties 3 required
ExportDetails
object
Input arguments for running a query synchronosly and streaming the results as soon as they become available.
12 properties 3 required
QueryDetails
object
Input arguments for running a log anlaytics query. If the request is set to run in asynchronous mode then shouldIncludeColumns and shouldIncludeFields can be o…
16 properties 3 required
AbstractColumn
object
Generic column defining all attributes common to all querylanguage columns.
13 properties 1 required
ArchivingConfiguration
object
This is the configuration for data archiving in object storage
3 properties
LogAnalyticsFieldCollection
object
LogAnalytics Field Collection
1 property
LabelNames
object
LabelName
1 property
LogAnalyticsEntityTopologyLinkCollection
object
Collection of log analytics entity relationship links.
1 property 1 required
LogAnalyticsSourceExtendedFieldDefinitionCollection
object
LogAnalyticsSourceExtendedFieldDefinitionCollection
1 property
ParsedField
object
Parsed field response.
2 properties
ParsedContent
object
Parsed representation of the log file.
6 properties
UploadCollection
object
Collection of UploadSummary objects.
1 property 1 required
UpsertLogAnalyticsLabelDetails
object
Upsert LogAnalytics Label Details
11 properties
ScheduledTaskCollection
object
Collection of scheduled tasks.
1 property 1 required
ChangeLogAnalyticsLogGroupCompartmentDetails
object
The information required to change a log group compartment.
1 property 1 required
QueryWorkRequest
object
Job details outlining parameters specified when job was submitted.
16 properties 7 required
EventTypeCollection
object
The collection of event types and corresponding versions mapped to the source.
1 property
LogAnalyticsTemplateSummary
object
Summary of a template object.
12 properties 5 required
SourceSummaryReport
object
SourceSummaryReport
3 properties
AbstractParserTestResultLogLine
object
AbstractParserTestResultLogLine
8 properties
LabelSummaryReport
object
LabelSummaryReport
2 properties
LogAnalyticsMetaSourceType
object
LogAnalyticsMetaSourceType
8 properties
Filter
object
Query builder filter action to apply edit to queryString.
3 properties 1 required
LogAnalyticsPatternFilter
object
LogAnalyticsPatternFilter
8 properties
UpsertLogAnalyticsAssociation
object
UpsertLogAnalyticsAssociation
9 properties
LogAnalyticsEntityTypeCollection
object
Collection of log analytics entities.
1 property 1 required
TimeRange
object
Specify time range. This paramter can be overwritten if time criteria is specified in the query string. If no time criteria are found in query string this time…
3 properties 2 required
StorageUsage
object
This is the storage usage information of a tenancy in Log Analytics application
3 properties 3 required
LogAnalyticsProperty
object
A property represented as a name-value pair.
2 properties 1 required
UpdateScheduledTaskDetails
object
The details for updating a schedule task.
6 properties 1 required
LogAnalyticsEndpoint
object
Endpoint configuration for REST API based log collection.
1 property 1 required
LogAnalyticsParserMetaPluginParameter
object
LogAnalyticsParserMetaPluginParameter
6 properties
Success
object
Success Information.
1 property 1 required
LogAnalyticsWarningCollection
object
A collection of warnings.
1 property
CreateLogAnalyticsEntityDetails
object
Details for new log analytics entity to be added.
13 properties 3 required
CreationSource
object
Details for auto-created entity.
2 properties
UiParserTestMetadata
object
UiParserTestMetadata
3 properties
RegexMatchResult
object
RegexMatchResult
5 properties
LogAnalyticsAssociatedEntityCollection
object
LogAnalytics Associated Entity Collection
1 property
ErrorDetails
object
Error Information.
2 properties 2 required
LogAnalyticsParserMetaPlugin
object
LogAnalyticsParserMetaPlugin
4 properties
TimezoneCollection
object
List of supported timezones.
1 property 1 required
OverlappingRecallCollection
object
This is the list of overlapping recall requests
1 property 1 required
EventType
object
The event type.
5 properties
ParserActionSummary
object
A parser action summary object.
3 properties 1 required
ChangeLogAnalyticsObjectCollectionRuleCompartmentDetails
object
New compartment details.
1 property 1 required
LogAnalyticsEntitySummary
object
Summary of a log analytics entity.
20 properties 9 required
EstimateRecallDataSizeResult
object
This is the size and time range of data to be recalled
9 properties 3 required
UpsertLogAnalyticsSourceDetails
object
UpsertLogAnalyticsSourceDetails
31 properties
LogAnalyticsSourceCollection
object
LogAnalyticsSourceCollection
1 property
FilterDetails
object
Query builder edit request details.
3 properties 2 required
EnableAutoAssociationDetail
object
The information required to enable log source auto-association.
1 property
SuggestOutput
object
Typeahead results
7 properties 1 required
RecalledInfoCollection
object
This is the list of recalled data for log explorer
1 property 1 required
LogAnalyticsResourceCategoryCollection
object
A collection of resources and their category assignments.
2 properties
ChangeLookupCompartmentDetails
object
The information required to change the compartment of a lookup.
1 property 1 required
LogAnalyticsConfigWorkRequest
object
LogAnalyticsConfigWorkRequest
9 properties
FileValidationResponse
object
Response object containing details about file upload eligibility.
3 properties 2 required
UpsertLogAnalyticsFieldDetails
object
Upsert LogAnalytics Field Details
6 properties
LogAnalyticsFieldUsages
object
Contains information about resources such as parsers and sources that use the field.
2 properties 2 required
Storage
object
This is the storage configuration and status of a tenancy in Log Analytics application
2 properties 2 required
ColumnNameCollection
object
Column Name Collection
1 property
VerifyOutput
object
Verify acceleration output.
6 properties 4 required
LogAnalyticsLogGroupSummary
object
Summary of a Log-Analytics log group.
8 properties 2 required
ParserTestResultFieldValue
object
A parser test result field value object.
5 properties
LogAnalyticsObjectCollectionRuleCollection
object
Collection of LogAnalyticsObjectCollectionRuleSummary objects.
1 property 1 required
LogAnalyticsEntityCollection
object
Collection of log analytics entities.
1 property 1 required
ParserTestResult
object
ParserTestResult
6 properties
LogAnalyticsExtendedField
object
LogAnalyticsExtendedField
7 properties
ReleaseRecalledDataDetails
object
This is the input used to release recalled data
5 properties 3 required
EnableAutoAssociationDetails
object
The information required to enable log source auto-association.
1 property
EstimatePurgeDataSizeDetails
object
This is the input used to estimate the size of data that might be purged
5 properties 2 required
DisableAutoAssociationDetail
object
The information required to disable log source auto-association.
1 property
LogAnalyticsMetaFunctionArgument
object
LogAnalyticsMetaFunctionArgument
14 properties
LookupSummaryReport
object
Summary report of lookups in the tenancy.
3 properties
PropertyMetadataSummary
object
Summary of property metadata details.
5 properties
LogAnalyticsLabel
object
LogAnalytics label
14 properties
LogAnalyticsCategoryCollection
object
A collection of categories.
1 property
LogAnalyticsSource
object
LogAnalyticsSource
40 properties
ParseQueryOutput
object
Returns a parser agnostic breakdown of a query string for client query string introspection.
8 properties 2 required
DependentParser
object
A parser that depends on or uses the resource such as a field or another parser.
6 properties
LogAnalyticsAssociationCollection
object
A collection of associations.
1 property
AbstractParserTestResultLogEntry
object
AbstractParserTestResultLogEntry
19 properties
AssignEncryptionKeyDetails
object
This is the input used to assign customer encryption key.
2 properties 2 required
ExtractLogHeaderDetails
object
log header values
2 properties
ExtractLogFieldResults
object
log field path values
1 property
WarningReferenceDetails
object
A list of LogAnalyticsWarning references. Used as input to APIs which operate on a list. For example, the suppress warning API accepts a list of warning refere…
1 property
LogAnalyticsMetaFunction
object
LogAnalyticsMetaFunction
7 properties
LogAnalyticsEmBridgeCollection
object
Collection of log analytics enterprise manager bridges.
1 property 1 required
LogAnalyticsLookup
object
LogAnalyticsLookup
20 properties
UsageStatusItem
object
UsageStatusItem
5 properties
ScheduledTask
object
Log analytics scheduled task resource.
18 properties 10 required
WorkRequestLogCollection
object
This is a list of logs for the work request.
1 property 1 required
UpdateLogAnalyticsEntityDetails
object
Details of log analytics entity to be updated.
10 properties
LogAnalyticsParserField
object
LogAnalyticsParserField
11 properties
OverlappingRecallSummary
object
This is the information about overlapping recall requests
10 properties 10 required
EffectivePropertySummary
object
A property and its effective value details.
4 properties 1 required
LogAnalyticsParserSummary
object
LogAnalyticsParserSummary
33 properties
LabelSourceSummary
object
source summary
9 properties
StatusSummary
object
StatusSummary
5 properties
LogAnalyticsSourcePatternCollection
object
LogAnalyticsSourcePatternCollection
1 property
LogAnalyticsMetadataDetails
object
Details of Entity Metadata.
1 property
ChangeIngestTimeRuleCompartmentDetails
object
The information required to change the compartment of an ingest time rule.
1 property 1 required
PropertyMetadataSummaryCollection
object
A collection of property metadata objects.
1 property
Upload
object
Upload is a container that can be used to put all the relevant and related on-demand upload based log files together.
7 properties 3 required
LogAnalyticsParserMetaPluginCollection
object
LogAnalyticsParserMetaPluginCollection
1 property
LogAnalyticsField
object
Field Details
23 properties
ExtendedFieldsValidationResult
object
ExtendedFieldsValidationResult
1 property
IngestTimeRuleSummary
object
Summary of an ingest time rule.
13 properties 3 required
LogAnalyticsAssociationParameter
object
LogAnalyticsAssociationParameter
11 properties
LogAnalyticsLabelSummary
object
LogAnalytics label
14 properties
AbstractCommandDescriptor
object
Generic command descriptor defining all attributes common to all querylanguage commands for parse output.
7 properties 3 required
PropertyOverride
object
Property overrides at the scope of objects. For example, if you want to use logSourceName as 'xyz' for all objects that conatins string 'abc/' then define matc…
4 properties
ValidateLabelConditionDetails
object
Required information needed to evaluate a source label condition.
3 properties
Level
object
An object used to represent a level at which a property or resource or constraint is defined.
2 properties 1 required
CharEncodingCollection
object
List of supported character encodings.
1 property 1 required
EstimateReleaseDataSizeResult
object
This is the size and time range of data to be released
3 properties 3 required
VariableDefinition
object
Defines a variable used in a macro or the initization section of a query.
6 properties 1 required
SuggestDetails
object
Typeahead input.
4 properties 3 required
LogAnalyticsCategory
object
A category into which resources can be placed.
5 properties
LogAnalyticsSourcePattern
object
LogAnalyticsSourcePattern
20 properties
LogGroupSummaryReport
object
A LogAnalytics Log Group summary report.
1 property
LogAnalyticsLabelCollection
object
A collection of LogAnalytics Labels.
1 property
RecalledDataCollection
object
This is the list of recalled data
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

oracle-loganalytics-api-openapi.yml Raw ↑

Other APIs Oracle publishes across the network.

Oracle Database REST APIs
Oracle Integration Cloud API
Oracle Fusion Cloud Applications API
Oracle Fusion Cloud Financials REST API
Oracle Fusion Cloud HCM REST API
Oracle Fusion Cloud CX Sales and Service REST API
Oracle Fusion Cloud SCM REST API
Oracle Fusion Cloud Procurement REST API
Oracle Content Management API
OCI Generative AI API
OCI AI Vision API
OCI AI Language API
Where this information came from

This is an independent, third-party profile of Oracle Log Analytics API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.