Documentation Powered by ReDoc

Simple Connect API (1.0.1)

Download OpenAPI specification:Download

API methods for Simple Connect

alert_notifications

bulk_destroy

Delete multiple alerts by ID, level, or both

Request Body schema: application/json
alert_ids
object (alert_ids)
level
string

Delete all alerts of a specified level (valid: all, info, warning, error)

Responses

200

Success

422

Unprocessable Entity

delete /alerts
http://localhost/api/v1/alerts

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "alert_ids":
    [
    ],
  • "level": "warning"
}

index

Returns a paginated list of alerts

query Parameters
limit
integer <int32>

limit

offset
integer <int32>

offset

order
string

order

ascending
boolean

ascending

filter
string
Enum:"pending" "acknowledged" "info" "warning" "error"

Filter alerts based on state

search_term
string

Filter alerts based on the search term

Responses

200

Success

422

Unprocessable Entity

get /alerts
http://localhost/api/v1/alerts

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "data":
    [
    ],
  • "metadata":
    {
    }
}

bulk_acknowledge

Acknowledge that you have seen multiple alerts

Request Body schema: application/json
alert_ids
required
Array of string

An array of ID strings

Responses

200

Success

404

Not Found

422

Unprocessable Entity

post /alerts/acknowledge
http://localhost/api/v1/alerts/acknowledge

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "alert_ids":
    [
    ]
}

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    },
  • {
    }
]

destroy

Delete an existing alert

path Parameters
id
required
string

Responses

200

Success

422

Unprocessable Entity

delete /alerts/{id}
http://localhost/api/v1/alerts/{id}

show

Returns a single alert

path Parameters
id
required
string

Responses

200

Success

404

Not Found

422

Unprocessable Entity

get /alerts/{id}
http://localhost/api/v1/alerts/{id}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "acknowledged_at": "2018-08-29T22:25:57.767Z",
  • "acknowledged_by": "Local Administrator",
  • "comment": null,
  • "created_at": "2018-08-29T20:02:58.605Z",
  • "event_action_id": null,
  • "id": "bc50db3b-bb3d-4db2-a404-5a511c36228b",
  • "level": "info",
  • "message": "HIPservice 'test-hipswitch2' has gone back offline after being online. <div> <span class='label label-success'> Offline at: 2018-08-29 20:02:58 UTC </span> <span class='label label-warning indented-sm'> Online since: 2018-08-29 18:55:38 UTC </span> </div> ",
  • "monitorable_id": null,
  • "monitorable_name": "test-hipswitch2",
  • "monitorable_type": null,
  • "person_id": "b45d4567-1234-def7-abc1-1234567d58f2",
  • "subject": "HIPservice has gone back offline"
}

acknowledge

Acknowledge that you have seen and optionally leave a comment for an alert

path Parameters
id
required
string
Request Body schema: application/json
string

Responses

200

Success

404

Not Found

422

Unprocessable Entity

post /alerts/{id}/acknowledge
http://localhost/api/v1/alerts/{id}/acknowledge

Request samples

application/json
Copy
 Expand all Collapse all
"This alert is acknowledged"

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "acknowledged_at": "2018-08-29T22:25:57.767Z",
  • "acknowledged_by": "Local Administrator",
  • "comment": null,
  • "created_at": "2018-08-29T20:02:58.605Z",
  • "event_action_id": null,
  • "id": "bc50db3b-bb3d-4db2-a404-5a511c36228b",
  • "level": "info",
  • "message": "HIPservice 'test-hipswitch2' has gone back offline after being online. <div> <span class='label label-success'> Offline at: 2018-08-29 20:02:58 UTC </span> <span class='label label-warning indented-sm'> Online since: 2018-08-29 18:55:38 UTC </span> </div> ",
  • "monitorable_id": null,
  • "monitorable_name": "test-hipswitch2",
  • "monitorable_type": null,
  • "person_id": "b45d4567-1234-def7-abc1-1234567d58f2",
  • "subject": "HIPservice has gone back offline"
}

backups

create

Starts a job to create a database backup

Responses

202

Accepted

400

Bad Request

post /backups
http://localhost/api/v1/backups

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "job_id": "272e0685685a6fe7fb9e377aea4cfbfe",
  • "status_url": "{request_base_url}/api/v1/jobs/272e0685685a6fe7fb9e377aea4cfbfe"
}

show

Returns a database backup

path Parameters
filename
required
string

Backup filename

Responses

200

Success

400

Bad Request

404

Not Found

get /backups/{id}
http://localhost/api/v1/backups/{id}

Response samples

application/json
Copy
 Expand all Collapse all
"string"

restore

Starts a job to restore a database backup

Responses

202

Accepted

400

Bad Request

post /backups/restore
http://localhost/api/v1/backups/restore

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "job_id": "272e0685685a6fe7fb9e377aea4cfbfe",
  • "status_url": "{request_base_url}/api/v1/jobs/272e0685685a6fe7fb9e377aea4cfbfe"
}

device_groups

bulk_destroy

Delete multiple device groups.

Request Body schema: application/json
device_group_ids
required
Array of string

An array of ID strings

Responses

200

Success

400

Bad Request

403

Forbidden

422

Unprocessable Entity

delete /device_groups
http://localhost/api/v1/device_groups

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "device_group_ids":
    [
    ]
}

index

Returns a collection of device groups.

query Parameters
filter
string

filter

sort
string

sort

limit
integer <int32>

limit

offset
integer <int32>

offset

Responses

200

Success

400

Bad Request

get /device_groups
http://localhost/api/v1/device_groups

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    },
  • {
    }
]

create

Create a new device group.

Request Body schema: application/json
device_ids
required
Array of string

An array of ID strings

name
required
string
description
string

Responses

201

Success

400

Bad Request

403

Forbidden

404

Not Found

422

Unprocessable Entity

post /device_groups
http://localhost/api/v1/device_groups

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "description": "API device_group created by automated testing.",
  • "device_ids":
    [
    ],
  • "name": "API device_group (non persistent)"
}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "description": "API device_group created by automated testing.",
  • "device_ids":
    [
    ],
  • "id": "a9890571-369a-4a77-a80b-8de89ed1f008",
  • "name": "API device_group (non persistent)",
  • "uuid": "a9890571-369a-4a77-a80b-8de89ed1f008"
}

destroy

Delete an existing device group.

path Parameters
id
required
integer <int32>

Device Group ID

Responses

200

Success

400

Bad Request

403

Forbidden

422

Unprocessable Entity

delete /device_groups/{id}
http://localhost/api/v1/device_groups/{id}

show

Returns a single device group.

path Parameters
id
required
string

Device Group ID

Responses

200

Success

403

Forbidden

404

Not Found

422

Unprocessable Entity

get /device_groups/{id}
http://localhost/api/v1/device_groups/{id}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "description": "API device_group created by automated testing.",
  • "device_ids":
    [
    ],
  • "id": "55535846-ae0f-4327-be88-f3cdd1dd9463",
  • "name": "API device_group (non persistent)",
  • "uuid": "55535846-ae0f-4327-be88-f3cdd1dd9463"
}

update

Update an existing device group (All fields are optional).

path Parameters
id
required
string

Device Group ID

Request Body schema: application/json
device_ids
required
Array of string

An array of ID strings

name
required
string
description
string

Responses

200

Success

400

Bad Request

403

Forbidden

404

Not Found

422

Unprocessable Entity

patch /device_groups/{id}
http://localhost/api/v1/device_groups/{id}

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "description": "API device_group created by automated testing.",
  • "device_ids":
    [
    ],
  • "name": "API device_group (non persistent)"
}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "description": "API device_group created by automated testing.",
  • "device_ids":
    [
    ],
  • "id": "55535846-ae0f-4327-be88-f3cdd1dd9463",
  • "name": "API device_group (non persistent) - Patched",
  • "uuid": "55535846-ae0f-4327-be88-f3cdd1dd9463"
}

add

Add devices to an existing device group.

path Parameters
id
required
string

Device Group ID

Request Body schema: application/json
device_ids
required
Array of string

An array of ID strings

Responses

200

Success

400

Bad Request

403

Forbidden

404

Not Found

422

Unprocessable Entity

post /device_groups/{id}/add
http://localhost/api/v1/device_groups/{id}/add

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "device_ids":
    [
    ]
}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "description": "API device_group created by automated testing.",
  • "device_ids":
    [
    ],
  • "id": "55535846-ae0f-4327-be88-f3cdd1dd9463",
  • "name": "API device_group (non persistent) - Patched",
  • "uuid": "55535846-ae0f-4327-be88-f3cdd1dd9463"
}

remove

Remove devices from an existing device group.

path Parameters
id
required
string

Device Group ID

Request Body schema: application/json
device_ids
required
Array of string

An array of ID strings

Responses

200

Success

400

Bad Request

403

Forbidden

404

Not Found

422

Unprocessable Entity

delete /device_groups/{id}/remove
http://localhost/api/v1/device_groups/{id}/remove

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "device_ids":
    [
    ]
}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "description": "API device_group created by automated testing.",
  • "device_ids": [ ],
  • "id": "55535846-ae0f-4327-be88-f3cdd1dd9463",
  • "name": "API device_group (non persistent) - Patched",
  • "uuid": "55535846-ae0f-4327-be88-f3cdd1dd9463"
}

tag_members

Directly set tag members for device_group.

path Parameters
id
required
string

Device Group ID

Request Body schema: application/json
tag_refs
required
Array of string

array of Tag References (IDs or Names)

Responses

200

success

403

Forbidden

404

Not Found

422

Unprocessable Entity

post /device_groups/{id}/tag_members
http://localhost/api/v1/device_groups/{id}/tag_members

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "tag_refs":
    [
    ]
}

Response samples

application/json
Copy
 Expand all Collapse all
{ }

tag_refresh

Refresh expiration time for tag(s) on device_group.

path Parameters
id
required
string

Device Group ID

Request Body schema: application/json
tag_refs
required
Array of string

array of Tag References (IDs or Names)

Responses

200

success

403

Forbidden

404

Not Found

422

Unprocessable Entity

post /device_groups/{id}/tag_refresh
http://localhost/api/v1/device_groups/{id}/tag_refresh

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "tag_refs":
    [
    ]
}

Response samples

application/json
Copy
 Expand all Collapse all
{ }

untag

Remove tag(s) from device_group.

path Parameters
id
required
string

Device Group ID

Request Body schema: application/json
tag_refs
required
Array of string

array of Tag References (IDs or Names)

Responses

200

success

403

Forbidden

404

Not Found

422

Unprocessable Entity

delete /device_groups/{id}/tags
http://localhost/api/v1/device_groups/{id}/tags

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "tag_refs":
    [
    ]
}

tag

Add tag(s) to device_group.

path Parameters
id
required
string

Device Group ID

Request Body schema: application/json
tag_refs
required
Array of string

array of Tag References (IDs or Names)

Responses

200

success

403

Forbidden

404

Not Found

422

Unprocessable Entity

post /device_groups/{id}/tags
http://localhost/api/v1/device_groups/{id}/tags

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "tag_refs":
    [
    ]
}

Response samples

application/json
Copy
 Expand all Collapse all
{ }

device_match_rules

index

Returns a collection of all device match rules on a device group

path Parameters
device_group_id
required
string

Device Group ID

Responses

200

Success

403

Forbidden

422

Unprocessable Entity

get /device_groups/{device_group_id}/device_match_rules
http://localhost/api/v1/device_groups/{device_group_id}/device_match_rules

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    },
  • {
    }
]

create

Creates a new device match rule on a device group

path Parameters
device_group_id
required
string

Device Group ID

Request Body schema: application/json
type
required
string
Enum:"match_cidr" "match_device_group" "match_hipservice" "match_hipservice_attribute" "match_hipservice_group" "match_inet" "match_mac_prefix" "match_range" "match_tag" "match_tag_search"

Type of device match rule

rule_order
required
integer

Priority of rule

operator
required
string
Enum:"include" "exclude" "filter"

Operator type for rule

negate
required
boolean

Responses

200

Success

400

Bad Request

403

Forbidden

404

Not Found

422

Unprocessable Entity

post /device_groups/{device_group_id}/device_match_rules
http://localhost/api/v1/device_groups/{device_group_id}/device_match_rules

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "match_cidr example":
    {
    },
  • "match_device_group example":
    {
    },
  • "match_hipservice example":
    {
    },
  • "match_hipservice_attribute example":
    {
    },
  • "match_hipservice_group example":
    {
    },
  • "match_inet example":
    {
    },
  • "match_mac_prefix example":
    {
    },
  • "match_range example":
    {
    },
  • "match_tag example":
    {
    },
  • "match_tag_search example":
    {
    }
}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "cidr": "192.168.23.0/24",
  • "created_at": "2018-11-26T19:56:06.193Z",
  • "id": "c21e2a4d-9443-4a52-906a-da3cec1067fc",
  • "negate": false,
  • "only_match_overlay_device_ip": false,
  • "operator": "+",
  • "rule_order": 10,
  • "type": "match_cidr",
  • "updated_at": "2018-11-26T19:56:06.193Z"
}

destroy

Removes a device match rule from a device group

path Parameters
device_group_id
required
string

Device Group ID

id
required
string

Device Match Rule ID

Responses

200

Success

403

Forbidden

404

Not Found

422

Unprocessable Entity

delete /device_groups/{device_group_id}/device_match_rules/{id}
http://localhost/api/v1/device_groups/{device_group_id}/device_match_rules/{id}

show

Returns a single device match rule

path Parameters
device_group_id
required
string

Device Group ID

id
required
string

Device Match Rule ID

Responses

200

Success

400

Bad Request

403

Forbidden

404

Not Found

422

Unprocessable Entity

get /device_groups/{device_group_id}/device_match_rules/{id}
http://localhost/api/v1/device_groups/{device_group_id}/device_match_rules/{id}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "cidr": "192.168.23.0/24",
  • "created_at": "2018-11-26T19:56:06.193Z",
  • "id": "c21e2a4d-9443-4a52-906a-da3cec1067fc",
  • "negate": false,
  • "only_match_overlay_device_ip": false,
  • "operator": "+",
  • "rule_order": 10,
  • "type": "match_cidr",
  • "updated_at": "2018-11-26T19:56:06.193Z"
}

update

Updates a device match rule on a device group

path Parameters
device_group_id
required
string

Device Group ID

id
required
string

Device Match Rule ID

Request Body schema: application/json
type
required
string
Enum:"match_cidr" "match_device_group" "match_hipservice" "match_hipservice_attribute" "match_hipservice_group" "match_inet" "match_mac_prefix" "match_range" "match_tag" "match_tag_search"

