Sign in

v1

latestOpenAPI 3.0.02026-07-14169146300.3 KB
Projects

Create a project

post/v1/projects

Request body

db_passstring required

Database password

namestring required

Name of your project

organization_idstring

Deprecated: Use organization_slug instead.

organization_slugstring required

Organization slug

plan'free' | 'pro'

Subscription Plan is now set on organization level and is ignored in this request

region'us-east-1' | 'us-east-2' | 'us-west-1' | 'us-west-2' | 'ap-east-1' | 'ap-southeast-1' | 'ap-northeast-1' | 'ap-northeast-2' | 'ap-southeast-2' | 'eu-west-1' | 'eu-west-2' | 'eu-west-3' | 'eu-north-1' | 'eu-central-1' | 'eu-central-2' | 'ca-central-1' | 'ap-south-1' | 'sa-east-1'

Region you want your server to reside in. Use region_selection instead.

kps_enabledboolean

This field is deprecated and is ignored in this request

desired_instance_size'nano' | 'micro' | 'small' | 'medium' | 'large' | 'xlarge' | '2xlarge' | '4xlarge' | '8xlarge' | '12xlarge' | '16xlarge' | '24xlarge' | '24xlarge_optimized_memory' | '24xlarge_optimized_cpu' | '24xlarge_high_memory' | '48xlarge' | '48xlarge_optimized_memory' | '48xlarge_optimized_cpu' | '48xlarge_high_memory'

Desired instance size. Omit this field to always default to the smallest possible size.

template_urlstring uri

Template URL used to create the project from the CLI.

high_availabilityboolean

[Experimental] Whether to enable high availability for the project.

Example request

{
  "db_pass": "correct-horse-battery-staple",
  "name": "acme-prod",
  "organization_slug": "tsrqponmlkjihgfedcba",
  "region": "us-east-1"
}

Response

idstring required

Deprecated: Use ref instead.

refstring required

Project ref

organization_idstring required

Deprecated: Use organization_slug instead.

organization_slugstring required

Organization slug

namestring required

Name of your project

regionstring required

Region of your project

created_atstring required

Creation timestamp

status'INACTIVE' | 'ACTIVE_HEALTHY' | 'ACTIVE_UNHEALTHY' | 'COMING_UP' | 'UNKNOWN' | 'GOING_DOWN' | 'INIT_FAILED' | 'REMOVED' | 'RESTORING' | 'UPGRADING' | 'PAUSING' | 'RESTORE_FAILED' | 'RESTARTING' | 'PAUSE_FAILED' | 'RESIZING' required

Example response

{
  "ref": "abcdefghijklmnopqrst",
  "organization_slug": "tsrqponmlkjihgfedcba"
}