Convex · Schema

CreateProjectRequest

BackendDatabaseFunctionsReal-TimeReactiveServerlessTypeScript

Properties

Name Type Description
name string Display name for the new project.
team_id integer ID of the team to create the project in.
deployment_region string Cloud region for the initial production deployment. If omitted, no initial deployment is created.
deployment_class string Compute class for the initial production deployment.
View JSON Schema on GitHub

JSON Schema

convex-createprojectrequest-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CreateProjectRequest",
  "title": "CreateProjectRequest",
  "type": "object",
  "required": [
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "Display name for the new project."
    },
    "team_id": {
      "type": "integer",
      "format": "int64",
      "description": "ID of the team to create the project in."
    },
    "deployment_region": {
      "type": "string",
      "description": "Cloud region for the initial production deployment. If omitted, no initial deployment is created.",
      "enum": [
        "aws-us-east-1",
        "aws-eu-west-1"
      ]
    },
    "deployment_class": {
      "type": "string",
      "description": "Compute class for the initial production deployment.",
      "enum": [
        "s16",
        "s256",
        "d1024"
      ]
    }
  }
}