Skip to main content

​
API keys

Every request carries an API key. Keys look like XXXXXXX-XXXXXXX-XXXXXX and work across all products your account has access to. Treat them like passwords. Manage keys under API Keys in the dashboard:
  • Create new adds a key.
  • Regenerate replaces a key. The old value stops working immediately.
  • Revoke disables a key for good.

​
Sending the key

Send the key as x-token request metadata.

​
Plan IPs

Plans decide which source IPs can use them. Manage IPs under Plans → Allowed IPs on each product page:
  • Add binds another IP, up to the plan’s limit.
  • Change moves a bound IP to a new address.
  • Remove unbinds an IP.
Changes apply within about a second. A stream that is open from an IP you remove ends with IP_NOT_ALLOWED.
Bind your server’s public IP address as seen from the internet, not a private or internal address.

​
Key access rules

Each key can carry its own rules under Access control on the product page:
  • Allowed IPs and Allowed CIDRs limit which addresses may use the key.
  • Allowed Domains checks the browser’s Origin (or Referer) header, for keys used from web pages.
With no rules set, the key works from any IP its plans allow.

​
Trials and pending plans

A trial request asks for the IP it should be bound to. You can change that IP while the request is awaiting approval; after approval, change it on the plan instead.