Type of device match rule

rule_order
required
integer

Priority of rule

operator
required
string
Enum:"include" "exclude" "filter"

Operator type for rule

negate
required
boolean

Responses

200

Success

400

Bad Request

403

Forbidden

404

Not Found

422

Unprocessable Entity

patch /device_groups/{device_group_id}/device_match_rules/{id}
http://localhost/api/v1/device_groups/{device_group_id}/device_match_rules/{id}

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "match_cidr example":
    {
    },
  • "match_device_group example":
    {
    },
  • "match_hipservice example":
    {
    },
  • "match_hipservice_attribute example":
    {
    },
  • "match_hipservice_group example":
    {
    },
  • "match_inet example":
    {
    },
  • "match_mac_prefix example":
    {
    },
  • "match_range example":
    {
    },
  • "match_tag example":
    {
    },
  • "match_tag_search example":
    {
    }
}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "cidr": "192.168.23.0/24",
  • "created_at": "2018-11-26T19:56:06.193Z",
  • "id": "c21e2a4d-9443-4a52-906a-da3cec1067fc",
  • "negate": false,
  • "only_match_overlay_device_ip": false,
  • "operator": "+",
  • "rule_order": 10,
  • "type": "match_cidr",
  • "updated_at": "2018-11-26T19:56:06.193Z"
}

devices

bulk_destroy

Delete multiple devices.

Request Body schema: application/json
device_ids
required
Array of string

An array of ID strings

Responses

200

Success

403

Forbidden

422

Unprocessable Entity

delete /devices
http://localhost/api/v1/devices

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "device_ids":
    [
    ]
}

index

Returns a collection of devices.

query Parameters
filter
string

filter

sort
string

sort

limit
integer <int32>

limit

offset
integer <int32>

offset

Responses

200

Success

400

Bad Request

get /devices
http://localhost/api/v1/devices

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    },
  • {
    }
]

create

Create a new device.

Request Body schema: application/json
hipservice_id
required
string

HIPservice ID

name
required
string

name

overlay_device_ip
required
string

Overlay Device IP

description
string

description

mac
string

MAC Address

mac_lockdown
boolean

MAC Address Lockdown

overlay_device_ip_nat
string

Overlay Device IP (NAT) - HIPswitch must have NAT enabled to set

Responses

201

Success

400

Bad Request

403

Forbidden

404

Not Found

422

Unprocessable Entity

post /devices
http://localhost/api/v1/devices

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "description": "API device created by automated testing.",
  • "hipservice_id": "4ae21af1-e5b8-4f92-8c17-c420a93bcdea",
  • "mac": "00:0D:29:F0:93:DD",
  • "mac_lockdown": true,
  • "name": "API device (non persistent)",
  • "overlay_device_ip": "192.168.2.10",
  • "overlay_device_ip_nat": "192.168.2.10"
}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "description": "API device created by automated testing.",
  • "discovered": false,
  • "hipservice_id": "4ae21af1-e5b8-4f92-8c17-c420a93bcdea",
  • "id": "73e2e02a-46ce-45cc-ac76-2ad945b9d2f8",
  • "last_activity_at": null,
  • "mac": "00:0d:29:f0:93:dd",
  • "mac_lockdown": true,
  • "name": "API device (non persistent)",
  • "overlay_device_ip": "192.168.2.10",
  • "uuid": "73e2e02a-46ce-45cc-ac76-2ad945b9d2f8"
}

accept_discovered_devices

Accept discovered device for multiple devices.

Request Body schema: application/json
device_ids
required
Array of string

An array of ID strings

Responses

200

Success

400

Bad Request

403

Forbidden

404

Not Found

422

Unprocessable Entity

post /devices/accept_discovered_devices
http://localhost/api/v1/devices/accept_discovered_devices

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "device_ids":
    [
    ]
}

export_devices

Export devices in CSV file format.

Responses

200

Success

401

Unauthorized

404

Not Found

get /devices/export_devices
http://localhost/api/v1/devices/export_devices

Response samples

text/csv
Copy
hipservice_id,device_name,overlay_device_ip,overlay_device_ip_nat,mac_address,mac_lockdown,BHI@40130#122B0252588C,tnw-device-1,192.168.2.10,,false,BHI@40130#5C201195E81D,tnw-device-2,198.168.100.3,,,false

destroy

Delete an existing device.

path Parameters
id
required
string

Device ID

Responses

200

Success

400

Bad Request

403

Forbidden

422

Unprocessable Entity

delete /devices/{id}
http://localhost/api/v1/devices/{id}

show

Returns a single device.

path Parameters
id
required
string

Device ID

Responses

200

Success

403

Forbidden

404

Not Found

422

Unprocessable Entity

get /devices/{id}
http://localhost/api/v1/devices/{id}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "description": "API device created by automated testing.",
  • "discovered": false,
  • "hipservice_id": "4ae21af1-e5b8-4f92-8c17-c420a93bcdea",
  • "id": "73e2e02a-46ce-45cc-ac76-2ad945b9d2f8",
  • "last_activity_at": null,
  • "mac": "00:0d:29:f0:93:dd",
  • "mac_lockdown": true,
  • "name": "API device (non persistent)",
  • "overlay_device_ip": "192.168.2.10",
  • "uuid": "73e2e02a-46ce-45cc-ac76-2ad945b9d2f8"
}

update

Updates a device

path Parameters
id
required
string

Device ID

Request Body schema: application/json
hipservice_id
required
string

HIPservice ID

name
required
string

name

overlay_device_ip
required
string

Overlay Device IP

description
string

description

mac
string

MAC Address

mac_lockdown
boolean

MAC Address Lockdown

overlay_device_ip_nat
string

Overlay Device IP (NAT) - HIPswitch must have NAT enabled to set

Responses

200

Success

400

Bad Request

403

Forbidden

404

Not Found

422

Unprocessable Entity

patch /devices/{id}
http://localhost/api/v1/devices/{id}

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "description": "API device created by automated testing.",
  • "hipservice_id": "4ae21af1-e5b8-4f92-8c17-c420a93bcdea",
  • "mac": "00:0D:29:F0:93:DD",
  • "mac_lockdown": true,
  • "name": "API device (non persistent)",
  • "overlay_device_ip": "192.168.2.10",
  • "overlay_device_ip_nat": "192.168.2.10"
}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "description": "API device created by automated testing.",
  • "discovered": false,
  • "hipservice_id": "4ae21af1-e5b8-4f92-8c17-c420a93bcdea",
  • "id": "73e2e02a-46ce-45cc-ac76-2ad945b9d2f8",
  • "last_activity_at": null,
  • "mac": "00:0d:29:f0:93:dd",
  • "mac_lockdown": true,
  • "name": "API device (non persistent)",
  • "overlay_device_ip": "192.168.2.10",
  • "uuid": "73e2e02a-46ce-45cc-ac76-2ad945b9d2f8"
}

accept_discovered_device

Accept discovered device.

path Parameters
id
required
string

Device ID

Responses

200

Success

400

Bad Request

403

Forbidden

404

Not Found

422

Unprocessable Entity

post /devices/{id}/accept_discovered_device
http://localhost/api/v1/devices/{id}/accept_discovered_device

tag_members

Directly set tag members for device.

path Parameters
id
required
string

Device ID

Request Body schema: application/json
tag_refs
required
Array of string

array of Tag References (IDs or Names)

Responses

200

success

403

Forbidden

404

Not Found

422

Unprocessable Entity

post /devices/{id}/tag_members
http://localhost/api/v1/devices/{id}/tag_members

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "tag_refs":
    [
    ]
}

Response samples

application/json
Copy
 Expand all Collapse all
{ }

tag_refresh

Refresh expiration time for tag(s) on device.

path Parameters
id
required
string

Device ID

Request Body schema: application/json
tag_refs
required
Array of string

array of Tag References (IDs or Names)

Responses

200

success

400

Bad Request

403

Forbidden

404

Not Found

422

Unprocessable Entity

post /devices/{id}/tag_refresh
http://localhost/api/v1/devices/{id}/tag_refresh

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "tag_refs":
    [
    ]
}

Response samples

application/json
Copy
 Expand all Collapse all
{ }

untag

Remove tag(s) from device.

path Parameters
id
required
string

Device ID

Request Body schema: application/json
tag_refs
required
Array of string

array of Tag References (IDs or Names)

Responses

200

success

403

Forbidden

404

Not Found

422

Unprocessable Entity

delete /devices/{id}/tags
http://localhost/api/v1/devices/{id}/tags

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "tag_refs":
    [
    ]
}

tag

Add tag(s) to device.

path Parameters
id
required
string

Device ID

Request Body schema: application/json
tag_refs
required
Array of string

array of Tag References (IDs or Names)

Responses

200

success

403

Forbidden

404

Not Found

422

Unprocessable Entity

post /devices/{id}/tags
http://localhost/api/v1/devices/{id}/tags

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "tag_refs":
    [
    ]
}

Response samples

application/json
Copy
 Expand all Collapse all
{ }

email_settings

destroy

Delete the existing email settings

Responses

200

Success

400

Bad Request

delete /email_settings
http://localhost/api/v1/email_settings

index

Returns the current email settings

Responses

200

Success

get /email_settings
http://localhost/api/v1/email_settings

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "address": "smtp.example.com",
  • "authentication_type": "login",
  • "enabled": true,
  • "from_email_address": "mailer@example.com",
  • "helo_domain": null,
  • "openssl_verify_mode": "none",
  • "password": "[filtered]",
  • "port": 587,
  • "subject_prefix": "test-config",
  • "time_zone": "America/Los_Angeles",
  • "tlsmail": true,
  • "username": "mailer@example.com"
}

update

Update the existing email settings (All fields are optional)

Request Body schema: application/json
password
string
address
string
enabled
boolean
from_email_address
string
helo_domain
string
openssl_verify_mode
string

SSL verification mode (e.g. none, peer)

authentication_type
string

Type of authorization (e.g. none, plain, login, cram_md5)

port
integer <int32>
subject_prefix
string

Prefix for subject line

time_zone
string

IANA standard string

tlsmail
boolean
username
string

Responses

200

Success

400

Bad Request

patch /email_settings
http://localhost/api/v1/email_settings

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "address": "smtp.example.com",
  • "authentication_type": "login",
  • "enabled": true,
  • "from_email_address": "mailer@example.com",
  • "helo_domain": "",
  • "openssl_verify_mode": "",
  • "password": "actualpassword",
  • "port": 587,
  • "subject_prefix": "test-config",
  • "time_zone": "America/Los_Angeles",
  • "tlsmail": true,
  • "username": "mailer@example.com"
}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "address": "smtp.example.com",
  • "authentication_type": "login",
  • "enabled": true,
  • "from_email_address": "mailer@example.com",
  • "helo_domain": null,
  • "openssl_verify_mode": "none",
  • "password": "[filtered]",
  • "port": 587,
  • "subject_prefix": "test-config",
  • "time_zone": "America/Los_Angeles",
  • "tlsmail": true,
  • "username": "mailer@example.com"
}

create

Set the conductor email settings

Request Body schema: application/json
password
string
address
string
enabled
boolean
from_email_address
string
helo_domain
string
openssl_verify_mode
string

SSL verification mode (e.g. none, peer)

authentication_type
string

Type of authorization (e.g. none, plain, login, cram_md5)

port
integer <int32>
subject_prefix
string

Prefix for subject line

time_zone
string

IANA standard string

tlsmail
boolean
username
string

Responses

201

Success

400

Bad Request

post /email_settings
http://localhost/api/v1/email_settings

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "address": "smtp.example.com",
  • "authentication_type": "login",
  • "enabled": true,
  • "from_email_address": "mailer@example.com",
  • "helo_domain": "",
  • "openssl_verify_mode": "",
  • "password": "actualpassword",
  • "port": 587,
  • "subject_prefix": "test-config",
  • "time_zone": "America/Los_Angeles",
  • "tlsmail": true,
  • "username": "mailer@example.com"
}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "address": "smtp.example.com",
  • "authentication_type": "login",
  • "enabled": true,
  • "from_email_address": "mailer@example.com",
  • "helo_domain": null,
  • "openssl_verify_mode": "none",
  • "password": "[filtered]",
  • "port": 587,
  • "subject_prefix": "test-config",
  • "time_zone": "America/Los_Angeles",
  • "tlsmail": true,
  • "username": "mailer@example.com"
}

test

Send a test email to the given address

Request Body schema: application/json
email
required
string

Responses

200

Success

400

Bad Request

401

Unauthorized

503

Service Unavailable

post /email_settings/test
http://localhost/api/v1/email_settings/test

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "email": "test@example.com"
}

hipservice_groups

bulk_destroy

Delete multiple HIPservices groups.

Request Body schema: application/json
hipservices_group_ids
required
Array of string

An array of ID strings

Responses

200

Success

400

Bad Request

403

Forbidden

422

Unprocessable Entity

delete /hipservice_groups
http://localhost/api/v1/hipservice_groups

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "hipservices_group_ids":
    [
    ]
}

index

Returns a collection of HIPservice groups.

query Parameters
filter
string

filter

sort
string

sort

limit
integer <int32>

limit

offset
integer <int32>

offset

Responses

200

Success

400

Bad Request

get /hipservice_groups
http://localhost/api/v1/hipservice_groups

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    },
  • {
    }
]

create

Create a new HIPservice group.

Request Body schema: application/json
name
required
string
description
string
enabled
boolean

Set enabled state of HIPservice group

hipservices_ids
Array of string

An array of ID strings

relay_group
boolean

Set whether this HIPservice group is a relay group (all HIPservices must be relays to enable)

Responses

201

Success

400

Bad Request

403

Forbidden

404

Not Found

422

Unprocessable Entity

post /hipservice_groups
http://localhost/api/v1/hipservice_groups

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "description": "API hipservice_group created by automated testing.",
  • "enabled": true,
  • "hipservices_ids":
    [
    ],
  • "name": "API hipservice_group (non persistent)",
  • "relay_group": true
}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "description": "API hipservice_group created by automated testing.",
  • "enabled": true,
  • "hipservices_ids":
    [
    ],
  • "id": "a851fe87-3247-4ade-9dd0-a62d6f340e3a",
  • "name": "API hipservice_group (non persistent)",
  • "relay_group": false,
  • "uuid": "a851fe87-3247-4ade-9dd0-a62d6f340e3a"
}

destroy

Delete an existing HIPservice group.

path Parameters
id
required
integer <int32>

HIPservice group ID

Responses

200

