Sign in

v1

latestOpenAPI 3.0.02026-07-14169146300.3 KB
Projects

Gets a specific project that belongs to the authenticated user

get/v1/projects/{ref}

Path parameters

refstring required
Example:abcdefghijklmnopqrst

Project ref

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"
}