Glossary
Look up the terms the Azion API uses, from personal tokens and workspace paths to pagination, field selection, and rate limit headers.
This glossary defines the terms that the Azion API uses in its paths, query parameters, and response headers.
| Term | Definition |
|---|---|
| API v4 | The version of the Azion API served at https://api.azion.com/v4, which the Azion API pages document. An account moves to it from API v3 through the Transition to API v4, and Verify your account’s API version shows how to check an account. |
fields | A query parameter that takes a comma-separated list of the field names to include in the response. On a list, fields=id,name returns each result with its id and name only. List and retrieve operations take it, and nested fields use dot notation, as the Azion API reference describes. |
ordering | A query parameter that names the field that sorts a list, such as ordering=name. A - before the field name sorts in descending order, as in ordering=-id. List operations take it, as the Azion API reference describes. |
page | A query parameter that picks one page of a list, counted from 1. List operations take it, as the Azion API reference describes. The list response gives the number of pages in total_pages, and a page past the last one returns 404. |
page_size | A query parameter that sets how many results one page of a list holds, 10 by default and 100 at most, as Azion API describes. A value above 100 returns 400. |
| personal token | The credential that authenticates your calls to the Azion API and your Azion CLI commands, shown only once, when you create it. The API reads it from the Authorization header as Token [TOKEN VALUE] and also accepts the Bearer prefix. Manage personal tokens creates and revokes them. |
| rate limit scope | The X-RateLimit-Scope response header, which every authenticated Azion API response carries with the value global-default. It comes with X-RateLimit-Limit set to 200, X-RateLimit-Remaining, and X-RateLimit-Reset, as Azion API describes. |
search | A query parameter that takes a search term, per the Azion API reference, and narrows a list to the matching results. On GET /v4/workspace/workloads, search=astro returns the workloads whose names contain astro. |
workspace | The path segment that holds the resource endpoints of Azion API v4, such as /v4/workspace/workloads and /v4/workspace/network_lists. Authentication operations sit under /v4/account/ instead. Azion API quickstart calls both of these workspace paths. |