Skip to main content
API docs by Redocly

OLA Rest Interface (6.13.0)

Download OpenAPI specification:Download

threatalarmlive

Upgrade the connection to a websocket

Upgrade the connection to a websocket to receive a stream of live ThreatAlarm objects as they occur.

Authorizations:
localauth
query Parameters
state
integer <int32>

Filter results by state, see ThreatAlarmState

level
integer <int32>

Filter results by level, see ThreatAlarmLevel

type
string

Filter results by type, see ThreatAlarmType

new
boolean

Filter results to only new ThreatAlarms

id
integer <int32>

Filter results based on fibre id

fibretype
string

Filter results based on fibre type

header Parameters
Connection
required
string

Control the connection for websocket upgrade, e.g "Upgrade"

Upgrade
required
string

Protocol to upgrade to, e.g "websocket"

Sec-WebSocket-Key
required
string

Random generated key for handshake, e.g "dGhlIHNhbXBsZSBub25jZQ=="

Sec-WebSocket-Version
required
integer <int32>

Websocket protocol version to use, e.g 13

Responses

Response samples

Content type
application/json
[
  • {
    }
]

fibreroute

Retrieve the systems fibre route.

Retrieve the systems fibre route.

Authorizations:
localauth
query Parameters
id
integer <int32>

Filter results based on fibre id

fibretype
string

Filter results based on fibre type

Responses

Response samples

Content type
application/json
[
  • {
    }
]

datastreamlive

Upgrade the connection to a websocket

Upgrade the connection to a websocket to receive a live stream of Protobuf byte[] serialized com.optasense.ola.interfaces.rest.pojo.protoc.Measurement objects.

Authorizations:
localauth
query Parameters
id
required
integer <int32>

Fibre id of the data to retrieve, see fibreid endpoint

fibretype
required
string

Fibre type of the data to retrieve, see fibreid endpoint

rate
integer <int32>

Applicable only to live data, the rate in which the data will be decimated, e.g 1 is no decimation 64 is one in every 64th sample

header Parameters
Connection
required
string

Control the connection for websocket upgrade, e.g "Upgrade"

Upgrade
required
string

Protocol to upgrade to, e.g "websocket"

Sec-WebSocket-Key
required
string

Random generated key for handshake, e.g "dGhlIHNhbXBsZSBub25jZQ=="

Sec-WebSocket-Version
required
integer <int32>

Websocket protocol version to use, e.g 13

Responses

Response samples

Content type
application/json
{ }

usernotificationlive

Upgrade the connection to a websocket

Upgrade the connection to a websocket to receive a stream of live UserNotificationNode objects.

Authorizations:
localauth
header Parameters
Connection
required
string

Control the connection for websocket upgrade, e.g "Upgrade"

Upgrade
required
string

Protocol to upgrade to, e.g "websocket"

Sec-WebSocket-Key
required
string

Random generated key for handshake, e.g "dGhlIHNhbXBsZSBub25jZQ=="

Sec-WebSocket-Version
required
integer <int32>

Websocket protocol version to use, e.g 13

Responses

Response samples

Content type
application/json
[
  • {
    }
]

threatalarm

Retrieve a list of historical threat alarms

Retrieve a list of all threat alarms the system has produced, default results are for last 24 hours limited to 100 items unless specified otherwise.

Authorizations:
localauth
query Parameters
limit
integer <int32>

Limit the amount of results returned

start
integer <int64>

Filter results created after the provided epoch milliseconds

end
integer <int64>

Filter results created before the provided epoch milliseconds

state
integer <int32>

Filter results by state, see Threat Alarm State

level
integer <int32>

Filter the results to a particular Threat Alarm Level

type
string

Filter the results to a particular Threat Alarm Type

id
integer <int32>

Filter results based on fibre id

fibretype
string

Filter results based on fibre type

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Insert or update a threat alarm.

Insert or update a threat alarm.

Authorizations:
localauth
Request Body schema: application/json

New (No persistentID) or existing threat alarm object

