API Reference

Services

Query recorded vendor status and dependency relationships

GET/services

API token

List monitored services

Returns vendors linked to your organization's projects, with each vendor listed once and its recorded status included.

Responses

dataService[]Required

Example Response

JSON

{
  "data": [
    {
      "id": "svc_stripe",
      "name": "Stripe",
      "slug": "stripe",
      "currentStatus": "operational",
      "statusPageUrl": "https://status.stripe.com",
      "lastCheckedAt": "2026-03-12T09:15:00.000Z"
    },
    {
      "id": "svc_openai",
      "name": "OpenAI",
      "slug": "openai",
      "currentStatus": "degraded",
      "statusPageUrl": "https://status.openai.com",
      "lastCheckedAt": "2026-03-12T09:14:30.000Z"
    }
  ]
}

Code Samples

Code

curl -H 'Authorization: Bearer YOUR_API_KEY' \
  https://checkupstream.com/api/v1/services

GET/services/{id}

API token

Get service detail

Returns a service's recorded status, components and active incidents. Check observation timestamps before treating the status as current.

Parameters

idstringpathrequired

Service ID

Responses

dataServiceDetailRequired

Example Response

JSON

{
  "data": {
    "id": "svc_stripe",
    "name": "Stripe",
    "slug": "stripe",
    "currentStatus": "degraded",
    "statusPageUrl": "https://status.stripe.com",
    "lastCheckedAt": "2026-03-12T09:15:00.000Z",
    "components": [
      {
        "id": "comp_01",
        "name": "API",
        "currentStatus": "degraded"
      },
      {
        "id": "comp_02",
        "name": "Dashboard",
        "currentStatus": "operational"
      },
      {
        "id": "comp_03",
        "name": "Webhooks",
        "currentStatus": "operational"
      }
    ],
    "activeIncidents": [
      {
        "id": "inc_789",
        "title": "Elevated API error rates",
        "impact": "minor",
        "status": "investigating",
        "startedAt": "2026-03-12T08:45:00.000Z"
      }
    ]
  }
}

Code Samples

Code

curl -H 'Authorization: Bearer YOUR_API_KEY' \
  https://checkupstream.com/api/v1/services/svc_stripe

GET/services/{id}/impact

API token

Get service impact analysis

Lists projects that depend on a vendor and the packages that create each relationship. Use these links to guide an investigation; they do not confirm application impact.

Parameters

idstringpathrequired

Service ID

Responses

dataImpactAnalysisRequired

Example Response

JSON

{
  "data": {
    "serviceId": "svc_stripe",
    "totalProjects": 2,
    "totalDependencies": 3,
    "projects": [
      {
        "id": "proj_abc123",
        "name": "my-saas-app",
        "dependencies": [
          {
            "name": "stripe",
            "version": "^14.0.0",
            "ecosystem": "npm"
          }
        ]
      },
      {
        "id": "proj_def456",
        "name": "billing-service",
        "dependencies": [
          {
            "name": "stripe",
            "version": "^13.0.0",
            "ecosystem": "npm"
          },
          {
            "name": "stripe",
            "version": ">=7.0.0",
            "ecosystem": "pypi"
          }
        ]
      }
    ]
  }
}

Code Samples

Code

curl -H 'Authorization: Bearer YOUR_API_KEY' \
  https://checkupstream.com/api/v1/services/svc_stripe/impact

Create an API token

Use a read-scoped API token for organization data in scripts and backend services.

Manage API tokens Credential guide