Skip to main content

List Ramps

Get all ramps associated with your account.

Endpoint

GET /ramps

Request

curl -X GET https://api.docyard.io/v1/ramps \
  -H "X-API-Key: dk_live_dist_aaaaaaaa" \
  -H "X-API-Secret: dk_secret_dist_bbbbbbbb"

Response

{
  "ramps": [
    {
      "ramp_id": "ramp-xyz789",
      "name": "Production Ramp",
      "description": "Main upload endpoint",
      "status": "active",
      "api_key_prefix": "dk_live_dist_",
      "created_at": "2026-03-01T09:00:00Z",
      "last_upload_at": "2026-03-15T10:30:00Z",
      "stats": {
        "total_uploads": 15420,
        "total_artifacts": 12350
      }
    },
    {
      "ramp_id": "ramp-dev-001",
      "name": "Development Ramp",
      "description": "Testing endpoint",
      "status": "active",
      "api_key_prefix": "dk_test_dist_",
      "created_at": "2026-03-01T09:00:00Z",
      "last_upload_at": "2026-03-14T15:00:00Z",
      "stats": {
        "total_uploads": 450,
        "total_artifacts": 320
      }
    }
  ]
}