Success

400

Bad Request

403

Forbidden

422

Unprocessable Entity

delete /hipservice_groups/{id}
http://localhost/api/v1/hipservice_groups/{id}

show

Returns a single HIPservice.

path Parameters
id
required
string

HIPservice group ID

Responses

200

Success

403

Forbidden

404

Not Found

422

Unprocessable Entity

get /hipservice_groups/{id}
http://localhost/api/v1/hipservice_groups/{id}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "description": "API hipservice_group created by automated testing.",
  • "enabled": true,
  • "hipservices_ids":
    [
    ],
  • "id": "a851fe87-3247-4ade-9dd0-a62d6f340e3a",
  • "name": "API hipservice_group (non persistent)",
  • "relay_group": false,
  • "uuid": "a851fe87-3247-4ade-9dd0-a62d6f340e3a"
}

update

Update an existing HIPservice group (All fields are optional).

path Parameters
id
required
string

HIPservice group ID

Request Body schema: application/json
name
required
string
description
string
enabled
boolean

Set enabled state of HIPservice group

hipservices_ids
Array of string

An array of ID strings

relay_group
boolean

Set whether this HIPservice group is a relay group (all HIPservices must be relays to enable)

Responses

200

Success

400

Bad Request

403

Forbidden

404

Not Found

422

Unprocessable Entity

patch /hipservice_groups/{id}
http://localhost/api/v1/hipservice_groups/{id}

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "description": "API hipservice_group created by automated testing.",
  • "enabled": true,
  • "hipservices_ids":
    [
    ],
  • "name": "API hipservice_group (non persistent)",
  • "relay_group": true
}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "description": "API hipservice_group created by automated testing.",
  • "enabled": true,
  • "hipservices_ids":
    [
    ],
  • "id": "a851fe87-3247-4ade-9dd0-a62d6f340e3a",
  • "name": "API hipservice_group (non persistent)",
  • "relay_group": false,
  • "uuid": "a851fe87-3247-4ade-9dd0-a62d6f340e3a"
}

reboot

Reboot HIPservice group.

path Parameters
id
required
integer <int32>

HIPservice group ID

Responses

200

Success

403

Forbidden

404

Not Found

422

Unprocessable Entity

post /hipservice_groups/{id}/reboot
http://localhost/api/v1/hipservice_groups/{id}/reboot

tag_members

Directly set tag members for HIPservice group.

path Parameters
id
required
string

HIPservice group ID

Request Body schema: application/json
tag_refs
required
Array of string

array of Tag References (IDs or Names)

Responses

200

success

403

Forbidden

404

Not Found

422

Unprocessable Entity

post /hipservice_groups/{id}/tag_members
http://localhost/api/v1/hipservice_groups/{id}/tag_members

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "tag_refs":
    [
    ]
}

Response samples

application/json
Copy
 Expand all Collapse all
{ }

tag_refresh

Refresh expiration time for tag(s) on HIPservice group.

path Parameters
id
required
string

HIPservice group ID

Request Body schema: application/json
tag_refs
required
Array of string

array of Tag References (IDs or Names)

Responses

200

success

403

Forbidden

404

Not Found

422

Unprocessable Entity

post /hipservice_groups/{id}/tag_refresh
http://localhost/api/v1/hipservice_groups/{id}/tag_refresh

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "tag_refs":
    [
    ]
}

Response samples

application/json
Copy
 Expand all Collapse all
{ }

untag

Remove tag(s) from HIPservice group.

path Parameters
id
required
string

HIPservice group ID

Request Body schema: application/json
tag_refs
required
Array of string

array of Tag References (IDs or Names)

Responses

200

success

403

Forbidden

404

Not Found

422

Unprocessable Entity

delete /hipservice_groups/{id}/tags
http://localhost/api/v1/hipservice_groups/{id}/tags

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "tag_refs":
    [
    ]
}

tag

Add tag(s) to HIPservice group.

path Parameters
id
required
string

HIPservice group ID

Request Body schema: application/json
tag_refs
required
Array of string

array of Tag References (IDs or Names)

Responses

200

success

403

Forbidden

404

Not Found

422

Unprocessable Entity

post /hipservice_groups/{id}/tags
http://localhost/api/v1/hipservice_groups/{id}/tags

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "tag_refs":
    [
    ]
}

Response samples

application/json
Copy
 Expand all Collapse all
{ }

hipservices

bulk_destroy

Delete multiple revoked HIPservices.

Request Body schema: application/json
hipservice_ids
required
Array of string

An array of ID strings

Responses

200

Success

400

Bad Request

403

Forbidden

422

Unprocessable Entity

delete /hipservices
http://localhost/api/v1/hipservices

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "hipservices_ids":
    [
    ]
}

index

Returns a collection of HIPservices.

query Parameters
filter
string

filter

sort
string

sort

limit
integer <int32>

limit

offset
integer <int32>

offset

Responses

200

Success

400

Bad Request

get /hipservices
http://localhost/api/v1/hipservices

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    },
  • {
    }
]

bulk_revoke

Deactivate the HIPservice.

Request Body schema: application/json
hipservice_ids
required
Array of string

An array of ID strings

Responses

200

Success

400

Bad Request

403

Forbidden

404

Not Found

422

Unprocessable Entity

post /hipservices/revoke
http://localhost/api/v1/hipservices/revoke

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "hipservices_ids":
    [
    ]
}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "result": "success"
}

destroy

Delete an existing revoked HIPservice.

path Parameters
id
required
string

HIPservice ID

Responses

200

Success

400

Bad Request

403

Forbidden

422

Unprocessable Entity

delete /hipservices/{id}
http://localhost/api/v1/hipservices/{id}

show

Returns a single HIPservice.

path Parameters
id
required
string

HIPservice ID

Responses

200

Success

400

Bad Request

403

Forbidden

404

Not Found

422

Unprocessable Entity

get /hipservices/{id}
http://localhost/api/v1/hipservices/{id}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "active": true,
  • "can_edit": true,
  • "capabilities":
    [
    ],
  • "ccert": null,
  • "ccert_completed_at": null,
  • "ccert_csr": null,
  • "ccert_csr_present": false,
  • "ccert_dn": null,
  • "ccert_dn_present": false,
  • "ccert_present": false,
  • "communication_disabled_through_groups": [ ],
  • "connected": true,
  • "description": "AUTOMATION - PATCHED",
  • "device_activity_reporting_interval": 300,
  • "device_auto_detect": true,
  • "dhcp": null,
  • "diagnostic_requested_at": null,
  • "dn": "/C=US/O=Asguard/OU=Endbox/CN=BHI@40130#42308D510FB2",
  • "enabled": true,
  • "esp_compress": false,
  • "esp_encryption": "AES256_GCM",
  • "factory_reset_at": null,
  • "firewall_config":
    {
    },
  • "firmware_install_at": "2018-08-27T16:17:20.000Z",
  • "firmware_revision": "HIPswitch-x86_64_r2.1.3-951",
  • "ha_available": false,
  • "ha_compatible": true,
  • "hipdevice_stats_filter": null,
  • "hipdevice_stats_interval": 300,
  • "hit": "2001:10:c384:9bde:a3aa:57bc:4473:dabf",
  • "hotfix_list": [ ],
  • "id": "ce5e081e-f063-4b16-8cd4-a353e276f575",
  • "link_manager":
    {
    },
  • "local_devices":
    [
    ],
  • "location": "VMWARE. - PATCHED",
  • "lsi": "1.115.218.191",
  • "managed": true,
  • "max_ft_bandwidth": null,
  • "model": "HIPswitch-300v",
  • "nat": false,
  • "network_list":
    [
    ],
  • "offline_at": "2018-08-28T18:24:42.180Z",
  • "online_at": "2018-08-28T18:24:48.093Z",
  • "overlay_gateway_ip": "192.168.2.10",
  • "overlay_netmask": "255.255.255.0",
  • "overlay_routes": [ ],
  • "packet_capture_started_at": null,
  • "path_mtu_enabled": true,
  • "peer_autoconnect_interval": 60,
  • "product_model": "ISA-300v",
  • "product_platform": "300v-101",
  • "relay": true,
  • "remote_session": null,
  • "serial_number": "42308D510FB2",
  • "source_nat_enabled": false,
  • "stp_enabled": true,
  • "support_bundle_requested_at": null,
  • "title": "HS-168.3.51",
  • "traffic_stats_interval": 300,
  • "transparent_mode": false,
  • "type": "HIPswitch",
  • "uid": "BHI@40130#42308D510FB2",
  • "unassigned": false,
  • "underlay_ip": "192.168.3.51",
  • "underlay_ip_nat": "203.0.113.254",
  • "uuid": "ce5e081e-f063-4b16-8cd4-a353e276f575",
  • "version": "2.1.3"
}

update

Update an existing HIPservice (All fields are optional).

path Parameters
id
required
string

HIPservice ID

Request Body schema: application/json
location
string
active
string
ccert_dn
string
description
string
device_activity_reporting_interval
string
device_auto_detect
string
dhcp
object (dhcp)
enabled
string
esp_encryption
string
esp_compress
boolean
exclusive_mode
string

deprecated

ha_ip
string
ha_partner_id
string
intrusion_detection_frequency
integer

Frequency that the intrusion detection system should processes alerts (in seconds)

ccert
string
nat
string
overlay_device_ip
string

Overlay Device IP (for HIPclient)

overlay_device_netmask
string

Overlay Device Netmask (for HIPclient)

overlay_gateway_ip
string
overlay_netmask
string
packet_capture_started
string
path_mtu_enabled
boolean

Enable path MTU detection (requires Advanced Networking)

source_nat_enabled
boolean

Enable source NAT (requires Advanced Networking)

stp_enabled
boolean

Enable spanning tree protocol (requires Advanced Networking)

title
string
transparent_mode
string
two_factor_auth
string

deprecated

underlay_ip_nat
string
user_auth
boolean

User auth enabled (for HIPclient)

Responses

200

Success

400

Bad Request

403

Forbidden

404

Not Found

422

Unprocessable Entity

patch /hipservices/{id}
http://localhost/api/v1/hipservices/{id}

Request samples

application/json
Copy
 Expand all Collapse all
[
  • {
    },
  • {
    }
]

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "active": true,
  • "can_edit": true,
  • "capabilities":
    [
    ],
  • "ccert": null,
  • "ccert_completed_at": null,
  • "ccert_csr": null,
  • "ccert_csr_present": false,
  • "ccert_dn": null,
  • "ccert_dn_present": false,
  • "ccert_present": false,
  • "communication_disabled_through_groups": [ ],
  • "connected": true,
  • "description": "AUTOMATION - PATCHED",
  • "device_activity_reporting_interval": 300,
  • "device_auto_detect": true,
  • "dhcp": null,
  • "diagnostic_requested_at": null,
  • "dn": "/C=US/O=Asguard/OU=Endbox/CN=BHI@40130#42308D510FB2",
  • "enabled": true,
  • "esp_compress": false,
  • "esp_encryption": "AES256_GCM",
  • "factory_reset_at": null,
  • "firewall_config":
    {
    },
  • "firmware_install_at": "2018-08-27T16:17:20.000Z",
  • "firmware_revision": "HIPswitch-x86_64_r2.1.3-951",
  • "ha_available": false,
  • "ha_compatible": true,
  • "hipdevice_stats_filter": null,
  • "hipdevice_stats_interval": 300,
  • "hit": "2001:10:c384:9bde:a3aa:57bc:4473:dabf",
  • "hotfix_list": [ ],
  • "id": "ce5e081e-f063-4b16-8cd4-a353e276f575",
  • "link_manager":
    {
    },
  • "local_devices":
    [
    ],
  • "location": "VMWARE. - PATCHED",
  • "lsi": "1.115.218.191",
  • "managed": true,
  • "max_ft_bandwidth": null,
  • "model": "HIPswitch-300v",
  • "nat": false,
  • "network_list":
    [
    ],
  • "offline_at": "2018-08-28T18:24:42.180Z",
  • "online_at": "2018-08-28T18:24:48.093Z",
  • "overlay_gateway_ip": "192.168.2.10",
  • "overlay_netmask": "255.255.255.0",
  • "overlay_routes": [ ],
  • "packet_capture_started_at": null,
  • "path_mtu_enabled": true,
  • "peer_autoconnect_interval": 60,
  • "product_model": "ISA-300v",
  • "product_platform": "300v-101",
  • "relay": true,
  • "remote_session": null,
  • "serial_number": "42308D510FB2",
  • "source_nat_enabled": false,
  • "stp_enabled": true,
  • "support_bundle_requested_at": null,
  • "title": "HS-168.3.51",
  • "traffic_stats_interval": 300,
  • "transparent_mode": false,
  • "type": "HIPswitch",
  • "uid": "BHI@40130#42308D510FB2",
  • "unassigned": false,
  • "underlay_ip": "192.168.3.51",
  • "underlay_ip_nat": "203.0.113.254",
  • "uuid": "ce5e081e-f063-4b16-8cd4-a353e276f575",
  • "version": "2.1.3"
}

blink

Sends a blink LED request to the HIPservice.

path Parameters
id
required
string

HIPservice ID

Responses

200

Success

404

Not Found

422

Unprocessable Entity

post /hipservices/{id}/blink
http://localhost/api/v1/hipservices/{id}/blink

Response samples

application/json
Copy
 Expand all Collapse all
{ }

detect_devices

Sends request to auto discover HIPservice local devices.

path Parameters
id
required
string

HIPservice ID

Request Body schema: application/json
overlay_gateway_ip
required
string

Overlay Gateway IP

overlay_netmask
required
string

Overlay Netmask

Responses

200

Success

400

Bad Request

403

Forbidden

404

Not Found

422

Unprocessable Entity

post /hipservices/{id}/detect_devices
http://localhost/api/v1/hipservices/{id}/detect_devices

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "overlay_gateway_ip": "192.168.2.4",
  • "overlay_netmask": "255.255.255.0"
}

devices

HIPservice devices

path Parameters
id
required
string

HIPservice ID

Responses

200

Success

404

Not Found

422

Unprocessable Entity

get /hipservices/{id}/devices
http://localhost/api/v1/hipservices/{id}/devices

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Show diagnostic report

Show a diagnostic report

path Parameters
id
required
string

HIPservice ID

Responses

200

Success

404

Not Found

get /hipservices/{id}/diagnostic
http://localhost/api/v1/hipservices/{id}/diagnostic

Response samples

application/json
Copy
 Expand all Collapse all
"string"

Request diagnostic report

Start a job to request a HIPservice diagnostic report

