---
title: "Pause a Sink"
method: PUT
path: "/data_sinks/{sink_id}/pause"
tags: ["Destinations (Data Sinks)"]
---

# Pause a Sink

`PUT /data_sinks/{sink_id}/pause`

## Request

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

Pause an active data sink.

## Path parameters

- `sink_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

- object
  - `id` integer
  - `owner` Owner
    - `id` integer
    - `full_name` string
    - `email` string, email
  - `org` Org
    - `id` integer
    - `name` string
    - `email_domain` string
    - `email` unknown
    - `client_identifier` unknown
  - `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.
  - `name` string
  - `description` unknown
  - `status` string
  - `data_set_id` integer
  - `data_map_id` unknown
  - `data_source_id` unknown
  - `sink_format` unknown
  - `sink_config` object: The destination configuration properties that were set as `sink_config` in the payload-to-destination create/update API calls.
  - `sink_schedule` unknown
  - `in_memory` boolean
  - `managed` boolean
  - `sink_type` string
  - `connector_type` string
  - `connector` object
    - `id` integer
    - `type` string
    - `connection_type` string
    - `name` string
    - `description` string
    - `nexset_api_compatible` boolean
  - `data_set` object
    - `id` integer
    - `name` string
  - `data_credentials` object
    - `id` integer
    - `name` string
    - `description` string
    - `owner` Owner
      - `id` integer
      - `full_name` string
      - `email` string, email
    - `org` Org
      - `id` integer
      - `name` string
      - `email_domain` string
      - `email` unknown
      - `client_identifier` unknown
    - `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.
    - `credentials_version` string
    - `managed` boolean
    - `credentials_type` string
    - `connector` object
      - `id` integer
      - `type` string
      - `connection_type` string
      - `name` string
      - `description` string
      - `nexset_api_compatible` boolean
    - `api_keys` unknown[]
      - unknown
    - `credentials_non_secure_data` object
    - `verified_status` string
    - `verified_at` string, date-time
    - `copied_from_id` unknown
    - `updated_at` string, date-time
    - `created_at` string, date-time
    - `tags` unknown[]
      - unknown
  - `copied_from_id` unknown
  - `updated_at` string, date-time
  - `created_at` string, date-time
  - `tags` unknown[]
    - unknown
  - `flow_type` string

## Other responses

- `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)