General Setup Information
Pagination
All endpoints that return a list of resources are paginated. You can select the size of the page and which page to get by using the query parameters size
and page
.
size
- Defines the size of the page. Defaults to 20. Max size is 100.page
- Defines which page to fetch, considering each page hassize
elements. The first page is page 0. Defaults to 0.
The X-Total-Count
header in the response indicate the total existent items, and the Link
header can provide the link for the first, next and last pages available:
Date format
All the dates follow ISO 8601 format. Specifically, all the dates should be in the format "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'".
File archiving
By default, our API archives files to slower storage after 180 days of no access. The file will only be available again upon a support request.
Error codes
Service | Endpoint | Message | HTTP Status | Reason |
---|---|---|---|---|
Field Operations | Upload a file | Bad Request | 400 | The uploaded file is bigger than 3 GB |
Downloading files from Leaf
To provide greater security all files provided by Leaf are now protected and must be accessed with authentication using the existing Leaf token.
tip
This is a recent change, so the old download links are still available, however, it will be discontinued soon. Therefore, it is strongly recommended that updates are made to access the new download links providers by Leaf (it can be identified with the prefix download-
).
Authentication sample
- cURL
- Python
- JavaScript