path Parameters
id
required
string

HIPservice ID

Responses

202

Accepted

404

Not Found

post /hipservices/{id}/diagnostic
http://localhost/api/v1/hipservices/{id}/diagnostic

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "job_id": "272e0685685a6fe7fb9e377aea4cfbfe",
  • "status_url": "{request_base_url}/api/v1/jobs/272e0685685a6fe7fb9e377aea4cfbfe"
}

export_devices

Export local devices to csv file.

path Parameters
id
required
string

HIPservice ID

Responses

200

Success

403

Forbidden

404

Not Found

422

Unprocessable Entity

get /hipservices/{id}/export_devices
http://localhost/api/v1/hipservices/{id}/export_devices

Response samples

text/csv
Copy
hipservice_id,device_name,overlay_device_ip,overlay_device_ip_nat,mac_address,mac_lockdown,BHI@40130#122B0252588C,tnw-device-1,192.168.2.10,,false,BHI@40130#5C201195E81D,tnw-device-2,198.168.100.3,,,false

health_data

Returns HIPservice health data.

path Parameters
id
required
string

HIPservice ID

query Parameters
timestamp
string

Health data range begin

timestamp_end
string

Health data rage end

limit
integer <int32>

limit

Responses

200

Success

403

Forbidden

404

Not Found

422

Unprocessable Entity

get /hipservices/{id}/health_data
http://localhost/api/v1/hipservices/{id}/health_data

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    },
  • {
    },
  • {
    }
]

manage

Sets the HIPservice state to managed.

path Parameters
id
required
string

HIPservice ID

Responses

200

Success

400

Bad Request

404

Not Found

422

Unprocessable Entity

post /hipservices/{id}/manage
http://localhost/api/v1/hipservices/{id}/manage

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "active": true,
  • "can_edit": true,
  • "capabilities":
    [
    ],
  • "ccert": null,
  • "ccert_completed_at": null,
  • "ccert_csr": null,
  • "ccert_csr_present": false,
  • "ccert_dn": null,
  • "ccert_dn_present": false,
  • "ccert_present": false,
  • "communication_disabled_through_groups": [ ],
  • "connected": true,
  • "description": null,
  • "device_activity_reporting_interval": 300,
  • "device_auto_detect": false,
  • "dhcp": null,
  • "diagnostic_requested_at": null,
  • "dn": "/C=US/O=Asguard/OU=Endbox/CN=BHI@40130#6ED7E57DBFDA",
  • "enabled": true,
  • "esp_compress": false,
  • "esp_encryption": "AES256_GCM",
  • "factory_reset_at": null,
  • "firewall_config":
    {
    },
  • "firmware_install_at": "2018-08-30T22:36:17.000Z",
  • "firmware_revision": "HIPswitch-x86_64_r2.1.4-1067",
  • "ha_available": false,
  • "ha_compatible": false,
  • "hipdevice_stats_filter": null,
  • "hipdevice_stats_interval": 300,
  • "hit": "2001:14:b61d:8183:d115:96e:229e:51f1",
  • "hotfix_list": [ ],
  • "id": "f106b324-afc3-409b-b48f-2de28cacfb5d",
  • "link_manager":
    {
    },
  • "local_devices": [ ],
  • "location": null,
  • "lsi": "1.158.81.241",
  • "managed": true,
  • "max_ft_bandwidth": null,
  • "model": "HIPswitch-300v",
  • "nat": false,
  • "network_list": [ ],
  • "offline_at": null,
  • "online_at": "2018-08-30T22:36:31.581Z",
  • "overlay_gateway_ip": null,
  • "overlay_netmask": "255.255.255.0",
  • "overlay_routes": [ ],
  • "packet_capture_started_at": null,
  • "path_mtu_enabled": true,
  • "peer_autoconnect_interval": 60,
  • "product_model": "ISA-300v",
  • "product_platform": "300v-108",
  • "relay": false,
  • "remote_session": null,
  • "serial_number": "6ED7E57DBFDA",
  • "source_nat_enabled": false,
  • "stp_enabled": true,
  • "support_bundle_requested_at": null,
  • "title": null,
  • "traffic_stats_interval": 300,
  • "transparent_mode": false,
  • "type": "HIPswitch",
  • "uid": "BHI@40130#6ED7E57DBFDA",
  • "unassigned": true,
  • "underlay_ip": "192.168.184.2",
  • "underlay_ip_nat": "203.0.113.254",
  • "uuid": "f106b324-afc3-409b-b48f-2de28cacfb5d",
  • "version": "2.1.4"
}

overlay_routes

HIPservice overlay routes

path Parameters
id
required
string

HIPservice ID

Responses

200

Success

404

Not Found

422

Unprocessable Entity

get /hipservices/{id}/overlay_routes
http://localhost/api/v1/hipservices/{id}/overlay_routes

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Stop a packet capture

Stop a packet capture on a HIPservice (will cause the HIPservice to upload what has been captured up until this call)

path Parameters
id
required
string

HIPservice ID

Responses

202

Accepted

404

Not Found

delete /hipservices/{id}/pcap
http://localhost/api/v1/hipservices/{id}/pcap

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "job_id": "272e0685685a6fe7fb9e377aea4cfbfe",
  • "status_url": "{request_base_url}/api/v1/jobs/272e0685685a6fe7fb9e377aea4cfbfe"
}

Show packet capture

Show a packet capture

path Parameters
id
required
string

HIPservice ID

Responses

200

Success

404

Not Found

get /hipservices/{id}/pcap
http://localhost/api/v1/hipservices/{id}/pcap

Response samples

application/json
Copy
 Expand all Collapse all
"string"

Request packet capture

Start a job to request a packet capture on the HIPservice

path Parameters
id
required
string

HIPservice ID

Request Body schema: application/json
capture_interface
required
string

Interface to capture on

ip_address
string

IP address to capture

max_bandwidth
integer

Maximum bandwidth to use on PCAP upload (KB)

max_size
integer

Max size of PCAP (MB)

max_time
integer

Time limit for packet capture (in minutes)

port
integer

Port to capture

protocol
string

Protocol to capture (any, icmp, tcp, udp, arp)

Responses

202

Accepted

404

Not Found

post /hipservices/{id}/pcap
http://localhost/api/v1/hipservices/{id}/pcap

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "capture_interface": "hip0",
  • "ip_address": "192.168.1.101",
  • "max_bandwidth": 1000,
  • "max_size": 100,
  • "max_time": 1,
  • "port": 80,
  • "protocol": "any"
}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "job_id": "272e0685685a6fe7fb9e377aea4cfbfe",
  • "status_url": "{request_base_url}/api/v1/jobs/272e0685685a6fe7fb9e377aea4cfbfe"
}

ports

Returns HIPservice port configuration

path Parameters
id
required
string

HIPservice ID

Responses

200

Success

403

Forbidden

404

Not Found

422

Unprocessable Entity

get /hipservices/{id}/ports
http://localhost/api/v1/hipservices/{id}/ports

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

reactivate

Activate the HIPservice.

path Parameters
id
required
string

HIPservice ID

Responses

200

Success

400

Bad Request

403

Forbidden

404

Not Found

422

Unprocessable Entity

post /hipservices/{id}/reactivate
http://localhost/api/v1/hipservices/{id}/reactivate

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "result": "success"
}

reassign

Reassign a to be replaced HIPservice config to the current HIPservice.

path Parameters
id
required
string

HIPservice ID

Request Body schema: application/x-www-form-urlencoded
replacement_hipservice_id
required
string

HIPservice ID

Responses

200

Success

400

Bad Request

403

Forbidden

404

Not Found

422

Unprocessable Entity

post /hipservices/{id}/reassign
http://localhost/api/v1/hipservices/{id}/reassign

Response samples

application/json
Copy
 Expand all Collapse all
{ }

reboot

Sends a reboot request to the HIPservice.

path Parameters
id
required
string

HIPservice ID

Responses

200

Success

403

Forbidden

404

Not Found

422

Unprocessable Entity

post /hipservices/{id}/reboot
http://localhost/api/v1/hipservices/{id}/reboot

reset_customer_pki

Clears customer certificate from the HIPservice.

path Parameters
id
required
string

HIPservice ID

Responses

200

Success

403

Forbidden

404

Not Found

422

Unprocessable Entity

post /hipservices/{id}/reset_customer_pki
http://localhost/api/v1/hipservices/{id}/reset_customer_pki

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    },
  • {
    }
]

revoke

Deactivate the HIPservice.

path Parameters
id
required
string

HIPservice ID

Responses

200

Success

400

Bad Request

403

Forbidden

404

Not Found

422

Unprocessable Entity

post /hipservices/{id}/revoke
http://localhost/api/v1/hipservices/{id}/revoke

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "result": "success"
}

Show support bundle

Show a support bundle

path Parameters
id
required
string

HIPservice ID

Responses

200

Success

404

Not Found

get /hipservices/{id}/support_bundle
http://localhost/api/v1/hipservices/{id}/support_bundle

Response samples

application/json
Copy
 Expand all Collapse all
"string"

Request support bundle

Start a job to request a HIPservice support bundle

path Parameters
id
required
string

HIPservice ID

Responses

202

Accepted

404

Not Found

post /hipservices/{id}/support_bundle
http://localhost/api/v1/hipservices/{id}/support_bundle

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "job_id": "272e0685685a6fe7fb9e377aea4cfbfe",
  • "status_url": "{request_base_url}/api/v1/jobs/272e0685685a6fe7fb9e377aea4cfbfe"
}

swap_ha

Swaps the HA role of the HIPservice.

path Parameters
id
required
string

HIPservice ID

Responses

200

Success

403

Forbidden

404

Not Found

422

Unprocessable Entity

post /hipservices/{id}/swap_ha
http://localhost/api/v1/hipservices/{id}/swap_ha

Response samples

application/json
Copy
 Expand all Collapse all
{ }

tag_members

Directly set tag members for HIPservice.

path Parameters
id
required
string

HIPservice ID

Request Body schema: application/json
tag_refs
required
Array of string

array of Tag References (IDs or Names)

Responses

200

success

403

Forbidden

404

Not Found

422

Unprocessable Entity

post /hipservices/{id}/tag_members
http://localhost/api/v1/hipservices/{id}/tag_members

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "tag_refs":
    [
    ]
}

Response samples

application/json
Copy
 Expand all Collapse all
{ }

tag_refresh

Refresh expiration time for tag(s) on HIPservice.

path Parameters
id
required
string

HIPservice ID

Request Body schema: application/json
tag_refs
required
Array of string

array of Tag References (IDs or Names)

Responses

200

success

403

Forbidden

404

Not Found

422

Unprocessable Entity

post /hipservices/{id}/tag_refresh
http://localhost/api/v1/hipservices/{id}/tag_refresh

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "tag_refs":
    [
    ]
}

Response samples

application/json
Copy
 Expand all Collapse all
{ }

untag

Remove tag(s) from HIPservice.

path Parameters
id
required
string

HIPservice ID

Request Body schema: application/json
tag_refs
required
Array of string

array of Tag References (IDs or Names)

Responses

200

success

403

Forbidden

404

Not Found

422

Unprocessable Entity

delete /hipservices/{id}/tags
http://localhost/api/v1/hipservices/{id}/tags

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "tag_refs":
    [
    ]
}

tag

Add tag(s) to HIPservice.

path Parameters
id
required
string

HIPservice ID

Request Body schema: application/json
tag_refs
required
Array of string

array of Tag References (IDs or Names)

Responses

200

success

403

Forbidden

404

Not Found

422

Unprocessable Entity

post /hipservices/{id}/tags
http://localhost/api/v1/hipservices/{id}/tags

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "tag_refs":
    [
    ]
}

Response samples

application/json
Copy
 Expand all Collapse all
{ }

traffic_stats

Returns HIPservice traffic stats

path Parameters
id
required
string

HIPservice ID

Responses

200

Success

403

Forbidden

404

Not Found

422

Unprocessable Entity

get /hipservices/{id}/traffic_stats
http://localhost/api/v1/hipservices/{id}/traffic_stats

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    },
  • {
    }
]

tunnel_stat_peers

Returns a list of ID pairs of tunnels on the given HIPservice.

path Parameters
id
required
string

HIPservice ID

Request Body schema: application/json
end_time
string

Time for the start of the data (ISO8601 datetime)

start_time
string

Time for the start of the data (ISO8601 datetime)

state
string
Enum:"unknown" "unassociated" "i1_sent" "i2_sent" "r2_sent" "established" "rekeying" "closing" "closed" "e_failed" "relayed"

Return only data in this state

Responses

200

Success

400

Bad Request

403

Forbidden

404

Not Found

422

Unprocessable Entity

post /hipservices/{id}/tunnel_stat_peers
http://localhost/api/v1/hipservices/{id}/tunnel_stat_peers

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "end_time": "2019-01-23 17:24:52 -0800",
  • "start_time": "2019-01-23 17:24:52 -0800",
  • "state": "unassociated"
}

Response samples

application/json
Copy
 Expand all Collapse all
[
  • "3f862971-3d78-443b-9cfe-a327b43f4451",
  • "f5ca9d80-7429-41ff-be30-e7b6a0382288"
]

tunnel_stats

Returns tunnel statistics that include the given HIPservices.

path Parameters
id
required
string

HIPservice ID

Request Body schema: application/json
end_time
string

Time for the start of the data (ISO8601 datetime)

hipservice_ids
Array of string

An array of HIPservice ID strings

limit
integer

Maximum number of stats to return

start_time
string

Time for the start of the data (ISO8601 datetime)

state
string
Enum:"unknown" "unassociated" "i1_sent" "i2_sent" "r2_sent" "established" "rekeying" "closing" "closed" "e_failed" "relayed"

Return only data in this state

wide_view
boolean

If true, will return stats that include only one of the given Hipservice IDs

Responses

200

Success

400

Bad Request

403

Forbidden

404

Not Found

422

Unprocessable Entity

post /hipservices/{id}/tunnel_stats
http://localhost/api/v1/hipservices/{id}/tunnel_stats

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "end_time": "2019-01-23 17:24:52 -0800",
  • "hipservice_ids":
    [
    ],
  • "limit": 1,
  • "start_time": "2019-01-23 17:24:52 -0800",
  • "state": "unassociated",
  • "wide_view": false
}

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    },
  • {
    }
]

overlay_routes

destroy

Delete an overlay route

path Parameters
id
required
string

HIPservice ID

id
required
string

Overlay route ID

Responses

200

Success

404

Not Found

422

Unprocessable Entity

