Sign in

v7

latestOpenAPI 3.0.3raw.githubusercontent.com2026-08-013764062.2 MB
Operational

[BETA] Disables a signal endpoint.

Enterprise feature

[BETA] This API is in beta state, which means it may change or be removed in the future.

Disables an existing signal endpoint, identified by its id.

post/api/admin/signal-endpoints/{id}/off

Path parameters

idstring required

Response

#/components/schemas/signalEndpointSchema

idinteger required

The signal endpoint's ID. Signal endpoint IDs are incrementing integers. In other words, a more recently created signal endpoint will always have a higher ID than an older one.

enabledboolean required

Whether the signal endpoint is currently enabled. If not specified, defaults to true.

namestring required

The signal endpoint name. Must be URL-safe.

descriptionstring nullable

A more detailed description of the signal endpoint and its intended use.

createdAtstring date-time required

The date and time of when the signal endpoint was created.

createdByUserIdinteger required

The ID of the user that created this signal endpoint.

urlstring

The full URL that should be used to call the signal endpoint. This property is only returned for newly created or updated signal endpoints.

Example response

{
  "id": 7,
  "enabled": true,
  "name": "cpu-over-90",
  "description": "Notifies when CPU usage is over 90%.",
  "createdAt": "2023-12-27T13:37:00+01:00",
  "createdByUserId": 1337,
  "url": "https://app.unleash-hosted.com/my-instance/signal-endpoint/cpu-over-90",
  "tokens": [
    {
      "id": 7,
      "token": "signal_xyzrandomstring",
      "name": "My external app #1",
      "signalEndpointId": 1337,
      "createdAt": "2023-12-27T13:37:00+01:00",
      "createdByUserId": 1337
    }
  ]
}