OnTrak API documentation

# Install the command line client
$ pip install coreapi-cli

# Install the Python client library
$ pip install coreapi

<!-- Load the JavaScript client library -->
<script src="/static/rest_framework/js/coreapi-0.1.1.js"></script>
<script src="/api/v1/docs/schema.js"></script>

activate

create

POST /api/v1/activate/

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`mac_addresses` required	An array of mac-addreses for OnTrak devices

# Load the schema document
$ coreapi get https://ontrak.cloud/api/v1/docs/

# Interact with the API endpoint
$ coreapi action activate create -p mac_addresses=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://ontrak.cloud/api/v1/docs/")

# Interact with the API endpoint
action = ["activate", "create"]
params = {
    "mac_addresses": ...,
}
result = client.action(schema, action, params=params)

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["activate", "create"]
var params = {
    mac_addresses: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

cloud-files

create

POST /api/v1/cloud-files/

Return an array of OnTrak devices with specified mac_addresses. Act like OnTrak endpoint except file and is_expired fields will be included for each OnTrak

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`mac_addresses` required	An array of mac-addreses for OnTrak devices

# Load the schema document
$ coreapi get https://ontrak.cloud/api/v1/docs/

# Interact with the API endpoint
$ coreapi action cloud-files create -p mac_addresses=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://ontrak.cloud/api/v1/docs/")

# Interact with the API endpoint
action = ["cloud-files", "create"]
params = {
    "mac_addresses": ...,
}
result = client.action(schema, action, params=params)

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["cloud-files", "create"]
var params = {
    mac_addresses: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

email-mailgun-route

create

POST /api/v1/email-mailgun-route/

This endpoint is used by mailgun email service.

# Load the schema document
$ coreapi get https://ontrak.cloud/api/v1/docs/

# Interact with the API endpoint
$ coreapi action email-mailgun-route create

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://ontrak.cloud/api/v1/docs/")

# Interact with the API endpoint
action = ["email-mailgun-route", "create"]
result = client.action(schema, action)

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["email-mailgun-route", "create"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

file-delete

delete

DELETE /api/v1/file-delete/

# Load the schema document
$ coreapi get https://ontrak.cloud/api/v1/docs/

# Interact with the API endpoint
$ coreapi action file-delete delete

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://ontrak.cloud/api/v1/docs/")

# Interact with the API endpoint
action = ["file-delete", "delete"]
result = client.action(schema, action)

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["file-delete", "delete"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

file-upload

create

POST /api/v1/file-upload/

Upload and save file with relation to spicific OnTrak

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`file` required
`ontrak` required	MAC address for appropriate OnTrak device
`filename` required

# Load the schema document
$ coreapi get https://ontrak.cloud/api/v1/docs/

# Interact with the API endpoint
$ coreapi action file-upload create -p file=... -p ontrak=... -p filename=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://ontrak.cloud/api/v1/docs/")

# Interact with the API endpoint
action = ["file-upload", "create"]
params = {
    "file": ...,
    "ontrak": ...,
    "filename": ...,
}
result = client.action(schema, action, params=params)

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["file-upload", "create"]
var params = {
    file: ...,
    ontrak: ...,
    filename: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

ontrak

create

POST /api/v1/ontrak/

Returns an array of OnTrak devices with specified mac_addresses. Each of them has expiration date and mac_address fields. If there is no OnTrak devices with specified mac_address, it will be created and included into the response.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`mac_addresses` required	An array of mac-addreses for OnTrak devices

# Load the schema document
$ coreapi get https://ontrak.cloud/api/v1/docs/

# Interact with the API endpoint
$ coreapi action ontrak create -p mac_addresses=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://ontrak.cloud/api/v1/docs/")

# Interact with the API endpoint
action = ["ontrak", "create"]
params = {
    "mac_addresses": ...,
}
result = client.action(schema, action, params=params)

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["ontrak", "create"]
var params = {
    mac_addresses: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})