External APIs
The External API are defined for the users outside your organization to upload data.
Endpoint
Endpoint: POST /api/secure-file-upload/upload
Description: This endpoint allows external application users to securely upload files to a designated bucket and directory in the Guardium® Quantum Safe system.
Authentication: This API uses an API key for authentication.
- Header Name: X-API-KEY
- Example Value: b3d2539b-8ee6-4f4c-af49-a12e48396009
| Header | Value | Required | Description |
|---|---|---|---|
| Content-Type | multipart/form-data | Yes | Required for file uploads |
| X-API-KEY | String | Yes | API key for authorization |
| Field | Type | Required | Description |
|---|---|---|---|
| bucket | string | Yes | Name of the bucket where the file should be upload. |
| directory | string | Yes | Subdirectory (within the bucket) to place the uploaded file |
| file | file | Yes | The file to upload |
Successful Response
Status Code: 200 OK
Example:
{
"message": "File uploaded successfully",
"filePath": "first.bucket/upload-dir/your-file-name.ext",
"timestamp": "2025-07-24T10:15:30Z"
}
| Taus code | Reason | Example message |
|---|---|---|
| 400 Bad Request | Missing required fields | Missing required form fields |
| 401 Unauthorized | Invalid or missing API key | Invalid API key |
| 500 Internal Server | Server error during uploa | Failed to upload file |