Loading ...

REST API: Add File | Axero Documentation

Home » axero documentation » Wiki » Documentation » REST API Overview » REST API: Content » REST API: Files » REST API: Add File
Axero Documentation  Wiki
Public Space
Activity Stream Content
Version 64

REST API: Add File

0 
 /5
0 (0votes)
Open API Guide
POST/api/files

Adds a file to a specific directory. ResponseData is the ID of the new file.

Request

Request Header

HeaderRequiredValueDescription
AuthorizationYESBearer YOUR_TOKENBearer token for the authenticated user. Learn how to create Bearer tokens.
Content-TypeYESapplication/octet-streamUse application/octet-stream. The endpoint does not check it: the request body is saved as the file whatever type is declared.

Required Parameters

ParameterTypeRequiredLocationDescription
FileDirectoryIDIntegerYESQueryUnique ID of the file directory to upload the file to. A value that is not a whole number answers 400.
FileNameStringYESQueryName of the file to create, with its extension. Rejected when it contains characters the site disallows or a file of that name already exists in the directory.

Optional Parameters

ParameterTypeRequiredLocationDescription
FileStreamFile StreamNOBodyThe file's content, sent as the raw request body. Not enforced: a request with no body creates an empty file. A multipart form-data body is not unpacked: the whole body, part headers and boundaries included, is saved as the file.
ContentBodyStringNOQueryThe file description
TagsStringNOQueryComma-separated tag names to apply to the file. Default: none.
DateExpiredDateTimeNOQueryDate and time when the file expires, in UTC. Must be later than the current server time; an earlier time returns an error. If omitted, left blank, or not a valid date, the file does not expire.
IsContentAvailablePostExpiryBooleanNOQuerySet to true to keep the file visible to users after its expiration date. Defaults to false. Applies only when DateExpired is set. A value that is not true or false is treated as false.

Example

Request Header

Authorization: Bearer YOUR_TOKEN
Content-Type: application/octet-stream

Request URL

https://your-site.com/api/files?FileDirectoryID=339&FileName=Axero Overview.pdf&ContentBody=The instantly searchable hub for your employees, projects, and documents.&DateExpired=2026-12-31T17:00:00Z&IsContentAvailablePostExpiry=true

Request Body

To upload a file to the intranet file library (e.g., HR documents, templates, presentations) using Postman:

  1. In Postman, select the Body tab
  2. Choose binary
  3. Select the file to upload
  4. Note: Additional parameters should be passed as query parameters in the URL

Success Response

{
  "IsError": false,
  "ResponseMessage": "ToBePublished",
  "ResponseData": 11557
}

Error Response

{
  "Message": "The requested resource does not support http method 'POST'."
}

Error Handling

Status CodeLikely CauseNext Action
200 with IsErrorThe request was refused, and ResponseMessage says why. The directory may not exist or its ID is 0, or the file name is empty or already used in the directory. The expiration date may not be in the future, or the caller cannot create files there.Read IsError and ResponseMessage and fix the value it names.
400 Bad RequestFileDirectoryID is not a whole number (The request is invalid.).Send the directory's numeric ID.
401 UnauthorizedMissing or invalid Bearer token.Check token validity. Learn how to create Bearer tokens →
403 ForbiddenNot returned: a caller who cannot create files in the directory gets 200 with IsError true, described above.Read IsError on every response.
500 Server ErrorAn internal failure answers 200 with IsError true and the exception text in ResponseMessage.Retry later.
404 or 405A required query parameter was left out, so the request matched a different action or none. The message reads No HTTP resource was found or The requested resource does not support http method.Send every required query parameter. The message does not mean the item you asked for is missing.
403 Forbidden with an HTML bodyThe file name carries a character the site's gateway rejects, such as an angle bracket. The request is refused before it reaches the endpoint, so the body is an HTML error page rather than JSON.Send a file name without characters that are illegal in a URL query value.

Rate Limits

While Axero does not enforce hard rate limits by default, we recommend the following best practices to ensure optimal performance:

  • Sustained Request Rate: Do not exceed 5 API calls per second
  • Sequential Processing: Wait for each request to complete before sending the next in automated workflows
  • Concurrent Connections: If parallel processing is required, limit to 3 or fewer simultaneous requests
  • Response Timeout: Ensure API responses complete within 15 seconds during testing

Axero may implement temporary rate restrictions if excessive API usage affects overall site performance. For high-volume integrations, contact Axero to discuss your requirements.

Wiki Index

Pages