> ## Documentation Index > Fetch the complete documentation index at: https://docs.cortex.io/llms.txt > Use this file to discover all available pages before exploring further. # Update Scaffolder template > Update a Scaffolder template by tag or Cortex ID. API key must have the `Configure Scaffolder` permission. ## OpenAPI ````yaml /openapi/cortex_swagger.json put /api/v1/scaffolders/{tagOrId} openapi: 3.0.1 info: description: >- The Cortex REST API provides programmatic access to the data in the catalog, Scorecards, and more. title: Cortex API version: v1 servers: - url: https://api.getcortexapp.com description: Cortex Cloud API host security: - bearerAuth: [] tags: - name: API Keys - name: Audit Logs - name: Catalog Entities - name: Catalogs - name: Custom Data - name: Custom Data [Advanced] - name: Custom Events - name: Custom Metrics - name: Dependencies - name: Deploys - name: Discovery Audit - name: Docs - name: 'Eng Intel: 1-Registry' - name: 'Eng Intel: 2-Metrics' - name: 'Eng Intel: 3-Trace' - name: 'Eng Intel: User Labels' - name: Entity Relationship Types - name: Entity Relationships - name: Entity Types - name: GitOps Logs - name: Groups - name: IP Allowlist - name: Initiatives - name: My Workspace - name: Notification Logs - name: On-call - name: Packages - name: Plugins - name: Queries - name: SCIM - name: Scaffolder - name: Scorecards - name: Secrets - name: Team Roles - name: Teams - name: Teams Hierarchies - name: Teams [Advanced] - name: Teams [Departments] (legacy) - name: Users - name: Verifications - name: Workflows - name: '[Integrations] AWS' - name: '[Integrations] Anthropic' - name: '[Integrations] Apiiro' - name: '[Integrations] ArgoCD' - name: '[Integrations] Azure Active Directory' - name: '[Integrations] Azure Devops' - name: '[Integrations] Azure Resources' - name: '[Integrations] BambooHR' - name: '[Integrations] Bitbucket' - name: '[Integrations] Bugsnag' - name: '[Integrations] Buildkite' - name: '[Integrations] Checkmarx SAST' - name: '[Integrations] CircleCI' - name: '[Integrations] ClickUp' - name: '[Integrations] Codecov' - name: '[Integrations] Coralogix' - name: '[Integrations] Datadog' - name: '[Integrations] Dynatrace' - name: '[Integrations] Firehydrant' - name: '[Integrations] GitHub' - name: '[Integrations] GitLab' - name: '[Integrations] Harness' - name: '[Integrations] Incident.io' - name: '[Integrations] Instana' - name: '[Integrations] Jenkins' - name: '[Integrations] Jira' - name: '[Integrations] Kubernetes' - name: '[Integrations] LaunchDarkly' - name: '[Integrations] Lightstep' - name: '[Integrations] Mend SAST' - name: '[Integrations] Mend SCA' - name: '[Integrations] New Relic' - name: '[Integrations] Okta' - name: '[Integrations] Opsgenie' - name: '[Integrations] PagerDuty' - name: '[Integrations] Prometheus' - name: '[Integrations] Rollbar' - name: '[Integrations] Rootly' - name: '[Integrations] Semgrep' - name: '[Integrations] Sentry' - name: '[Integrations] ServiceNow' - name: '[Integrations] SignalFx' - name: '[Integrations] Snyk' - name: '[Integrations] SonarQube' - name: '[Integrations] SumoLogic' - name: '[Integrations] Veracode' - name: '[Integrations] VictorOps' - name: '[Integrations] Wiz' - name: '[Integrations] Workday' - name: '[Integrations] xMatters' - name: dev-login-controller - name: public-scim-schema-controller paths: /api/v1/scaffolders/{tagOrId}: put: tags: - Scaffolder summary: Update Scaffolder template description: |- Update a Scaffolder template by tag or Cortex ID. API key must have the `Configure Scaffolder` permission. operationId: updateScaffolder parameters: - description: >- The tag or unique, auto-generated Cortex ID of the Scaffolder template. in: path name: tagOrId required: true schema: type: string description: Entity identifier - can be a tag or CID requestBody: content: application/json: schema: $ref: '#/components/schemas/ScaffolderRequest' application/yaml: schema: $ref: '#/components/schemas/ScaffolderRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/ScaffolderResponse' application/yaml: schema: $ref: '#/components/schemas/ScaffolderResponse' description: Scaffolder template updated successfully '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: Bad request '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: Access denied '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: Scaffolder template not found '429': $ref: '#/components/responses/TooManyRequests' components: schemas: ScaffolderRequest: required: - createYamlFile - labels - name - repoLocator - requireNewService - requirePullRequest - showReadme - strictAliasUsage - type type: object properties: createYamlFile: type: boolean description: >- Whether a cortex.yaml is generated for the created entity. Defaults to `true` description: type: string description: Description of the Scaffolder template labels: type: array description: Descriptive labels used to group templates in the UI items: type: string description: Descriptive labels used to group templates in the UI name: type: string description: Display name of the Scaffolder template publisherOptions: oneOf: - $ref: '#/components/schemas/AzureDevops' - $ref: '#/components/schemas/Bitbucket' - $ref: '#/components/schemas/Github' - $ref: '#/components/schemas/Gitlab' repoLocator: oneOf: - $ref: '#/components/schemas/AzureDevops' - $ref: '#/components/schemas/Bitbucket' - $ref: '#/components/schemas/Github' - $ref: '#/components/schemas/Gitlab' requireNewService: type: boolean description: >- Whether running the template must create a new entity. Defaults to `true` requirePullRequest: type: boolean description: >- Whether the template publishes via a pull request to an existing repository. Defaults to `false` showReadme: type: boolean description: >- Whether the template repository's README is shown before a run. Defaults to `false` strictAliasUsage: type: boolean description: >- Whether runs are restricted to the git configuration alias the template names. Defaults to `true` tag: type: string description: >- 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: type: string description: The templating engine of the template enum: - COOKIECUTTER ScaffolderResponse: required: - createYamlFile - createdAt - id - labels - name - repoLocator - requireNewService - requirePullRequest - showReadme - strictAliasUsage - tag - type - updatedAt type: object properties: createYamlFile: type: boolean description: Whether a cortex.yaml is generated for the created entity createdAt: type: string description: ISO-8601 timestamp at which the template was registered description: type: string description: Description of the Scaffolder template id: type: string description: Unique, auto-generated Cortex ID of the Scaffolder template labels: type: array description: Descriptive labels used to group templates in the UI items: type: string description: Descriptive labels used to group templates in the UI name: type: string description: Display name of the Scaffolder template publisherOptions: oneOf: - $ref: '#/components/schemas/AzureDevops' - $ref: '#/components/schemas/Bitbucket' - $ref: '#/components/schemas/Github' - $ref: '#/components/schemas/Gitlab' repoLocator: oneOf: - $ref: '#/components/schemas/AzureDevops' - $ref: '#/components/schemas/Bitbucket' - $ref: '#/components/schemas/Github' - $ref: '#/components/schemas/Gitlab' requireNewService: type: boolean description: Whether running the template must create a new entity requirePullRequest: type: boolean description: >- Whether the template publishes via a pull request to an existing repository showReadme: type: boolean description: Whether the template repository's README is shown before a run strictAliasUsage: type: boolean description: >- Whether runs are restricted to the git configuration alias the template names tag: type: string description: Stable, human-readable identifier, unique within the workspace type: type: string description: The templating engine of the template enum: - COOKIECUTTER updatedAt: type: string description: ISO-8601 timestamp at which the template was last updated ErrorResponse: required: - message - type type: object properties: details: type: string errorCode: type: string gatewayHttpStatus: type: integer format: int32 httpStatus: type: integer format: int32 message: type: string requestId: type: string type: type: string enum: - INTEGRATION_MISSING - INTEGRATION_UNREGISTERED - INTEGRATION_UNSUPPORTED - INTEGRATION_GRAPHQL_ERROR - INTEGRATION_BAD_REQUEST - INTEGRATION_UNAUTHORIZED - INTEGRATION_FORBIDDEN - INTEGRATION_NOT_FOUND - INTEGRATION_UNPROCESSABLE_CONTENT - INTEGRATION_RATE_LIMITED - INTEGRATION_INTERNAL_ERROR - INTEGRATION_NOT_IMPLEMENTED - INTEGRATION_BAD_GATEWAY - INTEGRATION_UNAVAILABLE - INTEGRATION_GATEWAY_TIMEOUT - INTEGRATION_TIMED_OUT - INTEGRATION_CACHE_ERROR - INTEGRATION_UNHANDLED_HTTP_ERROR - INTEGRATION_UNHANDLED_EXCEPTION - INTEGRATION_UNEXPECTED_ERROR - ILLEGAL_ARGUMENT_ERROR - BAD_REQUEST - FORBIDDEN - NOT_FOUND - REQUEST_TIMEOUT - CONFLICT - UNHANDLED_EXCEPTION - UNCATEGORIZED - SERVICE_CREATOR - UNKNOWN_HOST - TOO_MANY_REQUESTS AzureDevops: type: object allOf: - $ref: '#/components/schemas/ScaffolderPublisherOptions' Bitbucket: type: object allOf: - $ref: '#/components/schemas/ScaffolderPublisherOptions' - type: object properties: visibility: type: string description: Visibility of the created repository enum: - PUBLIC - PRIVATE Github: type: object allOf: - $ref: '#/components/schemas/ScaffolderPublisherOptions' - required: - sparseCheckout type: object properties: sparseCheckout: type: boolean description: Whether the destination is cloned with sparse checkout visibility: type: string description: Visibility of the created repository enum: - PUBLIC - PRIVATE Gitlab: type: object allOf: - $ref: '#/components/schemas/ScaffolderPublisherOptions' - type: object properties: visibility: type: string description: Visibility of the created repository enum: - PUBLIC - PRIVATE TooManyRequestsProblemDetail: required: - type - title - status type: object properties: detail: type: string instance: type: string format: uri-reference retryAfter: minimum: 0 type: integer description: The number of seconds until the rate limiting resets. format: int32 status: maximum: 599 minimum: 100 type: integer format: int32 enum: - 429 title: type: string type: type: string format: uri-reference ScaffolderPublisherOptions: required: - provider type: object properties: provider: type: string description: The git provider hosting the template repository enum: - GITHUB - GITLAB - BITBUCKET - AZUREDEVOPS description: Options applied to the repository the Scaffolder publishes to discriminator: propertyName: provider responses: TooManyRequests: content: application/problem+json: schema: $ref: '#/components/schemas/TooManyRequestsProblemDetail' description: >- The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay. headers: Retry-After: description: The number of seconds until the rate limiting resets. schema: minimum: 0 type: integer format: int32 securitySchemes: bearerAuth: bearerFormat: JWT description: >- All requests to the Cortex API need to provide an `Authorization: Bearer ` header, where `` is an API key created in the Settings page of your workspace. scheme: bearer type: http ```` ## Related topics - [Scaffolder](/api/rest/scaffolders.md) - [Create or update Scaffolder template](/api/rest/scaffolder/create-or-update-scaffolder-template.md) - [Registering a Scaffolder template](/streamline/workflows/scaffolder.md)