Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Roadie Scaffolder API

Backstage software templates - discover, dry-run, execute, and track scaffolder tasks.

Roadie Scaffolder API is one of 6 APIs that Roadie publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Scaffolder. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 6 operations across 5 paths, and defines 2 schemas. It is described by OpenAPI 3.0.3, at version 1.0.

Requests are made against a single base URL, https://api.roadie.so/api.

6 operations 5 paths 2 schemas 4 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Base URL
https://api.roadie.so/api/catalog
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Roadie Scaffolder API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Roadie API token (User Token or Service Token) created under Administration in the Roadie app. Passed as Authorization: Bearer YOURROADIEAPITOKEN.

Paths & Operations 6

Across 5 paths, the API surfaces 6 operations — 4 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Scaffolder 6

Backstage software templates - discover, dry-run, execute, and track scaffolder tasks.

GET
/scaffolder/v2/actions
List installed scaffolder actions
listScaffolderActions → 200401
GET
/scaffolder/v2/tasks
List scaffolder tasks
listScaffolderTasks → 200401
POST
/scaffolder/v2/tasks
Run a software template
createScaffolderTask body → 201401400
GET
/scaffolder/v2/tasks/{taskId}
Get a scaffolder task
getScaffolderTask 1 param → 200401404
GET
/scaffolder/v2/tasks/{taskId}/eventstream
Stream scaffolder task events
streamScaffolderTaskEvents 1 param → 200401
POST
/scaffolder/v2/dry-run
Dry-run a software template
dryRunScaffolderTemplate body → 200401

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are ScaffolderTask (4 properties), Error (1 property). Each schema is shown below with its type and property counts.

Error
object
1 property
ScaffolderTask
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

roadie-io-scaffolder-api-openapi.yml Raw ↑

Other APIs Roadie publishes across the network.

Roadie MCP Servers
Roadie Catalog API
Roadie Entity Push API
Roadie Tech Insights API
Roadie TechDocs API