Retrieve a shared token filter by ID
GEThttps://api.logz.io/v1/shared-tokens/filters/:id
Returns a shared token filter 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 filter
Responses
- 200
- 400
- 403
successful operation
- application/json
- Schema
- Example (from schema)
Schema
id int32
ID of the shared token filter
field stringrequired
Possible values: Value must match regular expression ^[a-zA-Z0-9_@.-]+$
The field to filter
value stringrequired
Possible values: Value must match regular expression ^[a-zA-Z0-9_@.-]+$
The filter query
description string
Name of the filter
{
"id": 339,
"field": "string",
"value": "string",
"description": "503 responses"
}
not found
- application/json
- Schema
- Example (from schema)
Schema
message string
The shared token or query filter could not be found
{
"message": "token with id 12345 not found for account 54321"
}
forbidden
- application/json
- Schema
- Example (from schema)
Schema
message string
Insufficient privileges. Contact our Support team for access to this API feature.
{
"message": "Insufficient privileges"
}
Authorization: X-API-TOKEN
name: X-API-TOKENtype: apiKeydescription: You can manage your API tokens from the [Logz.io API tokens](https://app.logz.io/#/dashboard/settings/manage-tokens/api) page. API tokens are account-specific. You will need to be logged into the relevant Log Management or SIEM account to view the API tokens associated with it. To manage your API tokens, log into the relevant account in your Logz.io platform, click the gear in the top-right menu, and select [**Tools > Manage tokens > API tokens**](https://app.logz.io/#/dashboard/settings/manage-tokens/api). It's important to keep your tokens secure. API tokens carry privileges to make changes to users and accounts, so if you believe an API token has been compromised, delete it, and replace it with a new token in your integrations.in: header
- curl
- python
- go
- nodejs
- ruby
- csharp
- php
- java
- powershell
- CURL
curl -L -X GET 'https://api.logz.io/v1/shared-tokens/filters/:id' \
-H 'Accept: application/json' \
-H 'X-API-TOKEN: <API_KEY_VALUE>'