Log config

Read a log configuration

Changed on

Read a specific log configuration.

get/controlplane/log/config/{id}

Request

  • Base URL
    https://api.nullplatform.com
  • URL
    https://api.nullplatform.com/controlplane/log/config/{id}
  • Auth
    HTTP bearer

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

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • info

      media type application/json was changed to a more specific media type application/problem+json for the response status

    • info

      media type application/json was changed to a more specific media type application/problem+json for the response status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      response property message deprecated

    • info

      response property message deprecated

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status