Skip to main content
GET
TypeScript SDK

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

projectId
string
required
Required string length: 1 - 255

Response

Retrieve a project

createdAt
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
description
string | null
required
id
string
required
Required string length: 1 - 255
name
string
required
setupScript
string | null
required
updatedAt
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
activeSnapshots
object[]
required
resourceSettings
object
required
agentInstructions
string | null
required
Maximum string length: 20000
codeRepositoryIds
string[] | null
required
Required string length: 1 - 255
color
enum<string>
required
Available options:
neutral,
red,
orange,
yellow,
green,
teal,
blue,
purple,
pink
defaultForSizes
enum<string>[]
required
Available options:
nano,
micro,
small,
medium,
large,
xl,
xxl,
ultra
icon
enum<string>
required
Available options:
folder,
code,
terminal,
book,
brain,
bug,
building,
cloud,
globe,
idea,
tools,
magic,
processor,
sandbox,
server,
tasks,
tactics,
images,
database,
api,
mobile,
package
onboardingDefault
boolean
required

True for the project created during onboarding until it is first edited

sizes
enum<string>[]
required
Available options:
nano,
micro,
medium,
large,
xl,
xxl,
ultra
warmPoolEnabled
boolean
required
warmPoolSchedule
object | null
required