latestOpenAPI 3.0.3Netlas API & Data License Agreement2026-08-104487309.0 KB

2b1f84425791

Indices

Get Indices

Retrieve a list of indices accessible to the user.

get/api/indices/

A List of Indices

idinteger required

Unique identifier for the index.

namestring required

System-generated name of the index.

labelstring nullable required

Unique text identifier for the index.

scan_started_atstring date-time required

Timestamp indicating when data collection started.

scan_ended_atstring date-time required

Timestamp indicating when data collection was completed.

type'responses' | 'domains' | 'whois_ip' | 'whois_domains' | 'certs' required

Type of the data collection.

availability'public' | 'private' required

Type of index availability.

is_defaultboolean

Indicates if this is the default index for the data collection.

speed'slow' | 'fast'

Access speed of the index. Older indices are moved to slower storage.

state'indexing' | 'full'

Current state of the index. indexing indicates that data is still being collected.

countinteger required

Count of items in the index.

[
  {
    "id": 1001
  }
]