Guide
Authentication
Send an API key with each request. The key's scopes set which endpoints it can call.
Send your API key#
Send all requests to https://api.playit.gg.
All endpoints use POST.
Put your API key in the Authorization header, after the Api-Key prefix:
Authorization: Api-Key YOUR_API_KEYScopes#
Each API key has a list of scopes. A scope gives the key access to one endpoint. The name of the scope is the path of the endpoint.
| Scope | Endpoint |
|---|---|
/firewalls/update | Replace firewall rules |
/firewall/patch | Allow or deny networks |
/tunnels/firewall/assign | Assign a firewall to a tunnel |
One key can have many scopes. Give each key only the scopes that your integration uses.
If the key does not have the scope for an endpoint, the API returns ScopeNotAllowed.
For more information, see Responses and errors.
Accounts#
A key can change only the firewalls and tunnels in its own account. If you send the ID of a firewall or tunnel in a different account, the API returns a "not found" error.
Keep your key secret#
You see the key secret one time only, when you create the key. Anyone with the key can change your firewalls.
Caution
Do not put your API key in source control, issues, or support messages.