persistentID
string
object (FibreID)
clientFibreName
string
source
string
startTime
integer <int64>
endTime
integer <int64>
startResPoint
integer <int64>
centreResPoint
integer <int64>
endResPoint
integer <int64>
startLatitude
number <double>
startLongitude
number <double>
centreLatitude
number <double>
centreLongitude
number <double>
endLatitude
number <double>
endLongitude
number <double>
threatLevel
integer <int32>
zoneName
string
state
integer <int32>
individualState
integer <int32>
activeState
integer <int32>
weighting
number <double>
speed
number <double>
threatTypeSettingsString
string
userName
string
userComment
string
externalType
string
externalId
string
initialCentreAlertLatitude
number <double>
initialCentreAlertLongitude
number <double>
redTime
integer <int64>
initialStartResPoint
integer <int64>
initialCentreResPoint
integer <int64>
initialEndResPoint
integer <int64>
minResPoint
integer <int64>
maxResPoint
integer <int64>
customTextField
string
assetScaleID
string
updateTime
integer <int64>
stateUpdateTime
integer <int64>
subordinates
object
clientScale
string
clientScalePoint
number <double>

Responses

Request samples

Content type
application/json
{
  • "persistentID": "string",
  • "fibreId": {
    },
  • "clientFibreName": "string",
  • "source": "string",
  • "startTime": 0,
  • "endTime": 0,
  • "startResPoint": 0,
  • "centreResPoint": 0,
  • "endResPoint": 0,
  • "startLatitude": 0.1,
  • "startLongitude": 0.1,
  • "centreLatitude": 0.1,
  • "centreLongitude": 0.1,
  • "endLatitude": 0.1,
  • "endLongitude": 0.1,
  • "threatLevel": 0,
  • "zoneName": "string",
  • "state": 0,
  • "individualState": 0,
  • "activeState": 0,
  • "weighting": 0.1,
  • "speed": 0.1,
  • "threatTypeSettingsString": "string",
  • "userName": "string",
  • "userComment": "string",
  • "externalType": "string",
  • "externalId": "string",
  • "initialCentreAlertLatitude": 0.1,
  • "initialCentreAlertLongitude": 0.1,
  • "redTime": 0,
  • "initialStartResPoint": 0,
  • "initialCentreResPoint": 0,
  • "initialEndResPoint": 0,
  • "minResPoint": 0,
  • "maxResPoint": 0,
  • "customTextField": "string",
  • "assetScaleID": "string",
  • "updateTime": 0,
  • "stateUpdateTime": 0,
  • "subordinates": { },
  • "clientScale": "string",
  • "clientScalePoint": 0.1
}

Response samples

Content type
application/json
[
  • {
    }
]

Unacknowledge an existing threat alarm.

Unacknowledge an existing threat alarm.

Authorizations:
localauth
path Parameters
id
required
string

The persistent id of the threat alarm to unacknowledge

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Acknowledge an existing threat alarm.

Acknowledge an existing threat alarm.

Authorizations:
localauth
path Parameters
id
required
string

The persistent id of the threat alarm to acknowledge

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Dismiss an existing threat alarm.

Dismiss an existing threat alarm.

Authorizations:
localauth
path Parameters
id
required
string

The persistent id of the threat alarm to dismiss

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Dismiss all existing threat alarms.

Dismiss all existing threat alarms.

Authorizations:
localauth

Responses

Response samples

Content type
application/json
true

Acknowledge all existing threat alarms.

Acknowledge all existing threat alarms.

Authorizations:
localauth

Responses

Response samples

Content type
application/json
true

usernotificationnode

Get current user notification nodes

Retrieve all live user notification nodes, user notifications and process information.

Authorizations:
localauth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

datarate

Data Rates

Retrieve a list of known data rates that can be applied to streaming data.

Authorizations:
localauth

Responses

Response samples

Content type
application/json
[
  • 0
]

fibretype

Retrieve a list of known fibre types.

Retrieve a list of known fibre types.

Authorizations:
localauth

Responses

Response samples

Content type
application/json
[
  • "string"
]

threatalarmstate

Retrieve a list of all possible threat alarm state

