Backstage Templates API

Endpoints for template metadata and parameter schemas.

Operations 1

GET /v2/templates/{namespace}/{kind}/{name}/parameter-schema Get template parameter schema #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/backstage-templates-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

backstage-templates-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Backstage Templates API
  version: '1.0'
  description: 'Operations tagged Templates across 2 of this provider''s published API definitions: backstage-scaffolder-backend-openapi.yaml, backstage-scaffolder-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: /
- url: https://localhost:7007/api/scaffolder
  description: Local development server
tags:
- name: Templates
paths:
  /v2/templates/{namespace}/{kind}/{name}/parameter-schema:
    get:
      operationId: GetTemplateParameterSchema
      description: Get template parameter schema.
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TemplateParameterSchema'
        '400':
          $ref: '#/components/responses/ErrorResponse'
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - {}
      - JWT: []
      parameters:
      - $ref: '#/components/parameters/namespace'
      - $ref: '#/components/parameters/kind'
      - $ref: '#/components/parameters/name'
      tags:
      - Templates
      summary: Get template parameter schema
      x-summary-source: derived
    servers:
    - url: /
components:
  parameters:
    name:
      name: name
      in: path
      required: true
      schema:
        type: string
    kind:
      name: kind
      in: path
      required: true
      schema:
        type: string
    namespace:
      name: namespace
      in: path
      required: true
      schema:
        type: string
  schemas:
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            name:
              type: string
            message:
              type: string
            stack:
              type: string
            code:
              type: string
          required:
          - name
          - message
        request:
          type: object
          properties:
            method:
              type: string
            url:
              type: string
          required:
          - method
          - url
        response:
          type: object
          properties:
            statusCode:
              type: number
          required:
          - statusCode
      required:
      - error
      - response
      additionalProperties: {}
    TemplateParameterSchema:
      type: object
      properties:
        title:
          type: string
        description:
          type: string
        steps:
          type: array
          items:
            type: object
            properties:
              title:
                type: string
              description:
                type: string
              schema:
                type: object
            required:
            - title
            - schema
      required:
      - title
      - steps
      description: 'The shape of each entry of parameters which gets rendered

        as a separate step in the wizard input'
      additionalProperties: {}
  responses:
    ErrorResponse:
      description: An error response from the backend.
      content:
        application/json; charset=utf-8:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Missing or invalid authentication token.
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: object
                properties:
                  name:
                    type: string
                  message:
                    type: string
    NotFound:
      description: The requested resource was not found.
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: object
                properties:
                  name:
                    type: string
                  message:
                    type: string
  securitySchemes:
    JWT:
      type: http
      scheme: bearer
      bearerFormat: JWT
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Backstage token returned by the identity API.
externalDocs:
  description: Backstage Software Templates Documentation
  url: https://backstage.io/docs/features/software-templates/
x-refined-from:
- backstage-scaffolder-backend-openapi.yaml
- backstage-scaffolder-openapi.yml