Skip to content

Rename a project

Change a project's name; its slug stays as it was.

Updated

patch

https://cloud.cahaves.com/api/projects/{slug}

Authorization

cahaves.cloud.sessionstringcookierequired

The session cookie Cloud sets when a customer signs in to the console with GitHub or Google. It is HttpOnly, so scripts cannot read it, and there are no API keys or tokens yet.

Path parameters

slugstringrequired

The project's slug. It is fixed when the project is created.

Example: "shop"

Headers

X-Cloud-Organizationstring<uuid>

The id of the organization the request works in, one the signed-in customer owns. Left out or empty, the request works in their oldest organization. Any other value answers 404 with `reason: "organization"`. A customer with no organization yet gets 409 "Create an organization first." from every route that works in one.

Example: "2f6c8e0a-4b1d-4e7f-9a3c-5d7e9f1b3a5c"

Body

application/jsonrequired

namestringrequired

Responses

application/json

The renamed project.

projectobjectrequired

The slug never moves, so every address built from it keeps working after a rename. A name another project in the organization already has, compared without regard to case, is refused with 422. Sending the current name changes nothing.