Publish or change a project's status page.

PUT

/api/v1/projects/{project}/status-page

curl --request PUT \
  --url https://example.com/api/v1/projects/example/status-page \
  --header 'Content-Type: application/json' \
  --data '{ "slug": "shop", "title": "Shop", "enabled": true, "environments": [ "example" ] }'

Parameters

Path Parameters

project

required

string

Project name

Request Body^required

Media typeapplication/json

object

slug

required

string

Example

shop

title

required

string

Example

Shop

enabled

boolean

environments

required

The environments whose apps the page lists.

Array<string>

Responses

200

Media typeapplication/json

object

slug

required

string

title

required

string

enabled

required

boolean

environments

required

Array<string>

path

required

Where the page is served: /status/<slug> on the console’s address.

string

updatedBy

required

string

updatedAt

required

string

Example^generated

{
  "slug": "example",
  "title": "example",
  "enabled": true,
  "environments": [
    "example"
  ],
  "path": "example",
  "updatedBy": "example",
  "updatedAt": "example"
}

409

The slug is taken

Media typeapplication/json

Problem Details body.

object

code

required

Stable machine-readable code, e.g. forbidden.

string

title

required

Short human readable title.

string

status

required

HTTP status.

integer format: int32

detail

Details, if safe to expose.

string | null

Example

{
  "code": "forbidden"
}

422

Media typeapplication/json

Problem Details body.

object

code

required

Stable machine-readable code, e.g. forbidden.

string

title

required

Short human readable title.

string

status

required

HTTP status.

integer format: int32

detail

Details, if safe to expose.

string | null

Example

{
  "code": "forbidden"
}