Skip to main content

API Reference

DevRamps provides a REST API for programmatic access to the platform.

Documentation Status

Full API documentation with request/response schemas, detailed endpoint paths, and interactive examples is coming soon. The information below covers the basics of authentication and available resources.

Base URL​

https://api.devramps.com/api/v1

Authentication​

All API requests require authentication using a bearer token:

curl -H "Authorization: Bearer YOUR_TOKEN" \
  https://api.devramps.com/api/v1/organizations/{orgId}/pipelines

Obtaining an API token​

API tokens can be generated from the DevRamps dashboard under Organization Settings > API Tokens. Tokens are scoped to your organization and have the same permissions as your user account.

Available Resources​

The API provides endpoints for managing:

  • Pipelines -- List, view, stop, and resume pipelines.
  • Deployments -- View deployment state, cancel stages, retry failed stages.
  • Approvals -- List pending approvals, approve or reject.
  • Secrets -- Create, update, and delete secrets.
  • Events -- View audit history and deployment events.
  • Step Registries -- Manage custom step registries.
  • Analysis -- Trigger AI failure analysis and create fix PRs.

Response Format​

All responses are JSON:

{
  "data": {
    "id": "pipeline-123",
    "name": "my-pipeline",
    "slug": "my-pipeline"
  }
}

Pagination​

List endpoints support pagination with limit and offset parameters:

GET /api/v1/organizations/{orgId}/pipelines?limit=50&offset=0