Aircampi Storage (0.1.0)

Download OpenAPI specification:Download

Support: [email protected] URL: https://github.com/aircampi Terms of Service

Introduction

The Aircampi Storage allows you to manage your project files. Using the Aircampi Storage, you can upload, view, download, and query all your project files.

Bucket

Buckets are distinct containers for files and folders. You can think of them like "drive". Generally you would create distinct buckets for different Security and Access Rules.
Folder

Folders are a way to organize your files (just like on your computer). There is no right or wrong way to organize your files. You can store them in whichever folder structure suits your project.
File

Files can be any sort of media file. This includes images, GIFs, and videos. It is best practice to store files outside of your database because of their sizes.

Quick Links:

Endpoints

This section contains the information about api references for Aircampi Storage.

Group of endpoints:

Buckets
Files
Health Check
Settings

Buckets

Buckets are distinct containers for files and folders. You can think of them like "drive". Generally you would create distinct buckets for different Security and Access Rules.

Get buckets

Retrieve filtered list of buckets.

Authorizations:

Scopes

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all
q	string This query parameter defines the where clause. Example: ?q=(id=497f6eca-6276-4993-bfeb-53cbbbba6f08)
sort	string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort=created_at asc,updated_at desc
offset	integer >= 0 Default: 0 Used to define the starting position of the item collection. If offset exceeds the item count then no items are returned.
limit	integer >= 1 Default: 10 This parameter restricts the number of items returned inside the collection. If the limit exceeds the item count then the server will only return the available items.
total_count	boolean Default: false The item collection representation will include the "estimated row count" when "?total_count=true", otherwise the total_count is not included.

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Access Token

Responses

Response samples

Content type

application/json

{"total_count": 0,
"count": 0,
"has_more": true,
"limit": 0,
"offset": 10,
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "public",
"description": "Public is a default bucket",
"metadata": { },
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"bucket_id": "8f7ac8aa-ed2b-4e16-81e0-0766bdb092b8",
"files": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"files": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"bucket_id": "8f7ac8aa-ed2b-4e16-81e0-0766bdb092b8",
"bucket_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "public",
"description": "Public is a default bucket",
"metadata": { },
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"name": "cover_pictures.png",
"description": "System Cover Picture",
"metadata": {"mime_type": "image/png",
"size_original": 0,
"size_compressed": 0,
"chunks_total": 3,
"chunks_uploaded": 2,
"signature": "string"
},
"created_date": "2019-08-24T14:15:22Z",
"updated_date": "2019-08-24T14:15:22Z"
}
]
}
]
}

Create storage

Authorizations:

Scopes

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Access Token

Request Body schema: application/json

Create Bucket

name required	string (bucket_name) Bucket Name
description	string Bucket Description
metadata	object (bucket_metadata) Bucket Metadata

Responses

Request samples

Payload

Content type

application/json

{"name": "public",
"description": "Public is a default bucket",
"metadata": { }
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "public",
"description": "Public is a default bucket",
"metadata": { },
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"bucket_id": "8f7ac8aa-ed2b-4e16-81e0-0766bdb092b8",
"files": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"files": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"bucket_id": "8f7ac8aa-ed2b-4e16-81e0-0766bdb092b8",
"bucket_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "public",
"description": "Public is a default bucket",
"metadata": { },
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"name": "cover_pictures.png",
"description": "System Cover Picture",
"metadata": {"mime_type": "image/png",
"size_original": 0,
"size_compressed": 0,
"chunks_total": 3,
"chunks_uploaded": 2,
"signature": "string"
},
"created_date": "2019-08-24T14:15:22Z",
"updated_date": "2019-08-24T14:15:22Z"
}
]
}

Get Storage

Retrieve databse details.

Authorizations:

Scopes

path Parameters

bucket

required

string (bucket_name)

Example: public

Bucket Name

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Access Token

