COcortex
Scaffolder

Create or update Scaffolder template

Changed on

Create or update a Scaffolder template.

API key must have the Configure Scaffolder permission.

Note: If a Scaffolder template with the same tag already exists, it will be updated.

post/api/v1/scaffolders

Request

  • Base URL
    https://api.getcortexapp.com
  • URL
    https://api.getcortexapp.com/api/v1/scaffolders
  • Auth
    HTTP bearer

Request body

createYamlFileboolean required

Whether a cortex.yaml is generated for the created entity. Defaults to true

descriptionstring

Description of the Scaffolder template

labelsstring[] required

Descriptive labels used to group templates in the UI

namestring required

Display name of the Scaffolder template

requireNewServiceboolean required

Whether running the template must create a new entity. Defaults to true

requirePullRequestboolean required

Whether the template publishes via a pull request to an existing repository. Defaults to false

showReadmeboolean required

Whether the template repository's README is shown before a run. Defaults to false

strictAliasUsageboolean required

Whether runs are restricted to the git configuration alias the template names. Defaults to true

tagstring

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.

type'COOKIECUTTER' required

The templating engine of the template

Response

Scaffolder template created or updated successfully

createYamlFileboolean required

Whether a cortex.yaml is generated for the created entity

createdAtstring required

ISO-8601 timestamp at which the template was registered

descriptionstring

Description of the Scaffolder template

idstring required

Unique, auto-generated Cortex ID of the Scaffolder template

labelsstring[] required

Descriptive labels used to group templates in the UI

namestring required

Display name of the Scaffolder template

requireNewServiceboolean required

Whether running the template must create a new entity

requirePullRequestboolean required

Whether the template publishes via a pull request to an existing repository

showReadmeboolean required

Whether the template repository's README is shown before a run

strictAliasUsageboolean required

Whether runs are restricted to the git configuration alias the template names

tagstring required

Stable, human-readable identifier, unique within the workspace

type'COOKIECUTTER' required

The templating engine of the template

updatedAtstring required

ISO-8601 timestamp at which the template was last updated

Changes