File storage API
Welcome to the File Storage API. You can use this API to access all File Storage API endpoints. Base URL The base URL for all API requests is…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Welcome to the File Storage API.
You can use this API to access all File Storage API endpoints.
Base URL
The base URL for all API requests is https://unify.apideck.com
Headers
Custom headers that are expected as part of the request. Note that RFC7230 states header names are case insensitive.
| Name | Type | Required | Description |
|---|---|---|---|
| x-apideck-consumer-id | String | Yes | The id of the customer stored inside Apideck Vault. This can be a user id, account id, device id or whatever entity that can have integration within your app. |
| x-apideck-service-id | String | No | Describe the service you want to call (e.g., pipedrive). Only needed when a customer has activated multiple integrations for the same Unified API. |
| x-apideck-app-id | String | Yes | The application id of your Unify application. Available at https://app.apideck.com/unify/api-keys. |
| Authorization | String | Yes | Bearer KEY |
Authorization
You can interact with the API through the authorization methods below.
-->
Pagination
All API resources have support for bulk retrieval via list APIs. Apideck uses cursor-based pagination via the optional cursor and limit parameters.
To fetch the first page of results, call the list API without a cursor parameter. Afterwards you can fetch subsequent pages by providing a cursor parameter. You will find the next cursor in the response body in meta.cursors.next. If meta.cursors.next is null you're at the end of the list.
In the REST API you can also use the links from the response for added convenience. Simply call the URL in links.next to get the next page of results.
Query Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| cursor | String | No | Cursor to start from. You can find cursors for next & previous pages in the meta.cursors property of the response. |
| limit | Number | No | Number of results to return. Minimum 1, Maximum 200, Default 20 |
Response Body
| Name | Type | Description |
|---|---|---|
| meta.cursors.previous | String | Cursor to navigate to the previous page of results through the API |
| meta.cursors.current | String | Cursor to navigate to the current page of results through the API |
| meta.cursors.next | String | Cursor to navigate to the next page of results through the API |
| meta.items_on_page | Number | Number of items returned in the data property of the response |
| links.previous | String | Link to navigate to the previous page of results through the API |
| links.current | String | Link to navigate to the current page of results through the API |
| links.next | String | Link to navigate to the next page of results through the API |
⚠️ meta.cursors.previous/links.previous is not available for all connectors.
SDKs and API Clients
We currently offer a Node.js, PHP, Python and .NET SDK.
Need another SDK? Request the SDK of your choice.
Debugging
Because of the nature of the abstraction we do in Apideck Unify we still provide the option to the receive raw requests and responses being handled underlying. By including the raw flag ?raw=true in your requests you can still receive the full request. Please note that this increases the response size and can introduce extra latency.
Errors
The API returns standard HTTP response codes to indicate success or failure of the API requests. For errors, we also return a customized error message inside the JSON response. You can see the returned HTTP status codes below.
| Code | Title | Description … |
Endpoints 33
Files
- GETList Files
/file-storage/files?raw=false&cursor=string&limit=20&filter={"drive_id":"1234","folder_id":"root","shared":true}&sort={"by":"updated_at","direction":"desc"}&pass_through={"search":"San Francisco"}&fields=id,updated_atList Files - POSTUpload file
https://upload.apideck.com/file-storage/files?raw=falseUpload file (max 100MB). Please use the Upload Sessions API to upload bigger files. For more information on uploads, refer to the file upload guide. - POSTSearch Files
/file-storage/files/search?pass_through={"search":"San Francisco"}&fields=id,updated_at&cursor=string&limit=20&raw=false&filter={"drive_id":"1234","folder_id":"root","shared":true}Search Files - GETGet File
/file-storage/files/:id?raw=false&fields=id,updated_atGet File - DELETEDelete File
/file-storage/files/:id?raw=falseDelete File - PATCHRename or move File
/file-storage/files/:id?raw=falseRename or move File - GETDownload File
/file-storage/files/:id/download?fields=id,updated_atDownload File - GETExport File
/file-storage/files/:id/export?fields=id,updated_at&format=pdfExport File
Folders
- POSTCreate Folder
/file-storage/folders?raw=false&fields=id,updated_atCreate Folder - GETGet Folder
/file-storage/folders/:id?raw=false&fields=id,updated_atGet Folder - DELETEDelete Folder
/file-storage/folders/:id?raw=falseDelete Folder - PATCHRename or move Folder
/file-storage/folders/:id?raw=falseRename or move Folder - POSTCopy Folder
/file-storage/folders/:id/copy?raw=false&fields=id,updated_atCopy Folder
Shared Links
- GETList Shared Links
/file-storage/shared-links?raw=false&cursor=string&limit=20&pass_through={"search":"San Francisco"}&fields=id,updated_atList Shared Links - POSTCreate Shared Link
/file-storage/shared-links?raw=falseCreate Shared Link - GETGet Shared Link
/file-storage/shared-links/:id?raw=false&fields=id,updated_atGet Shared Link - DELETEDelete Shared Link
/file-storage/shared-links/:id?raw=falseDelete Shared Link - PATCHUpdate Shared Link
/file-storage/shared-links/:id?raw=falseUpdate Shared Link
Upload Sessions
- POSTStart Upload Session
https://upload.apideck.com/file-storage/upload-sessions?raw=falseStart an Upload Session. Upload sessions are used to upload large files, use the Upload File endpoint to upload smaller files (up to 100MB). Note that the… - GETGet Upload Session
https://upload.apideck.com/file-storage/upload-sessions/:id?raw=false&fields=id,updated_atGet Upload Session. Use the part_size to split your file into parts. Upload the parts to the Upload part of File endpoint. Note that the base URL is… - PUTUpload part of File to Upload Session
https://upload.apideck.com/file-storage/upload-sessions/:id?part_number=0&raw=falseUpload part of File to Upload Session (max 100MB). Get part_size from Get Upload Session first. Every File part (except the last one) uploaded to this… - DELETEAbort Upload Session
/file-storage/upload-sessions/:id?raw=falseAbort Upload Session. Note that the base URL is upload.apideck.com instead of unify.apideck.com. For more information on uploads, refer to the file upload… - POSTFinish Upload Session
https://upload.apideck.com/file-storage/upload-sessions/:id/finish?raw=falseFinish Upload Session. Only call this endpoint after all File parts have been uploaded to Upload part of File. Note that the base URL is upload.apideck.com…
Drives
- GETList Drives
/file-storage/drives?raw=false&cursor=string&limit=20&filter={"group_id":"1234"}&fields=id,updated_atList Drives - POSTCreate Drive
/file-storage/drives?raw=falseCreate Drive - GETGet Drive
/file-storage/drives/:id?raw=false&fields=id,updated_atGet Drive - DELETEDelete Drive
/file-storage/drives/:id?raw=falseDelete Drive - PATCHUpdate Drive
/file-storage/drives/:id?raw=falseUpdate Drive
Drive Groups
- GETList DriveGroups
/file-storage/drive-groups?raw=false&cursor=string&limit=20&filter={"parent_group_id":"1234"}&pass_through={"search":"San Francisco"}&fields=id,updated_atList DriveGroups - POSTCreate DriveGroup
/file-storage/drive-groups?raw=falseCreate DriveGroup - GETGet DriveGroup
/file-storage/drive-groups/:id?raw=false&fields=id,updated_atGet DriveGroup - DELETEDelete DriveGroup
/file-storage/drive-groups/:id?raw=falseDelete DriveGroup - PATCHUpdate DriveGroup
/file-storage/drive-groups/:id?raw=falseUpdate DriveGroup
API details
- Base URL
https://unify.apideck.com- Authentication
- An API key in the Authorization header
- Operations
- 33 operations on 17 pathsGET 12POST 9DELETE 6PATCH 5PUT 1
- Main resources
- Files 8Drive Groups 5Drives 5Folders 5Shared Links 5Upload Sessions 5
- Description format
- OpenAPI 3.0.3, API version
10.83.0 - Links
- Documentation · OpenAPI document · Support
How to test the File storage API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the File storage API collection, without the publisher's secrets.
- Add your credentialsThis API uses an API key in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “List Files” (GET /file-storage/files?raw=false&cursor=string&limit=20&filter={"drive_id":"1234","folder_id":"root","shared":true}&sort={"by":"updated_at","direction":"desc"}&pass_through={"search":"San Francisco"}&fields=id,updated_at), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the File storage API?
Welcome to the File Storage API. You can use this API to access all File Storage API endpoints. Base URL The base URL for all API requests is… It is listed under Developer tools and has 33 endpoints.
Who publishes the File storage API?
It is listed from Apideck's public API description (an OpenAPI document), not published by Apideck on Swastik Codes. Anyone who controls apideck.com can claim the profile by adding a DNS TXT record.
What is the base URL of the File storage API?
Requests go to https://unify.apideck.com. Endpoint paths are added to this base URL.
How do I authenticate with the File storage API?
With an API key in the Authorization header.
How many endpoints does the File storage API have?
33 operations on 17 paths (12 GET, 9 POST, 6 DELETE, 5 PATCH, 1 PUT). The largest groups are Files, Drive Groups, Drives, Folders.
Is forking the File storage API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.