dungeonAPI Reference

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

square-downDownload openapi [v2] square-downDownload openapi [v1]

circle-info

Authentication Token

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

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

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

triangle-exclamation
circle-check

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"],
  "pagination": {
    "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:

circle-info

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

Last updated

Was this helpful?