Identifiers
The ids used in paths, what each one names and how unknown ids are answered.
Most ids are whole numbers, and a few are text: a log export's id, a database statement's id, an invoice link's token. Where an id is a whole number, a path with anything else in its place answers 404.
What each id names
| Path parameter | Names | Where to find it |
|---|---|---|
{site} | One site row: a website's production site, or one of its environments. Each has its own id | GET /corestack/sites |
{cluster} | A CoreCluster | GET /corestack/overview, or cluster on a site |
{snapshot} | A snapshot of one site row | GET / |
{operation} | A change in progress or finished | The answer of the request that started it |
{company} | A company you belong to or manage | GET /companies |
{website}, {environment} | A CoreStack Enterprise website and its environment. Different numbers from {site} | GET /websites |
{user} | A login or person; the endpoint says which | The list beside it |
A staging environment is its own {site}. Use the environment's own id to read or change it.
Every path parameter
What each path parameter of this reference is made of. A name that appears twice is a whole number on some endpoints and text on others; the endpoint's reference page says which.
The whole table
61
| Path parameter | Made of |
|---|---|
{agency} | Whole number |
{announcement} | Whole number |
{attachment} | Whole number |
{audit} | Whole number |
{changeRequest} | Whole number |
{client} | Whole number |
{cluster} | Whole number |
{company} | Whole number |
{connection} | Whole number |
{copy} | Whole number |
{demo} | Whole number |
{deployment} | Whole number |
{environment} | Whole number |
{id} | Whole number |
{member} | Whole number |
{name} | Text |
{operation} | Whole number |
{provider} | One of github, gitlab, bitbucket |
{referral} | Whole number |
{repository} | Whole number |
{secret} | Whole number |
{site} | Whole number |
{snapshot} | Whole number |
{subscriber} | Whole number |
{ticket} | Whole number |
{upload} | UUID |
{user} | Whole number |
{website} | Whole number |
{key} | Whole number |
{function} | Text matching ^[a-z0-9_]+$ |
{attention} | Text matching ^[a-z_]+:[0-9]+(?::[^/]+)?$ |
{invoice} | Whole number |
{number} | Text matching ^[A-Za-z0-9-]+$ |
{token} | Text matching ^[A-Za-z0-9_-]{1,64}$ |
{queued} | Whole number |
{rule} | Whole number |
{username} | Text |
{config} | One of production, uat |
{platform} | Text matching ^[a-z0-9_]{1,32}$ |
{stage} | One of build, database, post_deploy, settings, all |
{binding} | Whole number |
{name} | Text matching ^[A-Za-z_][A-Za-z0-9_]{0,63}$ |
{rehearsal} | Whole number |
{stage} | One of build, database, post_deploy |
{version} | Whole number |
{domain} | Text matching ^[A-Za-z0-9.-]{1,253}$ |
{command} | Whole number |
{revision} | Whole number |
{entry} | Whole number |
{subscription} | Whole number |
{change} | Whole number |
{download} | Text matching ^[0-9A-HJKMNP-TVW-Z]{26}$ |
{field} | Text matching ^[A-Za-z0-9_.:@-]+$ |
{query} | Whole number |
{conversion} | UUID |
{test} | Whole number |
{version} | Text matching ^[0-9]+\.[0-9]+$ |
{item} | Whole number |
{device} | Text |
{session} | Whole number |
{number} | Whole number |
Unknown and hidden ids
An id that does not exist and an id of something you cannot see answer the same body, so an answer never shows which ids exist elsewhere.
{
"message": "Not found."
}Attention items
An attention item's id is text in the form kind:number, sometimes with a third part, such as site_down:1042. URL-encode it in a path.