---
title: "Pause endpoint"
method: PUT
path: "/v1/projects/{projectID}/endpoints/{endpointID}/pause"
tags: ["Endpoints"]
---

# Pause endpoint

`PUT /v1/projects/{projectID}/endpoints/{endpointID}/pause`

Toggles an endpoint's status between active and paused states

## Path parameters

- `projectID` string, required
- `endpointID` string, required

## Response `202`

Accepted

- object
  - `message` string
  - `status` boolean
  - `data` ModelsEndpointResponse
    - `advanced_signatures` boolean
    - `authentication` DatastoreEndpointAuthentication
      - `api_key` DatastoreApiKey
        - `header_name` string
        - `header_value` string
      - `type` 'api_key'
    - `created_at` string
    - `deleted_at` string
    - `description` string
    - `events` integer
    - `failure_rate` number
    - `http_timeout` integer
    - `name` string
    - `owner_id` string
    - `project_id` string
    - `rate_limit` integer
    - `rate_limit_duration` integer
    - `secrets` DatastoreSecret[]
      - `created_at` string
      - `deleted_at` string
      - `expires_at` string
      - `uid` string
      - `updated_at` string
      - `value` string
    - `slack_webhook_url` string
    - `status` 'active' | 'inactive' | 'pending' | 'paused'
    - `support_email` string
    - `uid` string
    - `updated_at` string
    - `url` string

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `404` — Not Found

## Changes

- **2024-10-23** (v3) `de665d0e2fc3` — 1 info
  - added the optional property `allOf[subschema #2]/data/failure_rate` to the response with the `202` status
- **2024-07-15** (v3) `f48524f80fda` — 1 breaking, 1 info
  - removed the success response with the status `200`
  - added the success response with the status `202`
- **2024-03-26** (v3) `28d285e4302c` — 6 warning, 3 info
  - removed the optional property `allOf[#/components/schemas/util.ServerResponse]/data` from the response with the `200` status
  - removed the optional property `allOf[#/components/schemas/util.ServerResponse]/data` from the response with the `400` status
  - removed the optional property `allOf[#/components/schemas/util.ServerResponse]/data` from the response with the `401` status
  - removed the optional property `allOf[#/components/schemas/util.ServerResponse]/data` from the response with the `404` status
  - …5 more
- **2024-01-30** (v3) `a138f74e9d23` — 2 breaking
  - the `allOf[subschema #2]/data/http_timeout` response's property type/format changed from `string`/`` to `integer`/`` for status `200`
  - the `allOf[subschema #2]/data/rate_limit_duration` response's property type/format changed from `string`/`` to `integer`/`` for status `200`

[Change history](https://skmtc.dev/getconvoy/apis/convoy-api-reference/changes/v1/projects/:projectID/endpoints/:endpointID/pause/put.md)

---

[API](https://skmtc.dev/getconvoy/apis/convoy-api-reference.md) · [All operations](https://skmtc.dev/getconvoy/apis/convoy-api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/getconvoy/convoy-api-reference/revisions/de665d0e2fc3/schema)