delete /hipservices/{id}/overlay_routes/{id}
http://localhost/api/v1/hipservices/{id}/overlay_routes/{id}

event_action_types

index

Returns a collection of event action types

Responses

200

Success

403

Forbidden

get /event_action_types
http://localhost/api/v1/event_action_types

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    },
  • {
    }
]

event_actions

index

Returns a collection of event actions

Responses

200

Success

get /event_actions
http://localhost/api/v1/event_actions

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

create

Create a new event action

Request Body schema: application/json
event_action_type_id
required
string

Event action type ID

event_monitor_id
required
string

Event monitor ID

params
required
object

Hash of params for desired event action. Required and optional params are defined on each event action type

Responses

201

Success

403

Forbidden

422

Unprocessable Entity

post /event_actions
http://localhost/api/v1/event_actions

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "event_action_type_id": "48457ebc-2389-4460-b03f-038b7ab2353a",
  • "event_monitor_id": "3d09675b-b4a1-4d4e-a830-12c5d7904920",
  • "params":
    {
    }
}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "created_at": "2018-09-04T16:44:34.431Z",
  • "event_action_type_id": "48457ebc-2389-4460-b03f-038b7ab2353a",
  • "event_monitor_id": "3d09675b-b4a1-4d4e-a830-12c5d7904920",
  • "event_type": "match",
  • "id": "6a2f0651-2ba4-40ed-b3d8-2b549e610f59",
  • "params":
    {
    },
  • "updated_at": "2018-09-04T16:44:34.431Z"
}

destroy

Delete an existing event action

path Parameters
id
required
string

Responses

200

Success

403

Forbidden

422

Unprocessable Entity

delete /event_actions/{id}
http://localhost/api/v1/event_actions/{id}

show

Return a single event action

path Parameters
id
required
string

Responses

200

Success

403

Forbidden

404

Not Found

422

Unprocessable Entity

get /event_actions/{id}
http://localhost/api/v1/event_actions/{id}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "created_at": "2018-08-29T18:37:12.661Z",
  • "event_action_type_id": "48457ebc-2389-4460-b03f-038b7ab2353a",
  • "event_monitor_id": "6f205edf-d0b3-4578-b2ae-8b39183c035e",
  • "event_type": "match",
  • "id": "3c0e6d32-1664-4dba-9856-80f9cc7156aa",
  • "params":
    {
    },
  • "updated_at": "2018-08-29T18:37:12.661Z"
}

update

Update an existing event action

path Parameters
id
required
string
Request Body schema: application/json
params
required
object

Hash of params for desired event action. Required and optional params are defined on each event action type

Responses

200

Success

403

Forbidden

404

Not Found

422

Unprocessable Entity

patch /event_actions/{id}
http://localhost/api/v1/event_actions/{id}

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "params":
    {
    }
}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "created_at": "2018-09-04T16:44:34.431Z",
  • "event_action_type_id": "48457ebc-2389-4460-b03f-038b7ab2353a",
  • "event_monitor_id": "3d09675b-b4a1-4d4e-a830-12c5d7904920",
  • "event_type": "match",
  • "id": "6a2f0651-2ba4-40ed-b3d8-2b549e610f59",
  • "params":
    {
    },
  • "updated_at": "2018-09-04T16:44:34.431Z"
}

event_monitor_types

index

Returns a collection of event monitor types

Responses

200

Success

get /event_monitor_types
http://localhost/api/v1/event_monitor_types

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    },
  • {
    }
]

monitorables

Returns a list of IDs that are valid monitorable targets of a monitor for the given event monitor type

path Parameters
id
required
string

Responses

200

Success

404

Not Found

422

Unprocessable Entity

get /event_monitor_types/{id}/monitorables
http://localhost/api/v1/event_monitor_types/{id}/monitorables

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "hipservice":
    [
    ],
  • "hipservice_group":
    [
    ]
}

event_monitors

bulk_destroy

Delete multiple event monitors

Request Body schema: application/json
event_monitor_ids
required
Array of string

An array of ID strings

Responses

200

Success

403

Forbidden

422

Unprocessable Entity

delete /event_monitors
http://localhost/api/v1/event_monitors

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "event_monitor_ids":
    [
    ]
}

index

Returns a collection of event monitors

Responses

200

Success

get /event_monitors
http://localhost/api/v1/event_monitors

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    },
  • {
    }
]

create

Create a new event monitor

Request Body schema: application/json
event_monitor_type_id
required
string

Event monitor type ID

monitorable_id
required
string

ID of monitorable target

monitorable_type
required
string

Type of monitorable target (e.g. device, device_group, hipservice, hipservice_group)

params
required
object

Hash of params for desired event monitor. Required and optional params are defined on each event monitor type

Responses

201

Success

403

Forbidden

422

Unprocessable Entity

post /event_monitors
http://localhost/api/v1/event_monitors

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "event_monitor_type_id": "2dd0de70-6b90-4523-ab05-0a49d26ae077",
  • "monitorable_id": "d0017bc1-3762-4ade-9033-59f6ed4b8871",
  • "monitorable_type": "hipservice",
  • "params":
    {
    }
}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "can_edit": true,
  • "created_at": "2018-09-04T17:19:52.927Z",
  • "event_monitor_type_id": "2dd0de70-6b90-4523-ab05-0a49d26ae077",
  • "flapping": 0,
  • "id": "5ac5aa3e-dc90-490a-a01e-7123189b724a",
  • "monitorable_id": "d0017bc1-3762-4ade-9033-59f6ed4b8871",
  • "monitorable_type": "hipservice",
  • "params":
    {
    },
  • "updated_at": "2018-09-04T17:19:52.927Z"
}

bulk_disable

Disable multiple event monitors

Request Body schema: application/json
event_monitor_ids
required
Array of string

An array of ID strings

Responses

200

Success

403

Forbidden

404

Not Found

422

Unprocessable Entity

post /event_monitors/disable
http://localhost/api/v1/event_monitors/disable

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "event_monitor_ids":
    [
    ]
}

bulk_enable

Enable multiple event monitors

Request Body schema: application/json
event_monitor_ids
required
Array of string

An array of ID strings

Responses

200

Success

403

Forbidden

404

Not Found

422

Unprocessable Entity

post /event_monitors/enable
http://localhost/api/v1/event_monitors/enable

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "event_monitor_ids":
    [
    ]
}

destroy

Delete an existing event monitor

path Parameters
id
required
string

Responses

200

Success

403

Forbidden

422

Unprocessable Entity

delete /event_monitors/{id}
http://localhost/api/v1/event_monitors/{id}

show

Return a single event monitor

path Parameters
id
required
string

Responses

200

Success

403

Forbidden

404

Not Found

422

Unprocessable Entity

get /event_monitors/{id}
http://localhost/api/v1/event_monitors/{id}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "can_edit": true,
  • "created_at": "2018-08-29T20:04:26.978Z",
  • "disabled_at": null,
  • "event_monitor_type_id": "5b4c2da7-0953-4b5c-b500-47adf2dcdcd0",
  • "flapping": 0,
  • "id": "52f15a00-3b92-43f3-902f-b7fabfcd38be",
  • "monitorable_id": "98f52e8f-bb9b-4c18-9dca-cf0faa3d86ea",
  • "monitorable_type": "hipservice_group",
  • "params": { },
  • "updated_at": "2018-08-29T21:34:46.001Z"
}

update

Update an existing event monitor

path Parameters
id
required
string
Request Body schema: application/json
params
required
object

Hash of params for desired event monitor. Required and optional params are defined on each event monitor type

Responses

200

Success

403

Forbidden

404

Not Found

422

Unprocessable Entity

patch /event_monitors/{id}
http://localhost/api/v1/event_monitors/{id}

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "params":
    {
    }
}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "can_edit": true,
  • "created_at": "2018-09-04T17:19:52.927Z",
  • "event_monitor_type_id": "2dd0de70-6b90-4523-ab05-0a49d26ae077",
  • "flapping": 0,
  • "id": "5ac5aa3e-dc90-490a-a01e-7123189b724a",
  • "monitorable_id": "d0017bc1-3762-4ade-9033-59f6ed4b8871",
  • "monitorable_type": "hipservice",
  • "params":
    {
    },
  • "updated_at": "2018-09-04T17:19:52.927Z"
}

disable

Temporarily disable operation of an event monitor

path Parameters
id
required
string

Responses

200

Success

403

Forbidden

404

Not Found

422

Unprocessable Entity

post /event_monitors/{id}/disable
http://localhost/api/v1/event_monitors/{id}/disable

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "can_edit": true,
  • "created_at": "2018-08-29T20:04:26.978Z",
  • "disabled_at": "2018-08-29T21:31:46.598Z",
  • "event_monitor_type_id": "5b4c2da7-0953-4b5c-b500-47adf2dcdcd0",
  • "flapping": 0,
  • "id": "52f15a00-3b92-43f3-902f-b7fabfcd38be",
  • "monitorable_id": "98f52e8f-bb9b-4c18-9dca-cf0faa3d86ea",
  • "monitorable_type": "hipservice_group",
  • "params": { },
  • "updated_at": "2018-08-29T21:31:46.599Z"
}

enable

Enable operation of a disabled event monitor

path Parameters
id
required
string

Responses

200

Success

403

Forbidden

404

Not Found

422

Unprocessable Entity

post /event_monitors/{id}/enable
http://localhost/api/v1/event_monitors/{id}/enable

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "can_edit": true,
  • "created_at": "2018-08-29T20:04:26.978Z",
  • "disabled_at": null,
  • "event_monitor_type_id": "5b4c2da7-0953-4b5c-b500-47adf2dcdcd0",
  • "flapping": 0,
  • "id": "52f15a00-3b92-43f3-902f-b7fabfcd38be",
  • "monitorable_id": "98f52e8f-bb9b-4c18-9dca-cf0faa3d86ea",
  • "monitorable_type": "hipservice_group",
  • "params": { },
  • "updated_at": "2018-08-29T21:34:46.001Z"
}

people

Return a list of people that have permissions to view this event monitor

path Parameters
id
required
string

Responses

200

Success

403

Forbidden

404

Not Found

422

Unprocessable Entity

get /event_monitors/{id}/people
http://localhost/api/v1/event_monitors/{id}/people

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

invites

index

Returns a paginated list of HIP invites and their recipients

query Parameters
limit
integer <int32>

limit

offset
integer <int32>

offset

order
string

order

ascending
boolean

ascending

Responses

200

Success

403

Forbidden

get /invites
http://localhost/api/v1/invites

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "data":
    [
    ],
  • "metadata":
    {
    }
}

create

Create a HIP invite

Request Body schema: application/json
emails
required
Array of string

Array of emails

expires_at
required
string

ISO8601 date-time format when the HIP invites will expire if not used

name_schema
required
string

Schema used to determine name of HIPservice when it connects to conductor. Variables are wrapped in "${}". Valid variables are: email, email_name, hipswitch_type, ip

device_group_ids
Array of string

Array of device group ids

email_message
string

Message of email to send to invitees. It is advisable to include the Conductor URI, Conductor MAP port, and a location where users can download the HIPclient package.

email_subject
string

Subject line of email sent to invitees

hipservice_group_ids
Array of string

Array of hipservice group ids

overlay_device_ip_start
string

First overlay IP address in range to be assigned to HIPservice when it connects to Conductor

overlay_network_ids
Array of string

Array of overlay network ids

uniq_ip
string

'true' if IP addresses already assigned to existing devices should be skipped

Responses

201

Success

400

Bad Request

403

Forbidden

404

Not Found

422

Unprocessable Entity

post /invites
http://localhost/api/v1/invites

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "device_group_ids":
    [
    ],
  • "email_message": "Please find your Hip Invite!",
  • "email_subject": "Hip Invite",
  • "emails":
    [
    ],
  • "expires_at": "2019-01-01T10:15:00.000Z",
  • "hipservice_group_ids":
    [
    ],
  • "name_schema": "${email_name} - ${hipswitch_type}",
  • "overlay_device_ip_start": "",
  • "overlay_network_ids": [ ],
  • "uniq_ip": ""
}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "admin_ip": "203.0.113.254",
  • "created_at": "2018-08-28T22:05:25.971Z",
  • "email_message": "Please find your Hip Invite!",
  • "email_subject": " Hip Invite ",
  • "hip_invite_recipients":
    [
    ],
  • "id": "60ecdcda-4ef5-4e7b-8959-855de1662839",
  • "person_id": "b45d4567-1234-def7-abc1-1234567d58f2",
  • "updated_at": "2018-08-28T22:05:25.971Z"
}

show

Returns a single HIP invite and its recipients

path Parameters
id
required
string

Responses

200

Success

403

Forbidden

404

Not Found

422

Unprocessable Entity

get /invites/{id}
http://localhost/api/v1/invites/{id}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "admin_ip": "203.0.113.254",
  • "created_at": "2018-08-28T22:05:25.971Z",
  • "email_message": "Please find your Hip Invite!",
  • "email_subject": " Hip Invite ",
  • "hip_invite_recipients":
    [
    ],
  • "id": "60ecdcda-4ef5-4e7b-8959-855de1662839",
  • "person_id": "b45d4567-1234-def7-abc1-1234567d58f2",
  • "updated_at": "2018-08-28T22:05:25.971Z"
}

jobs

show

Returns the status of a job

path Parameters
id
required
string

Job id

Responses

200

Success

201

Created

400

Bad Request

get /jobs/{id}
http://localhost/api/v1/jobs/{id}

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

licensing

get_prov_requests

Returns all pending provisioning requests.

Responses

200

Success

get /licensing/prov_requests
http://localhost/api/v1/licensing/prov_requests

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    },
  • {
    }
]

grant_prov_requests

Grant or Deny a provisioning request.

Request Body schema: application/json
grant
required
string

Boolean true or false to grant or deny a provisioning request.

id
required
Array of string

An array of ID strings

Responses

200

success

403

Forbidden

404

Not Found

422

Unprocessable Entity

post /licensing/prov_requests
http://localhost/api/v1/licensing/prov_requests

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "grant": true,
  • "id":
    [
    ]
}

get_prov_request

Returns a single provisioning request.

path Parameters
licenseId
required
string

Responses

200

Success

404

Not Found

422

Unprocessable Entity

get /licensing/prov_requests/{licenseId}
http://localhost/api/v1/licensing/prov_requests/{licenseId}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "display_model": "HIPswitch-300v",
  • "entity_uid": "EC27F4DFAF07",
  • "id": "ed7f457c-c264-453e-944c-0ec4d1df7692",
  • "license_block_id": null,
  • "status": "grant",
  • "timestamp": "2018-08-28T22:18:24.097Z",
  • "uuid": "ed7f457c-c264-453e-944c-0ec4d1df7692"
}

