API

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

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

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
}

If you would like to see all possible errors, visit the API Reference page, which is generated from the OpenAPI specification for Zipline.

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

Zipline now exports OpenAPI specifications for all API routes, available here. This allows you to easily view all API routes, their parameters, and example responses.