Skip to content

Gets a specific project that belongs to the authenticated user

get/v1/projects/{ref}

OAuth scopes

  • projects:read

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

  • project_admin_read

Path parameters

  • ref
    Required
    string

    Project ref

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

Response (200)

{
"id": "lorem",
"ref": "abcdefghijklmnopqrst",
"organization_id": "lorem",
"organization_slug": "tsrqponmlkjihgfedcba",
"name": "lorem",
"region": "lorem",
"created_at": "lorem",
"status": "INACTIVE",
"database": {
"host": "lorem",
"version": "lorem",
"postgres_engine": "lorem",
"release_channel": "lorem"
}
}
{
"type": "object",
"properties": {
"id": {
"type": "string",
"deprecated": true,
"description": "Deprecated: Use `ref` instead."
},
"ref": {
"type": "string",
"minLength": 20,
"maxLength": 20,
"pattern": "^[a-z]+$",
"description": "Project ref",
"example": "abcdefghijklmnopqrst"
},
"organization_id": {
"type": "string",
"description": "Deprecated: Use `organization_slug` instead.",
"deprecated": true
},
"organization_slug": {
"type": "string",
"pattern": "^[\\w-]+$",
"description": "Organization slug",
"example": "tsrqponmlkjihgfedcba"
},
"name": {
"type": "string",
"description": "Name of your project"
},
"region": {
"type": "string",
"description": "Region of your project"
},
"created_at": {
"type": "string",
"description": "Creation timestamp"
},
"status": {
"type": "string",
"enum": [
"INACTIVE",
"ACTIVE_HEALTHY",
"ACTIVE_UNHEALTHY",
"COMING_UP",
"UNKNOWN",
"GOING_DOWN",
"INIT_FAILED",
"REMOVED",
"RESTORING",
"UPGRADING",
"PAUSING",
"RESTORE_FAILED",
"RESTARTING",
"PAUSE_FAILED",
"RESIZING"
]
},
"database": {
"type": "object",
"properties": {
"host": {
"type": "string",
"description": "Database host"
},
"version": {
"type": "string",
"description": "Database version"
},
"postgres_engine": {
"type": "string",
"description": "Database engine"
},
"release_channel": {
"type": "string",
"description": "Release channel"
}
},
"required": [
"host",
"version",
"postgres_engine",
"release_channel"
]
}
},
"required": [
"id",
"ref",
"organization_id",
"organization_slug",
"name",
"region",
"created_at",
"status",
"database"
]
}