Content

APIs for Content management

List content in the enterprise

Returns Content list

SecurityapiKey
Request
path Parameters
enterprise_id
required
string

A UUID string identifying this enterprise.

query Parameters
search
string

Seach by tags, description

limit
integer
Default: 20

Number of results to return per page.

offset
integer
Default: 0

The initial index from which to return the results.

Responses
200

successful operation

401

Authorization information is missing or invalid.

500

Internal server error

get/v0/enterprise/{enterprise_id}/content/
Response samples
application/json
{
  • "count": 0,
  • "next": "string",
  • "previous": "string",
  • "results": [
    ]
}

Get content information

Returns Content instance

SecurityapiKey
Request
path Parameters
content_id
required
string <uuid>

A UUID string identifying a content instance.

enterprise_id
required
string

A UUID string identifying enterprise.

Responses
200

successful operation

401

Authorization information is missing or invalid.

404

Not Found.

500

Internal server error

get/v0/enterprise/{enterprise_id}/content/{content_id}/
Response samples
application/json
{
  • "id": 0,
  • "download_url": "string",
  • "name": "string",
  • "key": "string",
  • "is_dir": false,
  • "kind": "string",
  • "hash": "string",
  • "size": "string",
  • "path": "string",
  • "permissions": "string",
  • "tags": [
    ],
  • "description": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z",
  • "enterprise": "string",
  • "owner": {
    }
}

Delete Content

Empty response

SecurityapiKey
Request
path Parameters
content_id
required
string <uuid>

A UUID string identifying a content instance.

enterprise_id
required
string

A UUID string identifying enterprise.

Responses
204

The resource was deleted successfully.

401

Authorization information is missing or invalid.

403

Forbidden, no permission to perform this action.

404

Not Found.

500

Internal server error

delete/v0/enterprise/{enterprise_id}/content/{content_id}/
Response samples
application/json
{
  • "errors": [
    ],
  • "message": "string",
  • "status": 0
}

Patch a content instance

SecurityapiKey
Request
path Parameters
content_id
required
string <uuid>

A UUID string identifying a content instance.

enterprise_id
required
string

A UUID string identifying enterprise.

