Skip to content

HeyDonto API Documentation (1.0)

API documentation for HeyDonto API

Overview
Languages
Servers
Mock server

https://docs.heydonto.com/_mock/apis/heydonto/openapi/

Sandbox

https://api-staging.heydonto.com/

Production

https://api.heydonto.com/

Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations

Request

Security
bearer
Query
filePathstringrequired
curl -i -X GET \
  'https://docs.heydonto.com/_mock/apis/heydonto/openapi/storage/path?filePath=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Unauthorized: Invalid or missing token.

Bodyapplication/json
messagestringrequired

Error message indicating unauthorized access.

Example: "Unauthorized"
statusCodenumberrequired

HTTP status code for unauthorized access.

Example: 401
Response
application/json
{ "message": "Unauthorized", "statusCode": 401 }

StorageController_findByPublicPath

Request

Query
filePathstringrequired
curl -i -X GET \
  'https://docs.heydonto.com/_mock/apis/heydonto/openapi/storage/public-access?filePath=string'

Responses

Download synchronizer active version

Request

Downloads active version of the synchronizer from public storage

Security
bearer
curl -i -X GET \
  https://docs.heydonto.com/_mock/apis/heydonto/openapi/storage/synchronizer/download/active \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Unauthorized: Invalid or missing token.

Bodyapplication/json
messagestringrequired

Error message indicating unauthorized access.

Example: "Unauthorized"
statusCodenumberrequired

HTTP status code for unauthorized access.

Example: 401
Response
application/json
{ "message": "Unauthorized", "statusCode": 401 }

Download synchronizer version by path

Request

Downloads a specific version of the synchronizer from public storage

Security
bearer
Path
versionstringrequired
curl -i -X GET \
  'https://docs.heydonto.com/_mock/apis/heydonto/openapi/storage/synchronizer/download/{version}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Unauthorized: Invalid or missing token.

Bodyapplication/json
messagestringrequired

Error message indicating unauthorized access.

Example: "Unauthorized"
statusCodenumberrequired

HTTP status code for unauthorized access.

Example: 401
Response
application/json
{ "message": "Unauthorized", "statusCode": 401 }

Download a GCS folder as a zip file

Request

Bundles all files in a GCS folder into a zip file and downloads it

Security
bearer
Query
folderPathstringrequired

The path to the folder in GCS to download as zip

Example: folderPath=synchronizer/site-123
curl -i -X GET \
  'https://docs.heydonto.com/_mock/apis/heydonto/openapi/storage/folder?folderPath=synchronizer%2Fsite-123' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Unauthorized: Invalid or missing token.

Bodyapplication/json
messagestringrequired

Error message indicating unauthorized access.

Example: "Unauthorized"
statusCodenumberrequired

HTTP status code for unauthorized access.

Example: 401
Response
application/json
{ "message": "Unauthorized", "statusCode": 401 }

Request

Security
bearer
Path
idnumberrequired
curl -i -X GET \
  'https://docs.heydonto.com/_mock/apis/heydonto/openapi/storage/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Unauthorized: Invalid or missing token.

Bodyapplication/json
messagestringrequired

Error message indicating unauthorized access.

Example: "Unauthorized"
statusCodenumberrequired

HTTP status code for unauthorized access.

Example: 401
Response
application/json
{ "message": "Unauthorized", "statusCode": 401 }

Request

Security
bearer
Path
idnumberrequired
curl -i -X DELETE \
  'https://docs.heydonto.com/_mock/apis/heydonto/openapi/storage/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Unauthorized: Invalid or missing token.

Bodyapplication/json
messagestringrequired

Error message indicating unauthorized access.

Example: "Unauthorized"
statusCodenumberrequired

HTTP status code for unauthorized access.

Example: 401
Response
application/json
{ "message": "Unauthorized", "statusCode": 401 }

Request

Security
bearer
curl -i -X POST \
  https://docs.heydonto.com/_mock/apis/heydonto/openapi/storage \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Unauthorized: Invalid or missing token.

Bodyapplication/json
messagestringrequired

Error message indicating unauthorized access.

Example: "Unauthorized"
statusCodenumberrequired

HTTP status code for unauthorized access.

Example: 401
Response
application/json
{ "message": "Unauthorized", "statusCode": 401 }
Operations
Operations
Operations
Operations
Operations
Operations
Operations