sync

Synchronize your license data.

Responses

200

Success

403

Forbidden

503

Service Unavailable

post /licensing/sync
http://localhost/api/v1/licensing/sync

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "sync_warnings": [ ]
}

sync_export

Export a conductor sync package. Used to manually sync a conductor.

Responses

200

Success

403

Forbidden

get /licensing/sync_export
http://localhost/api/v1/licensing/sync_export

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "auth_data": "3DjRbQ0G41fggfuE4lsQ==",
  • "auth_tag": "UcK4mz/IMNlMW84og==",
  • "cert_subject": "/C=US/O=Asguard/OU=AMA/CN=Test-AMA-Root",
  • "data": "VqsTnP2yUK3BHlyUTI+NLKb63MzVtoOJKCB",
  • "iv": "G2HfkKUp4xovibKu",
  • "key": "123cigHmo12345678mItrGGABCDEF0clJKjYs16RnD3FDkOk/CABCDOzJdZn+g="
}

sync_import

Import a conductor sync package response. Used to manually sync a conductor.

Request Body schema: application/json
auth_data
required
string

Auto-generated field. Do not modify.

auth_tag
required
string

Auto-generated field. Do not modify.

cert_subject
required
string

Auto-generated field. Do not modify.

data
required
string

Auto-generated field. Do not modify.

iv
required
string

Auto-generated field. Do not modify.

key
required
string

Auto-generated field. Do not modify.

Responses

200

Success

400

Bad Request

403

Forbidden

post /licensing/sync_import
http://localhost/api/v1/licensing/sync_import

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "auth_data": "1234aBCdeFghjklm4567==",
  • "auth_tag": "AbcdHi/jKlmno123q==",
  • "cert_subject": "/C=US/O=Asguard/OU=AMA/CN=Test-AMA-Root",
  • "data": "CdefabC7Hys3HlyU98+HdjHb7jbHtoOJKCB",
  • "iv": "ABcdefgH1234jkl7",
  • "key": "1234AbcdeFgHiJ1234klnmOpqr1234stuvWXYzs12345678kOk/abCDefghijk+g="
}

Response samples

application/json
Copy
 Expand all Collapse all
{ }

get_vouchers

Returns a collection of vouchers.

Responses

200

Success

get /licensing/vouchers
http://localhost/api/v1/licensing/vouchers

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

add_voucher

Add a licensing voucher.

Request Body schema: application/json
code
required
string

Tempered Networks voucher code.

Responses

200

Success

403

Forbidden

503

Service Unavailable

post /licensing/vouchers
http://localhost/api/v1/licensing/vouchers

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "code": "A123B45678911234"
}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "code": "A123B45678911234",
  • "expires_at": null,
  • "id": "b467bb5d-0987-4756-af7f-c0855ad2cec0",
  • "license_blocks": [ ],
  • "status": "processing",
  • "timestamp": "2018-08-28T22:23:30.344Z",
  • "uuid": "b467bb5d-0987-4756-af7f-c0855ad2cec0"
}

delete_voucher

Delete a licensing voucher.

path Parameters
voucher_id
required
integer <int32>

Voucher ID

Responses

200

Success

403

Forbidden

422

Unprocessable Entity

delete /licensing/vouchers/{voucher_id}
http://localhost/api/v1/licensing/vouchers/{voucher_id}

get_voucher

Returns a single voucher setting.

path Parameters
voucherId
required
string

Voucher ID

Responses

200

Success

404

Not Found

422

Unprocessable Entity

get /licensing/vouchers/{voucher_id}
http://localhost/api/v1/licensing/vouchers/{voucher_id}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "code": "A123B45678911234",
  • "expires_at": null,
  • "id": "d36a2706-2f71-4678-bf44-b7892237c285",
  • "license_blocks":
    [
    ],
  • "status": "active",
  • "timestamp": "2018-08-28T20:15:21.265Z",
  • "uuid": "d36a2706-2f71-4678-bf44-b7892237c285"
}

overlay_network_devices

destroy

Removes device groups and devices from an overlay policy.

Request Body schema: application/json
device_group_ids
required
Array of string

An Array of device group ID strings

network_id
required
string

Responses

200

Success

403

Forbidden

404

Not Found

422

Unprocessable Entity

delete /overlay_network_devices
http://localhost/api/v1/overlay_network_devices

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "device_group_ids":
    [
    ],
  • "network_id": "bd03d291-699d-4d33-af1c-493edea60bb3"
}

create

Adds device groups and devices to an overlay policy.

Request Body schema: application/json
device_group_ids
required
Array of string

An Array of device group ID strings

network_id
required
string

Responses

201

Success

400

Bad Request

403

Forbidden

404

Not Found

422

Unprocessable Entity

post /overlay_network_devices
http://localhost/api/v1/overlay_network_devices

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "device_group_ids":
    [
    ],
  • "network_id": "bd03d291-699d-4d33-af1c-493edea60bb3"
}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "can_edit": true,
  • "description": "API Overlay created by automated testing.",
  • "device_groups":
    [
    ],
  • "enabled": true,
  • "hipservices":
    [
    ],
  • "id": "bd03d291-699d-4d33-af1c-493edea60bb3",
  • "name": "API Automation Overlay (API: TestConductorAPIOverlayPolicy)",
  • "policy": [ ],
  • "uuid": "bd03d291-699d-4d33-af1c-493edea60bb3",
  • "vlan":
    {
    }
}

disconnect

Removes policy between two device groups/devices.

Request Body schema: application/json
device_group_1
required
string

ID of device group 1

device_group_2
required
string

ID of device group 2

network_id
required
string

Responses

200

Success

400

Bad Request

403

Forbidden

404

Not Found

422

Unprocessable Entity

delete /overlay_network_devices/trust
http://localhost/api/v1/overlay_network_devices/trust

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "device_group_1": "6dfda5e4-809c-414e-b9ab-b6b3e7a47085",
  • "device_group_2": "4e7264ea-79f2-43b1-bf1e-2b786a41450e",
  • "network_id": "cd4a9ed7-3ab4-484e-bf44-5feff5fbf2ea"
}

connect

Establishes policy between two device groups/devices.

Request Body schema: application/json
device_group_1
required
string

ID of device group 1

device_group_2
required
string

ID of device group 2

network_id
required
string

Responses

200

Success

400

Bad Request

403

Forbidden

404

Not Found

422

Unprocessable Entity

post /overlay_network_devices/trust
http://localhost/api/v1/overlay_network_devices/trust

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "device_group_1": "6dfda5e4-809c-414e-b9ab-b6b3e7a47085",
  • "device_group_2": "4e7264ea-79f2-43b1-bf1e-2b786a41450e",
  • "network_id": "cd4a9ed7-3ab4-484e-bf44-5feff5fbf2ea"
}

overlay_networks

bulk_destroy people

Delete multiple people from a network.

path Parameters
id
required
string

Overlay Network ID

Request Body schema: application/json
people_ids
required
Array of string

An array of ID strings

Responses

200

Success

403

Forbidden

404

Not Found

422

Unprocessable Entity

delete /overlay_networks/{id}/people
http://localhost/api/v1/overlay_networks/{id}/people

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "people_ids":
    [
    ]
}

index people

Returns a collection of network managers and members.

path Parameters
id
required
string

Overlay Network ID

Responses

200

Success

get /overlay_networks/{id}/people
http://localhost/api/v1/overlay_networks/{id}/people

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    },
  • {
    },
  • {
    }
]

add people

Add people to the overlay network.

path Parameters
id
required
string

Overlay Network ID

Request Body schema: application/json
network_people
required
Array of object

An array of network people

Responses

200

Success

400

Bad Request

403

Forbidden

post /overlay_networks/{id}/people
http://localhost/api/v1/overlay_networks/{id}/people

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "network_people":
    [
    ]
}

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    },
  • {
    },
  • {
    }
]

bulk_destroy

Delete multiple overlay networks.

Request Body schema: application/json
overlay_network_ids
required
Array of string

An array of ID strings

Responses

200

Success

403

Forbidden

422

Unprocessable Entity

delete /overlay_networks
http://localhost/api/v1/overlay_networks

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "overlay_network_ids":
    [
    ]
}

index

Returns a collection of overlay networks.

query Parameters
filter
string

filter

sort
string

sort

limit
integer <int32>

limit

offset
integer <int32>

offset

Responses

200

Success

400

Bad Request

get /overlay_networks
http://localhost/api/v1/overlay_networks

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

create

Create a new overlay network.

Request Body schema: application/json
name
required
string
description
string
enabled
boolean

Boolean true or false to set enabled state of network.

set_current_user_as_manager
boolean

Boolean true or false to enable creator of network as its manager.

Responses

201

Success

400

Bad Request

403

Forbidden

post /overlay_networks
http://localhost/api/v1/overlay_networks

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "description": "API Overlay created by automated testing.",
  • "enabled": true,
  • "name": "API Automation Overlay",
  • "set_current_user_as_manager": true
}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "can_edit": true,
  • "description": "API Overlay created by automated testing.",
  • "device_groups": [ ],
  • "enabled": true,
  • "hipservices": [ ],
  • "id": "b54a301c-2647-4844-bbc1-8d6e736f51f0",
  • "name": "API Overlay (non persistent)",
  • "policy": [ ],
  • "uuid": "b54a301c-2647-4844-bbc1-8d6e736f51f0",
  • "vlan":
    {
    }
}

destroy

Delete an existing overlay network.

path Parameters
id
required
string

Overlay Network ID

Responses

200

Success

403

Forbidden

422

Unprocessable Entity

delete /overlay_networks/{id}
http://localhost/api/v1/overlay_networks/{id}

show

Returns a single overlay network.

path Parameters
id
required
string

Overlay Network ID

Responses

200

Success

403

Forbidden

404

Not Found

422

Unprocessable Entity

get /overlay_networks/{id}
http://localhost/api/v1/overlay_networks/{id}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "can_edit": true,
  • "description": null,
  • "device_groups":
    [
    ],
  • "enabled": true,
  • "hipservices":
    [
    ],
  • "id": "cd4a9ed7-3ab4-484e-bf44-5feff5fbf2ea",
  • "name": "Overlay",
  • "policy":
    [
    ],
  • "uuid": "cd4a9ed7-3ab4-484e-bf44-5feff5fbf2ea",
  • "vlan":
    {
    }
}

update

Update an existing overlay network (All fields are optional).

path Parameters
id
required
string

Overlay Network ID

Request Body schema: application/json
name
required
string
description
string
enabled
boolean

Boolean true or false to set enabled state of network.

set_current_user_as_manager
boolean

Boolean true or false to enable creator of network as its manager.

Responses

200

Success

400

Bad Request

403

Forbidden

404

Not Found

422

Unprocessable Entity

patch /overlay_networks/{id}
http://localhost/api/v1/overlay_networks/{id}

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "description": "API Overlay created by automated testing.",
  • "enabled": true,
  • "name": "API Automation Overlay",
  • "set_current_user_as_manager": true
}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "can_edit": true,
  • "description": null,
  • "device_groups":
    [
    ],
  • "enabled": true,
  • "hipservices":
    [
    ],
  • "id": "cd4a9ed7-3ab4-484e-bf44-5feff5fbf2ea",
  • "name": "Overlay",
  • "policy":
    [
    ],
  • "uuid": "cd4a9ed7-3ab4-484e-bf44-5feff5fbf2ea",
  • "vlan":
    {
    }
}

tag_members

Directly set tag members for overlay_network.

path Parameters
id
required
string

Overlay Network ID

Request Body schema: application/json
tag_refs
required
Array of string

array of Tag References (IDs or Names)

Responses

200

success

403

Forbidden

404

Not Found

422

Unprocessable Entity

post /overlay_networks/{id}/tag_members
http://localhost/api/v1/overlay_networks/{id}/tag_members

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "tag_refs":
    [
    ]
}

Response samples

application/json
Copy
 Expand all Collapse all
{ }

tag_refresh

Refresh expiration time for tag(s) on overlay_network.

path Parameters
id
required
string

Overlay Network ID

Request Body schema: application/json
tag_refs
required
Array of string

array of Tag References (IDs or Names)

Responses

200

success

403

Forbidden

404

Not Found

422

Unprocessable Entity

post /overlay_networks/{id}/tag_refresh
http://localhost/api/v1/overlay_networks/{id}/tag_refresh

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "tag_refs":
    [
    ]
}

Response samples

application/json
Copy
 Expand all Collapse all
{ }

untag

Remove tag(s) from overlay_network.

path Parameters
id
required
string

Overlay Network ID

Request Body schema: application/json
tag_refs
required
Array of string

array of Tag References (IDs or Names)

Responses

200

success

403

Forbidden

404

Not Found

422

Unprocessable Entity

delete /overlay_networks/{id}/tags
http://localhost/api/v1/overlay_networks/{id}/tags

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "tag_refs":
    [
    ]
}

tag

Add tag(s) to overlay_network.

path Parameters
id
required
string

Overlay Network ID

Request Body schema: application/json
tag_refs
required
Array of string

array of Tag References (IDs or Names)

Responses

200

success

403

Forbidden

404

Not Found

422

Unprocessable Entity

post /overlay_networks/{id}/tags
http://localhost/api/v1/overlay_networks/{id}/tags

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "tag_refs":
    [
    ]
}

Response samples

application/json
Copy
 Expand all Collapse all
{ }

people

index

Returns a collection of People settings.

query Parameters
filter
string

filter

sort
string

sort

limit
integer <int32>

limit

offset
integer <int32>

offset

Responses

200

Success

400

Bad Request

get /people
http://localhost/api/v1/people

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

create

Create a new Person.

Request Body schema: application/json
is_active
required
string

Boolean true or false to set Person's enable status

name
required
string

Full Name

password
required
string

Password

role
required
string

Person's Role ( administrator, editor, viewer, remote)

username
required
string

Username

is_api_user
string

Boolean true or false to enable/disable Person's api access

email
string

Email

phone1
string

Phone 1

phone2
string

Phone 2

provider
string

User Directory, specify LDAP if remote

email_alert_level
string

Level at which alerts should be emailed to user (Options: none, info, warning, error). Email server must be configured.

description
string

description

Responses

201

Success

403

Forbidden

