Update

Update a project template.

You can read more about the role’s permissions field in the permissions documentation.

Path Parameters

templateId

string

required

The ID of the project template to be updated.

Body

application/json

description

string

The updated description of the project template.

Maximum length: 256

environments

object[]

The updated environments to be created when the template is applied to a project.

Show child attributes

environments.name

string

required

Minimum length: 1

environments.position

number

required

Required range: x > 1

environments.slug

string

required

Required string length: 1 - 32

name

string

The updated name of the project template. Must be slug-friendly.

Required string length: 1 - 32

roles

object[]

The updated roles to be created when the template is applied to a project.

Show child attributes

roles.name

string

required

Minimum length: 1

roles.permissions

object[]

required

• Option 1
• Option 2
• Option 3
• Option 4
• Option 5
• Option 6
• Option 7
• Option 8
• Option 9
• Option 10
• Option 11
• Option 12
• Option 13
• Option 14
• Option 15
• Option 16
• Option 17
• Option 18
• Option 19
• Option 20
• Option 21
• Option 22
• Option 23
• Option 24
• Option 25
• Option 26
• Option 27
• Option 28
• Option 29
• Option 30

Show child attributes

roles.permissions.action

required

Describe what action an entity can take.

Available options:

read,

create,

edit,

delete

roles.permissions.subject

enum<string>

required

The entity this permission pertains to.

Available options:

secrets

roles.permissions.conditions

object

When specified, only matching conditions will be allowed to access given resource.

Show child attributes

roles.permissions.conditions.environment

roles.permissions.conditions.secretName

roles.permissions.conditions.secretPath

roles.permissions.conditions.secretTags

object

Show child attributes

roles.permissions.conditions.secretTags.$in

string[]

roles.permissions.inverted

boolean

Whether rule allows or forbids.

roles.slug

string

required

Required string length: 1 - 32

Response

200 - application/json

projectTemplate

object

required

Show child attributes

projectTemplate.createdAt

string

required

projectTemplate.environments

object[]

required

Show child attributes

projectTemplate.environments.name

string

required

Minimum length: 1

projectTemplate.environments.position

number

required

Required range: x > 1

projectTemplate.environments.slug

string

required

Required string length: 1 - 32

projectTemplate.id

string

required

projectTemplate.name

string

required

projectTemplate.orgId

string

required

projectTemplate.roles

object[]

required

Show child attributes

projectTemplate.roles.name

string

required

Minimum length: 1

projectTemplate.roles.permissions

object[]

required

Show child attributes

projectTemplate.roles.permissions.action

required

Minimum length: 1

projectTemplate.roles.permissions.conditions

any

projectTemplate.roles.permissions.inverted

boolean

projectTemplate.roles.permissions.subject

Minimum length: 1

projectTemplate.roles.slug

string

required

Required string length: 1 - 32

projectTemplate.updatedAt

string

required

projectTemplate.description

string | null