Create a new Airbox

POST {{protocol}}://{{api-server}}/{{token}}/v4/airboxes

Create a New Airbox

This endpoint allows you to create a new Airbox with the specified configuration.

Body Parameters

• title (string, required): The title of the airbox.

• description (string, optional): Description of the airbox.

• starts_at (string, optional): The starting date and time when the airbox will become active. It should be in format YYYY-MM-DDTHH:mm

• expires_at (string, optional): Expiry date and time for the airbox. It should be in format YYYY-MM-DDTHH:mm

• starts_tz (string,optional): The time zone for the starts_at time. Only applicable if starts_at is provided.

• expires_tz (string, optional): The time zone for the expires_at time. Only applicable if expires_at is provided.

** If the timezone is not mentiond, by default it is UTC.

• airbox_limits (object, optional):

  • max_file_size_mb (number, optional): Maximum file size (in MBs) allowed per asset.
  • max_total_files_count (number, optional): Maximum total number of files allowed for upload.
  • max_total_files_size_mb (number, optional): Maximum file size (in MBs) of all uploaded assets.

• target_folder (string, required): Target folder where the files will be uploaded.

• auth (array, optional):

  • pass (string): Password that users must provide to access the Airbox.

Query String Parameters

• force=1(optional) - Forces the creation of a new Airbox, even if another Airbox is already pointing to the same target folder.
  If this parameter is omitted from the request, the system will check if another Airbox is referring to the same target folder and will return a notification if such exists (the Airbox won't be created in that case).

Response Body

The response body will contain the details of the newly created airbox, including its unique identifier, title, description, configuration, and authentication details.

Request Body

{"title"=>"ABC-1", "description"=>"Airbox Description", "starts_at"=>"2024-08-15T09:00", "expires_at"=>"2024-08-21T09:00", "airbox_limits"=>{"max_file_size_mb"=>50, "max_total_files_count"=>100, "max_total_files_size_mb"=>5120}, "target_folder"=>"/", "auth"=>[{"pass"=>"test-password"}], "forceCreating"=>true}

HEADERS

RESPONSES

status: OK

{"status":"success","msg":"Successfully added a new airbox","airbox":{"uuid":"69a5fbef-171c-4e35-bebe-159a6887879c","title":"ABC-1","type":"airbox","description":"Airbox Description","token":"token","starts_at":"2024-08-15T09:00:00Z","expires_at":"2024-08-21T09:00:00Z","starts_tz":"Europe/London","expires_tz":"Europe/London","auth":[{"pass":"test-password"}],"target_folder":"/","airbox_limits":{"max_file_size_mb":50,"max_total_files_count":100,"max_total_files_size_mb":5120},"airbox_configurations":{},"airbox_data":{},"airbox_uri":"https://airbox.filerobot.com/token/v3/a/ulnjCk515d0q/abc-1"},"info":{"duration":0.1013181209564209,"api_version":4},"api_version":{"hash":"1ce24f12ff9f3205395f34065a5b87bbfa619e25","datetime":"2024-08-13T12:13:54+07:00","module":"elastic_v2"}}