DocsAppearance
Cloud Storage integration
We currently only support Amazon S3 and Cloudflare R2. Stay tuned for more additional Storage providers.
Create Cloudflare R2 integration
Refer to Cloudflare's documentation how to create an API token. Once created, you will need to provide the bucket name, accessKeyId, secretAccessKey and accountId.
POST /integration
Request
json
{
"label": "My R2 Storage Credentials",
"provider": "r2",
"platform": "cloud",
"credentials": {
"bucket": "examplebucket",
"accessKeyId": "xxx",
"secretAccessKey": "yyy",
"accountId": "zzz",
"region": "auto"
}
}
Response
json
{
"id": "a7a0b392-4ec7-4b02-bef4-80c955ac674f",
"createdAt": "2024-02-27T17:16:42.590Z",
"updatedAt": "2024-02-27T17:16:42.590Z",
"message": "The Integration credentials have been successfully created."
}
HTTP Status codes:
| HTTP Code | Description |
|---|---|
| 200 | On success |
| 422 | Any validation-related errors |
| 500 | Any unhandled exceptions |
Create Amazon S3 integration
Refer to AWS Documentation on how to create access keys. Once created, you will need to provide the bucket name, accessKeyId and secretAccessKey.
Request
json
{
"label": "My S3 Storage Credentials",
"provider": "s3",
"platform": "cloud",
"credentials": {
"accessKeyId": "xxx",
"bucket": "yyy",
"secretAccessKey": "zzz"
}
}
Response
json
{
"id": "a7a0b392-4ec7-4b02-bef4-80c955ac674f",
"createdAt": "2024-02-27T17:16:42.590Z",
"updatedAt": "2024-02-27T17:16:42.590Z",
"message": "The Integration credentials have been successfully created."
}
HTTP Status codes:
| HTTP Code | Description |
|---|---|
| 200 | On success |
| 422 | Any validation-related errors |
| 500 | Any unhandled exceptions |