Responses

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "public",
"description": "Public is a default bucket",
"metadata": { },
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"bucket_id": "8f7ac8aa-ed2b-4e16-81e0-0766bdb092b8",
"files": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"files": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"bucket_id": "8f7ac8aa-ed2b-4e16-81e0-0766bdb092b8",
"bucket_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "public",
"description": "Public is a default bucket",
"metadata": { },
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"name": "cover_pictures.png",
"description": "System Cover Picture",
"metadata": {"mime_type": "image/png",
"size_original": 0,
"size_compressed": 0,
"chunks_total": 3,
"chunks_uploaded": 2,
"signature": "string"
},
"created_date": "2019-08-24T14:15:22Z",
"updated_date": "2019-08-24T14:15:22Z"
}
]
}

Update Bucket

Authorizations:

Scopes

path Parameters

bucket

required

string (bucket_name)

Example: public

Bucket Name

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Access Token

Request Body schema: application/json

Update Bucket

name	string (bucket_name) Bucket Name
description	string Bucket Description
metadata	object (bucket_metadata) Bucket Metadata

Responses

Request samples

Payload

Content type

application/json

{"name": "public",
"description": "Public is a default bucket",
"metadata": { }
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "public",
"description": "Public is a default bucket",
"metadata": { },
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"bucket_id": "8f7ac8aa-ed2b-4e16-81e0-0766bdb092b8",
"files": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"files": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"bucket_id": "8f7ac8aa-ed2b-4e16-81e0-0766bdb092b8",
"bucket_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "public",
"description": "Public is a default bucket",
"metadata": { },
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"name": "cover_pictures.png",
"description": "System Cover Picture",
"metadata": {"mime_type": "image/png",
"size_original": 0,
"size_compressed": 0,
"chunks_total": 3,
"chunks_uploaded": 2,
"signature": "string"
},
"created_date": "2019-08-24T14:15:22Z",
"updated_date": "2019-08-24T14:15:22Z"
}
]
}

Delete Storage

Delete Storage. Default Storage cannot be deleted.

Authorizations:

Scopes

path Parameters

bucket

required

string (bucket_name)

Example: public

Bucket Name

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Access Token

Responses

Response samples

Content type

application/json

{"code": "invalid_request",
"message": "Invalid `fields` parameter. See https://developer.aircampi.com/api/query-fields"
}

Rename Bucket

Authorizations:

Scopes

path Parameters

bucket

required

string (bucket_name)

Example: public

Bucket Name

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Access Token

Request Body schema: application/json

Rename Bucket

new_name

string (bucket_name)

Bucket Name

Responses

Request samples

Payload

Content type

application/json

{"new_name": "renamed_bucket"
}

Response samples

Content type

application/json

{"code": "invalid_request",
"message": "Invalid `fields` parameter. See https://developer.aircampi.com/api/query-fields"
}

Truncate Bucket

Authorizations:

Scopes

path Parameters

bucket

required

string (bucket_name)

Example: public

Bucket Name

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Access Token

Responses

Response samples

Content type

application/json

{"code": "invalid_request",
"message": "Invalid `fields` parameter. See https://developer.aircampi.com/api/query-fields"
}

Files

Files can be any sort of media file. This includes images, GIFs, and videos. It is best practice to store files outside of your database because of their sizes.

Get Files

Retrieve filtered list of files.

Authorizations:

Scopes

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all
q	string This query parameter defines the where clause. Example: ?q=(id=497f6eca-6276-4993-bfeb-53cbbbba6f08)
sort	string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort=created_at asc,updated_at desc
offset	integer >= 0 Default: 0 Used to define the starting position of the item collection. If offset exceeds the item count then no items are returned.
limit	integer >= 1 Default: 10 This parameter restricts the number of items returned inside the collection. If the limit exceeds the item count then the server will only return the available items.
total_count	boolean Default: false The item collection representation will include the "estimated row count" when "?total_count=true", otherwise the total_count is not included.

header Parameters

Authorization required	string (bearer_authorization) Default: Bearer {{access_token}} Access Token
bucket required	string (bucket_name) Example: public Bucket

Responses

Response samples

Content type

application/json

