[BETA] Create a signal endpoint. | Unleash Documentation

Enterprise feature

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

Creates a new signal endpoint.

Enterprise feature

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

Creates a new signal endpoint.

Authentication

Authorizationstring

API key needed to access this API

AuthorizationBearer

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

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 headers

locationstring

The location of the newly created resource.

Response

The resource was successfully created.

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

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

The list of tokens associated with the signal endpoint.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

415

Unsupported Media Type Error

API key needed to access this API

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

#/components/schemas/createSignalEndpointSchema

The signal endpoint name. Must be URL-safe.

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

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

The location of the newly created resource.

The resource was successfully created.

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.

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

The signal endpoint name. Must be URL-safe.

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

The ID of the user that created this signal endpoint.

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

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

The list of tokens associated with the signal endpoint.

$	curl -X POST https://app.unleash-instance.example.com/api/admin/signal-endpoints \
>	-H "Authorization: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"name": "cpu-over-90"
>	}'

1	{
2	"id": 7,
3	"enabled": true,
4	"name": "cpu-over-90",
5	"createdAt": "2023-12-27T13:37:00+01:00",
6	"createdByUserId": 1337,
7	"description": "Notifies when CPU usage is over 90%.",
8	"url": "https://app.unleash-hosted.com/my-instance/signal-endpoint/cpu-over-90",
9	"tokens": [
10	{
11	"id": 7,
12	"name": "My external app #1",
13	"signalEndpointId": 1337,
14	"createdAt": "2023-12-27T13:37:00+01:00",
15	"createdByUserId": 1337,
16	"token": "signal_xyzrandomstring"
17	}
18	]
19	}

$	curl -X POST https://app.unleash-instance.example.com/api/admin/signal-endpoints \
>	-H "Authorization: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"name": "cpu-over-90"
>	}'

1	{
2	"id": 7,
3	"enabled": true,
4	"name": "cpu-over-90",
5	"createdAt": "2023-12-27T13:37:00+01:00",
6	"createdByUserId": 1337,
7	"description": "Notifies when CPU usage is over 90%.",
8	"url": "https://app.unleash-hosted.com/my-instance/signal-endpoint/cpu-over-90",
9	"tokens": [
10	{
11	"id": 7,
12	"name": "My external app #1",
13	"signalEndpointId": 1337,
14	"createdAt": "2023-12-27T13:37:00+01:00",
15	"createdByUserId": 1337,
16	"token": "signal_xyzrandomstring"
17	}
18	]
19	}