dataset

Validate a Policy Dataset configuration without saving it

post/policies/dataset/validate

Request body

namestring required

A unique name label

agent_group_idstring uuid required

A unique identifier of an agent_group

agent_policy_idstring uuid required

A unique identifier of an agent_policy

sink_idsstring[] required

An array of one or more sink unique identifier

Example request

{
  "name": "my-dataset"
}

Response

Policy object

idstring uuid required

Unique identifier (UUID)

namestring

A unique name label

agent_group_idstring uuid

Unique identifier (UUID) of an agent_group

agent_policy_idstring uuid

Unique identifier (UUID) of an agent_policy

sink_idsstring[]

An array of one or more sink unique identifier

validboolean

Boolean field indicating whether the dataset is valid

tagsobject

User defined key/values for organization and searching

ts_createdstring date-time

Timestamp of creation

Example response

{
  "name": "my-dataset",
  "tags": {
    "region": "eu",
    "node_type": "dns"
  }
}

Changes

Changed in 7 of the 25 revisions of this API.742

Jul 17, 2026d95ee7691efb1See the full diff
- ▲
  added the new required header request parameter Authorization to all path's operations
  new-required-request-default-parameter-to-existing-path
Oct 4, 2022ce59b3bdec001See the full diff
- ▲
  added the new required header request parameter Bearer authorization to all path's operations
  new-required-request-default-parameter-to-existing-path
May 6, 20229309037e46b9121See the full diff
- ▲
  added the new required request property sink_ids
  new-required-request-property
- ●
  removed the request property sink_id
  request-property-removed
- ●
  removed the optional property sink_id from the response with the 200 status
  response-optional-property-removed
- ○
  added the optional property sink_ids to the response with the 200 status
  response-optional-property-added
Jan 12, 2022b3e28725ccae1See the full diff
- ●
  removed the request property tags
  request-property-removed
Sep 22, 2021dc9b53b51fdd31See the full diff
- ▲
  the sink_id request property's minItems was increased to 1
  request-property-min-items-increased
- ▲
  the sink_id request property type/format changed from string/uuid to array/
  request-property-type-changed
- ▲
  the sink_id response's property type/format changed from string/uuid to array/ for status 200
  response-property-type-changed
- ●
  removed the request property valid
  request-property-removed
Sep 14, 20217ff99630b4321See the full diff
- ○
  endpoint added
  endpoint-added
Jun 29, 2021e95a4da3dd7a1See the full diff
- ▲
  api path removed without deprecation
  api-path-removed-without-deprecation
This revision also has 15 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history