Skip to main content
GET
List log groups (or look up one by name)
Requires the IAM action telemetry:DescribeLogGroups. See TELEMETRY permissions for the full list, what each one covers, and an example policy.

Authorizations

Authorization
string
header
required

An OAuth 2.0 bearer token, sent as Authorization: Bearer <token>. This is the recommended way to authenticate.

Get one by exchanging a service account's access key pair at POST /v1/oauth/token with grant_type=client_credentials. It is the standard client-credentials grant, so any OAuth-aware library will obtain and refresh it for you.

Tokens last an hour by default. The same access key pair is separately your AWS SigV4 credential for the S3-compatible object endpoint, which speaks nothing else.

Query Parameters

name
string

Exact name filter, intersected with crn and pagination.

Example:

"app/prod/api"

crn
string

Exact telemetry/log-group CRN filter in the authenticated account and serving region. Malformed or empty CRNs return 400. Valid foreign or mismatched CRNs return an empty page. Intersected with name and pagination.

Example:

"crn:telemetry:sa-saopaulo-1:my-account:log-group/app/prod/api"

limit
integer
default:50

Maximum number of items to return. A value above the maximum is clamped to it rather than rejected, so a page shorter than the one you asked for is normal — page until meta.has_more is false, not until a page looks short.

Required range: 1 <= x <= 100
marker
string

Opaque pagination cursor. Echo back the meta.marker value from the previous page to fetch the next one; do not construct or parse it. The token's internal form varies by endpoint (a resource ID, a timestamp, …) and is not guaranteed stable across releases.

Response

Page of log groups

log_groups
object[]
required
meta
object
required