Update a relay

moq.relays.update(, ) -> RelayUpdateResponse

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.

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

ParametersExpand Collapse

account_id: str

Cloudflare account identifier.

relay_id: str

config: Optional[Config]

origin_fallback and lingering_subscribe are mutually exclusive.

lingering_subscribe: Optional[ConfigLingeringSubscribe]

enabled: Optional[bool]

max_timeout_ms: Optional[int]

Relay-level ceiling on lingering subscribe timeout (ms). Default 30000.

maximum300000

minimum0

origin_fallback: Optional[ConfigOriginFallback]

enabled: Optional[bool]

origins: Optional[Iterable[ConfigOriginFallbackOrigin]]

Ordered list of upstream origin relays. Each entry is an object (not a bare string) so per-origin configuration can be added in the future without another breaking change.

url: Optional[str]

Upstream origin relay URL.

name: Optional[str]

ReturnsExpand Collapse

class RelayUpdateResponse: …

Full relay details (no tokens).

config: Config

origin_fallback and lingering_subscribe are mutually exclusive.

lingering_subscribe: Optional[ConfigLingeringSubscribe]

enabled: Optional[bool]

max_timeout_ms: Optional[int]

Relay-level ceiling on lingering subscribe timeout (ms). Default 30000.

maximum300000

minimum0

origin_fallback: Optional[ConfigOriginFallback]

enabled: Optional[bool]

origins: Optional[List[ConfigOriginFallbackOrigin]]

Ordered list of upstream origin relays. Each entry is an object (not a bare string) so per-origin configuration can be added in the future without another breaking change.

url: Optional[str]

Upstream origin relay URL.

created: datetime

formatdate-time

modified: datetime

formatdate-time

name: str

uid: str

status: Optional[Literal["connected"]]

“connected” when active, omitted otherwise.

Update a relay

import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
relay = client.moq.relays.update(
    relay_id="a1b2c3d4e5f67890a1b2c3d4e5f67890",
    account_id="023e105f4ecef8ad9ca31a8372d0c353",
)
print(relay.uid)

{
  "errors": [
    {
      "code": 0,
      "message": "message"
    }
  ],
  "messages": [
    {
      "code": 0,
      "message": "message"
    }
  ],
  "success": true,
  "result": {
    "config": {
      "lingering_subscribe": {
        "enabled": true,
        "max_timeout_ms": 0
      },
      "origin_fallback": {
        "enabled": true,
        "origins": [
          {
            "url": "url"
          }
        ]
      }
    },
    "created": "2019-12-27T18:11:19.117Z",
    "modified": "2019-12-27T18:11:19.117Z",
    "name": "Production Live Stream",
    "uid": "a1b2c3d4e5f67890a1b2c3d4e5f67890",
    "status": "connected"
  }
}

Returns Examples

{
  "errors": [
    {
      "code": 0,
      "message": "message"
    }
  ],
  "messages": [
    {
      "code": 0,
      "message": "message"
    }
  ],
  "success": true,
  "result": {
    "config": {
      "lingering_subscribe": {
        "enabled": true,
        "max_timeout_ms": 0
      },
      "origin_fallback": {
        "enabled": true,
        "origins": [
          {
            "url": "url"
          }
        ]
      }
    },
    "created": "2019-12-27T18:11:19.117Z",
    "modified": "2019-12-27T18:11:19.117Z",
    "name": "Production Live Stream",
    "uid": "a1b2c3d4e5f67890a1b2c3d4e5f67890",
    "status": "connected"
  }
}