Set or rotate the shared password

PUT

/status-pages/{id}/shared-password

const url = 'https://api.perstat.io/status-pages/example/shared-password';
const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"password":"example"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request PUT \
  --url https://api.perstat.io/status-pages/example/shared-password \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "password": "example" }'

Sets or rotates the shared password of a status page. The password must be at least 12 characters and is stored only as a hash; rotation immediately invalidates all existing shared access sessions. Setting the password is separate from enabling the shared-password access mode in the page settings. Accepts API keys with the status-pages:write scope, subject to current role and resource grants.

Authorizations

bearer

Parameters

Path Parameters

required

string

Request Body^required

application/json

object

password

required

Klartext-Kennwort (min. 12 Zeichen). Wird Argon2-gehasht; at rest liegt nur der Hash. Wird NIE im DTO zurückgegeben.

string

Example^generated

{
  "password": "example"
}

Responses

204

Request succeeded. The response has no body.

400

Kennwort < 12 Zeichen

401

Authentication is missing or invalid.

403

The authenticated caller does not have permission to perform this operation.

404

No accessible resource matches the supplied identifier.