Skip to main content
PATCH
Update a project

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

Body

application/json
description
string | null
Maximum string length: 300
includeDeps
boolean
includeSkills
boolean
name
string
Required string length: 1 - 120
setupScript
string | null
Maximum string length: 20000
codeRepositoryIds
string[] | null
Required string length: 1 - 255
color
enum<string>
Available options:
neutral,
red,
orange,
yellow,
green,
teal,
blue,
purple,
pink
icon
enum<string>
Available options:
folder,
code,
terminal,
book,
brain,
bug,
building,
cloud,
globe,
idea,
tools,
magic,
processor,
sandbox,
server,
tasks,
tactics,
images,
database,
api,
mobile,
package
defaultForSizes
enum<string>[]
Available options:
nano,
micro,
medium,
large,
xl,
xxl,
ultra
environmentVariables
object
schedule
object
sizes
enum<string>[]
Minimum array length: 1
Available options:
nano,
micro,
medium,
large,
xl,
xxl,
ultra
warmPoolEnabled
boolean

Response

Update a project

createdAt
string<date-time>
required
description
string | null
required
id
string
required
Required string length: 1 - 255
includeDeps
boolean
default:true
required
includeSkills
boolean
default:true
required
name
string
required
setupScript
string | null
required
updatedAt
string<date-time>
required
activeSnapshots
object[]
required
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
sizes
enum<string>[]
required
Available options:
nano,
micro,
medium,
large,
xl,
xxl,
ultra
warmPoolEnabled
boolean
required