Skip to main content

API Documentation

The provides a comprehensive REST API for programmatic access to your projects, pipelines, and resources.
The interactive Swagger UI documentation is available at the external API documentation portal. This provides full details on all available endpoints, request/response schemas, and allows you to test API calls directly.

Available Resources

The API provides access to the following resources:
  • Projects - Create, list, and manage projects
  • Pipelines - Execute and monitor pipeline runs
  • Environments - Configure project environments
  • Schedules - Set up automated pipeline execution
  • Agents - Manage compute agents
  • Artifacts - Handle published pipeline versions
  • Secrets - Manage secret references

Authentication

All API requests require authentication using OAuth 2.0 client credentials. To authenticate:
  1. Generate API credentials in
  2. Use the client ID and secret to obtain an access token
  3. Include the token in the Authorization header as a Bearer token
For detailed authentication instructions, see Authenticating to the API.

Base URLs

RegionBase URL
EUhttps://api.eu.matillion.com
UShttps://api.us.matillion.com

External API Documentation

For the full interactive API reference with all endpoints, schemas, and the ability to test requests, visit the Matillion API Documentation.