Skip to main content
GET
Get a project

Authorizations

Authorization
string
header
required

Bearer token in the Authorization header (e.g. JWT / Cognito access token).

Headers

Tenant-Id
string
required

ID of the tenant (current tenant context).

Path Parameters

projectId
string
required

Project identifier.

Response

OK

Full project representation returned by the API (includes relations and cost summary).

id
string

Primary key (project id).

sk
string

Sort key.

type
string
created_at
string<date-time>
updated_at
string<date-time>
name
string
description
string
aws_account_id
string

Linked AWS account id (12 digits).

aws_region
enum<string>

AWS region identifier. Matches models.AwsRegion JSON values in paas-lib.

Available options:
us-east-1,
us-east-2,
us-west-1,
us-west-2,
us-gov-east-1,
us-gov-west-1,
ca-central-1,
ca-west-1,
eu-central-1,
eu-central-2,
eu-north-1,
eu-west-1,
eu-west-2,
eu-west-3,
eu-south-1,
eu-south-2,
me-south-1,
me-central-1,
mx-central-1,
cn-north-1,
cn-northwest-1,
ap-east-1,
ap-south-1,
ap-south-2,
ap-northeast-1,
ap-northeast-2,
ap-northeast-3,
ap-southeast-1,
ap-southeast-2,
ap-southeast-3,
ap-southeast-4,
ap-southeast-5,
ap-east-2,
ap-southeast-7,
ap-southeast-6,
af-south-1,
sa-east-1
Example:

"us-east-1"

max_budget
integer

Maximum budget threshold for notifications.

notify_when_forecast_cost_exceed
boolean
notify_when_actual_cost_exceed
boolean
domain
string
cost
integer

Current or last reported cost (application-defined units).

webhooks
object[]
env_variables
object[]
integrations
object[]
status
enum<string>

Lifecycle status of the project.

Available options:
ALPHA,
BETA,
RELEASE
notify_email
string | null

Notification email; may be null or empty when unset.

month_cost
object | null

Aggregated cost summary for a billing period.

cost_exceeded
boolean

True when cost has exceeded configured thresholds.