Skip to main content
GET
Get a specific stack

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)

Path Parameters

stack_id
string<uuid>
required

Response

Stack details

id
string<uuid>
name
string
slug
string
description
string | null
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
public_url
string<uri> | null
theme
enum<string>
default:auto

Colour scheme of the public page. auto follows the viewer's system preference.

Available options:
auto,
light,
dark
layout
enum<string>
default:grid

How components are arranged on the public page.

Available options:
grid,
list,
compact
custom_logo_url
string<uri> | null
refresh_interval
integer
default:30

How often the public page auto-refreshes, in seconds.

Required range: 10 <= x <= 300
show_timestamps
boolean
show_component_names
boolean
show_incident_history
boolean
incident_history_days
integer | null
metadata
object | null
settings
object | null
view_count
integer
subscriber_count
integer
health_percentage
number<float>

Only present on responses that computed it, such as /v1/stacks/{stack_id}/health.

sources_count
integer

Present on list responses and on create/update, which load counts rather than full relationships.

components_count
integer
active_subscribers_count
integer
team_id
string<uuid>
parent_stack_id
string<uuid> | null
created_at
string<date-time>
updated_at
string<date-time>
deleted_at
string<date-time> | null
team
object

The owning team. Included only for a viewer who may update the stack, so an unauthorised viewer never sees it.

parent_stack
any
child_stacks
array
sources
object[]
components
object[]