v1

latestOpenAPI 3.0.02026-08-064311,0881.3 MB
fieldManagementV1

Create a new field.

Adding a field will define it in the Fields schema allowing it to be assigned as metadata to your logs.

post/v1/fields

Request body

fieldNamestring required

Field name.

Example request

{
  "fieldName": "hostIP"
}

Response

The field was created successfully.

fieldNamestring required

Field name.

fieldIdstring required

Identifier of the field.

dataTypestring required

Field type. Possible values are String, Long, Int, Double, and Boolean.

statestring required

Indicates whether the field is enabled and its values are being accepted. Possible values are Enabled and Disabled.

Example response

{
  "fieldName": "hostIP",
  "fieldId": "00000000031D02DA",
  "dataType": "String",
  "state": "Enabled"
}