Request Body schema: */*
tags
Array of strings (Tags)

Tags for the content

description
string (Description)

Description of the content

Responses
200

successful operation

400

Bad request

401

Authorization information is missing or invalid.

403

Forbidden, no permission to perform this action.

404

Not Found.

415

Unsupported media type.

500

Internal server error

patch/v0/enterprise/{enterprise_id}/content/{content_id}/
Response samples
application/json
{
  • "id": 0,
  • "download_url": "string",
  • "name": "string",
  • "key": "string",
  • "is_dir": false,
  • "kind": "string",
  • "hash": "string",
  • "size": "string",
  • "path": "string",
  • "permissions": "string",
  • "tags": [
    ],
  • "description": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z",
  • "enterprise": "string",
  • "owner": {
    }
}

Upload new content

Returns Content instance

SecurityapiKey
Request
path Parameters
enterprise_id
required
string

A UUID string identifying this enterprise.

Request Body schema: multipart/form-data
key
required
string <binary>

Valid file to upload

Responses
200

Successful Operation

400

Bad request

401

Authorization information is missing or invalid.

403

Forbidden, no permission to perform this action.

415

Unsupported media type.

500

Internal server error

post/v0/enterprise/{enterprise_id}/content/upload/
Response samples
application/json
{
  • "id": 0,
  • "download_url": "string",
  • "name": "string",
  • "key": "string",
  • "is_dir": false,
  • "kind": "string",
  • "hash": "string",
  • "size": "string",
  • "path": "string",
  • "permissions": "string",
  • "tags": [
    ],
  • "description": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z",
  • "enterprise": "string",
  • "owner": {
    }
}

List alert channels in enterprise

Returns list of alert channels

SecurityapiKey
Request
path Parameters
enterprise_id
required
string

A UUID string identifying this enterprise.

query Parameters
name
string

Filter alert channels by name.

limit
integer
Default: 20

Number of results to return per page.

offset
integer
Default: 0

Return results from this index.

Responses
200

successful operation

401

Authorization information is missing or invalid.

404

Not Found.

500

Internal server error

get/api/v1/enterprise/{enterprise_id}/alertchannels/
Response samples
application/json
{
  • "count": 0,
  • "next": "string",
  • "previous": "string",
  • "results": [
    ]
}

Creates alert channel

Returns instance of alert channel

SecurityapiKey
Request
path Parameters
enterprise_id
required
string

A UUID string identifying this enterprise.

Request Body schema: application/json
id
integer
object
name
string
type
string

format of alert. e.g. email

created_on
string <date-time>
updated_on
string <date-time>
enterprise
string <uuid>
Responses
201

successful operation

400

Bad request

401

Authorization information is missing or invalid.

403

Forbidden, no permission to perform this action.

500

Internal server error

post/api/v1/enterprise/{enterprise_id}/alertchannels/
Request samples
application/json
{
  • "id": 0,
  • "properties": {
    },
  • "name": "string",
  • "type": "string",
  • "created_on": "2019-08-24T14:15:22Z",
  • "updated_on": "2019-08-24T14:15:22Z",
  • "enterprise": "796caaf9-a7de-4817-9ffa-39d04bf83de9"
}
Response samples
application/json
{
  • "id": 0,
  • "properties": {
    },
  • "name": "string",
  • "type": "string",
  • "created_on": "2019-08-24T14:15:22Z",
  • "updated_on": "2019-08-24T14:15:22Z",
  • "enterprise": "796caaf9-a7de-4817-9ffa-39d04bf83de9",
  • "linked_alerts": [
    ]
}

Get alert channel

Returns instance of alert channel

SecurityapiKey
Request
path Parameters
enterprise_id
required
string

A UUID string identifying this enterprise.

alert_id
required
integer

An integer identifying the alert channel.

Responses
200

successful operation

401

Authorization information is missing or invalid.

404

Not Found.

500

Internal server error

get/api/v1/enterprise/{enterprise_id}/alertchannels/{alert_id}
Response samples
application/json
{
  • "id": 0,
  • "properties": {
    },
  • "name": "string",
  • "type": "string",
  • "created_on": "2019-08-24T14:15:22Z",
  • "updated_on": "2019-08-24T14:15:22Z",
  • "enterprise": "796caaf9-a7de-4817-9ffa-39d04bf83de9",
  • "linked_alerts": [
    ]
}

Update alert channel information

Returns alert channel instance

SecurityapiKey
Request
path Parameters
enterprise_id
required
string <uuid>

A UUID string identifying the enterprise.

alert_id
required
integer

An integer identifying the alert channel.

Request Body schema: application/json
id
integer
object
name
string
type
string

format of alert. e.g. email

created_on
string <date-time>
updated_on
string <date-time>
enterprise
string <uuid>
Responses
200

successful operation

400

Invalid request.

401

Authorization information is missing or invalid.

404

Not Found.

500

Internal server error

put/api/v1/enterprise/{enterprise_id}/alertchannels/{alert_id}
Request samples
application/json
{
  • "id": 0,
  • "properties": {
    },
  • "name": "string",
  • "type": "string",
  • "created_on": "2019-08-24T14:15:22Z",
  • "updated_on": "2019-08-24T14:15:22Z",
  • "enterprise": "796caaf9-a7de-4817-9ffa-39d04bf83de9"
}
Response samples
application/json
{
  • "id": 0,
  • "properties": {
    },
  • "name": "string",
  • "type": "string",
  • "created_on": "2019-08-24T14:15:22Z",
  • "updated_on": "2019-08-24T14:15:22Z",
  • "enterprise": "796caaf9-a7de-4817-9ffa-39d04bf83de9",
  • "linked_alerts": [
    ]
}

Partially updates alert channel information

Returns alert channel instance

SecurityapiKey
Request
path Parameters
enterprise_id
required
string <uuid>

A UUID string identifying the enterprise.

alert_id
required
integer

An integer identifying the alert channel.

Request Body schema: application/json
id
integer
object
name
string
type
string

format of alert. e.g. email

created_on
string <date-time>
updated_on
string <date-time>
enterprise
string <uuid>
Responses
200

successful operation

400

Invalid request.

404

Not Found.

500

Internal server error

patch/api/v1/enterprise/{enterprise_id}/alertchannels/{alert_id}
Request samples
application/json
{
  • "id": 0,
  • "properties": {
    },
  • "name": "string",
  • "type": "string",
  • "created_on": "2019-08-24T14:15:22Z",
  • "updated_on": "2019-08-24T14:15:22Z",
  • "enterprise": "796caaf9-a7de-4817-9ffa-39d04bf83de9"
}
Response samples
application/json
{
  • "id": 0,
  • "properties": {
    },
  • "name": "string",
  • "type": "string",
  • "created_on": "2019-08-24T14:15:22Z",
  • "updated_on": "2019-08-24T14:15:22Z",
  • "enterprise": "796caaf9-a7de-4817-9ffa-39d04bf83de9",
  • "linked_alerts": [
    ]
}

Delete an alert channel

Empty response

SecurityapiKey
Request
path Parameters
enterprise_id
required
string <uuid>

A UUID string identifying the enterprise.

alert_id
required
integer

An integer identifying the alert channel.

Responses
204

The resource was deleted successfully.

400

Invalid request.

401

Authorization information is missing or invalid.

403

Forbidden, no permission to perform this action.

404

Not Found.

500

Internal server error

delete/api/v1/enterprise/{enterprise_id}/alertchannels/{alert_id}
Response samples
application/json
{
  • "errors": [
    ],
  • "message": "string",
  • "status": 0
}

Get list of alarm rules

Returns list of alarm rules

SecurityapiKey
Request
path Parameters
enterprise_id
required
string

A UUID string identifying this enterprise.

query Parameters
name
string

Filter alarm rules by name.

description
string

Filter alarm rules by description.

is_active
string

Filter active alarm rules.

created_on_gt
string

Filter alarm rules created after a given timestamp.

created_on_lt
string

Filter alarm rules created before a given timestamp.

limit
integer
Default: 20

Number of results to return per page.

offset
integer
Default: 0

Return results from this index.

Responses
200

successful operation

401

Authorization information is missing or invalid.

404

Not Found.

500

Internal server error

get/api/v1/enterprise/{enterprise_id}/alarmrules/
Response samples
application/json
{
  • "count": 0,
  • "next": "string",
  • "previous": "string",
  • "results": [
    ]
}

Creates instance of alarm rules

Returns instance of alarm rules

SecurityapiKey
Request
path Parameters
enterprise_id
required
string

A UUID string identifying this enterprise.

Request Body schema: application/json
id
string <uuid>
enterprise
required
string <uuid>
devices
Array of any <string>
groups
Array of strings
name
required
string
description
string
metric
required
string
required
object
action_emails
Array of strings <email>
actions
Array of strings
alert_channels
Array of strings
created_on
string <date-time>
updated_on
string <date-time>
is_active
boolean
realert_interval
required
integer
repeat_times
integer
trigger_count
integer
daily_trigger_count
integer
Responses
201

successful operation

400

Bad request

401

Authorization information is missing or invalid.

403

Forbidden, no permission to perform this action.

500

Internal server error

post/api/v1/enterprise/{enterprise_id}/alarmrules/
Request samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "enterprise": "796caaf9-a7de-4817-9ffa-39d04bf83de9",
  • "devices": [
    ],
  • "groups": [
    ],
  • "name": "string",
  • "description": "string",
  • "metric": "string",
  • "conditions": {
    },
  • "action_emails": [
    ],
  • "actions": [
    ],
  • "alert_channels": [
    ],
  • "created_on": "2019-08-24T14:15:22Z",
  • "updated_on": "2019-08-24T14:15:22Z",
  • "is_active": true,
  • "realert_interval": 0,
  • "repeat_times": 0,
  • "trigger_count": 0,
  • "daily_trigger_count": 0
}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "enterprise": "796caaf9-a7de-4817-9ffa-39d04bf83de9",
  • "devices": {
    },
  • "groups": [
    ],
  • "name": "string",
  • "description": "string",
  • "metric": "string",
  • "conditions": {
    },
  • "action_emails": [
    ],
  • "actions": [
    ],
  • "alert_channels": [
    ],
  • "created_on": "2019-08-24T14:15:22Z",
  • "updated_on": "2019-08-24T14:15:22Z",
  • "is_active": true,
  • "realert_interval": 0,
  • "repeat_times": 0,
  • "trigger_count": 0,
  • "daily_trigger_count": 0
}

Get instance of alarm rule

Returns instance of alarm rule

SecurityapiKey
Request
path Parameters
enterprise_id
required
string

A UUID string identifying this enterprise.

alarm_id
required
string

A UUID string identifying the alarm ruleset.

Responses
200

successful operation

401

Authorization information is missing or invalid.

404

Not Found.

500

Internal server error

get/api/v1/enterprise/{enterprise_id}/alarmrules/{alarm_id}/
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "enterprise": "796caaf9-a7de-4817-9ffa-39d04bf83de9",
  • "devices": {
    },
  • "groups": [
    ],
  • "name": "string",
  • "description": "string",
  • "metric": "string",
  • "conditions": {
    },
  • "action_emails": [
    ],
  • "actions": [
    ],
  • "alert_channels": [
    ],
  • "created_on": "2019-08-24T14:15:22Z",
  • "updated_on": "2019-08-24T14:15:22Z",
  • "is_active": true,
  • "realert_interval": 0,
  • "repeat_times": 0,
  • "trigger_count": 0,
  • "daily_trigger_count": 0
}

Update alarm rules

Return instance of alarm rules

SecurityapiKey
Request
path Parameters
enterprise_id
required
string

A UUID string identifying this enterprise.

alarm_id
required
string

A UUID string identifying the alarm ruleset.

Request Body schema: application/json
id
string <uuid>
enterprise
required
string <uuid>
devices
Array of any <string>
groups
Array of strings
name
required
string
description
string
metric
required
string
required
object
action_emails
Array of strings <email>
actions
Array of strings
alert_channels
Array of strings
created_on
string <date-time>
updated_on
string <date-time>
is_active
boolean
realert_interval
required
integer
repeat_times
integer
trigger_count
integer
daily_trigger_count
integer
Responses
200

successful operation

400

Invalid request.

401

Authorization information is missing or invalid.

404

Not Found.

500

Internal server error

put/api/v1/enterprise/{enterprise_id}/alarmrules/{alarm_id}/
Request samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "enterprise": "796caaf9-a7de-4817-9ffa-39d04bf83de9",
  • "devices": [
    ],
  • "groups": [
    ],
  • "name": "string",
  • "description": "string",
  • "metric": "string",
  • "conditions": {
    },
  • "action_emails": [
    ],
  • "actions": [
    ],
  • "alert_channels": [
    ],
  • "created_on": "2019-08-24T14:15:22Z",
  • "updated_on": "2019-08-24T14:15:22Z",
  • "is_active": true,
  • "realert_interval": 0,
  • "repeat_times": 0,
  • "trigger_count": 0,
  • "daily_trigger_count": 0
}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "enterprise": "796caaf9-a7de-4817-9ffa-39d04bf83de9",
  • "devices": {
    },
  • "groups": [
    ],
  • "name": "string",
  • "description": "string",
  • "metric": "string",
  • "conditions": {
    },
  • "action_emails": [
    ],
  • "actions": [
    ],
  • "alert_channels": [
    ],
  • "created_on": "2019-08-24T14:15:22Z",
  • "updated_on": "2019-08-24T14:15:22Z",
  • "is_active": true,
  • "realert_interval": 0,
  • "repeat_times": 0,
  • "trigger_count": 0,
  • "daily_trigger_count": 0
}

Partially updates alarm rules

Returns instance of alarm rules

SecurityapiKey
Request
path Parameters
enterprise_id
required
string

A UUID string identifying this enterprise.

alarm_id
required
string

A UUID string identifying the alarm ruleset.

Request Body schema: application/json
id
string <uuid>
enterprise
required
string <uuid>
devices
Array of any <string>
groups
Array of strings
name
required
string
description
string
metric
required
string
required
object
action_emails
Array of strings <email>
actions
Array of strings
alert_channels
Array of strings
created_on
string <date-time>
updated_on
string <date-time>
is_active
boolean
realert_interval
required
integer
repeat_times
integer
trigger_count
integer
daily_trigger_count
integer
Responses
200

successful operation

400

Invalid request.

401

Authorization information is missing or invalid.

404

Not Found.

500

Internal server error

patch/api/v1/enterprise/{enterprise_id}/alarmrules/{alarm_id}/
Request samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "enterprise": "796caaf9-a7de-4817-9ffa-39d04bf83de9",
  • "devices": [
    ],
  • "groups": [
    ],
  • "name": "string",
  • "description": "string",
  • "metric": "string",
  • "conditions": {
    },
  • "action_emails": [
    ],
  • "actions": [
    ],
  • "alert_channels": [
    ],
  • "created_on": "2019-08-24T14:15:22Z",
  • "updated_on": "2019-08-24T14:15:22Z",
  • "is_active": true,
  • "realert_interval": 0,
  • "repeat_times": 0,
  • "trigger_count": 0,
  • "daily_trigger_count": 0
}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "enterprise": "796caaf9-a7de-4817-9ffa-39d04bf83de9",
  • "devices": {
    },
  • "groups": [
    ],
  • "name": "string",
  • "description": "string",
  • "metric": "string",
  • "conditions": {
    },
  • "action_emails": [
    ],
  • "actions": [
    ],
  • "alert_channels": [
    ],
  • "created_on": "2019-08-24T14:15:22Z",
  • "updated_on": "2019-08-24T14:15:22Z",
  • "is_active": true,
  • "realert_interval": 0,
  • "repeat_times": 0,
  • "trigger_count": 0,
  • "daily_trigger_count": 0
}

Deletes alarm rule

Empty response

SecurityapiKey
Request
path Parameters
enterprise_id
required
string

A UUID string identifying this enterprise.

alarm_id
required
string

A UUID string identifying the alarm ruleset.

Responses
204

The resource was deleted successfully.

400

Invalid request.

401

Authorization information is missing or invalid.

403

Forbidden, no permission to perform this action.

404

Not Found.

500

Internal server error

delete/api/v1/enterprise/{enterprise_id}/alarmrules/{alarm_id}/
Response samples
application/json
{
  • "errors": [
    ],
  • "message": "string",
  • "status": 0
}

Get history of alarm rule

Returns instance of alarm rule history

SecurityapiKey
Request
path Parameters
enterprise_id
required
string

A UUID string identifying this enterprise.

alarm_id
required
string

A UUID string identifying the alarm ruleset.

Responses
200

successful operation

401

Authorization information is missing or invalid.

404

Not Found.

500

Internal server error

get/api/v1/enterprise/{enterprise_id}/alarmrules/{alarm_id}/alarmhistory/
Response samples
application/json
{
  • "device_name": "string",
  • "device_id": "3bafab7b-4400-4bcf-8e6e-09f954699940",
  • "group_id": [
    ],
  • "group_name": "string",
  • "alert_time": "2019-08-24T14:15:22Z",
  • "latest_seen": "2019-08-24T14:15:22Z"
}

Get list of DPC in enterprise

Returns list of dpc in enterprise

SecurityapiKey
Request
path Parameters
enterprise_id
required
string

A UUID string identifying this enterprise.

query Parameters
limit
integer
Default: 20

Number of results to return per page.

offset
integer
Default: 0

Return results from this index.

Responses
200

successful operation

401

Authorization information is missing or invalid.

404

Not Found.

500

Internal server error

get/api/v1/enterprise/{enterprise_id}/dpc/
Response samples
application/json
{
  • "count": 0,
  • "next": "string",
  • "previous": "string",
  • "results": [
    ]
}

Get instance of DPC in enterprise

Returns instance of DPC in enterprise

SecurityapiKey
Request
path Parameters
enterprise_id
required
string

A UUID string identifying this enterprise.

dpc_id
required
string

A UUID string identifying the DPC.

Responses
200

successful operation

401

Authorization information is missing or invalid.

404

Not Found.

500

Internal server error

get/api/v1/enterprise/{enterprise_id}/dpc/{dpc_id}/
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "version_code": "string",
  • "build_number": 0,
  • "hash_string": "string",
  • "download_url": "string",
  • "icon_url": "string",
  • "min_sdk_version": 0,
  • "target_sdk_version": 0,
  • "release_name": 0,
  • "release_comments": "string"
}

Get list of wallpapers

Returns list of wallpapers

SecurityapiKey
Request
path Parameters
enterprise_id
required
string

A UUID string identifying this enterprise.

query Parameters
created_on_gt
string <datetime>

Filter applications created after a given timestamp.

created_on_lt
string <datetime>

Filter applications created before a given timestamp.

updated_on_gt
string <datetime>

Filter applications updated after a given timestamp.

updated_on_lt
string <datetime>

Filter applications updated before a given timestamp.

limit
integer
Default: 20

Number of results to return per page.

offset
integer
Default: 0

Return results from this index.

Responses
200

successful operation

401

Authorization information is missing or invalid.

404

Not Found.

500

Internal server error

get/api/v1/enterprise/{enterprise_id}/wallpaper/
Response samples
application/json
{
  • "count": 0,
  • "next": "string",
  • "previous": "string",
  • "results": [
    ]
}

Create wallpaper

Returns instance of created wallpaper

SecurityapiKey
Request
path Parameters
enterprise_id
required
string

A UUID string identifying this enterprise.

Request Body schema: multipart/form-data
image_file
required
string <path>

Valid file to upload

orientation
required
string

Orientation of image e.g. landscape

Responses
201

Successful Operation

400

Bad request

401

Authorization information is missing or invalid.

403

Forbidden, no permission to perform this action.

415

Unsupported media type.

500

Internal server error

post/api/v1/enterprise/{enterprise_id}/wallpaper/
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "enterprise": "796caaf9-a7de-4817-9ffa-39d04bf83de9",
  • "image_file": "string",
  • "thumbnail": "string",
  • "orientation": "string",
  • "is_active": true,
  • "created_on": "2019-08-24T14:15:22Z",
  • "updated_on": "2019-08-24T14:15:22Z"
}

Get instance of wallpaper

Returns instance of wallpaper

SecurityapiKey
Request
path Parameters
enterprise_id
required
string

A UUID string identifying this enterprise.

wallpaper_id
required
string

A UUID string identifying the wallpaper.

Responses
200

successful operation

401

Authorization information is missing or invalid.

404

Not Found.

500

Internal server error

get/api/v1/enterprise/{enterprise_id}/wallpaper/{wallpaper_id}/
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "enterprise": "796caaf9-a7de-4817-9ffa-39d04bf83de9",
  • "image_file": "string",
  • "thumbnail": "string",
  • "orientation": "string",
  • "is_active": true,
  • "created_on": "2019-08-24T14:15:22Z",
  • "updated_on": "2019-08-24T14:15:22Z"
}

Deletes instance of wallpaper

Empty response

SecurityapiKey
Request
path Parameters
enterprise_id
required
string

A UUID string identifying this enterprise.

wallpaper_id
required
string

A UUID string identifying the wallpaper.

Responses
204

The resource was deleted successfully.

400

Invalid request.

401

Authorization information is missing or invalid.

403

Forbidden, no permission to perform this action.

404

Not Found.

500

Internal server error

delete/api/v1/enterprise/{enterprise_id}/wallpaper/{wallpaper_id}/
Response samples
application/json
{
  • "errors": [
    ],
  • "message": "string",
  • "status": 0
}

Gets list of user UI configurations

Returns list of user UI configurations

SecurityapiKey
Request
path Parameters
enterprise_id
required
string

A UUID string identifying this enterprise.

query Parameters
user
integer

Filter UI configurations by 'user' integer value.

Responses
200

successful operation

401

Authorization information is missing or invalid.

404

Not Found.

500

Internal server error

get/api/v1/enterprise/{enterprise_id}/user-ui-config/
Response samples
application/json
{
  • "count": 0,
  • "next": "string",
  • "previous": "string",
  • "results": [
    ]
}

Create user UI configuration

Returns instance of created UI configuration

SecurityapiKey
Request
path Parameters
enterprise_id
required
string

A UUID string identifying this enterprise.

Request Body schema: application/json
object
user
integer
Responses
201

Successful Operation

400

Bad request

401

Authorization information is missing or invalid.

403

Forbidden, no permission to perform this action.

500

Internal server error

post/api/v1/enterprise/{enterprise_id}/user-ui-config/
Request samples
application/json
{
  • "features": {
    },
  • "user": 0
}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "features": {
    },
  • "created_on": "2019-08-24T14:15:22Z",
  • "user": 0
}

Get instance of user UI configuration

Returns instance of user UI configuration

SecurityapiKey
Request
path Parameters
enterprise_id
required
string

A UUID string identifying this enterprise.

userui_id
required
string

A UUID string identifying the user UI configuration.

Responses
200

successful operation

401

Authorization information is missing or invalid.

404

Not Found.

500

Internal server error

get/api/v1/enterprise/{enterprise_id}/user-ui-config/{userui_id}/
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "features": {
    },
  • "created_on": "2019-08-24T14:15:22Z",
  • "user": 0
}

Updates instance of user UI configuration

Returns updated instance of user UI configuration

SecurityapiKey
Request
path Parameters
enterprise_id
required
string

A UUID string identifying this enterprise.

userui_id
required
string

A UUID string identifying the user UI configuration.

Request Body schema: application/json
object
user
integer
Responses
200

successful operation

400

Invalid request.

401

Authorization information is missing or invalid.

404

Not Found.

500

Internal server error

put/api/v1/enterprise/{enterprise_id}/user-ui-config/{userui_id}/
Request samples
application/json
{
  • "features": {
    },
  • "user": 0
}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "features": {
    },
  • "created_on": "2019-08-24T14:15:22Z",
  • "user": 0
}

Partially updates user UI configuration

Returns instance of user UI configuration

SecurityapiKey
Request
path Parameters
enterprise_id
required
string

A UUID string identifying this enterprise.

userui_id
required
string

A UUID string identifying the user UI configuration.

Request Body schema: application/json
object
user
integer
Responses
200

successful operation

400

Invalid request.

401

Authorization information is missing or invalid.

404

Not Found.

500

Internal server error

patch/api/v1/enterprise/{enterprise_id}/user-ui-config/{userui_id}/
Request samples
application/json
{
  • "features": {
    },
  • "user": 0
}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "features": {
    },
  • "created_on": "2019-08-24T14:15:22Z",
  • "user": 0
}

Deletes instance of user UI configuration

Empty response

SecurityapiKey
Request
path Parameters
enterprise_id
required
string

A UUID string identifying this enterprise.

userui_id
required
string

A UUID string identifying the user UI configuration.

Responses
204

The resource was deleted successfully.

400

Invalid request.

401

Authorization information is missing or invalid.

403

Forbidden, no permission to perform this action.

404

Not Found.

500

Internal server error

delete/api/v1/enterprise/{enterprise_id}/user-ui-config/{userui_id}/
Response samples
application/json
{
  • "errors": [
    ],
  • "message": "string",
  • "status": 0
}

Gets list of device tile icons

Returns list of tile icons

SecurityapiKey
Request
path Parameters
enterprise_id
required
string

A UUID string identifying this enterprise.

query Parameters
created_on_gt
string <datetime>

Filter tile icons created after a given timestamp.

created_on_lt
string <datetime>

Filter tile icons created before a given timestamp.

updated_on_gt
string <datetime>

Filter tile icons updated after a given timestamp.

updated_on_lt
string <datetime>

Filter tile icons updated before a given timestamp.

category
string

Filter tile icons by category.

device_model
string

Filter tile icons by device model.

custom
boolean

Filter custom tile icons.

Responses
200

successful operation

401

Authorization information is missing or invalid.

404

Not Found.

500

Internal server error

get/api/v1/enterprise/{enterprise_id}/tile-icons/
Response samples
application/json
{
  • "count": 0,
  • "next": "string",
  • "previous": "string",
  • "results": [
    ]
}

Create tile icon

Returns instance of created tile icon

SecurityapiKey
Request
path Parameters
enterprise_id
required
string

A UUID string identifying this enterprise.

Request Body schema: multipart/form-data
icon_file
required
string <path>

Valid file to upload

device_model
required
string

Device model

enterprise
required
string <uuid>

UUID string representing enterprise of tile icon

Responses
201

Successful Operation

400

Bad request

401

Authorization information is missing or invalid.

403

Forbidden, no permission to perform this action.

415

Unsupported media type.

500

Internal server error

post/api/v1/enterprise/{enterprise_id}/tile-icons/
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "category": "string",
  • "icon_file": "string",
  • "device_model": "string",
  • "custom": true,
  • "created_on": "2019-08-24T14:15:22Z",
  • "updated_on": "2019-08-24T14:15:22Z"
}

Get instance of tile icon

Returns instance of tile icon

SecurityapiKey
Request
path Parameters
enterprise_id
required
string

A UUID string identifying this enterprise.

tileicons_id
required
string

A UUID string identifying the tile icon.

Responses
200

successful operation

401

Authorization information is missing or invalid.

404

Not Found.

500

Internal server error

get/api/v1/enterprise/{enterprise_id}/tile-icons/{tileicons_id}/
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "category": "string",
  • "icon_file": "string",
  • "device_model": "string",
  • "custom": true,
  • "created_on": "2019-08-24T14:15:22Z",
  • "updated_on": "2019-08-24T14:15:22Z"
}

Deletes instance of tile icon

Empty response

SecurityapiKey
Request
path Parameters
enterprise_id
required
string

A UUID string identifying this enterprise.

tileicons_id
required
string

A UUID string identifying the tile icon.

Responses
204

The resource was deleted successfully.

400

Invalid request.

401

Authorization information is missing or invalid.

403

Forbidden, no permission to perform this action.

404

Not Found.

500

Internal server error

delete/api/v1/enterprise/{enterprise_id}/tile-icons/{tileicons_id}/
Response samples
application/json
{
  • "errors": [
    ],
  • "message": "string",
  • "status": 0
}

Sets tile icon for device

Returns instance of applied mode

SecurityapiKey
Request
path Parameters
enterprise_id
required
string

A UUID string identifying this enterprise.

Request Body schema: application/json
icon
string or null <uuid>
apply_mode
string
Default: "devices"
Enum: "devices" "all_devices" "groups" "device_model"
device_model
string or null
devices
Array of any <string>
groups
Array of strings
Responses
201

Successful Operation

400

Bad request

401

Authorization information is missing or invalid.

403

Forbidden, no permission to perform this action.

500

Internal server error

post/api/v1/enterprise/{enterprise_id}/tile-icon-apply/
Request samples
application/json
{
  • "icon": "bc9b3dc5-578a-4929-a13c-7d1a9725e2b0",
  • "apply_mode": "devices",
  • "device_model": "string",
  • "devices": [
    ],
  • "groups": [
    ]
}
Response samples
application/json
{
  • "icon": "bc9b3dc5-578a-4929-a13c-7d1a9725e2b0",
  • "apply_mode": "devices",
  • "device_model": "string",
  • "devices": [
    ],
  • "groups": [
    ]
}

Removes tile icon for device

Returns the model of the device(s)

SecurityapiKey
Request
path Parameters
enterprise_id
required
string

A UUID string identifying this enterprise.

Request Body schema: application/json
model
required
string

Model of device

Responses
201

Successful Operation

400

Bad request

401

Authorization information is missing or invalid.

403

Forbidden, no permission to perform this action.

500

Internal server error

post/api/v1/enterprise/{enterprise_id}/tile-icon-unapply/
Request samples
application/json
{
  • "model": "string"
}
Response samples
application/json
{
  • "model": "string"
}

Get alert triggers within start and end date

Returns alert triggers within start and end date

SecurityapiKey
Request
path Parameters
enterprise_id
required
string

A UUID string identifying this enterprise.

query Parameters
start_date
string <date-time>

Start date of alert triggers

end_date
string <date-time>

End date of alert triggers

Responses
200

successful operation

401

Authorization information is missing or invalid.

404

Not Found.

500

Internal server error

get/api/v1/enterprise/{enterprise_id}/dashboard/alert-panel/
Response samples
application/json
{
  • "total": 0,
  • "results": [
    ]
}

Get latest pipeline runs for an enterprise

Returns latest pipeline runs for an enterprise

SecurityapiKey
Request
path Parameters
enterprise_id
required
string

A UUID string identifying this enterprise.

query Parameters
limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

Responses
200

successful operation

401

Authorization information is missing or invalid.

404

Not Found.

500

Internal server error

get/api/v1/enterprise/{enterprise_id}/dashboard/pipeline-panel/
Response samples
application/json
{
  • "count": 0,
  • "next": "string",
  • "previous": "string",
  • "results": [
    ]
}

Gets data from provisioned device panel

Returns data from provisioned device panel

SecurityapiKey
Request
path Parameters