Sign in
Management

Create project

Changed on

Creates a new project within your account. This endpoint requires the write:all scope. You can specify the project type, name, region, and version creation timeout. Upon success, returns information about the newly created project, including its ID, keys, region, and settings.

post/management/projects

Request

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

Request body

namestring
descriptionstring
type'dev' | 'prod' required
region'earth' | 'eu' | 'fedramp'

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

Example request

{
  "name": "My Project",
  "description": "Project description",
  "type": "dev",
  "region": "earth",
  "versionCreationTimeout": false
}

Response

Success. Returns the created 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