Welcome to the Bobsled API! To register your interest, please contact our sales team.

Create A Service Account

To get started you will need to create a Service Account and generate a Secret to authenticate with.

Please visit our Service Account & Secret Documentation to learn more.

Authentication

By default, each Provider organization will be issued with an application public identifier sled-client-id and API Service Account credentials used to authenticate with Bobsled. The API Service Account credentials consist of a sled-service-account-email & sled-service-account-secret. The Bobsled API uses the client credential grant flow (RFC 4.4).

How to Authenticate

To authenticate with Bobsled, you first need to request an access token using the /auth/generateToken endpoint.

In this endpoint you will pass the following as headers:

sled-client-id (located: Environment page)
sled-service-account-email (located: Service Account page)
sled-service-account-secret (located: Service Account page)

See our API documentation on Generating an Auth Token

Making requests to the API

Once you have obtained the auth token, in every request to a resource endpoint you must pass:

The authorization bearer token in the Authorization header
The sled-client-id value in the sled-client-id custom header

Each auth token has an expiration time of 1 hour.

Limits

This section describes the limits of requesting the Bobsled API.

Soft Limits

DIMENSION	DESCRIPTION	SOFT LIMIT
Number of shares per provider	The maximum number of shares that can be created.	1,000
Number of transfers per share	The maximum number of transfers that can be created in a single share.	50
Number of items in pathNames array for a file transfer	The maximum number of items in the pathNames array. The pathNames array is nested inside of the transferEntity. (1 file storage transfer : 1 transferEntity)	35

Soft Limits can be increased to meet your use case needs. Please reach out to your account manager to discuss increasing your limits.

Hard Limits

DIMENSION	DESCRIPTION	HARD LIMIT
Number of items in pathNames array for a table transfer	The maximum number of items in the pathNames array. The pathNames array is nested inside of each transferEntity. (1 transferEntity : 1 table)	100

Format standards

As a standard, all timestamps are returned as epoch milliseconds

Bobsled API Compatibility

Backwards compatible changes:

Adding new API resources or method
New error codes and messages for new resources or methods
Adding new optional request parameters to existing API methods.
Adding new properties to existing API responses.
Changing the order of properties in existing API responses.
Changing a once required parameter to an optional parameter
Changing the text in error messages
Adding a value to an enum.
Modifying limits & rate-limiting
Modifying auth
- Adding a new optional authentication method
- Adding new optional input fields to the auth endpoint