STstatusstack
Stacks

Create a new stack

Requires a team-scoped API key with the write permission, and consumes stack quota.

post/v1/stacks

Request

  • Base URL
    https://statusstack.com/api
  • Auth
    HTTP bearer

Request body

namestring required
slugstring nullable

Lowercase letters, numbers, dashes and underscores. Generated from name when null or omitted.

descriptionstring nullable
stack_type'application' | 'tech' | 'business' | 'custom' required

The types a stack may be created as. Excludes the legacy status_page.

visibility'public' | 'private' | 'password' | 'unlisted' required

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

passwordstring nullable

Access password for a password-visibility stack.

parent_stack_idstring uuid nullable

Response

Stack created

idstring uuid
namestring
slugstring
descriptionstring nullable
stack_type'application' | 'tech' | 'business' | 'custom' | 'status_page'

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 (StackType::selectableValuesIncluding()).

visibility'public' | 'private' | 'password' | 'unlisted'

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

public_urlstring uri nullable
parent_stack_idstring uuid nullable
sources_countinteger
components_countinteger
created_atstring date-time
updated_atstring date-time
parent_stackStack circular
child_stacksStack[] circular

Changes

No recorded changes to this operation across all 1 revision of this API.