REST API

The MetaKraftwerk REST API provides programmatic access to the core resources of the platform. It enables you to automate workflows such as uploading instance metadata, triggering builds, downloading generated artifacts, querying the meta database, and managing deployments — all without using the web interface.

See Also

• What is MetaKraftwerk? — Platform overview
• Overview of the web application — Web UI reference

Base URL

All API endpoints are served under the following base URL:

https://app.metakraftwerk.com/api/v1

Authentication

All endpoints require a valid JSON Web Token (JWT) in the Authorization header. See the Authentication page for details on how to obtain and use a token.

Authorization: Bearer <ACCESS_TOKEN>

Available Endpoints

Core Resources

Endpoint	Methods	Description
/projects	GET	List and retrieve projects.
/patterns	GET	List and retrieve data integration patterns.
/instances	GET, POST	List, retrieve, and upload instance metadata.
/instance_folders	GET	List and retrieve instance folder hierarchies.

Build & Deployment

Endpoint	Methods	Description
/builds	GET, POST	List builds and trigger new build executions.
/downloads	GET	List and download build result files.
/deployments	GET	List deployment definitions for patterns.
/build_deployments	GET, POST	List and trigger build deployments.

Metadata & Configuration

Endpoint	Methods	Description
/metadata	POST	Execute SQL statements in the meta database.
/functional_roles	GET	List functional role definitions for patterns.
/instance_properties	GET	List instance property schemas for patterns.
/pattern_variables	GET	List pattern variables and their resolved values.
/labels	GET	List labels for projects and patterns.

Release Management

Endpoint	Methods	Description
/releases	GET	List and retrieve releases.
/release_groups	GET	List and retrieve release groups.

Agents

Endpoint	Methods	Description
/agents	GET	List and retrieve agents.
/agent_groups	GET	List and retrieve agent groups.

Common Patterns

Name-Based Lookups

Most endpoints support filtering by name as a query parameter, in addition to filtering by id. Where a related resource is required (e.g., pattern_id), you can often use the name-based alternative (e.g., pattern=CORE_DV_HLS) instead of the numeric ID.

Error Handling

All error responses follow this structure:

{
  "name": "BadRequest",
  "message": "Descriptive error message",
  "code": 400
}

Status Code	Meaning
400	Bad Request — Missing or invalid parameters.
401	Not Authenticated — Missing or expired token.
403	Forbidden — Insufficient permissions.
404	Not Found — Resource does not exist.
405	Method Not Allowed — HTTP method not supported for this endpoint.
500	Internal Server Error — Unexpected server error.