Management

Update project

Changed on

Updates an existing project specified by its ID. This endpoint allows you to modify project details such as the project name and the version creation timeout. The versionCreationTimeout can be set to false to disable the timeout or to a number of seconds between 30 and 300. Fields omitted from the request body will not be updated. Requires the write:all scope.

If the project cannot be found, a 404 error response is returned.

post/management/projects/{projectId}

Request

  • Base URL: https://api.liveblocks.io/v2
  • URL: https://api.liveblocks.io/v2/management/projects/{projectId}
  • Auth: none declared

Path parameters

projectIdstring required

ID of the project

Example:683d49ed6b4d1cec5a597b13

Request body

namestring
descriptionstring

Example request

{
  "name": "Updated Project Name",
  "description": "Updated project description",
  "versionCreationTimeout": 60
}

Response

Success. Returns the updated project.

idstring required
teamIdstring required
type'dev' | 'prod' required
namestring required
descriptionstring nullable required
createdAtstring date-time required
updatedAtstring date-time required
region'earth' | 'eu' | 'fedramp' required

The region where the project's data is stored and processed.

Example response

{
  "id": "683d49ed6b4d1cec5a597b13",
  "teamId": "team_123",
  "type": "dev",
  "name": "My Project",
  "createdAt": "2024-09-03T12:34:56.000Z",
  "updatedAt": "2024-09-03T12:34:56.000Z",
  "publicKey": {
    "activated": true,
    "createdAt": "2024-09-03T12:34:56.000Z",
    "value": "pk_dev_123"
  },
  "secretKey": {
    "createdAt": "2024-09-03T12:34:56.000Z",
    "value": "sk_dev_123"
  },
  "region": "earth",
  "versionCreationTimeout": false
}

Changes

  • 48a7e340b8adRevision changes
    • info

      added the new optional request property

    • info

      added the required property to the response with the status

  • 77cd6a75b2b7Revision changes
    • breaking

      request body became required

    • breaking

      request property list-of-types was narrowed by removing types number from media type application/json

    • breaking

      the / request property type changed from number to integer

    • breaking

      removed the required property from the response with the status

    • info

      api operation id post-management-project removed and replaced with update-management-project

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status