Projects

List all projects

Returns a list of all projects you've previously created.

Use /v1/organizations/{slug}/projects instead when possible to get more precise results and pagination support.

get/v1/projects

Request

  • The document declares no server URL.
  • Auth: one of:
    • HTTP bearer
    • fga_permissions (a scheme the document does not define)

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

[
  {
    "region": "us-east-1",
    "created_at": "2023-03-29T16:32:59Z"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.