Pause a queue on every instance

POST /ops/queues/{name}/pause

Authorization

bearer

Authorizationheader · stringrequired

Session token from POST /v1/auth/login with "transport": "bearer". Browsers use the session cookie that login sets instead.

Path

namestringrequired

maxLength: 100

Responses

errors: application/problem+json

204

No Content

401

Unauthorized

403

Forbidden

422

Unprocessable Entity

500

Internal Server Error

Match errors on the problem's code, which stays the same, not on its message.

Send a request

Server

Bearer token

name path

The request goes from your browser straight to this server; nothing passes through this site. The API must allow this site's origin for CORS.

Requestexample

curl -X POST "$API_URL/ops/queues/$NAME/pause" \
  -H "Authorization: Bearer $TOKEN"

req, err := http.NewRequestWithContext(ctx, http.MethodPost,
	apiURL + "/ops/queues/" + name + "/pause", nil)
if err != nil {
	return err
}
req.Header.Set("Authorization", "Bearer "+token)
res, err := http.DefaultClient.Do(req)
if err != nil {
	return err
}
defer res.Body.Close()

const res = await fetch(`${apiUrl}/ops/queues/${name}/pause`, {
  method: "POST",
  headers: {
    Authorization: `Bearer ${token}`,
  },
});

Responseexample

{
  "code": "string",
  "status": 401,
  "title": "Unauthorized",
  "detail": "string",
  "request_id": "req_9f86d081884c7d65",
  "type": "string"
}

{
  "code": "string",
  "status": 403,
  "title": "Forbidden",
  "detail": "string",
  "request_id": "req_9f86d081884c7d65",
  "type": "string"
}

{
  "code": "string",
  "status": 422,
  "title": "Unprocessable Entity",
  "detail": "string",
  "errors": [
    {
      "message": "expected length >= 1",
      "location": "body.name"
    }
  ],
  "request_id": "req_9f86d081884c7d65",
  "type": "string"
}