HumHub - cFiles API (1.0.0)

Download OpenAPI specification:Download

E-mail: info@humhub.com License: AGPLv2

Welcome to the HumHub cFiles module API reference.

Authentication

Bearer

Security scheme type: JWT

BasicAuth

Security scheme type: HTTP
HTTP Authorization Scheme basic

Directory

Find all folders by content container

path Parameters
id
required
integer

The id of content container

query Parameters
page
string >= 0

The number of page of the result set.

limit
string [ 1 .. 50 ]
Default: 20

The numbers of items to return per page.

Responses

200

Success

get /cfiels/folders/container/{id}
/api/v1/cfiels/folders/container/{id}

Response samples

Copy
Expand all Collapse all
{}

Create new directory

path Parameters
id
required
integer

The id of content container

Request Body schema: application/json

Directory information

target_id
required
integer <int64>
Folder
required
object

Responses

200

Success

404

Not found

422

Validation failed

500

Internal server error

post /cfiels/folders/container/{id}
/api/v1/cfiels/folders/container/{id}

Request samples

application/json
Copy
Expand all Collapse all
{
  • "target_id": 1,
  • "Folder":
    {
    }
}

Response samples

application/json
Copy
Expand all Collapse all
{}

Get directory by id

path Parameters
id
required
integer

The id of directory

Responses

200

Success

404

Not found

get /cfiels/folder/{id}
/api/v1/cfiels/folder/{id}

Response samples

application/json
Copy
Expand all Collapse all
{}

Update directory by id

path Parameters
id
required
integer

The id of the directory

Request Body schema: application/json

Directory information

target_id
required
integer <int64>
Folder
required
object

Responses

200

Success

404

Not found

422

Validation failed

500

Internal server error

put /cfiels/folder/{id}
/api/v1/cfiels/folder/{id}

Request samples

application/json
Copy
Expand all Collapse all
{
  • "target_id": 1,
  • "Folder":
    {
    }
}

Response samples

application/json
Copy
Expand all Collapse all
{}

Deletes a directory by id

path Parameters
id
required
integer

The id of directory

Responses

200

Success

404

Not found

delete /cfiels/folder/{id}
/api/v1/cfiels/folder/{id}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "code": 200,
  • "message": "Selected items are successfully deleted!"
}

File

Find all files by content container

path Parameters
id
required
integer

The id of content container

query Parameters
page
string >= 0

The number of page of the result set.

limit
string [ 1 .. 50 ]
Default: 20

The numbers of items to return per page.

Responses

200

Success

get /cfiels/files/container/{id}
/api/v1/cfiels/files/container/{id}

Response samples

Copy
Expand all Collapse all
{
  • "total": 76,
  • "page": 1,
  • "results":
    []
}

Upload files

path Parameters
id
required
integer

The id of content container

Request Body schema: application/x-www-form-urlencoded
folder_id
required
integer <int64>

Id of directory

files
required
Array of file

The files to upload.

Responses

200

Success

400

Bad Request

404

Not found

422

Validation failed

500

Internal server error

post /cfiels/files/container/{id}
/api/v1/cfiels/files/container/{id}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "code": 200,
  • "message": "Files successfully uploaded!"
}

Get file info by id

path Parameters
id
required
integer

The id of file

Responses

200

Success

404

Not found

get /cfiels/file/{id}
/api/v1/cfiels/file/{id}

Response samples

application/json
Copy
Expand all Collapse all
{}

Deletes a file by id

path Parameters
id
required
integer

The id of file

Responses

200

Success

404

Not found

delete /cfiels/file/{id}
/api/v1/cfiels/file/{id}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "code": 200,
  • "message": "Successfully deleted!"
}

Items Management

Make items public

path Parameters
id
required
integer

The id of content container

Request Body schema: application/json

Array of items

selection
required
Array of strings (Selection)

Item id in format {type}_{id}

Responses

200

Success

400

Bad Request

404

Not found

500

Internal server error

patch /cfiels/items/container/{id}/make-public
/api/v1/cfiels/items/container/{id}/make-public

Request samples

application/json
Copy
Expand all Collapse all
{
  • "selection":
    [
    ]
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "code": 200,
  • "message": "Items successfully marked public!"
}

Make items private

path Parameters
id
required
integer

The id of content container

Request Body schema: application/json

Array of items

selection
required
Array of strings (Selection)

Item id in format {type}_{id}

Responses

200

Success

400

Bad Request

404

Not found

500

Internal server error

patch /cfiels/items/container/{id}/make-private
/api/v1/cfiels/items/container/{id}/make-private

Request samples

application/json
Copy
Expand all Collapse all
{
  • "selection":
    [
    ]
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "code": 200,
  • "message": "Items successfully marked private!"
}

Move items to another folder

path Parameters
id
required
integer

The id of content container

Request Body schema: application/json

Directory information

source_id
required
integer <int64>
MoveForm
required
object
selection
required
Array of strings (Selection)

Item id in format {type}_{id}

Responses

200

Success

400

Bad Request

404

Not found

422

Validation failed

500

Internal server error

post /cfiels/items/container/{id}/move
/api/v1/cfiels/items/container/{id}/move

Request samples

application/json
Copy
Expand all Collapse all
{
  • "source_id": 14,
  • "MoveForm":
    {
    },
  • "selection":
    [
    ]
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "code": 200,
  • "message": "Items successfully moved."
}

Delete items from folder

path Parameters
id
required
integer

The id of content container

Request Body schema: application/json

Array of items

selection
required
Array of strings (Selection)

Item id in format {type}_{id}

Responses

200

Success

400

Bad Request

404

Not found

500

Internal server error

delete /cfiels/items/container/{id}/delete
/api/v1/cfiels/items/container/{id}/delete

Request samples

application/json
Copy
Expand all Collapse all
{
  • "selection":
    [
    ]
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "code": 200,
  • "message": "Selected items are successfully deleted!"
}