[BETA] Update a signal endpoint. | Unleash Documentation

import requests
url = "https://app.unleash-instance.example.com/api/admin/signal-endpoints/id"
payload = { "name": "cpu-over-90" }
headers = {
    "Authorization": "<apiKey>",
    "Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.json())

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

Enterprise feature

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

Updates an existing signal endpoint identified by its id.

Authentication

Authorizationstring

API key needed to access this API

AuthorizationBearer

API key needed to access this API, in Bearer token format

Path parameters

idstringRequired

Request

#/components/schemas/createSignalEndpointSchema

namestringRequired

The signal endpoint name. Must be URL-safe.

enabledbooleanOptional

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

descriptionstring or nullOptional

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

Response

#/components/schemas/signalEndpointSchema

idinteger>=1

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

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

namestring

The signal endpoint name. Must be URL-safe.

createdAtstringformat: "date-time"

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

createdByUserIdinteger

The ID of the user that created this signal endpoint.

descriptionstring or null

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

urlstring or null

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

tokenslist of objects or null

The list of tokens associated with the signal endpoint.

Authentication

Path parameters

Request

Response

Errors