Retrieve a list of all possible threat alarm states.

Authorizations:
localauth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

pu

Retrieve a list of pu's the system is aware of.

Retrieve a list of pu's the system is aware of.

Authorizations:
localauth
query Parameters
id
integer <int32>

Filter results based on fibre id

fibretype
string

Filter results based on fibre type

ip
string

Filter results based on ip address

Responses

Response samples

Content type
application/json
[
  • {
    }
]

clientscale

Retrieve an array of all the client scales in the

Retrieve an array of all the client scales in the system. The points on each client scale are sorted in ascending order of scale value

Authorizations:
localauth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

threatalarmlevel

Retrieve a list of all possible threat alarm level

Retrieve a list of all possible threat alarm levels.

Authorizations:
localauth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

fibreid

Get all fibre IDs

Retrieve a list of fibreids the system is aware of.

Authorizations:
localauth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get all fibre IDs on this PU

Retrieve a list of fibreids associated with this pu.

Authorizations:
localauth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

systemhealthoverview

Retrieve the overall system health state.

Retrieve the overall system health state.

Authorizations:
localauth

Responses

Response samples

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

usernotification

Retrieve all live user notifications.

Retrieve all live user notifications.

Authorizations:
localauth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

ips

Retrieve a list of ip's the system is aware of.

Retrieve a list of ip's the system is aware of.

Authorizations:
localauth

Responses

Response samples

Content type
application/json
[
  • "string"
]

Retrieve a list of ip's associated with this pu.

Retrieve a list of ip's associated with this pu.

Authorizations:
localauth

Responses

Response samples

Content type
application/json
[
  • "string"
]

threatalarmtype

Retrieve a list of all possible threat alarm types

Retrieve a list of all possible threat alarm types.

Authorizations:
localauth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

datastreamhistory

Upgrade the connection to a websocket

Upgrade the connection to a websocket to receive a historical stream of Protobuf byte[] serialized com.optasense.ola.interfaces.rest.pojo.protoc.Measurement objects.

Authorizations:
localauth
query Parameters
id
required
integer <int32>

Fibre id of the data to retrieve, see fibreid endpoint

fibretype
required
string

Fibre type of the data to retrieve, see fibreid endpoint

start
required
integer <int64>

Begin stream from the provided epoch milliseconds

end
required
integer <int64>

End stream from the provided epoch milliseconds

samples
integer <int32>

How many samples you want the data to be aggregated into

rateLimit
boolean <binary>

Slow the response from the server to allow the client time to process each in turn. Send any string to acknowledge receipt and request next packet

header Parameters
Connection
required
string

Control the connection for websocket upgrade, e.g "Upgrade"

Upgrade
required
string

Protocol to upgrade to, e.g "websocket"

Sec-WebSocket-Key
required
string

Random generated key for handshake, e.g "dGhlIHNhbXBsZSBub25jZQ=="

Sec-WebSocket-Version
required
integer <int32>

Websocket protocol version to use, e.g 13

Responses

Response samples

Content type
application/json
{ }

systemspecification

Retrieve the overall system specification object.

Retrieve the overall system specification object.

Authorizations:
localauth
query Parameters
id
integer <int32>

Filter results based on fibre id

fibretype
string

Filter results based on fibre type

Responses

Response samples

Content type
application/json
{
  • "siteName": "string",
  • "puList": [
    ],
  • "processingBlocks": [
    ],
  • "standaloneProcesses": [
    ],
  • "systemWideProcesses": [
    ]
}

threatalarmupdates

Retrieve a list of all updates for a specific Threat Alarm

Retrieve a list of all updates for a specific Threat Alarm

Authorizations:
localauth
query Parameters
id
required
string

Persistent ID of the Threat Alarm to query

start
integer <int64>

Filter results created after the provided epoch milliseconds

end
integer <int64>

Filter results created before the provided epoch milliseconds

fibreid
required
integer <int64>

Fibre ID to search for specified alert

fibretype
required
string

Fibre type to search for specified alert

Responses

Response samples

Content type
application/json
[
  • {
    }
]