Backstage

Backstage Dry Run API

The Dry Run API from Backstage — 1 operation(s) for dry run.

GitHub OpenAPI

Operations 1

POST /v2/dry-run Dry run #

Documentation

📖
Documentation
https://backstage.io/docs/plugins/backend-plugin
📖
Documentation
https://backstage.io/docs/notifications/
📖
Documentation
https://backstage.io/docs/backend-system/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/backstage/refs/heads/main/openapi/backstage-dry-run-api-openapi.yml
⚙
AsyncAPI
https://raw.githubusercontent.com/api-evangelist/backstage/refs/heads/main/asyncapi/backstage-events-asyncapi.yml

Other Resources

🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/backstage/refs/heads/main/asyncapi/backstage-webhooks.yml

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-dry-run-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.

GitHub Google LinkedIn

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

OpenAPI Specification

backstage-dry-run-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: scaffolder Dry Run API
  version: '1'
  description: The Backstage backend plugin that helps you create new things
  license:
    name: Apache-2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  contact: {}
servers:
- url: /
tags:
- name: Dry Run
paths:
  /v2/dry-run:
    post:
      operationId: DryRun
      description: Perform a dry-run of a template
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                template:
                  type: object
                values:
                  $ref: '#/components/schemas/JsonObject'
                secrets:
                  type: object
                  additionalProperties:
                    type: string
                directoryContents:
                  type: array
                  items:
                    type: object
                    properties:
                      path:
                        type: string
                      base64Content:
                        type: string
              required:
              - template
              - values
              - directoryContents
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/DryRunResult'
                - type: object
                  properties:
                    steps:
                      type: array
                      items:
                        type: object
                        properties:
                          id:
                            type: string
                          name:
                            type: string
                          action:
                            type: string
                        required:
                        - id
                        - name
                        - action
                        additionalProperties: {}
                    directoryContents:
                      type: array
                      items:
                        type: object
                        properties:
                          path:
                            type: string
                          executable:
                            type: boolean
                          base64Content:
                            type: string
                        required:
                        - path
                        - base64Content
                  required:
                  - steps
        '400':
          description: Validation errors.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ValidationError'
                required:
                - errors
      parameters: []
      tags:
      - Dry Run
      summary: Dry run
      x-summary-source: derived
components:
  schemas:
    ValidationError:
      type: object
      properties:
        path:
          type: array
          items:
            oneOf:
            - type: string
            - type: integer
        property:
          type: string
        message:
          type: string
        instance:
          type: object
        name:
          type: string
        argument:
          oneOf:
          - type: boolean
          - type: number
          - type: object
          - type: string
        stack:
          type: string
      required:
      - path
      - property
      - message
      - schema
      - instance
      - name
      - argument
      - stack
      additionalProperties: {}
    TaskStatus:
      type: string
      enum:
      - cancelled
      - completed
      - failed
      - open
      - processing
      - skipped
      description: The status of each step of the Task
    DryRunResult:
      type: object
      properties:
        log:
          type: array
          items:
            type: object
            properties:
              body:
                allOf:
                - $ref: '#/components/schemas/JsonObject'
                - type: object
                  properties:
                    message:
                      type: string
                    status:
                      $ref: '#/components/schemas/TaskStatus'
                    stepId:
                      type: string
                  required:
                  - message
            required:
            - body
        directoryContents:
          type: array
          items:
            $ref: '#/components/schemas/SerializedFile'
        output:
          $ref: '#/components/schemas/JsonObject'
      required:
      - log
      - directoryContents
      - output
    SerializedFile:
      type: object
      properties:
        path:
          type: string
        content:
          type: string
        executable:
          type: boolean
        symlink:
          type: boolean
      required:
      - path
      - content
    JsonObject:
      type: object
      properties: {}
      description: A type representing all allowed JSON object values.
      additionalProperties: {}
  securitySchemes:
    JWT:
      type: http
      scheme: bearer
      bearerFormat: JWT