Skip to content
Management API Reference

Create a project

post/v1/projects

OAuth scopes

  • projects:write

The fine-grained token must include the following permissions to access this endpoint:

  • organization_projects_create

Body

  • db_pass
    Required
    string
  • name
    Required
    string
  • organization_id
    Optional
    Deprecatedstring
  • organization_slug
    Required
    string
  • plan
    Optional
    Deprecatedenum
  • region
    Optional
    Deprecatedenum
  • region_selection
    Optional
    one of the following options
  • kps_enabled
    Optional
    Deprecatedboolean
  • desired_instance_size
    Optional
    enum
  • template_url
    Optional
    string
  • release_channel
    Optional
    Deprecatedunknown
  • postgres_engine
    Optional
    Deprecatedunknown
  • high_availability
    Optional
    boolean

Response codes

  • 201
  • 401
  • 403
  • 429

Response (201)

{
  "id": "lorem",
  "ref": "abcdefghijklmnopqrst",
  "organization_id": "lorem",
  "organization_slug": "tsrqponmlkjihgfedcba",
  "name": "lorem",
  "region": "lorem",
  "created_at": "lorem",
  "status": "INACTIVE"
}