Private File Actions

https://api.losant.com/applications/APPLICATION_ID/privateFiles/PRIVATE_FILE_ID

Below are the various requests that can be performed against the Private File resource, as well as the expected parameters and the potential responses.

Delete

Deletes a private file or directory, if a directory all the contents that directory will also be removed.

Method And Url

DELETE https://api.losant.com/applications/APPLICATION_ID/privateFiles/PRIVATE_FILE_ID

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.Application, all.Application.cli, all.Organization, all.User, all.User.cli, privateFile.*, or privateFile.delete.

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID associated with the application	575ec8687ae143cd83dc4a97
PRIVATE_FILE_ID	ID associated with the private file	575ec76c7ae143cd83dc4a96

Request Headers

Name	Required	Description	Default
Authorization	Y	The token for authenticating the request, prepended with Bearer

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X DELETE \
    https://api.losant.com/applications/APPLICATION_ID/privateFiles/PRIVATE_FILE_ID

Successful Responses

Code	Type	Description
200	Success	If private file was successfully deleted

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if private file was not found

Get

Retrieves information on a private file

Method And Url

GET https://api.losant.com/applications/APPLICATION_ID/privateFiles/PRIVATE_FILE_ID

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.Application, all.Application.cli, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.cli, all.User.read, privateFile.*, or privateFile.get.

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID associated with the application	575ec8687ae143cd83dc4a97
PRIVATE_FILE_ID	ID associated with the private file	575ec76c7ae143cd83dc4a96

Request Query Parameters

Name	Required	Description	Default	Example
urlTTL	N	Time in seconds that the private file url will be valid for. Only applies to private files of type 'file'. If 0, no url will be returned.	900	urlTTL=900

Request Headers

Name	Required	Description	Default
Authorization	Y	The token for authenticating the request, prepended with Bearer

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X GET \
    https://api.losant.com/applications/APPLICATION_ID/privateFiles/PRIVATE_FILE_ID

Successful Responses

Code	Type	Description
200	File Schema	Private file information

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if private file was not found

Move

Move a private file or the entire contents of a directory

Method And Url

POST https://api.losant.com/applications/APPLICATION_ID/privateFiles/PRIVATE_FILE_ID/move

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.Application, all.Application.cli, all.Organization, all.User, all.User.cli, privateFile.*, or privateFile.move.

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID associated with the application	575ec8687ae143cd83dc4a97
PRIVATE_FILE_ID	ID associated with the private file	575ec76c7ae143cd83dc4a96

Request Query Parameters

Name	Required	Description	Default	Example
name	N	The new name of the private file or directory		name=fileA
parentDirectory	N	The new parent directory for the private file or directory to move into.		parentDirectory=/new/location/here
urlTTL	N	Time in seconds that the private file url will be valid for. Only applies to private files of type 'file'. If 0, no url will be returned.	900	urlTTL=900

Request Headers

Name	Required	Description	Default
Authorization	Y	The token for authenticating the request, prepended with Bearer

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X POST \
    https://api.losant.com/applications/APPLICATION_ID/privateFiles/PRIVATE_FILE_ID/move

Successful Responses

Code	Type	Description
201	File Schema	Returns a new private file or directory that was created by the move, if a directory a job will kick off to move all the directories children.

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if private file was not found

Patch

Reupload a private file

Method And Url

PATCH https://api.losant.com/applications/APPLICATION_ID/privateFiles/PRIVATE_FILE_ID

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.Application, all.Application.cli, all.Organization, all.User, all.User.cli, privateFile.*, or privateFile.patch.

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID associated with the application	575ec8687ae143cd83dc4a97
PRIVATE_FILE_ID	ID associated with the private file	575ec76c7ae143cd83dc4a96

Request Headers

Name	Required	Description	Default
Authorization	Y	The token for authenticating the request, prepended with Bearer

Request Body

The body of the request should be serialized JSON that validates against the File Patch schema. For example, the following would be a valid body for this request:

{
  "fileSize": 500,
  "contentType": "image",
  "fileDimensions": {
    "width": 200,
    "height": 200
  }
}

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X PATCH \
    -d '{"fileSize":500,"contentType":"image","fileDimensions":{"width":200,"height":200}}' \
    https://api.losant.com/applications/APPLICATION_ID/privateFiles/PRIVATE_FILE_ID

