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. Please ensure to change the region in the URL to match your account's region.

Request

Path Parameters

id int32required

ID of the shared token

Responses

200

successful operation

application/json

Schema

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.

lastUsed int64[]

UNIX timestamp in milliseconds. If token wasn't in use, null.

expirationDate int64[]

UNIX timestamp in milliseconds. If token doesn't have expiration date, null.

filtersOperator string[]

Logical operator used to combine filters. Possible values can be OR or AND.

Example (from schema)

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

400

not found

application/json

Schema

Schema

message string

The shared token or query filter could not be found

Example (from schema)

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

403

forbidden

application/json

Schema

Schema

message string

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

Example (from schema)

{
  "message": "Insufficient privileges"
}

Loading...