{"total_count": 0,
"count": 0,
"has_more": true,
"limit": 0,
"offset": 10,
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"bucket_id": "8f7ac8aa-ed2b-4e16-81e0-0766bdb092b8",
"bucket_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "public",
"description": "Public is a default bucket",
"metadata": { },
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"name": "cover_pictures.png",
"description": "System Cover Picture",
"metadata": {"mime_type": "image/png",
"size_original": 0,
"size_compressed": 0,
"chunks_total": 3,
"chunks_uploaded": 2,
"signature": "string"
},
"created_date": "2019-08-24T14:15:22Z",
"updated_date": "2019-08-24T14:15:22Z"
}
]
}

Create File

Authorizations:

Scopes

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization required	string (bearer_authorization) Default: Bearer {{access_token}} Access Token
bucket required	string (bucket_name) Example: public Bucket

Request Body schema: application/json

Create File

name required	string (file_name) File Name
description	string File Description
	object (file_metadata) File Metadata

Responses

Request samples

Payload

Content type

application/json

{"name": "cover_pictures.png",
"description": "All users",
"metadata": {"mime_type": "image/png",
"size_original": 0,
"size_compressed": 0,
"chunks_total": 3,
"chunks_uploaded": 2,
"signature": "string"
}
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"bucket_id": "8f7ac8aa-ed2b-4e16-81e0-0766bdb092b8",
"bucket_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "public",
"description": "Public is a default bucket",
"metadata": { },
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"name": "cover_pictures.png",
"description": "System Cover Picture",
"metadata": {"mime_type": "image/png",
"size_original": 0,
"size_compressed": 0,
"chunks_total": 3,
"chunks_uploaded": 2,
"signature": "string"
},
"created_date": "2019-08-24T14:15:22Z",
"updated_date": "2019-08-24T14:15:22Z"
}

Get File

Retrieve table details.

Authorizations:

Scopes

path Parameters

file_id

required

string <uuid> (file_id)

File Unique Identifier (ID)

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization required	string (bearer_authorization) Default: Bearer {{access_token}} Access Token
bucket required	string (bucket_name) Example: public Bucket

Responses

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"bucket_id": "8f7ac8aa-ed2b-4e16-81e0-0766bdb092b8",
"bucket_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "public",
"description": "Public is a default bucket",
"metadata": { },
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"name": "cover_pictures.png",
"description": "System Cover Picture",
"metadata": {"mime_type": "image/png",
"size_original": 0,
"size_compressed": 0,
"chunks_total": 3,
"chunks_uploaded": 2,
"signature": "string"
},
"created_date": "2019-08-24T14:15:22Z",
"updated_date": "2019-08-24T14:15:22Z"
}

Update File

Authorizations:

Scopes

path Parameters

file_id

required

string <uuid> (file_id)

File Unique Identifier (ID)

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization required	string (bearer_authorization) Default: Bearer {{access_token}} Access Token
bucket required	string (bucket_name) Example: public Bucket

Request Body schema: application/json

Update File

name	string (file_name) File Name
description	string File Description
	object (file_metadata) File Metadata

Responses

Request samples

Payload

Content type

application/json

{"name": "cover_pictures.png",
"description": "All users",
"metadata": {"mime_type": "image/png",
"size_original": 0,
"size_compressed": 0,
"chunks_total": 3,
"chunks_uploaded": 2,
"signature": "string"
}
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"bucket_id": "8f7ac8aa-ed2b-4e16-81e0-0766bdb092b8",
"bucket_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "public",
"description": "Public is a default bucket",
"metadata": { },
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"name": "cover_pictures.png",
"description": "System Cover Picture",
"metadata": {"mime_type": "image/png",
"size_original": 0,
"size_compressed": 0,
"chunks_total": 3,
"chunks_uploaded": 2,
"signature": "string"
},
"created_date": "2019-08-24T14:15:22Z",
"updated_date": "2019-08-24T14:15:22Z"
}

Delete File

Authorizations:

Scopes

path Parameters

file_id

required

string <uuid> (file_id)

File Unique Identifier (ID)

header Parameters

Authorization required	string (bearer_authorization) Default: Bearer {{access_token}} Access Token
bucket required	string (bucket_name) Example: public Bucket

Responses

Response samples

Content type

application/json

