Log Management API Operations Index

Log Management API Operations Index

All available Log Management API Operations

Agent Groups
GET
Get All Agent Group Config

Get all agent group configs

POST
Create Agent Group Config

Create an agent group config

DELETE
Delete Agent Group Config

Delete an agent group config

GET
Get Agent Group Config By Id

Get agent group config by ID

PATCH
Patch Update Agent Group Config

Patch (partial update) an agent group config

PUT
Update Agent Group Config

Update an agent group config

Agent Secret
GET
List Agent Secrets

Retrieves a paginated list of all agent secrets configured in the system. The response includes secret names and metadata but does not include the actual secret values.

Supports pagination parameters to control the number of results returned.

POST
Create Agent Secret

Creates a new agent secret that can be used by log ingestion agents to authenticate with the system. The secret name must be unique and will be used to identify the agent. The returned secret value should be stored securely as it will only be displayed once.

POST
Create Agent Session

Exchange a secret for a token. The Time-To-Live (TTL) is specified in milliseconds and must be between a minimum of 1 minute (60,000 ms) and a maximum of 180 days (15,552,000,000 ms). If not provided or zero, the system defaults to 30 minutes (1,800,000 ms).

POST
Revoke Agent Secret

Revokes an existing agent secret, making it immediately invalid for authentication. Any agents configured to use this secret will no longer be able to authenticate with the system.

This action cannot be undone - to restore access, a new secret must be created.

This action does not invalidate any previously created token.

Extracted Fields
GET
Get Extracted Fields

Get all extracted fields

POST
Create Extracted Field

Create a new extracted field

Ingest
POST
Ingest Json Events

The ingestion API has the following limits: JSON payload - 1MB, Log message size - 16KB, Field name size - 64 characters

POST
Ingest Events

The ingestion API has the following limits: JSON payload - 1MB, Log message size - 16KB, Field name size - 64 characters

Log Forwarder
GET
Get All Log Forwarders

Get all log forwarders

POST
Create Log Forwarder

Create a log forwarder

POST
Test Log Forwarder Connection

Test log forwarder connection

DELETE
Delete Log Forwarder

Delete a log forwarder

GET
Get Log Forwarder By Id

Get log forwarder by ID

PATCH
Patch Log Forwarder

Patch (partial update) a log forwarder

PUT
Update Log Forwarder

Update a log forwarder

Query
POST
Execute Log Search Query 1

Execute a log search query

POST
Execute Log Search Query Deprecated

Execute a log search query