Admin Files

Upload Files

post
Authorizations
AuthorizationstringRequired

Enter your JWT token (without 'Bearer ' prefix)

Body
uploader_usernamestringRequired
metadatastringRequired
filesstring[]Required
Responses
chevron-right
200

Successful Response

application/json
filenamestring · max: 255Required
sourcestring · max: 255Required
descriptionany ofOptional
string · max: 512Optional
or
nullOptional
storage_pathstring · max: 512Required
uploader_usernamestring · max: 255Required
access_levelany ofOptionalDefault: public
string · max: 50Optional
or
nullOptional
tagsany ofOptional
string[]Optional
or
nullOptional
organization_idintegerRequired
active_statusany ofOptionalDefault: active
string · max: 50Optional
or
nullOptional
post
/api/v1/admin/files/upload

List Admin Files

get
Authorizations
AuthorizationstringRequired

Enter your JWT token (without 'Bearer ' prefix)

Query parameters
role_idany ofOptional
integerOptional
or
nullOptional
Responses
chevron-right
200

Successful Response

application/json
filenamestring · max: 255Required
sourcestring · max: 255Required
descriptionany ofOptional
string · max: 512Optional
or
nullOptional
storage_pathstring · max: 512Required
uploader_usernamestring · max: 255Required
access_levelany ofOptionalDefault: public
string · max: 50Optional
or
nullOptional
tagsany ofOptional
string[]Optional
or
nullOptional
organization_idintegerRequired
active_statusany ofOptionalDefault: active
string · max: 50Optional
or
nullOptional
file_idintegerRequired
uploaded_atstring · date-timeRequired
get
/api/v1/admin/files

Get Admin File

get
Authorizations
AuthorizationstringRequired

Enter your JWT token (without 'Bearer ' prefix)

Path parameters
file_idintegerRequired
Responses
chevron-right
200

Successful Response

application/json
filenamestring · max: 255Required
sourcestring · max: 255Required
descriptionany ofOptional
string · max: 512Optional
or
nullOptional
storage_pathstring · max: 512Required
uploader_usernamestring · max: 255Required
access_levelany ofOptionalDefault: public
string · max: 50Optional
or
nullOptional
tagsany ofOptional
string[]Optional
or
nullOptional
organization_idintegerRequired
active_statusany ofOptionalDefault: active
string · max: 50Optional
or
nullOptional
file_idintegerRequired
uploaded_atstring · date-timeRequired
get
/api/v1/admin/files/{file_id}

Delete Admin File

delete
Authorizations
AuthorizationstringRequired

Enter your JWT token (without 'Bearer ' prefix)

Path parameters
file_idintegerRequired
Responses
chevron-right
200

Successful Response

application/json
anyOptional
delete
/api/v1/admin/files/{file_id}

No content

Update Admin File

patch
Authorizations
AuthorizationstringRequired

Enter your JWT token (without 'Bearer ' prefix)

Path parameters
file_idintegerRequired
Body
filenameany ofOptional
stringOptional
or
nullOptional
sourceany ofOptional
stringOptional
or
nullOptional
descriptionany ofOptional
stringOptional
or
nullOptional
uploaded_atany ofOptional
string · date-timeOptional
or
nullOptional
storage_pathany ofOptional
stringOptional
or
nullOptional
uploader_usernameany ofOptional
stringOptional
or
nullOptional
access_levelany ofOptional
stringOptional
or
nullOptional
tagsany ofOptional
string[]Optional
or
nullOptional
organization_idany ofOptional
integerOptional
or
nullOptional
Responses
chevron-right
200

Successful Response

application/json
filenamestring · max: 255Required
sourcestring · max: 255Required
descriptionany ofOptional
string · max: 512Optional
or
nullOptional
storage_pathstring · max: 512Required
uploader_usernamestring · max: 255Required
access_levelany ofOptionalDefault: public
string · max: 50Optional
or
nullOptional
tagsany ofOptional
string[]Optional
or
nullOptional
organization_idintegerRequired
active_statusany ofOptionalDefault: active
string · max: 50Optional
or
nullOptional
file_idintegerRequired
uploaded_atstring · date-timeRequired
patch
/api/v1/admin/files/{file_id}

Download Admin File

get
Authorizations
AuthorizationstringRequired

Enter your JWT token (without 'Bearer ' prefix)

Path parameters
file_idintegerRequired
Responses
chevron-right
200

Successful Response

No content

get
/api/v1/admin/files/{file_id}/download

No content

Sync Admin Files

post
Authorizations
AuthorizationstringRequired

Enter your JWT token (without 'Bearer ' prefix)

Body
directory_pathstringRequired
uploader_usernamestringRequired
organization_idintegerOptionalDefault: 1
Responses
chevron-right
200

Successful Response

application/json
anyOptional
post
/api/v1/admin/files/sync_files

No content

Last updated