Update Scaffolder template
Update a Scaffolder template by tag or Cortex ID.
API key must have the Configure Scaffolder permission.
Authorizations
All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.
Path Parameters
The tag or unique, auto-generated Cortex ID of the Scaffolder template. Entity identifier - can be a tag or CID
Body
Whether a cortex.yaml is generated for the created entity. Defaults to true
Descriptive labels used to group templates in the UI
Descriptive labels used to group templates in the UI
Display name of the Scaffolder template
Options applied to the repository the Scaffolder publishes to
- Option 1
- Option 2
- Option 3
- Option 4
Whether running the template must create a new entity. Defaults to true
Whether the template publishes via a pull request to an existing repository. Defaults to false
Whether the template repository's README is shown before a run. Defaults to false
Whether runs are restricted to the git configuration alias the template names. Defaults to true
The templating engine of the template
COOKIECUTTER Description of the Scaffolder template
Options applied to the repository the Scaffolder publishes to
- Option 1
- Option 2
- Option 3
- Option 4
Stable, human-readable identifier, unique within the workspace. Lowercase letters, numbers, and dashes; may not start or end with a dash. Derived from the name when omitted on creation; an existing template keeps its tag unless a new one is provided.
Response
Scaffolder template updated successfully
Whether a cortex.yaml is generated for the created entity
ISO-8601 timestamp at which the template was registered
Unique, auto-generated Cortex ID of the Scaffolder template
Descriptive labels used to group templates in the UI
Descriptive labels used to group templates in the UI
Display name of the Scaffolder template
Options applied to the repository the Scaffolder publishes to
- Option 1
- Option 2
- Option 3
- Option 4
Whether running the template must create a new entity
Whether the template publishes via a pull request to an existing repository
Whether the template repository's README is shown before a run
Whether runs are restricted to the git configuration alias the template names
Stable, human-readable identifier, unique within the workspace
The templating engine of the template
COOKIECUTTER ISO-8601 timestamp at which the template was last updated
Description of the Scaffolder template
Options applied to the repository the Scaffolder publishes to
- Option 1
- Option 2
- Option 3
- Option 4