Pause Existing Destination

PUT/destinations/{destination_id}/pause

Authorization

AuthorizationBearer token · headerrequired

Path parameters

destination_idstringrequired

Query parameters

waitboolean

When False, return 202 immediately with desired_state set to Pending Pause; the action is applied asynchronously and desired_state becomes Paused once it completes. When True (default), wait for it.

default: true

Responses

200

Successful Response

any

422

Validation Error

detailValidationError[]

Show properties

Array of ValidationError

locstring | integer[]required

Show properties

Array of string | integer

Any of:

string

string

integer

integer

msgstringrequired

typestringrequired

inputany

ctxobject

Request

curl -X PUT 'https://api.streamkap.com/destinations/string/pause' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'

const response = await fetch("https://api.streamkap.com/destinations/string/pause", {
  method: "PUT",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json"
  }
});

import requests

response = requests.put(
    "https://api.streamkap.com/destinations/string/pause",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json"
    },
)

Response

Successful Response

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}