Successful Responses

Code	Type	Description
201	File Upload Post Response	Successfully updated private file and the information needed to upload the file content

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if private file was not found

Upload

Uploads the private file

Method And Url

POST https://api.losant.com/applications/APPLICATION_ID/privateFiles/PRIVATE_FILE_ID/upload

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.Application, all.Application.cli, all.Organization, all.User, all.User.cli, privateFile.*, or privateFile.upload.

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID associated with the application	575ec8687ae143cd83dc4a97
PRIVATE_FILE_ID	ID associated with the private file	575ec76c7ae143cd83dc4a96

Request Query Parameters

Name	Required	Description	Default	Example
urlTTL	N	Time in seconds that the private file url will be valid for. Only applies to private files of type 'file'. If 0, no url will be returned.	900	urlTTL=900

Request Headers

Name	Required	Description	Default
Authorization	Y	The token for authenticating the request, prepended with Bearer

Request Body

The body of the request should be a multipart form data post containing the following:

Name	Required	Description	Default	Example
privateFile	Y	The content of the private file to upload		``

Curl Example

curl -H 'Content-Type: multipart/form-data' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X POST \
    -F privateFile=@localfilename' \
    https://api.losant.com/applications/APPLICATION_ID/privateFiles/PRIVATE_FILE_ID/upload

Successful Responses

Code	Type	Description
200	File Schema	Updated private file content

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if file was not found

Schemas

Error

Schema for errors returned by the API

Error Schema

▶
(root){} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 2 keys
▶
type:{} 1 key
▶
message:{} 1 key

Error Example

▶
(root){} 2 keys
type:"NotFound"
message:"Application was not found"

File Schema

Schema for a single public or private file

File Schema Schema

▶
(root){} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 16 keys
▶
id:{} 2 keys
▶
applicationId:{} 2 keys
▶
creationDate:{} 2 keys
▶
lastUpdated:{} 2 keys
▶
authorId:{} 2 keys
▶
authorType:{} 2 keys
▶
status:{} 2 keys
▶
name:{} 3 keys
▶
parentDirectory:{} 2 keys
▶
type:{} 2 keys
▶
fileSize:{} 1 key
▶
s3etag:{} 1 key
▶
contentType:{} 2 keys
▶
fileDimensions:{} 2 keys
▶
moveIntoId:{} 2 keys
▶
url:{} 1 key

File Schema Example

▶
(root){} 12 keys
id:"575ec8687ae143cd83dc4a97"
applicationId:"575ec8687ae143cd83dc4a97"
creationDate:"2016-06-13T04:00:00.000Z"
lastUpdated:"2016-06-13T04:00:00.000Z"
authorId:"575ed70c7ae143cd83dc4aa9"
authorType:"user"
status:"pending"
name:"file.csv"
type:"file"
parentDirectory:"/"
fileSize:500
contentType:"text/csv"

File Patch

Schema to patch a public or private file

File Patch Schema

▶
(root){} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 3 keys
▶
fileSize:{} 1 key
▶
contentType:{} 2 keys
▶
fileDimensions:{} 2 keys

File Patch Example

▶
(root){} 3 keys
fileSize:500
contentType:"image"
▶
fileDimensions:{} 2 keys

File Upload Post Response

Schema with the information needed to upload public or private file contents

File Upload Post Response Schema

▶
(root){} 2 keys
$schema:"http://json-schema.org/draft-07/schema#"
▶
allOf:[] 2 items

File Upload Post Response Example

▶
(root){} 13 keys
id:"575ec8687ae143cd83dc4a97"
applicationId:"575ec8687ae143cd83dc4a97"
creationDate:"2016-06-13T04:00:00.000Z"
lastUpdated:"2016-06-13T04:00:00.000Z"
authorId:"575ed70c7ae143cd83dc4aa9"
authorType:"user"
status:"pending"
name:"file.csv"
type:"file"
parentDirectory:"/"
fileSize:500
contentType:"text/csv"
▶
upload:{} 2 keys

Success

Schema for reporting a successful operation

Success Schema

▶
(root){} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 1 key
▶
success:{} 2 keys

Success Example

▶
(root){} 1 key
success:true