Skip to navigation
API ReferenceProcess

Update Launch Template

Rename it, describe it, reorder it, make it the default, or archive it and bring it back. Archiving the default is refused with 409 default_template, and making an archived template the default with 409 archived.

Authentication

AuthorizationBearer

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

Path parameters

launchTemplateIdstringRequired

Request

This endpoint expects an object.
namestringOptional
descriptionstringOptional
isDefaultbooleanOptional

Only true, which makes it the default and the old default an ordinary template; false is a 422, since the default stops being one only when another takes over. An archived template cannot be made the default (409 archived) unless archived: false comes with it.

archivedbooleanOptional

true archives it, refused with 409 default_template for the default; false brings it back.

sortOrderintegerOptional

Response

This endpoint returns an object.
idstring
organizationIdstring
namestring
isDefaultboolean
The one new launches get when they name none. Exactly one per workspace.
sortOrderinteger
archivedboolean

Archived templates are offered nowhere; launches that use one keep it.

stepCountinteger
How many of its steps are not archived.
createdAtdatetime
updatedAtdatetime
descriptionstringOptional
archivedAtdatetimeOptional

Errors

403
Forbidden Error
404
Not Found Error
409
Conflict Error
429
Too Many Requests Error