projects

Rename a project (owner/admin)

patch/v1/projects/{project_id}

Request

  • Base URL: https://api.wavehouse.cloud
  • URL: https://api.wavehouse.cloud/v1/projects/{project_id}
  • Auth: one of:
    • API key in cookie whc_session
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

project_idstring required

Request body

namestring required

the project's new display name

Response

OK

created_atstring date-time required
default_rolestring required

policy role for roleless requests (the 'public' access level); empty = locked

deletion_grace_secondsinteger required

how long a deletion scheduled now keeps the project's data before destroying it; cancellable until then

destroy_afterstring date-time

instant a scheduled deletion becomes due; present only while status is deleting or destroying

namestring required
org_idstring required

the org that owns the project

project_idstring required
provisioning_failedboolean

setting this project up did not finish and nothing is retrying it; POST .../provision resumes it from where it stopped

statusstring required

pending | provisioning | active | suspended | deleting (scheduled, cancellable until destroy_after) | destroying (the teardown has begun and can no longer be cancelled)

writes_pausedboolean

writes are paused for maintenance and resume on their own; reads, the id, credentials and policy are unaffected

Changes

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