post /people
http://localhost/api/v1/people

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "description": "Robin of the Hood",
  • "email": "robin@stealfromtherich.com",
  • "email_alert_level": "none",
  • "is_active": true,
  • "is_api_user": true,
  • "name": "Robin Longstride",
  • "password": "actualpassword",
  • "phone1": "217-555-1234",
  • "phone2": "217-555-1234",
  • "provider": "",
  • "role": "administrator",
  • "username": "robinhood_test_crud_person"
}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "current_sign_in_at": null,
  • "description": "Robin of the Hood",
  • "email": "robin@stealfromtherich.com",
  • "email_alert_level": "none",
  • "id": "bd570507-7c1e-40a7-b961-216eb56c8142",
  • "is_active": true,
  • "is_api_user": true,
  • "is_locked": false,
  • "me": false,
  • "name": "Robin Longstride",
  • "phone1": "217-555-1234",
  • "phone2": "217-555-1234",
  • "remote_session_active": false,
  • "role": "administrator",
  • "username": "robinhood_test_crud_person",
  • "uuid": "bd570507-7c1e-40a7-b961-216eb56c8142"
}

destroy

Delete a Person.

path Parameters
id
required
string

Person ID

Responses

200

Success

403

Forbidden

422

Unprocessable Entity

delete /people/{id}
http://localhost/api/v1/people/{id}

show

Returns a single Person setting.

path Parameters
id
required
string

Person ID

Responses

200

Success

404

Not Found

422

Unprocessable Entity

get /people/{id}
http://localhost/api/v1/people/{id}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "current_sign_in_at": null,
  • "description": "Robin of the Hood",
  • "email": "robin@stealfromtherich.com",
  • "email_alert_level": "none",
  • "id": "bd570507-7c1e-40a7-b961-216eb56c8142",
  • "is_active": true,
  • "is_api_user": true,
  • "is_locked": false,
  • "me": false,
  • "name": "Robin Longstride",
  • "phone1": "217-555-1234",
  • "phone2": "217-555-1234",
  • "remote_session_active": false,
  • "role": "administrator",
  • "username": "robinhood_test_crud_person",
  • "uuid": "bd570507-7c1e-40a7-b961-216eb56c8142"
}

update

Update a Person setting (All fields are optional).

path Parameters
id
required
string

Person ID

Request Body schema: application/json
is_active
required
string

Boolean true or false to set Person's enable status

name
required
string

Full Name

password
required
string

Password

role
required
string

Person's Role ( administrator, editor, viewer, remote)

username
required
string

Username

is_api_user
string

Boolean true or false to enable/disable Person's api access

email
string

Email

phone1
string

Phone 1

phone2
string

Phone 2

provider
string

User Directory, specify LDAP if remote

email_alert_level
string

Level at which alerts should be emailed to user (Options: none, info, warning, error). Email server must be configured.

description
string

description

Responses

200

Success

400

Bad Request

403

Forbidden

404

Not Found

422

Unprocessable Entity

patch /people/{id}
http://localhost/api/v1/people/{id}

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "description": "Robin of the Hood",
  • "email": "robin@stealfromtherich.com",
  • "email_alert_level": "none",
  • "is_active": true,
  • "is_api_user": true,
  • "name": "Robin Longstride",
  • "password": "actualpassword",
  • "phone1": "217-555-1234",
  • "phone2": "217-555-1234",
  • "provider": "",
  • "role": "administrator",
  • "username": "robinhood_test_crud_person"
}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "current_sign_in_at": null,
  • "description": "Robin of the Hood",
  • "email": "robin@stealfromtherich.com",
  • "email_alert_level": "none",
  • "id": "bd570507-7c1e-40a7-b961-216eb56c8142",
  • "is_active": true,
  • "is_api_user": true,
  • "is_locked": false,
  • "me": false,
  • "name": "Robin Longstride",
  • "phone1": "217-555-1234",
  • "phone2": "217-555-1234",
  • "remote_session_active": false,
  • "role": "administrator",
  • "username": "robinhood_test_crud_person",
  • "uuid": "bd570507-7c1e-40a7-b961-216eb56c8142"
}

tag_members

Directly set tag members for person.

path Parameters
id
required
string

Person ID

Request Body schema: application/json
tag_refs
required
Array of string

array of Tag References (IDs or Names)

Responses

200

success

403

Forbidden

404

Not Found

422

Unprocessable Entity

post /people/{id}/tag_members
http://localhost/api/v1/people/{id}/tag_members

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "tag_refs":
    [
    ]
}

Response samples

application/json
Copy
 Expand all Collapse all
{ }

tag_refresh

Refresh expiration time for tag(s) on person.

path Parameters
id
required
string

Person ID

Request Body schema: application/json
tag_refs
required
Array of string

array of Tag References (IDs or Names)

Responses

200

success

403

Forbidden

404

Not Found

422

Unprocessable Entity

post /people/{id}/tag_refresh
http://localhost/api/v1/people/{id}/tag_refresh

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "tag_refs":
    [
    ]
}

Response samples

application/json
Copy
 Expand all Collapse all
{ }

untag

Remove tag(s) from person.

path Parameters
id
required
string

Person ID

Request Body schema: application/json
tag_refs
required
Array of string

array of Tag References (IDs or Names)

Responses

200

success

403

Forbidden

404

Not Found

422

Unprocessable Entity

delete /people/{id}/tags
http://localhost/api/v1/people/{id}/tags

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "tag_refs":
    [
    ]
}

tag

Add tag(s) to person.

path Parameters
id
required
string

Person ID

Request Body schema: application/json
tag_refs
required
Array of string

array of Tag References (IDs or Names)

Responses

200

success

403

Forbidden

404

Not Found

422

Unprocessable Entity

post /people/{id}/tags
http://localhost/api/v1/people/{id}/tags

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "tag_refs":
    [
    ]
}

Response samples

application/json
Copy
 Expand all Collapse all
{ }

provisioning

request

Provision a new conductor

Request Body schema: application/json
proxy_address
string

Address of proxy server

proxy_password
string

Password for proxy server

proxy_port
integer

Port for proxy server

proxy_username
string

Username for proxy server

use_proxy
boolean

Use a proxy server for provisioning

voucher_code
string

Tempered Networks voucher code

Responses

200

success

400

Bad Request

post /provisioning/request
http://localhost/api/v1/provisioning/request

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "proxy_address": "192.168.2.90",
  • "proxy_password": "password123",
  • "proxy_port": "80",
  • "proxy_username": "admin",
  • "use_proxy": true,
  • "voucher_code": "ABCDEF0123456789"
}

sync_export

Export a conductor provisioning package.Used to manually provision a conductor

query Parameters
voucher_code
required
string

Tempered Networks voucher code

Responses

200

success

400

Bad Request

get /provisioning/sync_export
http://localhost/api/v1/provisioning/sync_export

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

sync_import

Import a conductor provisioning package response. Used to manually provisioning a conductor

Request Body schema: application/json
cert_subject
required
string

Certificate subject of conductor sync package belongs to

key
required
string

Encrypted key

iv
required
string

Cryptographic initializaion vector

auth_data
required
string

Cryptographic auth data

auth_tag
required
string

Cryptographic auth tag

data
required
string

Encrypted data

Responses

200

success

400

Bad Request

post /provisioning/sync_import
http://localhost/api/v1/provisioning/sync_import

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "auth_data": "string",
  • "auth_tag": "string",
  • "cert_subject": "string",
  • "data": "string",
  • "iv": "string",
  • "key": "string"
}

relay_rules

index

Returns a collection of relay rules

Responses

200

Success

get /relay_rules
http://localhost/api/v1/relay_rules

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

create

Create a new relay rule

Request Body schema: application/json
name
required
string
description
string

Responses

201

Success

400

Bad Request

403

Forbidden

post /relay_rules
http://localhost/api/v1/relay_rules

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "description": "This is a test relay rule",
  • "name": "Test Relay Rule"
}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "description": "This is a test relay rule",
  • "group_1": { },
  • "group_2": { },
  • "id": "69ecc675-b8d3-406c-9be9-a64ed45ea755",
  • "name": "Test Relay Rule",
  • "relay": { }
}

destroy

Delete an existing relay rule

path Parameters
id
required
string

HIPservice ID

Responses

200

Success

403

Forbidden

422

Unprocessable Entity

delete /relay_rules/{id}
http://localhost/api/v1/relay_rules/{id}

show

Returns a single relay rule

path Parameters
id
required
string

HIPservice ID

Responses

200

Success

403

Forbidden

404

Not Found

422

Unprocessable Entity

get /relay_rules/{id}
http://localhost/api/v1/relay_rules/{id}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "description": "This is a test relay rule",
  • "group_1":
    {
    },
  • "group_2":
    {
    },
  • "id": "69ecc675-b8d3-406c-9be9-a64ed45ea755",
  • "name": "Test Relay Rule",
  • "relay":
    {
    }
}

update

Update an existing relay rule

path Parameters
id
required
string

HIPservice ID

Request Body schema: application/json
description
string
name
string

Responses

200

Success

400

Bad Request

403

Forbidden

404

Not Found

422

Unprocessable Entity

patch /relay_rules/{id}
http://localhost/api/v1/relay_rules/{id}

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "description": "This is a test relay rule",
  • "name": "Test Relay Rule"
}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "description": "This is a test relay rule",
  • "group_1":
    {
    },
  • "group_2":
    {
    },
  • "id": "69ecc675-b8d3-406c-9be9-a64ed45ea755",
  • "name": "Test Relay Rule",
  • "relay":
    {
    }
}

add

Add HIPservices or HIPservice groups to a relay rule

path Parameters
id
required
string

HIPservice ID

Request Body schema: application/json
group_1
object (group_1)
group_2
object (group_2)
relay
object (relay)

Responses

200

Success

400

Bad Request

403

Forbidden

404

Not Found

422

Unprocessable Entity

post /relay_rules/{id}/add
http://localhost/api/v1/relay_rules/{id}/add

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "group_1":
    {
    },
  • "group_2":
    {
    },
  • "relay":
    {
    }
}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "description": "This is a test relay rule",
  • "group_1":
    {
    },
  • "group_2":
    {
    },
  • "id": "69ecc675-b8d3-406c-9be9-a64ed45ea755",
  • "name": "Test Relay Rule",
  • "relay":
    {
    }
}

remove

Remove HIPservices or HIPservice groups from a relay rule

path Parameters
id
required
string

HIPservice ID

Request Body schema: application/json
group_1
object (group_1)
group_2
object (group_2)
relay
object (relay)

Responses

200

Success

400

Bad Request

403

Forbidden

404

Not Found

422

Unprocessable Entity

post /relay_rules/{id}/remove
http://localhost/api/v1/relay_rules/{id}/remove

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "group_1":
    {
    },
  • "group_2":
    {
    },
  • "relay":
    {
    }
}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "description": "This is a test relay rule",
  • "group_1": { },
  • "group_2": { },
  • "id": "69ecc675-b8d3-406c-9be9-a64ed45ea755",
  • "name": "Test Relay Rule",
  • "relay": { }
}

settings

show

Show current conductor configuration

Responses

200

Success

403

Forbidden

get /settings/network
http://localhost/api/v1/settings/network

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "completed": true,
  • "db_status": "rw",
  • "device_id": "Unavailable",
  • "domain_name": "",
  • "eula": true,
  • "firmware_revision": "test-revision-of-no-consequence",
  • "hostname": "conductor",
  • "hotfix_list": [ ],
  • "network_interface_configs":
    [
    ],
  • "product_model": "SCMP-2p",
  • "product_platform": "401v-101",
  • "serial_number": "Unavailable",
  • "version": ""
}

update

Update conductor configuration

Request Body schema: application/json
domain_name
string

Domain name for the Conductor

hostname
string

Hostname for the Conductor

nic1
object (NicConfig)
nic2
object (NicConfig)

Responses

200

Success

403

Forbidden

patch /settings/network
http://localhost/api/v1/settings/network

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "domain_name": "domain.com",
  • "hostname": "Conductor",
  • "nic1":
    {
    },
  • "nic2":
    {
    }
}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "completed": true,
  • "db_status": "rw",
  • "device_id": "Unavailable",
  • "domain_name": "",
  • "eula": true,
  • "firmware_revision": "test-revision-of-no-consequence",
  • "hostname": "conductor",
  • "hotfix_list": [ ],
  • "network_interface_configs":
    [
    ],
  • "product_model": "SCMP-2p",
  • "product_platform": "401v-101",
  • "serial_number": "Unavailable",
  • "version": ""
}

support_bundles

create

Starts a job to create a support bundle

Responses

202

Accepted

400

Bad Request

post /support_bundles
http://localhost/api/v1/support_bundles

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "job_id": "272e0685685a6fe7fb9e377aea4cfbfe",
  • "status_url": "{request_base_url}/api/v1/jobs/272e0685685a6fe7fb9e377aea4cfbfe"
}

show

Returns a support bundle

path Parameters
filename
required
string

Bundle filename

Responses

200

Success

400

Bad Request

404

Not Found

get /support_bundles/{id}
http://localhost/api/v1/support_bundles/{id}

Response samples

application/json
Copy
 Expand all Collapse all
"string"

syslog_config

destroy

Remove remote syslog server configuration.

Responses

200

Success

403

Forbidden

delete /syslog_config
http://localhost/api/v1/syslog_config

show

Current remote syslog server configuration.

Responses

200

Success

403

Forbidden

get /syslog_config
http://localhost/api/v1/syslog_config

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "log_conductor": true,
  • "log_hipservices": true,
  • "port": 514,
  • "server": "192.168.33.33",
  • "use_tls": false
}

update

Update remote syslog server configuration.

Request Body schema: application/json
port
required
string

Remote syslog server port

server
required
string

Remote syslog server URL

log_conductor
boolean
log_hipservices
boolean
use_tls
boolean

Responses

200

Success

403

Forbidden

422

Unprocessable Entity

patch /syslog_config
http://localhost/api/v1/syslog_config

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "log_conductor": true,
  • "log_hipservices": true,
  • "port": "514",
  • "server": "192.168.33.33",
  • "use_tls": false
}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "log_conductor": true,
  • "log_hipservices": true,
  • "port": 514,
  • "server": "192.168.33.33",
  • "use_tls": false
}

create

Add remote syslog server configuration.

Request Body schema: application/json
port
required
string

Remote syslog server port

server
required
string

Remote syslog server URL

log_conductor
boolean
log_hipservices
boolean
use_tls
boolean

Responses

200

Success

403

Forbidden

422

Unprocessable Entity

post /syslog_config
http://localhost/api/v1/syslog_config

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "log_conductor": true,
  • "log_hipservices": true,
  • "port": "514",
  • "server": "192.168.33.33",
  • "use_tls": false
}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "log_conductor": true,
  • "log_hipservices": true,
  • "port": 514,
  • "server": "192.168.33.33",
  • "use_tls": false
}

