API Documentation

The Zipline API provides programmatic access to all core functionality of your Zipline instance, including file uploads, URL shortening, and user management.

Base URL

All API endpoints are prefixed with the base URL to your instance, e.g https://zipline.example.com/api.

Errors

In the event of an error, the API will return a JSON response with the following structure:

{
  "error": "EXXXX: Error message",
  "code": 1000,
  "statusCode": 400
}

In any route, click the 4xx response, and in the dropdown you can select different error codes to see the different error responses.

API Reference

You can download the OpenAPI spec here, or visit the Generate OpenAPI Spec github action's artifacts to download the latest version of the OpenAPI spec.

The one that lives on the docs is automatically generated whenever the docs are built, and may not be the latest version of the spec.

Next Steps