Home Knowledge base APIs Files API

Access to this API requires the use of an API key. To acquire your API key, do the following:

  1. Login to your nodeboost.io account.
  2. Click the “Settings” menu, then click on “Accounts”.
  3. On the API Key form, enter your password.
  4. Copy your key to a safe place. Do not reveal this key to anyone outside your organization.

You can then use your API key in the “Authorization” header for your HTTP requests to our API.

Unless otherwise specified, all APIs will return a JSON object string in the response body. All API calls must be made using HTTPS.

Query individual files in a configuration

API endpoint: /api/control/user/files/<slug>/[filename]

Where:

slug – the slug for your domain configuration, for example if your nodeboost.io domain is mysite-t1.nodeboost.io then the slug is “mysite”

filename – the full path of the file you wish to query or purge.

An HTTP GET request against this API will retrieve cache details about the file. An HTTP DELETE request against this API will purge the file from all cache nodes.

Example

curl -H 'Authorization: Token 1234567890abcdef' \
     https://control.nodeboost.io/api/control/user/files/mysite/path/file.txt