Skip to content
RelayDocumentation

API ReferenceEndpoints

Update an endpoint

Change the URL, subscriptions or settings of an endpoint, or pause and resume it.

PATCH/v1/endpoints/{endpoint_id}

Only the fields you send are changed.

Body parameters

urlstring
A new URL. Deliveries in progress finish on the old one.
eventsstring[]
Replaces the whole list of subscribed types.
statusstring
enabled or paused. Re-enabling a disabled endpoint also resets its failure count.
filterstring | null
A new filter, or null to remove it.
rate_limitinteger | null
A new limit, or null to remove it.
metadataobject
Merged with the existing metadata. Set a key to null to delete it.

Request

curl -X PATCH https://api.relay.dev/v1/endpoints/ep_2kq8XcV1 \
  -H "Authorization: Bearer $RELAY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "status": "paused" }'

Response

Returns the updated endpoint object, without the secret.