PUT /accounts/{account_id}/moq/relays/{relay_id}
Updates a relay's name and/or configuration. Partial updates: omitted fields are preserved. Config sub-objects replace as whole objects when present. origin_fallback and lingering_subscribe are mutually exclusive.
Servers
- https://api.cloudflare.com/client/v4
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
relay_id |
String | Yes |
Relay unique identifier (32 hex characters). |
account_id |
String | Yes |
Cloudflare account identifier. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
name |
String | No | |
config |
Object | No |
origin_fallback and lingering_subscribe are mutually exclusive. |
config.origin_fallback |
Object | No | |
config.origin_fallback.enabled |
Boolean | No |
Default value: false |
config.origin_fallback.urls[] |
Array | No |
Ordered list of upstream origin relay URLs. |
config.lingering_subscribe |
Object | No | |
config.lingering_subscribe.max_timeout_ms |
Integer | No |
Relay-level ceiling on lingering subscribe timeout (ms). Default 30000. Default value: 30000 |
config.lingering_subscribe.enabled |
Boolean | No |
Default value: true |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.