Skip to main content
GET
List all stacks

Authorizations

Authorization
string
header
required

StatusStack authenticates requests with API keys, created via the dashboard with granular permissions (read, write, delete, admin, *).

API keys support version compatibility:

  • v1 keys: Can only access v1 endpoints
  • v2 keys: Can access both v1 and v2 endpoints

Available permissions:

  • read: View resources (GET requests)
  • write: Create and update resources (POST, PUT requests)
  • delete: Delete resources (DELETE requests)
  • admin: Administrative access to all resources
  • *: Wildcard permission (all actions allowed)

Query Parameters

page
integer
Required range: x >= 1
per_page
integer
default:15
Required range: 1 <= x <= 100
stack_type
enum<string>

What the stack groups together, as stored. status_page is legacy: it is never selectable on create, and on update it is accepted only when it is already the stack's current type.

Available options:
application,
tech,
business,
custom,
status_page
visibility
enum<string>

Who may view the stack's public page. password requires a password on the create/update request.

Available options:
public,
private,
password,
unlisted

Case-insensitive match against name or slug.

order_by
enum<string>
default:created_at
Available options:
created_at,
updated_at,
name,
slug
order_dir
enum<string>
default:desc
Available options:
asc,
desc

Response

Paginated list of stacks

data
object[]
meta
object