Requests

A Request is a file that should be uploaded by a specific user or group.

Requests can either be manually created and managed, or managed automatically by an Automation.

List Requests

Endpoint

GET/requests

Return Object

Request[]

Authorization Requirement

Available to all authenticated keys or sessions.

Request Parameters

ParameterDescription
mine
boolean		Only show requests of the current user? (Defaults to true if current user is not a site admin.)
path
string		Path to show requests for. If omitted, shows all paths. Send / to represent the root directory.

Additional Arguments

Example Request

curl "https://app.files.com/api/rest/v1/requests.json" \
  -H 'X-FilesAPI-Key: YOUR_API_KEY'

Example Response

[
  {
    "id": 1,
    "path": "example",
    "source": "example",
    "destination": "example",
    "automation_id": 1,
    "user_display_name": "example"
  }
]

List Requests

Endpoint

GET/requests/folders/{path}

Return Object

Request[]

Authorization Requirement

Available to all authenticated keys or sessions.

Request Parameters

ParameterDescription
mine
boolean		Only show requests of the current user? (Defaults to true if current user is not a site admin.)
path
string
Required		Path to show requests for. If omitted, shows all paths. Send / to represent the root directory.

Additional Arguments

Example Request

curl "https://app.files.com/api/rest/v1/requests/folders/{path}" \
  -H 'X-FilesAPI-Key: YOUR_API_KEY'

Example Response

[
  {
    "id": 1,
    "path": "example",
    "source": "example",
    "destination": "example",
    "automation_id": 1,
    "user_display_name": "example"
  }
]

Create Request

Endpoint

POST/requests

Return Object

Request

Authorization Requirement

Available to all authenticated keys or sessions.

Request Parameters

ParameterDescription
path
string
Required		Folder path on which to request the file.
destination
string
Required		Destination filename (without extension) to request.
user_ids
string		A list of user IDs to request the file from. If sent as a string, it should be comma-delimited.
group_ids
string		A list of group IDs to request the file from. If sent as a string, it should be comma-delimited.

Example Request

curl https://app.files.com/api/rest/v1/requests.json \
  -X POST \
  -H 'Content-Type: application/json' \
  -d '{"path":"path","destination":"destination"}' \
  -H 'X-FilesAPI-Key: YOUR_API_KEY'

Example Response

{
  "id": 1,
  "path": "example",
  "source": "example",
  "destination": "example",
  "automation_id": 1,
  "user_display_name": "example"
}

Delete Request

Endpoint

DELETE/requests/{id}

Return Object

No return value.

Authorization Requirement

Available to all authenticated keys or sessions.

Request Parameters

ParameterDescription
id
int64
Required		Request ID.

Example Request

curl https://app.files.com/api/rest/v1/requests/{id}.json \
  -X DELETE \
  -H 'X-FilesAPI-Key: YOUR_API_KEY'

The Request Object

Some of the endpoints above return a Request object. The attributes of this object are listed below.

AttributeDescription
id
int64		Request ID
path
string		Folder path. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
source
string		Source filename, if applicable
destination
string		Destination filename
automation_id
int64		ID of automation that created request
user_display_name
string		User making the request (if applicable)

Example Request Object

{
  "id": 1,
  "path": "example",
  "source": "example",
  "destination": "example",
  "automation_id": 1,
  "user_display_name": "example"
}