Nexsets (Data Sets)

Pause Nexset

Pauses an active Nexset.

put/data_sets/{set_id}/pause

Request

Path parameters

set_idinteger required

The unique ID of the Nexset that needs to be paused.

Headers

Accept'application/vnd.nexla.api.v1+json' | 'application/json'

Setting to application/vnd.nexla.api.v1+json is recommended.

Response

Success

idinteger
namestring
descriptionstring
statusstring
data_source_idinteger nullable

Id of the data source this Nexset was detected from. This is only relevant for detected Nexsets.

access_rolesstring[]

This property reflects all the permissions the user/team/organization has to this resource.

  1. collaborator: The user/team/organization can view the resource but not make any modifications to it.
  2. operator: The user/team/organization can view the resource and can activate/pause it, but not make any other modifications to it.
  3. administrator: The user/team/organization has complete administrative rights to this resource.
  4. owner: This user created the resource and so has complete administrative rights to it.
transform_idinteger nullable

The ID of the Transform entity that has been used to create the output of this Nexset from the parent Nexset.

This element is null for detected Nexsets.

output_schemaobject

JSON schema of this Nexset's output.

copied_from_idinteger

Reference ID of the Nexset that this Nexset was created as a copy of. This is only valid if the Nexset was created by issuing a request to the copy endpoint of another Nexset.

created_atstring date-time
updated_atstring date-time
tagsstring[]
flow_typestring

The flow type of the origin node.

Changes

No recorded changes to this operation across all 1 revision of this API.