system

api_docs

Returns a JSON representation of the API documentation

Responses

200

Success

get /system/api_docs
http://localhost/api/v1/system/api_docs

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "swagger": "2.0",
  • "info":
    {
    },
  • "host": "localhost",
  • "basePath": "/api/v1",
  • "schemes":
    [
    ],
  • "consumes":
    [
    ],
  • "produces":
    [
    ],
  • "paths": { },
  • "definitions": { }
}

diagnostic

Starts a job to generate a Conductor diagnostic report

Responses

202

Accepted

403

Forbidden

get /system/diagnostic
http://localhost/api/v1/system/diagnostic

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "job_id": "272e0685685a6fe7fb9e377aea4cfbfe",
  • "status_url": "{request_base_url}/api/v1/jobs/272e0685685a6fe7fb9e377aea4cfbfe"
}

ping

Starts a job to ping an IP address

Request Body schema: application/x-www-form-urlencoded
ip
required
string

IP address to ping

Responses

202

Accepted

403

Forbidden

422

Unprocessable Entity

post /system/ping
http://localhost/api/v1/system/ping

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "job_id": "272e0685685a6fe7fb9e377aea4cfbfe",
  • "status_url": "{request_base_url}/api/v1/jobs/272e0685685a6fe7fb9e377aea4cfbfe"
}

reboot

Reboots the Conductor

Responses

200

Success

400

Bad Request

403

Forbidden

post /system/reboot
http://localhost/api/v1/system/reboot

traceroute

Starts a job to run traceroute on an IP address

Request Body schema: application/x-www-form-urlencoded
ip
required
string

IP address to perform traceroute on

Responses

202

Accepted

403

Forbidden

422

Unprocessable Entity

post /system/traceroute
http://localhost/api/v1/system/traceroute

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "job_id": "272e0685685a6fe7fb9e377aea4cfbfe",
  • "status_url": "{request_base_url}/api/v1/jobs/272e0685685a6fe7fb9e377aea4cfbfe"
}

pcap

pcap

Returns a list of pcaps saved on the Conductor

Responses

200

Success

403

Forbidden

get /system/pcap
http://localhost/api/v1/system/pcap

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

remove_pcap

Removes a pcap file

path Parameters
id
required
string

Pcap id

Responses

200

Success

400

Bad Request

403

Forbidden

delete /system/pcap/{id}
http://localhost/api/v1/system/pcap/{id}

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

get_pcap

Returns a pcap file

path Parameters
id
required
string

Pcap id

Responses

200

Success

403

Forbidden

404

Not Found

get /system/pcap/{id}
http://localhost/api/v1/system/pcap/{id}

Response samples

application/json
Copy
 Expand all Collapse all
"string"

start_pcap

Starts a job to run a packet capture on the Conductor

Request Body schema: application/x-www-form-urlencoded
capture_interface
required
string

Interface on which to run the packet capture

protocol
required
string

Protocol to capture (any, icmp, tcp, udp, arp)

ip_address
string

IP address to capture

port
integer

Port to capture

max_size
integer

Maximum packet size to capture

max_time
integer

Time limit for packet capture (in minutes)

Responses

202

Accepted

403

Forbidden

422

Unprocessable Entity

post /system/pcap/start_pcap
http://localhost/api/v1/system/pcap/start_pcap

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "job_id": "272e0685685a6fe7fb9e377aea4cfbfe",
  • "status_url": "{request_base_url}/api/v1/jobs/272e0685685a6fe7fb9e377aea4cfbfe"
}

stop_pcap

Starts a job to stop the running packet capture on the Conductor

Responses

202

Accepted

400

Bad Request

403

Forbidden

post /system/pcap/stop_pcap
http://localhost/api/v1/system/pcap/stop_pcap

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "job_id": "272e0685685a6fe7fb9e377aea4cfbfe",
  • "status_url": "{request_base_url}/api/v1/jobs/272e0685685a6fe7fb9e377aea4cfbfe"
}

tags

bulk_destroy

Delete multiple tags.

Request Body schema: application/json
tag_refs
required
Array of string

array of Tag References (IDs or Names)

Responses

200

Success

403

Forbidden

delete /tags
http://localhost/api/v1/tags

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "tag_refs":
    [
    ]
}

index

Returns a collection of tags.

query Parameters
filter
string

filter

sort
string

sort

limit
integer <int32>

limit

offset
integer <int32>

offset

Responses

200

Success

400

Bad Request

403

Forbidden

get /tags
http://localhost/api/v1/tags

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

create

Create a new tag.

Request Body schema: application/json
name
required
string

name

color
string

cosmetic; one of { black, blue, brown, gray, green, orange, purple, red, white, yellow }

ownership
string

one of { anyone, admins, user }, determines who may utilize this tag; if "user", then a valid tag_owner_id must also be given.

priority
string

cosmetic; determines tag sort order in lists. Lower numbers take precedence (1 = highest priority, 5 = default, etc.).

remove_if_unused
boolean

When a tag is removed from something, check to see if anything else uses it; if not then delete it.

tag_owner_id
string

if ownership == "user", then ID of the specific user who may utilize the tag (else, ignored).

usage_ttl
string

tagging an object will last for this amount of time (if 0, tagging never expires). Supported units: y, M, w, d, h, m, s (default: s). No spaces between parts. For example, these are equivalent: 16250, 16250s, 270m50s, and 4h30m50s.

Responses

201

Success

400

Bad Request

403

Forbidden

422

Unprocessable Entity

post /tags
http://localhost/api/v1/tags

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "tags":
    {
    }
}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "api_uuid": "3857fb12-861c-4cef-9fb1-74e7190bcb20",
  • "canUse": true,
  • "can_edit": true,
  • "color": "red",
  • "id": 1,
  • "name": "I'm a new tag!",
  • "ownership": "anyone",
  • "priority": 50,
  • "remove_if_unused": false,
  • "usage_ttl": "0s"
}

destroy

Delete an existing tag.

path Parameters
id
required
string

Tag Reference (ID or Name)

Responses

200

Success

403

Forbidden

delete /tags/{id}
http://localhost/api/v1/tags/{id}

show

Returns a single tag.

path Parameters
id
required
string

Tag Reference (ID or Name)

Responses

200

Success

403

Forbidden

404

Not Found

get /tags/{id}
http://localhost/api/v1/tags/{id}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "color": "red",
  • "id": "3857fb12-861c-4cef-9fb1-74e7190bcb20",
  • "name": "I'm a new tag!",
  • "ownership": "anyone",
  • "priority": 50,
  • "remove_if_unused": false,
  • "usage_ttl": "0s"
}

update

Update an existing tag (All fields are optional).

path Parameters
id
required
string

Tag Reference (ID or Name)

Request Body schema: application/json
name
required
string

name

color
string

cosmetic; one of { black, blue, brown, gray, green, orange, purple, red, white, yellow }

ownership
string

one of { anyone, admins, user }, determines who may utilize this tag; if "user", then a valid tag_owner_id must also be given.

priority
string

cosmetic; determines tag sort order in lists. Lower numbers take precedence (1 = highest priority, 5 = default, etc.).

remove_if_unused
boolean

When a tag is removed from something, check to see if anything else uses it; if not then delete it.

tag_owner_id
string

if ownership == "user", then ID of the specific user who may utilize the tag (else, ignored).

usage_ttl
string

tagging an object will last for this amount of time (if 0, tagging never expires). Supported units: y, M, w, d, h, m, s (default: s). No spaces between parts. For example, these are equivalent: 16250, 16250s, 270m50s, and 4h30m50s.

Responses

200

Success

400

Bad Request

403

Forbidden

404

Not Found

422

Unprocessable Entity

patch /tags/{id}
http://localhost/api/v1/tags/{id}

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "tags":
    {
    }
}

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

render_device_groups

Returns all device groups that have this tag.

path Parameters
id
required
string

Tag Reference (ID or Name)

Responses

200

Success

403

Forbidden

404

Not Found

get /tags/{id}/device_groups
http://localhost/api/v1/tags/{id}/device_groups

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

render_devices

Returns all devices that have this tag.

path Parameters
id
required
string

Tag Reference (ID or Name)

Responses

200

Success

403

Forbidden

404

Not Found

get /tags/{id}/devices
http://localhost/api/v1/tags/{id}/devices

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

disable_tagged

Disable network communications for all objects with this tag.

path Parameters
id
required
string

Tag Reference (ID or Name)

Responses

200

Success

404

Not Found

post /tags/{id}/disable_tagged
http://localhost/api/v1/tags/{id}/disable_tagged

Response samples

application/json
Copy
 Expand all Collapse all
{ }

enable_tagged

Enable network communications for all objects with this tag.

path Parameters
id
required
string

Tag Reference (ID or Name)

Responses

200

Success

404

Not Found

post /tags/{id}/enable_tagged
http://localhost/api/v1/tags/{id}/enable_tagged

Response samples

application/json
Copy
 Expand all Collapse all
{ }

render_hipservice_groups

Returns all HIPservice groups that have this tag.

path Parameters
id
required
string

Tag Reference (ID or Name)

Responses

200

Success

403

Forbidden

404

Not Found

get /tags/{id}/hipservice_groups
http://localhost/api/v1/tags/{id}/hipservice_groups

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

render_hipservices

Returns all HIPservices that have this tag.

path Parameters
id
required
string

Tag Reference (ID or Name)

Responses

200

Success

403

Forbidden

404

Not Found

get /tags/{id}/hipservices
http://localhost/api/v1/tags/{id}/hipservices

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

render_networks

Returns all networks that have this tag.

path Parameters
id
required
string

Tag Reference (ID or Name)

Responses

200

Success

403

Forbidden

404

Not Found

get /tags/{id}/networks
http://localhost/api/v1/tags/{id}/networks

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

render_people

Returns all people that have this tag.

path Parameters
id
required
string

Tag Reference (ID or Name)

Responses

200

Success

403

Forbidden

404

Not Found

get /tags/{id}/people
http://localhost/api/v1/tags/{id}/people

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

refresh_tagged

Refresh expires-at time for all expiring tagged object relationships (based on current usage_ttl).

path Parameters
id
required
string

Tag Reference (ID or Name)

Responses

200

Success

404

Not Found

post /tags/{id}/refresh_tagged
http://localhost/api/v1/tags/{id}/refresh_tagged

Response samples

application/json
Copy
 Expand all Collapse all
{ }

untag_tagged

Remove this tag from all objects.

path Parameters
id
required
string

Tag Reference (ID or Name)

Responses

200

Success

404

Not Found

post /tags/{id}/untag_tagged
http://localhost/api/v1/tags/{id}/untag_tagged

Response samples

application/json
Copy
 Expand all Collapse all
{ }

token

generate

Generate an authentication token for the API

query Parameters
provider
string

Authentication provider. Options: local, ldap / Default: local

header Parameters
Authorization
required
string

Basic auth is in the format 'Basic ' where user_token is a base64 endcoded string with username + ':' + password

Responses

201

Created

400

Bad Request

403

Forbidden

post /token/generate
http://localhost/api/v1/token/generate

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "client_id": "-Ijdbnk4V0i1ZoWG-5NTOA",
  • "token": "xV1234uat1234xkpPr1234"
}

wireless

index

Returns wireless settings.

query Parameters
filter
string

filter

sort
string

sort

limit
integer <int32>

limit

offset
integer <int32>

offset

Responses

200

Success

400

Bad Request

403

Forbidden

get /wireless_settings
http://localhost/api/v1/wireless_settings

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    },
  • {
    }
]

create

Create new wireless settings.

Request Body schema: application/json
ca_chain
required
string
enabled
required
string

Boolean true or false to enabled WiFi network.

key
required
string
ssid
required
string
wireless_auth_type
required
string
Enum:"Open" "WEP" "WPA-PSK" "EAP-TLS"

Authorization standard to use

Responses

201

Success

400

Bad Request

403

Forbidden

post /wireless_settings
http://localhost/api/v1/wireless_settings

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "ca_chain": "tn-api-test",
  • "enabled": true,
  • "key": "tn-api-test",
  • "ssid": "tn-api-test",
  • "wireless_auth_type": "WPA-PSK"
}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "ca_chain": "tn-api-test",
  • "enabled": true,
  • "id": "c9244489-48c9-436a-a716-5311be2190cd",
  • "key": "tn-api-test",
  • "ssid": "tn-api-test",
  • "uuid": "c9244489-48c9-436a-a716-5311be2190cd",
  • "wireless_auth_type": "WPA-PSK"
}

destroy

Delete wireless settings.

path Parameters
id
required
integer <int32>

Wireless settings ID

Responses

200

Success

403

Forbidden

422

Unprocessable Entity

delete /wireless_settings/{id}
http://localhost/api/v1/wireless_settings/{id}

show

Returns a single wireless setting.

path Parameters
id
required
string

Wireless settings ID

Responses

200

Success

403

Forbidden

404

Not Found

422

Unprocessable Entity

get /wireless_settings/{id}
http://localhost/api/v1/wireless_settings/{id}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "ca_chain": "tn-api-test",
  • "enabled": true,
  • "id": "c9244489-48c9-436a-a716-5311be2190cd",
  • "key": "tn-api-test",
  • "ssid": "tn-api-test",
  • "uuid": "c9244489-48c9-436a-a716-5311be2190cd",
  • "wireless_auth_type": "WPA-PSK"
}

update

Update an wireless settings (All fields are optional).

path Parameters
id
required
string
Request Body schema: application/json
ca_chain
required
string
enabled
required
string

Boolean true or false to enabled WiFi network.

key
required
string
ssid
required
string
wireless_auth_type
required
string
Enum:"Open" "WEP" "WPA-PSK" "EAP-TLS"

Authorization standard to use

Responses

200

Success

400

Bad Request

403

Forbidden

404

Not Found

422

Unprocessable Entity

patch /wireless_settings/{id}
http://localhost/api/v1/wireless_settings/{id}

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "ca_chain": "tn-api-test",
  • "enabled": true,
  • "key": "tn-api-test",
  • "ssid": "tn-api-test",
  • "wireless_auth_type": "WPA-PSK"
}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "ca_chain": "tn-api-test",
  • "enabled": true,
  • "id": "c9244489-48c9-436a-a716-5311be2190cd",
  • "key": "tn-api-test",
  • "ssid": "tn-api-test",
  • "uuid": "c9244489-48c9-436a-a716-5311be2190cd",
  • "wireless_auth_type": "WPA-PSK"
}