---
title: "Pause Nexset"
method: PUT
path: "/data_sets/{set_id}/pause"
tags: ["Nexsets (Data Sets)"]
---

# Pause Nexset

`PUT /data_sets/{set_id}/pause`

## Request

- Base URL: `https://dataops.nexla.io/nexla-api`
- URL: `https://dataops.nexla.io/nexla-api/data_sets/{set_id}/pause`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/nexla/apis/nexla-rest-api/docs/data_sets/:set_id/pause/put.ts> (a function with typed inputs; its response is checked against the schema)

Pauses an active Nexset.

## Path parameters

- `set_id` integer, required

## Headers

- `Accept` 'application/vnd.nexla.api.v1+json' | 'application/json': Setting to `application/vnd.nexla.api.v1+json` is recommended.

## Response `200`

Success

- DataSet
  - `id` integer
  - `owner` UserSimplified
    - `id` integer
    - `full_name` string
    - `email` string
    - `email_verified_at` string, date-time
  - `org` OrgSimplified
    - `id` integer
    - `name` string
    - `email_domain` string
    - `email` string
    - `client_identifier` string
    - `org_webhook_host` string
  - `name` string
  - `description` string
  - `status` string
  - `data_source_id` integer, nullable: Id of the data source this Nexset was detected from. This is only relevant for detected Nexsets.
  - `data_source` DataSource
    - `id` integer
    - `owner_id` integer
    - `org_id` integer
    - `name` string
    - `description` string, nullable
    - `status` string
    - `source_type` string
    - `connector` object
      - `id` integer
      - `type` string
      - `connection_type` string
      - `name` string
      - `description` string
      - `nexset_api_compatible` boolean
    - `vendor_id` string, nullable
  - `parent_data_sets` DataSetBrief[]: Details about the Nexset this Nexset is derived from. This element is empty in case of detected Nexsets and has 1 item in case of derived Nexsets.
    - `id` integer
    - `owner_id` integer
    - `org_id` integer
    - `name` string
    - `description` string
    - `created_at` string, date-time
    - `updated_at` string, date-time
  - `data_sinks` DataSinkSimplified[]: Details about every data sink this Nexset is directly connected to.
    - `id` integer
    - `owner_id` integer
    - `org_id` integer
    - `name` string
    - `status` string
    - `sink_type` string
  - `access_roles` string[]: 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_id` integer, 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_schema` object: JSON schema of this Nexset's output.
  - `copied_from_id` integer: 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_at` string, date-time
  - `updated_at` string, date-time
  - `tags` string[]
  - `flow_type` string: The flow type of the origin node.

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found

---

[API](https://skmtc.dev/nexla/apis/nexla-rest-api.md) - [All operations](https://skmtc.dev/nexla/apis/nexla-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/nexla/apis/nexla-rest-api/revisions/ef02be92fe7b?raw)