Skip to content
Musher Docs

API Reference

The Musher REST API gives you programmatic access to bundles, organizations, publishers, and pipelines. All endpoints follow consistent conventions for authentication, errors, and pagination.

Base URL

text
https://api.musher.dev/v1

All endpoints are versioned under /v1. Breaking changes will use a new version prefix.

Authentication

Include your API key as a Bearer token in the Authorization header:

http
Authorization: Bearer mush_your_api_key_here

Create and manage API keys from the Console. See the Authentication page for details on key scopes and rotation.

Request & Response Format

  • Request and response bodies use JSON with camelCase field names.
  • Dates are ISO 8601 strings in UTC.
  • IDs are UUIDs.

Errors

Error responses follow RFC 9457 Problem Details:

json
{
  "type": "https://docs.musher.dev/errors/not-found",
  "title": "Not Found",
  "status": 404,
  "detail": "Bundle 'acme/missing' does not exist."
}

See Errors for the full error type reference.

Pagination

List endpoints use cursor-based pagination. Pass a cursor query parameter to page through results. Responses include a nextCursor field when more results are available.

http
GET /v1/bundles?limit=20&cursor=eyJpZCI6Ii4uLiJ9

Resources