v1

latestOpenAPI 3.0.12026-07-24110189356.6 KB

index

Inserts index data to an index layer

Adds index data for a given data blob to an index layer. For more information, see Publish to an Index Layer.

post/layers/{layerID}

Path parameters

layerIDstring required

The layer ID of the index layer.

Request body

checksumstring byte

The checksum of the data being indexed by this index record.

crcstring byte

The cyclic redundancy check (CRC) of the data being indexed by this index record.

fieldsobject

The indexing attributes for the data being indexed by this index record. The attributes must match the indexing attributes defined for the index layer. To get or set the index attributes for an index layer, use the config API.

idstring [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

The unique identifier (UUID) of the data being indexed by this index record.

metadataobject

User-defined fields that can store extra metadata about this index record.

sizeinteger

The size of the data being indexed by this index record.

Example request

[
  {
    "checksum": "checksum",
    "crc": "crc",
    "fields": {
      "hour": 0,
      "tile": 377782527,
      "containsProbe": true,
      "eventType": "vss"
    },
    "id": "7a320ce9-e4d0-4d74-9c7a-19810f99a3a1",
    "metadata": {
      "ingestionTime": "1532018660873"
    },
    "size": 100
  }
]

Response

OK - The index was successfully created.