API docs by Redocly

Arbitrator API Documentation (1.0.0)

Download OpenAPI specification:Download

alt insights

Insights Arbitrator API Documentation

Introduction

The base URL for all routes is the following:

https:///api/

All responses from the api will be in JSON format.

/api

The Arbitrator API is broken up into the resources below. Each resource represents an object in the Arbitrator system. A resource will have associated data and a set of methods in which the user may operate on it.

Resource Description
/alerts This resource will return data associated with alerts generated by the system.
/assets This resource will return data associated with all the assets configured and discovered by the system. An asset can be added using the Arbitrator configuration screen. The Arbitrator will also automatically discover assets if the asset is configured to send logs to the Arbitrator.
/ciscocdr This resource will return data associated with Cisco CDR and CMR files. The api will return a running total of various statistics associated with Cisco's call records.
/system This resource will return data about the Arbitrator system in general.

/api/ciscocdr?cm_ip=x.x.x.x

cm_ip is an optional query parameter that will filter the totals down to a specific Cisco Call Manager.

query Parameters
cm_ip
number
Example: cm_ip=10.13.37.42

Responses

Response samples

Content type
application/json
{
  • "ciscocdrs": {
    }
}

/api/v2

/api/v2 > login

/api/v2/login

Authorizations:
noauthAuth
header Parameters
Content-Type
string
Example: application/x-www-form-urlencoded
Request Body schema: multipart/form-data
username
string
password
string

Responses

/api/v2 > alerts

Get All Alerts No Header

Authorizations:
noauthAuth

Responses

/api/v2 > assets

/api/v2/configs/assets

Authorizations:
basicAuth
header Parameters
x-lxt-api-token
string
Example: {{x-lxt-kapapi-id}}

Responses

Update Large Assets

Authorizations:
basicAuth
header Parameters
x-lxt-api-token
string
Example: {{x-lxt-kapapi-id}}
Content-Type
string
Example: application/json
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Add a NAT IP Address to An Asset

Authorizations:
basicAuth
header Parameters
x-lxt-api-token
string
Example: {{x-lxt-kapapi-id}}
Content-Type
string
Example: application/json
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "name": "",
  • "ipaddress": "172.30.42.169",
  • "hostname": "Unknown",
  • "parent_id": "T4UB8BZFO6Y7UWR21686317921W6XPQA5QAASJ4RNJ4YZAFNH2CLBJKN6WIPUJL7SP7OM1VJ8",
  • "customer": "",
  • "site": "",
  • "render_type": "unknown",
  • "last_method": "",
  • "last_byte_time": 0,
  • "did": "Unknown",
  • "mac_address": "",
  • "address": "",
  • "version": "",
  • "manufacturer": "",
  • "timezone": "UTC",
  • "description": "NAT",
  • "comments": "",
  • "model": ""
}

Response samples

Content type
application/json
Example
{
  • "status": 200,
  • "message": "Success",
  • "data": [
    ]
}

/api/v2 > policy_modules

GET policy modules

Authorizations:
noauthAuth
header Parameters
x-lxt-api-token
string
Example: {{x-lxt-kapapi-id}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Success",
  • "data": [
    ]
}

/api/v2 > asset_groups

GET All Asset Groups

header Parameters
x-lxt-api-token
string
Example: {{x-lxt-kapapi-id}}

Responses

Insert TestGroup

header Parameters
x-lxt-api-token
string
Example: {{x-lxt-kapapi-id}}
Content-Type
string
Example: application/json
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "name": "TestGroup",
  • "assets": [
    ]
}

Delete Asset Group

header Parameters
x-lxt-api-token
string
Example: {{x-lxt-kapapi-id}}

Responses

/api/v2 > lxt_updates

/api/v2/lxt_updates

query Parameters
id
integer
Example: id=18
header Parameters
x-lxt-api-token
string
Example: {{x-lxt-kapapi-id}}
Content-Type
string
Example: application/x-www-form-urlencoded
Request Body schema: application/x-www-form-urlencoded
id
integer
delay
integer
url
string

Responses

/api/v2/lxt_updates?id=18

header Parameters
x-lxt-api-token
string
Example: eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJhbmFseXRpeCIsImlhdCI6MTU4MTUyNTc0NCwiZXhwIjoxNTgxNjEyMTQ0LCJ1c2VySWQiOiIwNjZlYmYzNjY1MGVhOGQ1MTcyMDJkNjU3NTcyNzlmODQ5ODc3YTlmMDYxY2I0YjUwMDA0OWE1OTgzNzQ4MDg0In0.n3VMnJcofzzj7W_pxaCsDsMsGBBSvmal1OvmapcB65g36HaKKonAs15eR12BaEUOhtLH_uo_OllEL-bMJgHZHJJ1EcWplMOrqleVYQ6hadEc2EJX_ynOHletDcZwG3OXdywsEyztP2K0FnEkVuuEGTOspPVQpsP_Ujt25skiBPE
Content-Type
string
Example: application/x-www-form-urlencoded

Responses

/api/v2/configs/asset_groups

header Parameters
x-lxt-api-token
string
Example: eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJhbmFseXRpeCIsImlhdCI6MTU5ODk4Njc5NiwiZXhwIjoxNTk5MDczMTk2LCJ1c2VySWQiOiIwNjZlYmYzNjY1MGVhOGQ1MTcyMDJkNjU3NTcyNzlmODQ5ODc3YTlmMDYxY2I0YjUwMDA0OWE1OTgzNzQ4MDg0In0.Ss4Kfx8EYOfQd0TsXXyKiYAfkBaNoDLyC_eQgypKsw3Kh82ViRIHgrnL03o-SMYERnd7-EgcwKeiPBrYzvpJU5fWbps7gW2CtFBRsnZC9GG_5wZ2oT_IzsGgnYUZwKIa5Y_v3o23CJOxzFT5HZSmMdRPCVNFVDF_qk5OlpiSy0s

Responses

/api/v2 > probe_groups

Get Probes

Authorizations:
basicAuth
header Parameters
x-lxt-api-token
string
Example: {{x-lxt-kapapi-id}}

Responses

/api/v2 > response_procedures

Get Response Procedures

Authorizations:
basicAuth
header Parameters
x-lxt-api-token
string
Example: {{x-lxt-kapapi-id}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Success",
  • "data": [
    ]
}

/api/v2 > rule_definitions

Get Rule Definitions

Authorizations:
basicAuth
header Parameters
x-lxt-api-token
string
Example: {{x-lxt-kapapi-id}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Success",
  • "data": [
    ]
}

/api/v2 > profiles

Get Profiles

Authorizations:
basicAuth
header Parameters
x-lxt-api-token
string
Example: {{x-lxt-kapapi-id}}

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Success",
  • "data": [
    ]
}

/api/v2 > cucm

api/v2/cucm/drop

Authorizations:
basicAuth

Responses

/api/v2 > users

/api/v2/users No Token

Authorizations:
noauthAuth

Responses

/api/v2/users

Authorizations:
noauthAuth
header Parameters
x-lxt-api-token
string
Example: {{x-lxt-kapapi-id}}
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "userId": "testuser1",
  • "password": "testpassword",
  • "email": "[email protected]",
  • "firstName": "Test",
  • "lastName": "User1",
  • "customerId": "",
  • "customerName": ""
}