{"code": "invalid_request",
"message": "Invalid `fields` parameter. See https://developer.aircampi.com/api/query-fields"
}

Rename File

Authorizations:

Scopes

path Parameters

file_id

required

string <uuid> (file_id)

File Unique Identifier (ID)

header Parameters

Authorization required	string (bearer_authorization) Default: Bearer {{access_token}} Access Token
bucket required	string (bucket_name) Example: public Bucket

Request Body schema: application/json

Rename File

new_name

string (file_name)

File Name

Responses

Request samples

Payload

Content type

application/json

{"new_name": "renamed_file"
}

Response samples

Content type

application/json

{"code": "invalid_request",
"message": "Invalid `fields` parameter. See https://developer.aircampi.com/api/query-fields"
}

Settings

Aircampi Storage's settings allow you to edit your server setup configuration and customize it. You can easily change the it by changing them when running Aircampi Storage.

Get Settings

Authorizations:

Scopes

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Access Token

Responses

Response samples

Content type

application/json

{"environment": "development"
}

Update Settings

Authorizations:

Scopes

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Access Token

Request Body schema: application/json

Update Settings

environment

string

Default: "development"

Enum: "development" "staging" "production"

Environment

Responses

Request samples

Payload

Content type

application/json

{"environment": "development"
}

Response samples

Content type

application/json

{"environment": "development"
}

Health Check

The Health service is designed to allow you to both validate and monitor that your Aircampi Storage's instance and all of its internal components are up and responsive.

Check Health

Responses

Response samples

Content type

application/json

{"server_name": "Aircampi Storage",
"server_version": "0.1.0",
"server_status": "Active",
"server_description": "File Store"
}

Models

This section contains the information about resources for Aircampi Storage and their fields, and child resources.

Group of models:

Bucket Models
File Models
Settings Models
Health Check Models

Bucket Models

Bucket
Buckets
Bucket Aggregation

Bucket

Resource Type: Single Resource

Fields:

id
name
description
metadata
created_at
updated_at

Child Resources:

aggregations
files

id	string <uuid> (bucket_id) Bucket Unique Identifier (ID)
name	string (bucket_name) Bucket Name
description	string Bucket Description
metadata	object (bucket_metadata) Bucket Metadata
created_by	string <uuid> (user_id) User Id
created_at	string <date-time> (created_at) Create at date and time
updated_by	string <uuid> (user_id) User Id
updated_at	string <date-time> (updated_at) Updated at date and time
	object (bucket_aggregation) Storage Aggregation
	Array of objects (file)

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "public",
"description": "Public is a default bucket",
"metadata": { },
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"bucket_id": "8f7ac8aa-ed2b-4e16-81e0-0766bdb092b8",
"files": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"files": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"bucket_id": "8f7ac8aa-ed2b-4e16-81e0-0766bdb092b8",
"bucket_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "public",
"description": "Public is a default bucket",
"metadata": { },
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"name": "cover_pictures.png",
"description": "System Cover Picture",
"metadata": {"mime_type": "image/png",
"size_original": 0,
"size_compressed": 0,
"chunks_total": 3,
"chunks_uploaded": 2,
"signature": "string"
},
"created_date": "2019-08-24T14:15:22Z",
"updated_date": "2019-08-24T14:15:22Z"
}
]
}

Buckets

Resource Type: Collection Resource

total_count	integer (Total Count) The total number of search records that match the query If you send request with query parameter ?total_count=true only. Otherwise the total_count is not included.
count	integer (Count) The number of items returned in the current range.
has_more	boolean (HasMore) Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
limit	integer (Limit) The actual paging size used by the server.
offset	integer (Offset) Default: 10 The offset value used in the current page.
	Array of objects (bucket) The clients in the collection.

