API Reference

Get access to management functions for your Edgegap resources using HTTP requests.

Download the full openAPI specification of Edgegap API.

If you need help, please reach out to us over Discord. For live games support see our ticketing system.

Authentication Token

Generate (and view) your secret tokens for Edgegap API in Dashboard - User Settings / Tokens.

Add your secret token with each API request as an HTTP header (include the word token):

Authorization: token xxxxxxxx-e458-4592-b607-c2c28afd8b62

Do not integrate Edgegap API endpoints in game client, as your API token provides unlimited access to your account. See Matchmaking for secure client-facing API endpoints and functions.

In case your secret tokens are compromised, delete them, and update organization member passwords.

Response Pagination

In case a response would contain too many items, we return a subset of data with pagination info:

{
  "count": 100,
  "data": ["foo-0", "[...]", "bar-9"],
  "": {
    "number": 1,
    "next_page_number": 2,
    "previous_page_number": null
    "paginator": {
      "num_pages": 10
    },
    "has_next": true,
    "has_previous": false
  }
}

For paginated response, use parameters page and limit to retrieve more results:

• second page: https://api.edgegap.com/v1/apps?page=2

• more results: https://api.edgegap.com/v1/apps?limit=20

• combined: https://api.edgegap.com/v1/apps?page=2&limit=20

Rate Limiting

To ensure platform stability and prevent surprise invoices, we rate limit your organization's API usage:

• Deployments at 40 requests per second,

• Context & Status at 10 requests per second.

Contact us to plan releases, run load tests, estimate launch traffic, and prepare for success.

See Getting Started for your first steps with Matchmaker, game integration, and detailed examples.