API Reference

Integrate Marathoon into your workflows with our REST API.

Authentication

Authenticate with an API key created under Settings → API Keys, sent in the X-API-Key header (the Authorization header with the ApiKey scheme also works). Every route is scoped to your organization: replace tenantId with your organization's id.

X-API-Key: mk_your_api_key

Base URL

https://api.marathoon.io

Endpoints

GET/api/v1/tenants/{tenantId}/projects
POST/api/v1/tenants/{tenantId}/projects
GET/api/v1/tenants/{tenantId}/projects/{projectId}/pipelines
POST/api/v1/tenants/{tenantId}/projects/{projectId}/pipelines
POST/api/v1/tenants/{tenantId}/jobs/run/{pipelineId}
POST/api/v1/tenants/{tenantId}/jobs/batch/{pipelineId}
GET/api/v1/tenants/{tenantId}/jobs/{jobId}
GET/api/v1/tenants/{tenantId}/jobs/{jobId}/logs
POST/api/v1/tenants/{tenantId}/jobs/{jobId}/cancel

Rate Limits

Limits are counted per organization and per type of operation, over one-minute windows: 50 requests per minute on job endpoints and 20 on job file endpoints, with an overall ceiling of 600 requests per minute per IP address. Past a limit, the API answers 429 Too Many Requests with a Retry-After header and a JSON body giving the wait in seconds.

Need more details?

View the full documentation, with request examples.

View Full Documentation →