{"total_count": 0,
"count": 0,
"has_more": true,
"limit": 0,
"offset": 10,
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "public",
"description": "Public is a default bucket",
"metadata": { },
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"bucket_id": "8f7ac8aa-ed2b-4e16-81e0-0766bdb092b8",
"files": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"files": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"bucket_id": "8f7ac8aa-ed2b-4e16-81e0-0766bdb092b8",
"bucket_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "public",
"description": "Public is a default bucket",
"metadata": { },
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"name": "cover_pictures.png",
"description": "System Cover Picture",
"metadata": {"mime_type": "image/png",
"size_original": 0,
"size_compressed": 0,
"chunks_total": 3,
"chunks_uploaded": 2,
"signature": "string"
},
"created_date": "2019-08-24T14:15:22Z",
"updated_date": "2019-08-24T14:15:22Z"
}
]
}
]
}

Bucket Aggregation

Resource Type: Single Resource

Fields:

id
bucket_id
files
created_at
updated_at

Child Resources: No child resources.

id	string <uuid> (id) Unique Identifier (ID)
bucket_id	string <uuid> (bucket_id) Bucket Unique Identifier (ID)
files	integer Default: 0 Number of Files
created_by	string <uuid> (user_id) User Id
created_at	string <date-time> (created_at) Create at date and time
updated_by	string <uuid> (user_id) User Id
updated_at	string <date-time> (updated_at) Updated at date and time

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"bucket_id": "8f7ac8aa-ed2b-4e16-81e0-0766bdb092b8",
"files": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

File Models

File
Files

File

Resource Type: Single Resource

Fields:

id
bucket_id
name
description
metadata
created_at
updated_at

Child Resources:

bucket_data

id	string <uuid> (file_id) File Unique Identifier (ID)
bucket_id	string <uuid> (bucket_id) Bucket Unique Identifier (ID)
	object (file_bucket_data) Storage's data and child items
name	string (file_name) File Name
description	string (file_description) File Description
	object (file_metadata) File Metadata
created_date	string <date-time> (created_at) Create at date and time
updated_date	string <date-time> (updated_at) Updated at date and time

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"bucket_id": "8f7ac8aa-ed2b-4e16-81e0-0766bdb092b8",
"bucket_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "public",
"description": "Public is a default bucket",
"metadata": { },
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"name": "cover_pictures.png",
"description": "System Cover Picture",
"metadata": {"mime_type": "image/png",
"size_original": 0,
"size_compressed": 0,
"chunks_total": 3,
"chunks_uploaded": 2,
"signature": "string"
},
"created_date": "2019-08-24T14:15:22Z",
"updated_date": "2019-08-24T14:15:22Z"
}

Files

Resource Type: Collection Resource

total_count	integer (Total Count) The total number of search records that match the query If you send request with query parameter ?total_count=true only. Otherwise the total_count is not included.
count	integer (Count) The number of items returned in the current range.
has_more	boolean (HasMore) Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
limit	integer (Limit) The actual paging size used by the server.
offset	integer (Offset) Default: 10 The offset value used in the current page.
	Array of objects (file) The resources in the collection.

{"total_count": 0,
"count": 0,
"has_more": true,
"limit": 0,
"offset": 10,
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"bucket_id": "8f7ac8aa-ed2b-4e16-81e0-0766bdb092b8",
"bucket_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "public",
"description": "Public is a default bucket",
"metadata": { },
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"name": "cover_pictures.png",
"description": "System Cover Picture",
"metadata": {"mime_type": "image/png",
"size_original": 0,
"size_compressed": 0,
"chunks_total": 3,
"chunks_uploaded": 2,
"signature": "string"
},
"created_date": "2019-08-24T14:15:22Z",
"updated_date": "2019-08-24T14:15:22Z"
}
]
}

Settings Models

Server Settings

Server Settings

Resource Type: Single Resource

Fields:

id
created_at
updated_at

Child Resources: No child resources.

environment

string

Default: "development"

Enum: "development" "staging" "production"

Environment

{"environment": "development"
}

Health Check Models

Health Check

Health Check

Resource Type: Single Resource

Fields:

server_name
server_version
server_status
server_description

Child Resources: No child resources.

server_name	string Name of server
server_version	string Version of server
server_status	string Default: "Active" Enum: "Active" "Warning" "Error" Status of server
server_description	string Description of server

{"server_name": "Aircampi Storage",
"server_version": "0.1.0",
"server_status": "Active",
"server_description": "File Store"
}