API Reference

Learn how to access UNLOQ end points

POST /custom/storage

Save custom storage settings

POST https://api.unloq.io/v1/custom/storage
Headers:
   Authorization: Bearer {your application API Key}
Body parameters
  • type (enum) - Required. Default is 'AWS'.
  • region (string) - Required. Storage region, max 50 characters.
  • bucket (string) - Required. Min 16 characters, max 50.
  • auth (JSON) - Required. Settings from the storage provider in JSON format.
Notes

The auth must contain access information from your storage provider.

AWS example:

{
  "type": "AWS",
  "region": "eu-west-2",
  "bucket": "bucket-information",
  "auth": {
    "accessKeyId": "1234567890123456",
    "secretAccessKey": "1234567890123456",
    "api_key": "key-1234567890123456123456789"
  }
}
Result format (200 OK)
{
  "type": "api.application.storage.save",
  "result": {
    "id": "123456789",
    "is_verified": false,
    "region": "eu-west-2",
    "bucket": "bucket-information",
    "auth": "1234567890***",
    "upload_count": 0,
    "organization_id": "123",
    "application_id": "10",
    "created_at": "2016-11-17T08:10:22.000Z"
  }
}
      

Have a question? You can always send us an email at support@unloq.io, or contact us on chat.

For security related concerns, please visit our Security page.