Sign in
Log config

Read a log configuration

Read a specific log configuration.

get/controlplane/log/config/{id}

Path parameters

idstring required

The unique ID of the log configuration.

Response

The operation was successful.

is_defaulttrue | false

Defines whether this log configuration is the default.

Note: If true, it requires the agent:log_config:create-default permission; otherwise, it requires agent:log_config:create.

expires_atstring

If the log configuration is not default, an expiration date must be specified.

account_idinteger

Applicable if the log specification is at the account level.

selectorobject

The tags to be matched to apply the log configuration.

configurationobject

The log configuration as defined in the log specification.

Example response

{
  "expires_at": "2024-07-12T15:00:00Z",
  "account_id": 2345,
  "selector": {
    "environment": "production"
  },
  "configuration": {
    "log_level": "debug",
    "no_error_sampling": 50
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.