Skip to main content
GET
Get Project

Authorizations

Authorization
string
header
required

Service Account Token authentication. To authenticate API requests:

  1. Create a Service Account Token:

    • Go to the Cerebrium Dashboard and open the API Keys page
    • Click Create Service Account, name it (e.g., "GitHub Actions CI/CD"), choose an expiry date, and click Create
    • Copy the token generated for the desired service account
  2. Use the Token: Include the service account token in the Authorization header of API requests: Authorization: Bearer <your-service-account-token>

  3. Best Practices:

    • Create separate service accounts for different environments (dev, staging, prod)
    • Store tokens securely as secrets in consuming applications or workflows
    • Set appropriate expiry dates and rotate tokens regularly
    • Never commit tokens to source control

For CI/CD integration examples, see the CI/CD documentation.

Path Parameters

project_id
string
required

Response

Details of the requested project.

aboutInfo
string

Short description of what the project is used for. Omitted when not set.

alertAmountDollars
integer

Monthly spend amount in US dollars at which a usage alert is sent.

basePlanAmountCents
integer

Base subscription plan amount in US cents.

createdAt
string

Timestamp when the project was created, in RFC3339 format.

createdByUserId
string

ID of the user who created the project.

effectiveLimits
object

Resource limits in effect for the project's plan tier.

emailAddress
string

Billing contact email address for the project.

hardwareCosts
array

Compute pricing entries for the project. Each item has billableMetricCode (string), amountPerSecond (number), and type (string) fields.

id
string

Unique identifier of the project.

name
string

Name of the project.

onboarding
object

Onboarding answers for the project, with intent, companyWebsite, useCases, and otherUseCaseReason keys. Omitted when the project has none.

ownerEmailAddress
string

Email address of the project owner.

protected
boolean

Whether the project runs on the protected compute tier. Omitted when false.

requiresPaymentMethod
boolean

Whether a payment method must be added before deploying.

telephoneNumber
string

Contact telephone number for the project. Omitted when not set.

updatedAt
string

Timestamp when the project was last updated, in RFC3339 format.