---
title: "Disable a destination"
method: PUT
path: "/destinations/{id}/archive"
tags: ["Destinations"]
---

# Disable a destination

`PUT /destinations/{id}/archive`

This endpoint disables a destination. A disabled destination will no longer deliver any events.

## Path parameters

- `id` string, required — Destination ID

## Response `200`

A single destination

- Destination — Associated [Destination](#destination-object) object
  - `id` string, required — ID of the destination
  - `name` string, required — A unique, human-friendly name for the destination
  - `description` string, nullable — Description of the destination
  - `team_id` string, required — ID of the project
  - `type` 'HTTP' | 'CLI' | 'MOCK_API', required — Type of the destination
  - `config` union — Configuration object for the destination type
    - object — The type config for HTTP. Requires type to be `HTTP`.
      - `url` string, URL, required
      - `rate_limit` number, float, nullable
      - `rate_limit_period` 'second' | 'minute' | 'hour' | 'concurrent', nullable
      - `delivery_groups` DestinationDeliveryGroups, nullable — Delivery groups configuration for this destination
        - `key` string, required — Payload field path used to compute the delivery group, e.g. `body.customer_id`. Scalar values group as-is (non-scalar values are JSON-serialized); events where the path does not resolve group under `__unknown__`.
        - `rate_limit` integer, nullable — Default delivery rate limit per group.
        - `rate_limit_period` 'second' | 'minute' | 'hour', nullable — Default delivery rate limit period per group
        - `overrides` object, nullable — Delivery rate limit overrides keyed by computed delivery group
      - `path_forwarding_disabled` boolean
      - `http_method` 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE', nullable
      - `auth_type` 'HOOKDECK_SIGNATURE' | 'CUSTOM_SIGNATURE' | 'BASIC_AUTH' | 'API_KEY' | 'BEARER_TOKEN' | 'OAUTH2_CLIENT_CREDENTIALS' | 'OAUTH2_AUTHORIZATION_CODE' | 'AWS_SIGNATURE' | 'GCP_SERVICE_ACCOUNT', nullable
      - `auth` union
        - object
        - object
          - `key` string
          - `signing_secret` string
        - object
          - `username` string
          - `password` string
        - object
          - `key` string
          - `api_key` string
          - `to` 'header' | 'query'
        - object
          - `token` string
        - object
          - `auth_server` string
          - `client_id` string
          - `client_secret` string
          - `scope` string
          - `authentication_type` 'basic' | 'bearer' | 'x-www-form-urlencoded'
        - object
          - `auth_server` string
          - `client_id` string
          - `client_secret` string
          - `refresh_token` string
          - `scope` string
        - object
          - `access_key_id` string
          - `secret_access_key` string
          - `region` string
          - `service` string
        - object
          - `service_account_key` string
          - `scope` string, nullable
        - object, nullable
    - object — The type config for CLI. Requires type to be `CLI`.
      - `path` string, required — Path for the CLI destination
      - `path_forwarding_disabled` boolean
      - `http_method` 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE', nullable
      - `auth_type` 'HOOKDECK_SIGNATURE' | 'CUSTOM_SIGNATURE' | 'BASIC_AUTH' | 'API_KEY' | 'BEARER_TOKEN' | 'OAUTH2_CLIENT_CREDENTIALS' | 'OAUTH2_AUTHORIZATION_CODE' | 'AWS_SIGNATURE' | 'GCP_SERVICE_ACCOUNT', nullable
      - `auth` union
        - object
        - object
          - `key` string
          - `signing_secret` string
        - object
          - `username` string
          - `password` string
        - object
          - `key` string
          - `api_key` string
          - `to` 'header' | 'query'
        - object
          - `token` string
        - object
          - `auth_server` string
          - `client_id` string
          - `client_secret` string
          - `scope` string
          - `authentication_type` 'basic' | 'bearer' | 'x-www-form-urlencoded'
        - object
          - `auth_server` string
          - `client_id` string
          - `client_secret` string
          - `refresh_token` string
          - `scope` string
        - object
          - `access_key_id` string
          - `secret_access_key` string
          - `region` string
          - `service` string
        - object
          - `service_account_key` string
          - `scope` string, nullable
        - object, nullable
    - object — The type config for MOCK_API. Requires type to be `MOCK_API`.
      - `rate_limit` number, float, nullable
      - `rate_limit_period` 'second' | 'minute' | 'hour' | 'concurrent', nullable
      - `delivery_groups` DestinationDeliveryGroups, nullable — Delivery groups configuration for this destination
        - `key` string, required — Payload field path used to compute the delivery group, e.g. `body.customer_id`. Scalar values group as-is (non-scalar values are JSON-serialized); events where the path does not resolve group under `__unknown__`.
        - `rate_limit` integer, nullable — Default delivery rate limit per group.
        - `rate_limit_period` 'second' | 'minute' | 'hour', nullable — Default delivery rate limit period per group
        - `overrides` object, nullable — Delivery rate limit overrides keyed by computed delivery group
      - `path_forwarding_disabled` boolean
      - `http_method` 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE', nullable
      - `auth_type` 'HOOKDECK_SIGNATURE' | 'CUSTOM_SIGNATURE' | 'BASIC_AUTH' | 'API_KEY' | 'BEARER_TOKEN' | 'OAUTH2_CLIENT_CREDENTIALS' | 'OAUTH2_AUTHORIZATION_CODE' | 'AWS_SIGNATURE' | 'GCP_SERVICE_ACCOUNT', nullable
      - `auth` union
        - object
        - object
          - `key` string
          - `signing_secret` string
        - object
          - `username` string
          - `password` string
        - object
          - `key` string
          - `api_key` string
          - `to` 'header' | 'query'
        - object
          - `token` string
        - object
          - `auth_server` string
          - `client_id` string
          - `client_secret` string
          - `scope` string
          - `authentication_type` 'basic' | 'bearer' | 'x-www-form-urlencoded'
        - object
          - `auth_server` string
          - `client_id` string
          - `client_secret` string
          - `refresh_token` string
          - `scope` string
        - object
          - `access_key_id` string
          - `secret_access_key` string
          - `region` string
          - `service` string
        - object
          - `service_account_key` string
          - `scope` string, nullable
        - object, nullable
  - `disabled_at` string, date-time, nullable, required — Date the destination was disabled
  - `updated_at` string, date-time, required — Date the destination was last updated
  - `created_at` string, date-time, required — Date the destination was created

## Other responses

- `404` — Not Found

---

[API](https://skmtc.net/hookdeck/apis/hookdeck-admin-rest-api.md) · [All operations](https://skmtc.net/hookdeck/apis/hookdeck-admin-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/hookdeck/hookdeck-admin-rest-api/versions/31da4ed27d31/schema)