Get all/Search lookup lists

POST 
https://api.logz.io/v1/lookup-lists/search

Searches for lookup lists by name or ID. Can also be run without a filter to return the full list of existing lookups. Returns a paginated list of results. Please ensure to change the region in the URL to match your account's region.

Request

application/json

Body

filter object

Filter by names that contain a term, by lookup ID, or by both. If both properties are sent, they must both be satsified (AND logic).

searchTerm string

Filters for lookup names that contains the search term.

byIds string[]

List of lookup IDs.

pagination object

Default pagination is a page of 25 results. Look for the total field in the response for the number of available results overall, and use the pagination function to page through the results.

pageNumber int32

Default value: 1

If you overshoot the page number, it will return empty with no results, but it won't fail the request.

pageSize int32

Possible values: <= 1000

Default value: 25

Controls the number of results per page. Valid inputs are 1 to 1000.

Responses

200

successful operation

Response Headers

application/json

Schema

Schema

total int32

Total number of search results.

results object[]
Array [
id string
GUID of the lookup list.
name string
Possible values: non-empty and <= 40 characters
Name of the lookup list.
description string
Possible values: <= 400 characters
Description of the lookup list.
]
pagination object

Default pagination is a page of 25 results. Look for the total field in the response for the number of available results overall, and use the pagination function to page through the results.

pageNumber int32

Default value: 1

If you overshoot the page number, it will return empty with no results, but it won't fail the request.

pageSize int32

Possible values: <= 1000

Default value: 25

Controls the number of results per page. Valid inputs are 1 to 1000.

Example (from schema)

{
  "total": 0,
  "results": [
    {
      "id": "7c985e09-3db6-5dc6-ae33-58403493e13f",
      "name": "string",
      "description": "string"
    }
  ],
  "pagination": {
    "pageNumber": 1,
    "pageSize": 100
  }
}

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 POST 'https://api.logz.io/v1/lookup-lists/search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'X-API-TOKEN: <API_KEY_VALUE>' \
--data-raw '{
  "filter": {
    "searchTerm": "servers",
    "byIds": [
      "string"
    ]
  },
  "pagination": {
    "pageNumber": 1,
    "pageSize": 100
  }
}'

Request Collapse all

Base URL

https://api.logz.io

Auth

X-API-TOKEN

Body

{
  "filter": {
    "searchTerm": "servers",
    "byIds": [
      "string"
    ]
  },
  "pagination": {
    "pageNumber": 1,
    "pageSize": 100
  }
}