Retrieve a shared token by ID

GET /v1/shared-tokens/:id

Returns a shared token as a JSON object.

Note: This endpoint requires permissions that must be set by our Support team. Please email help@logz.io for assistance.

Request

id int32required

ID of the shared token

successful operation

Schema

id int32

ID of the shared token

name string

Descriptive name of the token

token string

The token

filters int32[]

Array of filter IDs attached to each token. If no filter is attached, null.

{
  "id": 1241,
  "name": "Snapshotting token",
  "token": "6c36edf51-cf93883aa35-5bc6ce6-7bcfe60d87",
  "filters": [
    339,
    340
  ]
}

not found

Schema

message string

The shared token or query filter could not be found

{
  "message": "token with id 12345 not found for account 54321"
}

forbidden

Schema

message string

Insufficient privileges. Contact our Support team for access to this API feature.

{
  "message": "Insufficient privileges"
}