Operations Manager REST version v2
https://{appliancehost}/api/v2
- appliancehost: required(string)
Operations Manager REST API
This API allows control and inspection of an Opengear Operations Manager appliance.
/sessions
The sessions endpoint is used to authenticate the user and create a session token for accessing all other Operations Manager endpoints.
Create a new authenticated session.
post /sessions
Create a new authenticated session.
Body
Media type: application/json
Type: object
Properties- username: required(string)
- password: required(string)
- new_password: (string)
- confirm_password: (string)
Examples:
example1:
{
"username": "root",
"password": "default"
}example2:
{
"username": "root",
"password": "default",
"new_password": "abcdefg",
"confirm_password": "abcdefg"
}HTTP status code 200
Body
Media type: application/json
Type: object
Properties- state: required(string)
- session: required(string)
- user: (string)
- last_challenge: (string)
Example:
{
"state": "authenticated",
"session": "71dcba707b6c177644ede1b224f69096",
"user": "root"
}HTTP status code 303
Redirect to new authentication session
Body
Media type: application/json
Type: object
Example:
{
"sid": "71dcba707b6c177644ede1b224f69096",
"message": "Redirecting to new session at {redirect-url}"
}HTTP status code 400
Failed to initiate session creation due to error in post body.
Body
Media type: application/json
Type: object
Example:
{
"error": [
{
"type": 4,
"code": 40,
"text": "Required field 'username' was not provided in the request",
"args": {
"param": "username"
},
"level": 1
},
{
"type": 4,
"code": 40,
"text": "Required field 'password' was not provided in the request",
"args": {
"param": "password"
},
"level": 1
}
]
}HTTP status code 401
Body
Media type: application/json
Type: object
Examples:
example1:
Authentication failed due to invalid credentials or session.
{
"error": [
{
"type": 7,
"code": 41,
"text": "Invalid login credentials",
"args": {},
"level": 1
}
]
}example2:
Authentication failed due to expired credentials.
{
"error": [
{
"type": 7,
"code": 113,
"text": "You are required to change your password immediately",
"args": {},
"level": 1
}
]
}Retrieve the state of an authentication session.
Apply a challenge response to a session
Log out of and delete a session
get /sessions/self
Retrieve the state of an authentication session.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Session exists
Body
Media type: application/json
Type: object
Properties- state: required(string)
- session: required(string)
- user: (string)
- last_challenge: (string)
Example:
{
"state": "authenticated",
"session": "71dcba707b6c177644ede1b224f69096",
"user": "root"
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}HTTP status code 404
Session does not exist
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /sessions/self
Apply a challenge response to a session
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- session: required(string)
- state: required(object)
- challenge: required(string)
Next challenge (if any)
HTTP status code 200
Response applied. Next challenge in {challenge} if required.
Body
Media type: application/json
Type: object
Properties- session: required(string)
- state: required(object)
- challenge: required(string)
Next challenge (if any)
HTTP status code 400
Invalid request
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 4,
"code": 39,
"text": "Invalid request body",
"args": {},
"level": 1
}
]
}HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}HTTP status code 403
Authentication failed. No more attempts allowed.
HTTP status code 404
Authentication failed.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
delete /sessions/self
Log out of and delete a session
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Session deleted
Body
Media type: application/json
Type: object
Properties- session: required(string)
- success: required(string)
- state: required(string)
- user: required(string)
HTTP status code 400
Incomplete data
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}HTTP status code 404
Session did not exist
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
/ports
Configuring and viewing ports information
Gets ports attached to this appliance. Any number of search query parameters can be provided to perform an ANDed search on the ports.
get /ports
Gets ports attached to this appliance. Any number of search query parameters can be provided to perform an ANDed search on the ports.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Query Parameters
- searchparameters: (string)
Caution: This is not an actual parameter but exists to help document additional search related parameters.
Parameters used for matching specific port attributes can be included inside the request.
For example,
config:label=port-1
config:mode=consoleServer
Where config:label and config:mode prameter keys are attributes (or fields) of a port. The values of these fields will be matched against all ports.
A List of available fields can be retrieved from the /ports/fields endpoint.
- json: (string)
One or more json URL encoded search parameters.
Example %7B%22type%22%3A1%2C%22items%22%3A%5B%7B%22datatype%22%3A4 %2C%22type%22%3A3%2C%22oper%22%3A1%2C%22fieldname%22%3A%22 config%3Aname%22%2C%22value%22%3A%22test%22%7D%5D%7D
which is the URL encoded json
{type:1,items:[{"datatype":4,type:3,"oper":1,"fieldname":"config:name","value":"test"}]}
- jb64: (string)
one or more base64 encoded json search parameters.
Ensure that any trailing = padding is URL encoded to %3D
- operator: (string - default: AND)
Operator applied between all searchparameters, json and jb64 query parameters.
AND or OR
- searchId: (string)
The Operations Manager appliance maintains search results for a limited timespan. The searchId is returned in meta data of a normal search and can then be used as a parameter to retrieve the same results. When searchId is used, no other search parameter may be included.
HTTP status code 200
The array of ports, either a full array or as requested by parameters
Body
Media type: application/json
Type: object
Properties- ports: required(array of object)
Items: items
- parity: required(string)
The format of the parity byte.
- label: required(string)
The label for the serial port.
- id: required(string)
The ID of the serial port. This ID can be used to fetch individual ports using the /ports/
endpoint. - stopbits: required(string)
The number of stop bits between characters.
- status: required(one of ok, disconnected)
The status of the RJ45 and USB serial ports. If the serial port type is RJ45, then this will always return 'ok'.
- pinout: required(one of X1, X2, USB)
The physical pinout of the port connector.
- available_pinouts: required(array of string)
Valid values for the "pinout" property of this port. Pinout settings are not applicable for USB ports and must always be set to "USB". In addition, some units do not support pinout switching on all ports and in those cases the pinout must always be set to "X2".
- ip_alias: required(array of object)
[consoleServer mode only] An IP address for dedicated access to a specific serial or USB console port.
Items: items
- id: required(string)
- port: required(string)
- ipaddress: required(string)
- interface: required(string)
- baudrate: required(string)
The communication rate of the port.
- mode: required(one of disabled, consoleServer, localConsole)
The mode that the port is in.
- logging_level: required(one of disabled, eventsOnly, eventsAndReceivedCharacters, eventsAndAllCharacters)
Indicates the logging level for the port.
- databits: required(string)
The number of data bits in a character.
- escape_char: required(string)
[consoleServer mode only] The escape character for pmshell.
- terminal_emulation: required(string)
[localConsole mode only] The terminal emulation type.
- kernel_debug: required(boolean)
[localConsole mode only] Emits kernel debug messages from the chosen port. Only one instance of this is allowed per device.
- sessions: required(array of object)
Items: items
- username: required(string)
- client_pid: required(integer)
- device: required(string)
- parity: required(string)
- meta: required(object)
- searchId: (string)
- total_pages: (string)
Example:
{
"ports": [
{
"parity": "none",
"label": "Port-1",
"id": "ports-1",
"escape_char": "",
"stopbits": "1",
"status": "ok",
"pinout": "X2",
"available_pinouts": [
"X2",
"X1"
],
"ip_alias": [
{
"id": "ipalias-1",
"port": "serial/by-opengear-id/port01",
"ipaddress": "192.168.33.201/24",
"interface": "net1"
}
],
"baudrate": "9600",
"mode": "localConsole",
"logging_level": "disabled",
"databits": "8",
"terminal_emulation": "linux",
"kernel_debug": false,
"sessions": [],
"device": "serial/by-opengear-id/port01"
},
{
"parity": "none",
"label": "Port-2",
"id": "ports-2",
"escape_char": "~",
"stopbits": "1",
"status": "ok",
"pinout": "X2",
"available_pinouts": [
"X2",
"X1"
],
"ip_alias": [],
"baudrate": "9600",
"mode": "consoleServer",
"logging_level": "disabled",
"databits": "8",
"terminal_emulation": "",
"kernel_debug": false,
"sessions": [],
"device": "serial/by-opengear-id/port02"
},
{
"parity": "none",
"label": "Port-3",
"id": "ports-3",
"escape_char": "~",
"stopbits": "1",
"status": "ok",
"pinout": "X2",
"available_pinouts": [
"X2",
"X1"
],
"ip_alias": [
{
"id": "ipalias-1",
"port": "serial/by-opengear-id/port03",
"ipaddress": "192.168.33.11/24",
"interface": "net1"
}
],
"baudrate": "9600",
"mode": "consoleServer",
"logging_level": "disabled",
"databits": "8",
"terminal_emulation": "",
"kernel_debug": false,
"sessions": [],
"device": "serial/by-opengear-id/port03"
},
{
"parity": "none",
"label": "Port-4",
"id": "ports-4",
"escape_char": "",
"stopbits": "1",
"status": "ok",
"pinout": "X2",
"available_pinouts": [
"X2",
"X1"
],
"ip_alias": [],
"baudrate": "9600",
"mode": "localConsole",
"logging_level": "disabled",
"databits": "8",
"terminal_emulation": "vt220",
"kernel_debug": false,
"sessions": [],
"device": "serial/by-opengear-id/port04"
},
{
"parity": "none",
"label": "Port-5",
"id": "ports-5",
"escape_char": "~",
"stopbits": "1",
"status": "ok",
"pinout": "X2",
"available_pinouts": [
"X2",
"X1"
],
"ip_alias": [],
"baudrate": "9600",
"mode": "consoleServer",
"logging_level": "disabled",
"databits": "8",
"terminal_emulation": "",
"kernel_debug": false,
"sessions": [],
"device": "serial/by-opengear-id/port05"
},
{
"parity": "none",
"label": "Port-6",
"id": "ports-6",
"escape_char": "~",
"stopbits": "1",
"status": "ok",
"pinout": "X2",
"available_pinouts": [
"X2",
"X1"
],
"ip_alias": [],
"baudrate": "9600",
"mode": "consoleServer",
"logging_level": "disabled",
"databits": "8",
"terminal_emulation": "",
"kernel_debug": false,
"sessions": [],
"device": "serial/by-opengear-id/port06"
},
{
"parity": "none",
"label": "Port-7",
"id": "ports-7",
"escape_char": "~",
"stopbits": "1",
"status": "ok",
"pinout": "X2",
"available_pinouts": [
"X2",
"X1"
],
"ip_alias": [],
"baudrate": "9600",
"mode": "consoleServer",
"logging_level": "disabled",
"databits": "8",
"terminal_emulation": "",
"kernel_debug": false,
"sessions": [],
"device": "serial/by-opengear-id/port07"
},
{
"parity": "none",
"label": "Port-8",
"id": "ports-8",
"escape_char": "~",
"stopbits": "1",
"status": "ok",
"pinout": "X2",
"available_pinouts": [
"X2",
"X1"
],
"ip_alias": [],
"baudrate": "9600",
"mode": "consoleServer",
"logging_level": "disabled",
"databits": "8",
"terminal_emulation": "",
"kernel_debug": false,
"sessions": [],
"device": "serial/by-opengear-id/port08"
},
{
"parity": "none",
"label": "Port-9",
"id": "ports-9",
"escape_char": "~",
"stopbits": "1",
"status": "ok",
"pinout": "X2",
"available_pinouts": [
"X2",
"X1"
],
"ip_alias": [],
"baudrate": "9600",
"mode": "consoleServer",
"logging_level": "disabled",
"databits": "8",
"terminal_emulation": "",
"kernel_debug": false,
"sessions": [],
"device": "serial/by-opengear-id/port09"
},
{
"parity": "none",
"label": "USB A",
"id": "ports-10",
"escape_char": "~",
"stopbits": "1",
"status": "disconnected",
"pinout": "USB",
"available_pinouts": [
"USB"
],
"ip_alias": [],
"baudrate": "9600",
"mode": "consoleServer",
"logging_level": "disabled",
"databits": "8",
"terminal_emulation": "",
"kernel_debug": false,
"sessions": [],
"device": "serial/by-opengear-id/port10"
}
],
"meta": {
"searchId": "{49ec4c2-5f78-11e8-899f-97417ae8617}"
}
}HTTP status code 400
Invalid request
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 4,
"code": 39,
"level": 1,
"text": "Invalid request body",
"args": {}
},
{
"type": 4,
"code": 48,
"level": 1,
"text": "Invalid parameter 'config:nam' was provided",
"args": {
"param": "config:nam"
}
},
{
"type": 2,
"code": 49,
"level": 1,
"text": "Invalid json '{\"type\":1,\"items\":{\"datatype\":4,\"type\":3,\"oper\":1,\"fieldname\":\"config:name\",\"value\":\"test\"}]}' for parameter 'json'",
"args": {
"line": "1",
"position": "92",
"value": "{\"type\":1,\"items\":{\"datatype\":4,\"type\":3,\"oper\":1,\"fieldname\":\"config:name\",\"value\":\"test\"}]}",
"column": "92",
"error": "'}' expected near ']'",
"param": "json"
}
}
]
}HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}HTTP status code 404
Invalid request, Incomplete data, Port not found, Failure during retrieval of ports
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Failed to read ports.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Retrieve a single port by ID.
Update properties for a single port.
get /ports/{id}
Retrieve a single port by ID.
Operations Manager base authentication scheme
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Port has been updated.
Body
Media type: application/json
Type: object
Properties- port: required(object)
- parity: required(string)
The format of the parity byte.
- label: required(string)
The label for the serial port.
- id: required(string)
The ID of the serial port. This ID can be used to fetch individual ports using the /ports/
endpoint. - stopbits: required(string)
The number of stop bits between characters.
- status: required(one of ok, disconnected)
The status of the RJ45 and USB serial ports. If the serial port type is RJ45, then this will always return 'ok'.
- pinout: required(one of X1, X2, USB)
The physical pinout of the port connector.
- available_pinouts: required(array of string)
Valid values for the "pinout" property of this port. Pinout settings are not applicable for USB ports and must always be set to "USB". In addition, some units do not support pinout switching on all ports and in those cases the pinout must always be set to "X2".
- ip_alias: required(array of object)
[consoleServer mode only] An IP address for dedicated access to a specific serial or USB console port.
Items: items
- id: required(string)
- port: required(string)
- ipaddress: required(string)
- interface: required(string)
- baudrate: required(string)
The communication rate of the port.
- mode: required(one of disabled, consoleServer, localConsole)
The mode that the port is in.
- logging_level: required(one of disabled, eventsOnly, eventsAndReceivedCharacters, eventsAndAllCharacters)
Indicates the logging level for the port.
- databits: required(string)
The number of data bits in a character.
- escape_char: required(string)
[consoleServer mode only] The escape character for pmshell.
- terminal_emulation: required(string)
[localConsole mode only] The terminal emulation type.
- kernel_debug: required(boolean)
[localConsole mode only] Emits kernel debug messages from the chosen port. Only one instance of this is allowed per device.
- sessions: required(array of object)
Items: items
- username: required(string)
- client_pid: required(integer)
- device: required(string)
- parity: required(string)
Examples:
port_with_ipaliases:
{
"port": {
"parity": "none",
"label": "Port-1",
"id": "ports-1",
"escape_char": "~",
"stopbits": "1",
"status": "ok",
"pinout": "X2",
"available_pinouts": [
"X2",
"X1"
],
"ip_alias": [
{
"id": "ipalias-1",
"port": "serial/by-opengear-id/port01",
"ipaddress": "192.168.33.201/24",
"interface": "net1"
},
{
"id": "ipalias-2",
"port": "serial/by-opengear-id/port01",
"ipaddress": "192.168.33.9/24",
"interface": "net1"
}
],
"baudrate": "9600",
"mode": "consoleServer",
"logging_level": "disabled",
"databits": "8",
"terminal_emulation": "",
"kernel_debug": false,
"sessions": [],
"device": "serial/by-opengear-id/port01"
}
}port_without_ipaliases:
{
"port": {
"parity": "none",
"label": "Port-3",
"id": "ports-3",
"escape_char": "~",
"stopbits": "1",
"status": "ok",
"pinout": "X2",
"available_pinouts": [
"X2",
"X1"
],
"ip_alias": [],
"baudrate": "9600",
"mode": "localConsole",
"logging_level": "disabled",
"databits": "8",
"terminal_emulation": "linux",
"kernel_debug": true,
"sessions": [],
"device": "serial/by-opengear-id/port01"
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /ports/{id}
Update properties for a single port.
Operations Manager base authentication scheme
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- port: required(object)
- parity: required(string)
The format of the parity byte.
- label: required(string)
The label for the serial port.
- stopbits: required(string)
The number of stop bits between characters.
- pinout: required(one of X1, X2, USB)
The physical pinout of the port connector.
- ip_alias: (array of object)
[consoleServer mode only] An IP address for dedicated access to a specific serial or USB console port.
Items: items
- ipaddress: required(string)
- interface: required(string)
- baudrate: required(string)
The communication rate of the port.
- mode: required(one of disabled, consoleServer, localConsole)
The mode that the port is in.
- logging_level: required(one of disabled, eventsOnly, eventsAndReceivedCharacters, eventsAndAllCharacters)
Indicates the logging level for the port.
- databits: required(string)
The number of data bits in a character.
- escape_char: required(string)
[consoleServer mode only] The escape character for pmshell.
- terminal_emulation: required(string)
[localConsole mode only] The terminal emulation type.
- kernel_debug: required(boolean)
[localConsole mode only] Emits kernel debug messages from the chosen port. Only one instance of this is allowed per device.
- parity: required(string)
Examples:
port_with_ipaliases:
{
"port": {
"parity": "none",
"label": "Port-1",
"stopbits": "1",
"pinout": "X2",
"ip_alias": [
{
"ipaddress": "192.168.33.201/24",
"interface": "net1"
},
{
"ipaddress": "192.168.33.9/24",
"interface": "net1"
}
],
"baudrate": "9600",
"mode": "consoleServer",
"logging_level": "disabled",
"databits": "8",
"terminal_emulation": "",
"kernel_debug": false,
"escape_char": "!",
"device": "serial/by-opengear-id/port01"
}
}port_without_ipaliases:
{
"port": {
"parity": "none",
"label": "Port-1",
"stopbits": "1",
"pinout": "X2",
"ip_alias": [],
"baudrate": "9600",
"mode": "consoleServer",
"logging_level": "disabled",
"databits": "8",
"terminal_emulation": "",
"kernel_debug": false,
"escape_char": "!",
"device": "serial/by-opengear-id/port01"
}
}HTTP status code 200
Port has been updated.
Body
Media type: application/json
Type: object
Properties- port: required(object)
- parity: required(string)
The format of the parity byte.
- label: required(string)
The label for the serial port.
- id: required(string)
The ID of the serial port. This ID can be used to fetch individual ports using the /ports/
endpoint. - stopbits: required(string)
The number of stop bits between characters.
- status: required(one of ok, disconnected)
The status of the RJ45 and USB serial ports. If the serial port type is RJ45, then this will always return 'ok'.
- pinout: required(one of X1, X2, USB)
The physical pinout of the port connector.
- available_pinouts: required(array of string)
Valid values for the "pinout" property of this port. Pinout settings are not applicable for USB ports and must always be set to "USB". In addition, some units do not support pinout switching on all ports and in those cases the pinout must always be set to "X2".
- ip_alias: required(array of object)
[consoleServer mode only] An IP address for dedicated access to a specific serial or USB console port.
Items: items
- id: required(string)
- port: required(string)
- ipaddress: required(string)
- interface: required(string)
- baudrate: required(string)
The communication rate of the port.
- mode: required(one of disabled, consoleServer, localConsole)
The mode that the port is in.
- logging_level: required(one of disabled, eventsOnly, eventsAndReceivedCharacters, eventsAndAllCharacters)
Indicates the logging level for the port.
- databits: required(string)
The number of data bits in a character.
- escape_char: required(string)
[consoleServer mode only] The escape character for pmshell.
- terminal_emulation: required(string)
[localConsole mode only] The terminal emulation type.
- kernel_debug: required(boolean)
[localConsole mode only] Emits kernel debug messages from the chosen port. Only one instance of this is allowed per device.
- sessions: required(array of object)
Items: items
- username: required(string)
- client_pid: required(integer)
- device: required(string)
- parity: required(string)
Example:
{
"port": {
"parity": "none",
"label": "Port-1",
"id": "ports-1",
"escape_char": "!",
"stopbits": "1",
"status": "ok",
"pinout": "X2",
"available_pinouts": [
"X2",
"X1"
],
"ip_alias": [
{
"id": "ipalias-1",
"port": "serial/by-opengear-id/port01",
"ipaddress": "192.168.33.201/24",
"interface": "net1"
},
{
"id": "ipalias-2",
"port": "serial/by-opengear-id/port01",
"ipaddress": "192.168.33.9/24",
"interface": "net1"
}
],
"baudrate": "9600",
"mode": "consoleServer",
"logging_level": "disabled",
"databits": "8",
"terminal_emulation": "",
"kernel_debug": false,
"sessions": [],
"device": "serial/by-opengear-id/port01"
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Retrieve all active sessions on this port.
Disconnect active sessions on this port. Use query parameters to select a subset of sessions for disconnection. If no query parameters are given, all sessions on this port will be disconnected.
get /ports/{id}/sessions
Retrieve all active sessions on this port.
Operations Manager base authentication scheme
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- port_sessions: required(array of object)
Items: items
- username: required(string)
- client_pid: required(integer)
Example:
{
"port_sessions": [
{
"username": "alice",
"client_pid": 123
}
]
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}HTTP status code 404
Port does not exist.
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
delete /ports/{id}/sessions
Disconnect active sessions on this port. Use query parameters to select a subset of sessions for disconnection. If no query parameters are given, all sessions on this port will be disconnected.
Operations Manager base authentication scheme
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Query Parameters
- username: (string)
Only disconnect active sessions belonging to this user.
HTTP status code 200
Request succeeded. Note that if there were no active sessions to be disconnected, the request is nevertheless successful. Check the 'disconnected_session_count' field of the response body to determine how many sessions were disconnected.
Body
Media type: application/json
Type: object
Properties- disconnected_session_count: required(integer)
Example:
{
"disconnected_session_count": 1
}HTTP status code 400
Incomplete data
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}HTTP status code 404
Port does not exist.
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Retrieve an active session on this port.
Disconnect the session.
get /ports/{id}/sessions/{pid}
Retrieve an active session on this port.
Operations Manager base authentication scheme
URI Parameters
- id: required(string)
- pid: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- port_session: required(object)
- username: required(string)
- client_pid: required(integer)
Example:
{
"port_session": {
"username": "alice",
"client_pid": 123
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}HTTP status code 404
Port does not exist, or active session with the given pid does not exist.
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
delete /ports/{id}/sessions/{pid}
Disconnect the session.
Operations Manager base authentication scheme
URI Parameters
- id: required(string)
- pid: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 204
Request succeeded.
HTTP status code 400
Incomplete data
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}HTTP status code 404
Port does not exist, or active session with the given pid does not exist.
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Control power for a console device.
put /ports/{id}/power
Control power for a console device.
Operations Manager base authentication scheme
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- cmd: required(object)
- action: required(one of on, off, cycle, status)
Example:
{
"cmd": {
"action": "cycle"
}
}HTTP status code 200
Power command executed.
Body
Media type: application/json
Type: object
Properties- cmd: required(string)
Example:
{
"cmd": "/usr/bin/ogpowergroup 'port16' cycle"
}HTTP status code 400
Power command failed.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 2,
"code": 307,
"level": 1,
"text": "ogpower failed running command '/usr/bin/ogpowergroup 'port02' cycle'",
"args": {}
}
]
}HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Obtain a list of fields which can be used to perform queries against ports.
get /ports/fields
Obtain a list of fields which can be used to perform queries against ports.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
authorization session token
Example:
Token {{sessionUid}}
HTTP status code 200
The list of search fields
Body
Media type: application/json
Type: object
Properties- fields: required(array of string)
Example:
{
"fields": [
"config:label",
"config:mode"
]
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}HTTP status code 500
Unexpected error
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Manage Port Auto-Discovery
Trigger the port Auto-Discovery process
Get Port Auto-Discovery state
post /ports/auto_discover
Trigger the port Auto-Discovery process
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Possible types:
portAutoDiscoveryParameters
- auto_discover: required(object)
The Port Auto-Discovery root object
- ports: required(array of integer)
The list of ports (as integers) to discover. Setting this value to null will result in all ports being set for Auto-Discovery.
- ports: required(array of integer)
- auto_discover: required(object)
portAutoDiscoveryParameters
- auto_discover: required(object)
The Port Auto-Discovery root object
- ports: required(nil)
The list of ports (as integers) to discover. Setting this value to null will result in all ports being set for Auto-Discovery.
- ports: required(nil)
- auto_discover: required(object)
Examples:
example1:
Run Port Auto-Discover on all available ports
{
"auto_discover": {
"ports": null
}
}example2:
Run Port Auto-Discover on all available ports
{
"auto_discover": {
"ports": []
}
}example3:
Run Auto-Disover on ports 1, 10, 33, and 42
{
"auto_discover": {
"ports": [
1,
10,
33,
42
]
}
}HTTP status code 200
Port Auto-Discovery was triggered
Body
Media type: application/json
Possible types:
portAutoDiscoveryParameters
- auto_discover: required(object)
The Port Auto-Discovery root object
- ports: required(array of integer)
The list of ports (as integers) to discover. Setting this value to null will result in all ports being set for Auto-Discovery.
- ports: required(array of integer)
- auto_discover: required(object)
portAutoDiscoveryParameters
- auto_discover: required(object)
The Port Auto-Discovery root object
- ports: required(nil)
The list of ports (as integers) to discover. Setting this value to null will result in all ports being set for Auto-Discovery.
- ports: required(nil)
- auto_discover: required(object)
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
get /ports/auto_discover
Get Port Auto-Discovery state
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
The Port Auto-Discovery script state
Body
Media type: application/json
Type: object
Properties- auto_discover: required(object)
The Port Auto-Discovery root object
- status: required(string)
The status, as returned by the Port Auto-Discover process
- status: required(string)
Example:
{
"auto_discover": {
"status": "running"
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Manage Port Auto-Discovery Scheduling
Schedule the Port Auto-Discovery process
Get the Port Auto-Discovery schedule
put /ports/auto_discover/schedule
Schedule the Port Auto-Discovery process
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Possible types:
portAutoDiscoverySchedule
- auto_discover_schedule: required(object)
The Port Auto-Discovery scheduling root object
- enabled: required(boolean - default: false)
- period: required(one of daily, weekly, monthly)
- day_of_month: (integer - minimum: 1 - maximum: 31)
- day_of_week: (integer - minimum: 0 - maximum: 6)
0 (Sunday) to 6 (Saturday)
- hour: required(integer - minimum: 0 - maximum: 23)
- minute: required(integer - minimum: 0 - maximum: 59)
- ports: required(array of integer)
The list of ports (as integers) to discover (1 based numbering). Setting this value to null will result in all ports being set for Auto-Discovery.
- auto_discover_schedule: required(object)
portAutoDiscoverySchedule
- auto_discover_schedule: required(object)
The Port Auto-Discovery scheduling root object
- enabled: required(boolean - default: false)
- period: required(one of daily, weekly, monthly)
- day_of_month: (integer - minimum: 1 - maximum: 31)
- day_of_week: (integer - minimum: 0 - maximum: 6)
0 (Sunday) to 6 (Saturday)
- hour: required(integer - minimum: 0 - maximum: 23)
- minute: required(integer - minimum: 0 - maximum: 59)
- ports: required(nil)
The list of ports (as integers) to discover (1 based numbering). Setting this value to null will result in all ports being set for Auto-Discovery.
- auto_discover_schedule: required(object)
Examples:
example1:
Schedule Port Auto-Discover for all available ports on daily basis
{
"auto_discover_schedule": {
"enabled": true,
"period": "daily",
"hour": 2,
"minute": 30,
"ports": null
}
}example2:
Schedule Port Auto-Discover for selected ports on daily basis
{
"auto_discover_schedule": {
"enabled": true,
"period": "daily",
"hour": 2,
"minute": 30,
"ports": [
11,
33,
4,
20
]
}
}example3:
Schedule Port Auto-Discover for all ports on monthly basis
{
"auto_discover_schedule": {
"enabled": true,
"period": "monthly",
"day_of_month": 10,
"hour": 2,
"minute": 30,
"ports": null
}
}example4:
Schedule Port Auto-Discover for selected ports on weekly basis
{
"auto_discover_schedule": {
"enabled": true,
"period": "weekly",
"day_of_week": 4,
"hour": 2,
"minute": 30,
"ports": [
11,
33,
4,
20
]
}
}HTTP status code 200
Port Auto-Discovery was scheduled
Body
Media type: application/json
Possible types:
portAutoDiscoverySchedule
- auto_discover_schedule: required(object)
The Port Auto-Discovery scheduling root object
- enabled: required(boolean - default: false)
- period: required(one of daily, weekly, monthly)
- day_of_month: (integer - minimum: 1 - maximum: 31)
- day_of_week: (integer - minimum: 0 - maximum: 6)
0 (Sunday) to 6 (Saturday)
- hour: required(integer - minimum: 0 - maximum: 23)
- minute: required(integer - minimum: 0 - maximum: 59)
- ports: required(array of integer)
The list of ports (as integers) to discover (1 based numbering). Setting this value to null will result in all ports being set for Auto-Discovery.
- auto_discover_schedule: required(object)
portAutoDiscoverySchedule
- auto_discover_schedule: required(object)
The Port Auto-Discovery scheduling root object
- enabled: required(boolean - default: false)
- period: required(one of daily, weekly, monthly)
- day_of_month: (integer - minimum: 1 - maximum: 31)
- day_of_week: (integer - minimum: 0 - maximum: 6)
0 (Sunday) to 6 (Saturday)
- hour: required(integer - minimum: 0 - maximum: 23)
- minute: required(integer - minimum: 0 - maximum: 59)
- ports: required(nil)
The list of ports (as integers) to discover (1 based numbering). Setting this value to null will result in all ports being set for Auto-Discovery.
- auto_discover_schedule: required(object)
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
get /ports/auto_discover/schedule
Get the Port Auto-Discovery schedule
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
The Port Auto-Discovery scheduling information
Body
Media type: application/json
Possible types:
portAutoDiscoverySchedule
- auto_discover_schedule: required(object)
The Port Auto-Discovery scheduling root object
- enabled: required(boolean - default: false)
- period: required(one of daily, weekly, monthly)
- day_of_month: (integer - minimum: 1 - maximum: 31)
- day_of_week: (integer - minimum: 0 - maximum: 6)
0 (Sunday) to 6 (Saturday)
- hour: required(integer - minimum: 0 - maximum: 23)
- minute: required(integer - minimum: 0 - maximum: 59)
- ports: required(array of integer)
The list of ports (as integers) to discover (1 based numbering). Setting this value to null will result in all ports being set for Auto-Discovery.
- auto_discover_schedule: required(object)
portAutoDiscoverySchedule
- auto_discover_schedule: required(object)
The Port Auto-Discovery scheduling root object
- enabled: required(boolean - default: false)
- period: required(one of daily, weekly, monthly)
- day_of_month: (integer - minimum: 1 - maximum: 31)
- day_of_week: (integer - minimum: 0 - maximum: 6)
0 (Sunday) to 6 (Saturday)
- hour: required(integer - minimum: 0 - maximum: 23)
- minute: required(integer - minimum: 0 - maximum: 59)
- ports: required(nil)
The list of ports (as integers) to discover (1 based numbering). Setting this value to null will result in all ports being set for Auto-Discovery.
- auto_discover_schedule: required(object)
Example:
{
"auto_discover_schedule": {
"enabled": true,
"period": "daily",
"hour": 2,
"minute": 30,
"ports": [
1,
10,
33,
42
]
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
/managementports
Used for working with local management console information.
Gets the local management console ports attached to this appliance.
get /managementports
Gets the local management console ports attached to this appliance.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
The array of management ports, either a full array or as requested by parameters
Body
Media type: application/json
Type: object
Properties- managementports: required(array of object)
Items: items
- id: required(string)
- device: required(string)
- enabled: required(boolean)
- kerneldebug: required(boolean)
- termemulation: required(one of vt100, vt102, vt220, linux, ansi)
- baud: required(string)
- databits: required(string)
- parity: required(string)
- stopbits: required(string)
- meta: required(object)
- searchId: (string)
- total_pages: (string)
Example:
{
"managementports": [
{
"id": "mgmtPorts-1",
"device": "ttyS0",
"enabled": true,
"kerneldebug": false,
"termemulation": "vt100",
"baud": "115200",
"databits": "8",
"parity": "none",
"stopbits": "1"
},
{
"id": "mgmtPorts-2",
"device": "ttyS1",
"enabled": true,
"kerneldebug": true,
"termemulation": "vt100",
"baud": "115200",
"databits": "8",
"parity": "none",
"stopbits": "1"
}
],
"meta": {
"searchId": "{49ec4c2-5f78-11e8-899f-97417ae8617}"
}
}HTTP status code 400
Invalid request, missing or incorrect page/per_page
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 4,
"code": 39,
"level": 1,
"text": "Invalid request body",
"args": {}
}
]
}HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}HTTP status code 404
Invalid request, Incomplete data, management port not found, Failure during retrieval of management ports
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Failed to read management ports.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Retrieve a single local management console port by ID.
Update properties for a single local management console port.
get /managementports/{id}
Retrieve a single local management console port by ID.
Operations Manager base authentication scheme
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
management port has been updated.
Body
Media type: application/json
Type: object
Properties- managementport: required(object)
- id: required(string)
- device: required(string)
- enabled: required(boolean)
- kerneldebug: required(boolean)
- termemulation: required(one of vt100, vt102, vt220, linux, ansi)
- baud: required(string)
- databits: required(string)
- parity: required(string)
- stopbits: required(string)
Example:
{
"managementport": {
"id": "mgmtPorts-1",
"device": "ttyS0",
"enabled": true,
"kerneldebug": false,
"termemulation": "vt100",
"baud": "115200",
"databits": "8",
"parity": "none",
"stopbits": "1"
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /managementports/{id}
Update properties for a single local management console port.
Operations Manager base authentication scheme
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- managementport: required(object)
- device: required(string)
- enabled: required(boolean)
- kerneldebug: required(boolean)
- termemulation: required(one of vt100, vt102, vt220, linux, ansi)
- baud: required(string)
- databits: required(string)
- parity: required(string)
- stopbits: required(string)
Example:
{
"managementport": {
"device": "ttyS0",
"enabled": true,
"kerneldebug": false,
"termemulation": "vt100",
"baud": "115200",
"databits": "8",
"parity": "none",
"stopbits": "1"
}
}HTTP status code 200
Management Port has been updated.
Body
Media type: application/json
Type: object
Properties- managementport: required(object)
- id: required(string)
- device: required(string)
- enabled: required(boolean)
- kerneldebug: required(boolean)
- termemulation: required(one of vt100, vt102, vt220, linux, ansi)
- baud: required(string)
- databits: required(string)
- parity: required(string)
- stopbits: required(string)
Example:
{
"managementport": {
"id": "mgmtPorts-1",
"device": "ttyS0",
"enabled": true,
"kerneldebug": false,
"termemulation": "vt100",
"baud": "115200",
"databits": "8",
"parity": "none",
"stopbits": "1"
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
/search
Used to perform searches on ports on the system.
Creating a search ID for ports from the given query parameters.
Gets a search ID for searching ports attached to this Operations Manager appliance. Any number of search query parameters can be provided to perform an ANDed search on the ports. The list provided is dynamic.
get /search/ports
Gets a search ID for searching ports attached to this Operations Manager appliance. Any number of search query parameters can be provided to perform an ANDed search on the ports. The list provided is dynamic.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Query Parameters
- json: (string)
One or more json URL encoded search parameters. Example %7B%22type%22%3A1%2C%22items%22%3A%5B%7B%22datatype%22%3A4 %2C%22type%22%3A3%2C%22oper%22%3A1%2C%22fieldname%22%3A%22 config%3Aname%22%2C%22value%22%3A%22test%22%7D%5D%7D which is the URL encoded json {type:1,items:[{"datatype":4,type:3,"oper":1,"fieldname":"config:label","value":"test"}]}
- jb64: (string)
one or more base64 encoded json search parameters. Ensure that any trailing = padding is URL encoded to %3D
- searchparameters: (string)
Caution: This is not an actual parameter but exists to help document additional search related parameters.
Parameters used for matching specific port attributes can be included inside the request.
For example,
config:label=port-1
config:mode=consoleServer
Where config:label and config:mode prameter keys are attributes (or fields) of a port. The values of these fields will be matched against all ports.
A List of available fields can retrieved from the /ports/fields endpoint.
- operator: (string - default: AND)
Operator applied between all searchparameters, json and jb64 query parameters. AND or OR
HTTP status code 200
The search ID, as defined by given parameters
Body
Media type: application/json
Type: object
Properties- search: required(object)
- id: required(string)
Example:
{
"search": {
"id": "{268daae-5555-11e7-8af6-b7116753aa5}"
}
}HTTP status code 400
Invalid request, missing or incorrect search parameters.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 4,
"code": 39,
"level": 1,
"text": "Invalid request body",
"args": {}
}
]
}HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}HTTP status code 404
Invalid request, Incomplete data.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Failed to retrieve a search ID.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
/logs
Used for working with the logs on the system.
Fetch last n log lines in syslog.
get /logs/syslog
Fetch last n log lines in syslog.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Query Parameters
- logLines: (integer - default: 100)
The number of lines to fetch - max 1000, min 10.
HTTP status code 200
Returns the last n lines in the syslog
Body
Media type: application/json
Type: object
Properties- syslog: required(object)
- id: required(string)
- no_of_log_lines: required(integer)
- log_lines: required(array of any)
Example:
{
"syslog": {
"id": "3fe0c4281c994a34225db3224b0cf4b4",
"log_lines": [
"2018-04-23T16:49:35.285554+00:00 qemux86-64 sshd[20111]: Disconnected from 192.168.33.101",
"2018-04-23T16:49:35.285625+00:00 qemux86-64 sshd[20111]: pam_unix(sshd:session): session closed for user root",
"2018-04-23T16:49:35.379184+00:00 qemux86-64 sshd[20139]: pam_unix(sshd:auth): authentication failure; logname= uid=0 euid=0 tty=ssh ruser= rhost=192.168.33.101 user=root",
"2018-04-23T16:49:37.937315+00:00 qemux86-64 sshd[20139]: Accepted publickey for root from 192.168.33.101 port 57058 ssh2: RSA SHA256:6ED9MiX/6QXhSLN5g25V4T0okuO9o0aQl0ONT9BCxKE",
"2018-04-23T16:49:37.938147+00:00 qemux86-64 sshd[20139]: pam_unix(sshd:session): session opened for user root by (uid=0)",
"2018-04-23T16:49:43.308764+00:00 qemux86-64 sshd[20139]: Received disconnect from 192.168.33.101: 11: disconnected by user",
"2018-04-23T16:49:43.308798+00:00 qemux86-64 sshd[20139]: Disconnected from 192.168.33.101",
"2018-04-23T16:49:43.308887+00:00 qemux86-64 sshd[20139]: pam_unix(sshd:session): session closed for user root",
"2018-04-23T17:20:51.938418+00:00 qemux86-64 udhcpc[1660]: Sending renew...",
"2018-04-23T17:20:51.941182+00:00 qemux86-64 udhcpc[1660]: Lease of 192.168.33.207 obtained, lease time 7200"
],
"no_of_log_lines": 10
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Fetch last n log lines in portlog.
get /logs/portlog/{id}
Fetch last n log lines in portlog.
Operations Manager base authentication scheme
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Query Parameters
- logLines: (integer - default: 100 - minimum: 10 - maximum: 1000)
The number of lines to fetch - max 1000, min 10.
HTTP status code 200
Returns the last n lines in the portlog
Body
Media type: application/json
Type: object
Properties- portlog: required(object)
- id: required(string)
- no_of_log_lines: required(integer)
- log_lines: required(array of any)
Example:
{
"portlog": {
"id": "portlogports-1771bed6129488a69764d064ed7e6086d",
"log_lines": [
"2018-04-19T21:59:42.475157+00:00 TXDATA ",
"2018-04-19T21:59:43.720286+00:00 TXDATA ^C",
"2018-04-19T21:59:44.004623+00:00 TXDATA ^C",
"2018-04-19T21:59:49.053138+00:00 TXDATA ^C",
"2018-04-19T21:59:49.739765+00:00 TXDATA ^C",
"2018-04-19T21:59:50.349753+00:00 LOGOUT root",
"2018-04-19T21:59:50.373627+00:00 RXDATA ",
"2018-04-19T21:59:50.402295+00:00 RXDATA asdfasdf",
"2018-04-19T22:00:18.216623+00:00 LOGIN root",
"2018-04-19T22:00:21.386050+00:00 TXDATA rootrootakjdfaksjdf",
"2018-04-19T22:00:25.145561+00:00 TXDATA rootrootakjdfaksjdfkjasdkjfakdjf",
"2018-04-19T22:00:26.473879+00:00 TXDATA rootrootakjdfaksjdfkjasdkjfakdjf ",
"2018-04-19T22:00:42.660939+00:00 TXDATA rootrootakjdfaksjdfkjasdkjfakdjf ^C",
"2018-04-19T22:00:45.472921+00:00 TXDATA rootrootakjdfaksjdfkjasdkjfakdjf ^C~",
"2018-04-19T22:00:46.456493+00:00 TXDATA rootrootakjdfaksjdfkjasdkjfakdjf ^C~.",
"2018-04-19T22:00:46.887685+00:00 TXDATA rootrootakjdfaksjdfkjasdkjfakdjf ^C~.",
"2018-04-19T22:00:47.057797+00:00 TXDATA ",
"2018-04-19T22:00:47.236891+00:00 TXDATA ",
"2018-04-19T22:00:47.413115+00:00 TXDATA ",
"2018-04-19T22:00:48.328447+00:00 LOGOUT root"
],
"no_of_log_lines": 20
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
logs/portlog_settings endpoint is to check and update port log settings.
Retrieve the current settings.
Update the port log settings.
get /logs/portlog_settings
Retrieve the current settings.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Returns the current failover settings.
Body
Media type: application/json
Type: object
Properties- portlog_settings: required(object)
- facility: required(one of daemon, auth, authpriv, cron, daemon, ftp, kern, lpr, mail, news, syslog, user, uucp, local0, local1, local2, local3, local4, local5, local6, local7)
- severity: required(one of info, alert, critical, debug, emergency, error, info, notice, warning)
Example:
{
"portlog_settings": {
"facility": "daemon",
"severity": "info"
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /logs/portlog_settings
Update the port log settings.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- portlog_settings: required(object)
- facility: required(one of daemon, auth, authpriv, cron, daemon, ftp, kern, lpr, mail, news, syslog, user, uucp, local0, local1, local2, local3, local4, local5, local6, local7)
- severity: required(one of info, alert, critical, debug, emergency, error, info, notice, warning)
Example:
{
"portlog_settings": {
"facility": "cron",
"severity": "critical"
}
}HTTP status code 200
Returns the current failover settings.
Body
Media type: application/json
Type: object
Properties- portlog_settings: required(object)
- facility: required(one of daemon, auth, authpriv, cron, daemon, ftp, kern, lpr, mail, news, syslog, user, uucp, local0, local1, local2, local3, local4, local5, local6, local7)
- severity: required(one of info, alert, critical, debug, emergency, error, info, notice, warning)
Example:
{
"portlog_settings": {
"facility": "cron",
"severity": "critical"
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
/monitor
Used for monitoring the state of the various services running on the system.
Used for monitoring the state of the various network discovery (LLDP/CDP) protocols running on the system.
Get the current status of the network discovery (LLDP/CDP) protocols on the chassis
get /monitor/lldp/chassis
Get the current status of the network discovery (LLDP/CDP) protocols on the chassis
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Returns the current status of the network discovery (LLDP/CDP) protocols on the chassis.
Body
Media type: application/json
Type: object
Properties- lldpstat: required(object)
- name: required(string)
- mac: required(string)
- Bridge: required(boolean)
- Router: required(boolean)
- Station: required(boolean)
- Wlan: required(boolean)
- descr: required(string)
- mgmt_ip: required(array of string)
Example:
{
"lldpstat": {
"mac": "00:13:c6:08:07:ab",
"Wlan": false,
"name": "platypus",
"Router": true,
"Station": false,
"Bridge": true,
"mgmt_ip": [
"10.250.242.110",
"fdcd:41a4:5559:faf2:213:c6ff:fe08:7ab"
],
"descr": "description 1"
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Get the neighbors
get /monitor/lldp/neighbor
Get the neighbors
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Returns the neighbors.
Body
Media type: application/json
Type: object
Properties- lldp-status-neighbor: required(array of object)
Items: items
- name: required(string)
- remote_name: required(string)
- remote_mac: required(string)
- mgmt_ip: required(array of string)
- port_name: required(string)
- port: required(string)
- id: required(integer)
Example:
{
"lldp-status-neighbor": [
{
"remote_name": "NGCS-Switch",
"port_name": "Port #1",
"name": "enp3s0f1",
"id": 1,
"port": "1",
"mgmt_ip": [
"192.168.1.13"
],
"remote_mac": "ec:9a:74:bc:57:e0"
},
{
"remote_name": "foobar.hostname",
"port_name": "net1",
"name": "tap1",
"id": 2,
"port": "52:54:00:76:27:fc",
"mgmt_ip": [
"192.168.0.1",
"fe80::5054:ff:fe76:27fc"
],
"remote_mac": "52:54:00:76:27:fc"
}
]
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
/services
Used for working with the properties of the various services running on the system.
Provides access to the SSL certificate used by web services on the device.
Fetch HTTPS certificate details, or a CSR file if the zip flag is set.
Update HTTPS details. A certificate matching the CSR can be uploaded by setting the https.cert field, a CSR can be cancelled by sending through no https.csr body, and a new csr can be created by sending through a https.csr body with a csr value of "new".
get /services/https
Fetch HTTPS certificate details, or a CSR file if the zip flag is set.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Query Parameters
- secrets: (one of cleartext, obfuscate, mask - default: cleartext)
Accepts sensitive fields as either cleartext or obfuscated values. The response will display the sensitive fields in the same way.
- zip: (boolean - default: false)
A flag to download the CSR instead of view the details
HTTP status code 200
Returns the certificate currently in use by the server, as well as details about any current CSR.
Body
Media type: application/json
Type: object
Properties- https: required(object)
- common_name: required(string)
- org_unit: required(string)
- organization: required(string)
- locality: required(string)
- state: required(string)
- country: required(string)
- email: required(string)
- valid_from: required(string)
- valid_to: required(string)
- cert: required(string)
- key_length: required(integer)
- key: required(string)
[sensitive]
- csr: (object)
- common_name: required(string)
- org_unit: required(string)
- organization: required(string)
- locality: required(string)
- state: required(string)
- country: required(string)
- email: required(string)
- key_length: (integer)
- csr: (string)
Example:
{
"https": {
"valid_from": "Sep 21 00:39:03 2016 GMT",
"valid_to": "Sep 21 00:39:03 2016 GMT",
"common_name": "CName",
"country": "AU",
"locality": "Toowong",
"org_unit": "OU",
"state": "Queensland",
"email": "bob@bob.com",
"organization": "Internet Widgits Pty Ltd",
"key_length": 2048,
"cert": "-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----",
"key": "-----BEGIN PRIVATE KEY-----...",
"csr": {
"country": "AU",
"common_name": "aa",
"csr": "new",
"org_unit": "Unit 1",
"organization": "Org",
"state": "ee",
"locality": "dd",
"email": "bob@bob.com",
"key_length": 512
}
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /services/https
Update HTTPS details. A certificate matching the CSR can be uploaded by setting the https.cert field, a CSR can be cancelled by sending through no https.csr body, and a new csr can be created by sending through a https.csr body with a csr value of "new".
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Query Parameters
- secrets: (one of cleartext, obfuscate - default: cleartext)
Accepts sensitive fields as either cleartext or obfuscated values. The response will display the sensitive fields in the same way.
Body
Media type: application/json
Type: object
Properties- https: required(object)
- csr: (object)
- common_name: required(string)
- org_unit: required(string)
- organization: required(string)
- locality: required(string)
- state: required(string)
- country: required(string)
- email: required(string)
- key_length: required(integer)
- csr: required(string)
- challenge_password: (string)
[sensitive]
- private_key: (string)
[sensitive]
- cert: (string)
- csr: (object)
Example:
{
"https": {
"cert": "-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----",
"csr": {
"country": "AU",
"challenge_password": "aaa",
"common_name": "aa",
"state": "ee",
"locality": "dd",
"org_unit": "unit",
"organization": "org",
"key_length": 2048,
"email": "bob@bob.com",
"csr": "new"
}
}
}HTTP status code 200
Returns the updated HTTPS server details
Body
Media type: application/json
Type: object
Properties- https: required(object)
- common_name: required(string)
- org_unit: required(string)
- organization: required(string)
- locality: required(string)
- state: required(string)
- country: required(string)
- email: required(string)
- valid_from: required(string)
- valid_to: required(string)
- cert: required(string)
- key_length: required(integer)
- key: required(string)
[sensitive]
- csr: (object)
- common_name: required(string)
- org_unit: required(string)
- organization: required(string)
- locality: required(string)
- state: required(string)
- country: required(string)
- email: required(string)
- key_length: (integer)
- csr: (string)
Example:
{
"https": {
"valid_from": "Sep 21 00:39:03 2016 GMT",
"valid_to": "Sep 21 00:39:03 2016 GMT",
"common_name": "CName",
"country": "AU",
"state": "QLD",
"locality": "Toowong",
"org_unit": "OU",
"email": "bob@bob.com",
"organization": "Internet Widgits Pty Ltd",
"key_length": 2048,
"cert": "-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----",
"csr": {
"country": "AU",
"common_name": "aa",
"state": "ee",
"locality": "dd",
"org_unit": "unit",
"organization": "org",
"email": "bob@bob.com",
"key_length": 512
},
"key": "-----BEGIN PRIVATE KEY-----..."
}
}HTTP status code 400
Returns an error after the operation failed due to invalid user input.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 2,
"code": 14,
"text": " String did not conform to the expected format.",
"args": {
"uuid": "root-1-services_https_csr_email"
},
"level": 1
},
{
"type": 1,
"code": 33,
"text": "Push command failed",
"args": {},
"level": 1
}
]
}HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Returns an error after the operation failed.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 2,
"code": 14,
"text": " String did not conform to the expected format.",
"args": {
"uuid": "root-1-services_https_csr_email"
},
"level": 1
},
{
"type": 1,
"code": 33,
"text": "Push command failed",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Provides access to the NTP client configuration on the system.
Fetch NTP client configuration.
Update NTP client configuration, including enabling/disabling the NTP service.
get /services/ntp
Fetch NTP client configuration.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Returns the current NTP configuration.
Body
Media type: application/json
Type: object
Properties- ntp: required(object)
- id: required(string)
- enabled: required(boolean)
- servers: required(array of object)
Items: items
- id: required(string)
- value: required(string)
Example:
{
"ntp": {
"enabled": true,
"servers": [
{
"id": "services_ntp_servers-1",
"value": "0.au.pool.ntp.org"
},
{
"id": "services_ntp_servers-2",
"value": "1.au.pool.ntp.org"
}
],
"id": "root-1-services_ntp"
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /services/ntp
Update NTP client configuration, including enabling/disabling the NTP service.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- ntp: required(object)
- enabled: required(boolean)
- servers: required(array of object)
Items: items
- value: required(string)
Example:
{
"ntp": {
"enabled": true,
"servers": [
{
"value": "0.au.pool.ntp.org"
},
{
"value": "2.au.pool.ntp.org"
},
{
"value": "3.au.pool.ntp.org"
}
]
}
}HTTP status code 200
Returns the updated NTP configuration.
Body
Media type: application/json
Type: object
Properties- ntp: required(object)
- id: required(string)
- enabled: required(boolean)
- servers: required(array of object)
Items: items
- id: required(string)
- value: required(string)
Example:
{
"ntp": {
"enabled": true,
"servers": [
{
"id": "services_ntp_servers-1",
"value": "0.au.pool.ntp.org"
},
{
"id": "services_ntp_servers-2",
"value": "2.au.pool.ntp.org"
},
{
"id": "services_ntp_servers-3",
"value": "3.au.pool.ntp.org"
}
],
"id": "root-1-services_ntp"
}
}HTTP status code 400
Returns an error after the operation failed due to invalid request.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 4,
"code": 40,
"text": "Required field 'services_syslog_servers-1' was not provided in the request",
"args": {
"param": "services_syslog_servers-1"
},
"level": 1
}
]
}HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Error saving NTP configuration.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 2,
"code": 25,
"text": "'' is not a valid hostname",
"args": {
"address": "",
"uuid": "services_ntp_servers-0"
},
"level": 1
},
{
"type": 1,
"code": 33,
"text": "Push command failed",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Provides access to the Network Discovery Protocols (LLDP/CDP) configuration.
Fetch the Network Discovery Protocols configuration.
Modify Network Discovery Protocols configuration.
get /services/lldp
Fetch the Network Discovery Protocols configuration.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Returns the current Network Discovery Protocols configuration.
Body
Media type: application/json
Type: object
Properties- lldp: required(object)
- enabled: required(boolean)
- description: required(string)
- platform: required(string)
- physifs: required(array of string)
Example:
{
"lldp": {
"enabled": true,
"platform": "platform 1",
"description": "description 1",
"physifs": [
"net1",
"net2"
]
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /services/lldp
Modify Network Discovery Protocols configuration.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- lldp: required(object)
- enabled: required(boolean)
- description: (string)
- platform: (string)
- physifs: required(array of string)
Example:
{
"lldp": {
"enabled": true,
"platform": "platform 1",
"description": "description 1",
"physifs": [
"net1",
"net2"
]
}
}HTTP status code 200
Created the Network Discovery Protocols configuration.
Body
Media type: application/json
Type: object
Properties- lldp: required(object)
- enabled: required(boolean)
- description: required(string)
- platform: required(string)
- physifs: required(array of string)
Example:
{
"lldp": {
"enabled": true,
"platform": "platform 1",
"description": "description 1",
"physifs": [
"net1",
"net2"
]
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failed due to invalid session.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"text": "Invalid session ID",
"args": {},
"level": 1
}
]
}HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Provides access to the remote syslog server configuration.
Fetch remote syslog server configuration list.
Create a new syslog server data in the configuration.
get /services/syslog
Fetch remote syslog server configuration list.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Returns the current syslog server configuration.
Body
Media type: application/json
Type: object
Properties- syslogServers: required(array of object)
Items: items
- id: required(string)
- multi_field_identifier: required(string)
A string which can be used to uniquely identify this syslog server
- port: required(integer)
- protocol: required(string)
- address: required(string)
- description: required(string)
- port_logging_enabled: required(boolean)
- min_severity: required(one of info, alert, critical, debug, emergency, error, info, notice, warning)
Example:
{
"syslogServers": [
{
"id": "services_syslog_servers-31",
"multi_field_identifier": "0.au.pool.rsyslog.org:601/UDP",
"port": 601,
"protocol": "UDP",
"address": "0.au.pool.rsyslog.org",
"description": "Remote logging server",
"port_logging_enabled": true,
"min_severity": "info"
},
{
"id": "services_syslog_servers-32",
"multi_field_identifier": "2001:b:c:d::8329:602/UDP",
"port": 602,
"protocol": "UDP",
"address": "2001:b:c:d::8329",
"description": "Remote port logging server",
"port_logging_enabled": false,
"min_severity": "alert"
}
]
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
post /services/syslog
Create a new syslog server data in the configuration.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- syslogServer: required(object)
- port: (integer)
- protocol: (string)
- address: required(string)
- description: (string)
- port_logging_enabled: (boolean)
- min_severity: (one of info, alert, critical, debug, emergency, error, info, notice, warning)
Example:
{
"syslogServer": {
"port": 1000,
"protocol": "UDP",
"address": "192.168.33.199",
"description": "Remote logging server",
"port_logging_enabled": true,
"min_severity": "info"
}
}HTTP status code 200
Created syslog server configuration
Body
Media type: application/json
Type: object
Properties- syslogServer: required(object)
- id: required(string)
- multi_field_identifier: required(string)
A string which can be used to uniquely identify this syslog server
- port: required(integer)
- protocol: required(string)
- address: required(string)
- description: required(string)
- port_logging_enabled: required(boolean)
- min_severity: required(one of info, alert, critical, debug, emergency, error, info, notice, warning)
Example:
{
"syslogServer": {
"id": "services_syslog_servers-2",
"multi_field_identifier": "192.168.33.199:1000/UDP",
"port": 1000,
"protocol": "UDP",
"address": "192.168.33.199",
"description": "Remote logging server",
"port_logging_enabled": true,
"min_severity": "info"
}
}HTTP status code 400
Failed to initiate syslog server creation due to error in post body.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 2,
"code": 22,
"text": "Element [protocol] is of the wrong type",
"args": {
"uuid": "protocol"
},
"level": 1
}
]
}HTTP status code 401
Authentication failed due to invalid session.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"text": "Invalid session ID",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Fetch a configured syslog server by id.
Update syslog server configuration
Delete a syslog server.
get /services/syslog/{syslog_server_id}
Fetch a configured syslog server by id.
Operations Manager base authentication scheme
URI Parameters
- syslog_server_id: required(string)
unique identifier for syslog servers
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Returns the requested syslog server configuration.
Body
Media type: application/json
Type: object
Properties- syslogServer: required(object)
- id: required(string)
- multi_field_identifier: required(string)
A string which can be used to uniquely identify this syslog server
- port: required(integer)
- protocol: required(string)
- address: required(string)
- description: required(string)
- port_logging_enabled: required(boolean)
- min_severity: required(one of info, alert, critical, debug, emergency, error, info, notice, warning)
Example:
{
"syslogServer": {
"id": "services_syslog_servers-1",
"multi_field_identifier": "192.168.33.200:705/UDP",
"port": 705,
"protocol": "UDP",
"address": "192.168.33.200",
"description": "Remote logging server",
"port_logging_enabled": false,
"min_severity": "warning"
}
}HTTP status code 400
Returns an error after the operation failed due to invalid request.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 4,
"code": 40,
"text": "Required field 'services_syslog-1' was not provided in the request",
"args": {
"param": "services_syslog_servers-1"
},
"level": 1
}
]
}HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}HTTP status code 500
Error saving syslog configuration.
Body
Media type: application/json
Type: object
Example:
{
"error": [
{
"type": 2,
"code": 25,
"text": "'' is not a valid hostname",
"args": {
"address": "",
"uuid": "services_syslog_servers-1"
},
"level": 1
},
{
"type": 1,
"code": 33,
"text": "Push command failed",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /services/syslog/{syslog_server_id}
Update syslog server configuration
Operations Manager base authentication scheme
URI Parameters
- syslog_server_id: required(string)
unique identifier for syslog servers
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- syslogServer: required(object)
- port: (integer)
- protocol: (string)
- address: required(string)
- description: (string)
- port_logging_enabled: (boolean)
- min_severity: (one of info, alert, critical, debug, emergency, error, info, notice, warning)
Example:
{
"syslogServer": {
"address": "192.168.33.199",
"port": 1000,
"protocol": "UDP",
"description": "Remote logging server",
"port_logging_enabled": false,
"min_severity": "debug"
}
}HTTP status code 200
Returns the updated syslog server configuration.
Body
Media type: application/json
Type: object
Properties- syslogServer: required(object)
- id: required(string)
- multi_field_identifier: required(string)
A string which can be used to uniquely identify this syslog server
- port: required(integer)
- protocol: required(string)
- address: required(string)
- description: required(string)
- port_logging_enabled: required(boolean)
- min_severity: required(one of info, alert, critical, debug, emergency, error, info, notice, warning)
Example:
{
"syslogServer": {
"id": "services_syslog_servers-1",
"multi_field_identifier": "192.168.33.200:705/UDP",
"port": 705,
"protocol": "UDP",
"address": "192.168.33.200",
"description": "Remote logging server",
"port_logging_enabled": false,
"min_severity": "debug"
}
}HTTP status code 400
Returns an error after the operation failed due to invalid request.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 4,
"code": 40,
"text": "Required field 'services_syslog-1' was not provided in the request",
"args": {
"param": "services_syslog_servers-1"
},
"level": 1
}
]
}HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Error saving syslog configuration.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 2,
"code": 25,
"text": "'' is not a valid hostname",
"args": {
"address": "",
"uuid": "services_syslog_servers-1"
},
"level": 1
},
{
"type": 1,
"code": 33,
"text": "Push command failed",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
delete /services/syslog/{syslog_server_id}
Delete a syslog server.
Operations Manager base authentication scheme
URI Parameters
- syslog_server_id: required(string)
unique identifier for syslog servers
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
syslog server deleted
HTTP status code 400
Returns an error after the operation failed due to invalid request.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 4,
"code": 40,
"text": "Required field 'services_syslog-1' was not provided in the request",
"args": {
"param": "services_syslog_servers-1"
},
"level": 1
}
]
}HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}HTTP status code 404
syslog server does not exist
Body
Media type: application/json
Type: object
Example:
{
"error": [
{
"type": 5,
"code": 29,
"text": "Could not find element with UUID 'services_syslog_servers-2'",
"args": {
"uuid": "services_syslog_servers-2"
},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Retrieve and configure the SNMP TRAP/INFORM settings.
Get the snmp manager legacy configuration.
Update the snmp manager legacy configuration.
get /services/snmp_manager
Get the snmp manager legacy configuration.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Query Parameters
- secrets: (one of cleartext, obfuscate, masked - default: cleartext)
Returns sensitive fields displayed as either cleartext, obfuscated or masked values.
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- snmp_manager: required(object)
- id: required(string)
- multi_field_identifier: required(string)
A string which can be used to uniquely identify this snmp alert manager
- protocol: required(one of UDP, TCP, UDP6, TCP6)
- address: (string)
- port: (integer - minimum: 1 - maximum: 65535)
- msg_type: required(one of TRAP, INFORM)
Type of SNMP message to send.
- version: required(one of v1, v2c, v3)
- community: (string)
[sensitive]
- auth_protocol: (one of SHA, MD5)
- auth_password: (string)
[sensitive]
- username: (string)
- engine_id: (string)
- privacy_protocol: (one of AES, DES)
- privacy_password: (string)
[sensitive]
- security_level: (one of noAuthNoPriv, authNoPriv, authPriv)
Example:
{
"snmp_manager": {
"id": "snmp_manager_1",
"multi_field_identifier": "snmp.example.com:167/UDP",
"enabled": true,
"protocol": "UDP",
"community": "secret",
"auth_protocol": "SHA",
"username": "michaelf",
"engine_id": "0x80001f8803555000000000",
"version": "v3",
"privacy_protocol": "DES",
"security_level": "noAuthNoPriv",
"msg_type": "TRAP",
"address": "snmp.example.com",
"port": 167
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /services/snmp_manager
Update the snmp manager legacy configuration.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Query Parameters
- secrets: (one of cleartext, obfuscate - default: cleartext)
Accepts sensitive fields as either cleartext or obfuscated values. The response will display the sensitive fields in the same way.
Body
Media type: application/json
Type: object
Properties- snmp_manager: required(object)
- protocol: required(one of UDP, TCP, UDP6, TCP6)
- address: (string)
- port: (integer - minimum: 1 - maximum: 65535)
- msg_type: required(one of TRAP, INFORM)
Type of SNMP message to send.
- version: required(one of v1, v2c, v3)
- community: (string)
[sensitive]
- auth_protocol: (one of SHA, MD5)
- auth_password: (string)
[sensitive]
- username: (string)
- engine_id: (string)
- privacy_protocol: (one of AES, DES)
- privacy_password: (string)
[sensitive]
- security_level: (one of noAuthNoPriv, authNoPriv, authPriv)
Example:
{
"snmp_manager": {
"enabled": true,
"protocol": "UDP",
"community": "secret",
"auth_protocol": "SHA",
"auth_password": "secret123",
"username": "michaelf",
"engine_id": "0x80001f8803555000000000",
"version": "v3",
"privacy_protocol": "DES",
"privacy_password": "secret123",
"security_level": "noAuthNoPriv",
"msg_type": "TRAP",
"address": "snmp.example.com",
"port": 167
}
}HTTP status code 200
Body
Media type: application/json
Type: object
Properties- snmp_manager: required(object)
- id: required(string)
- multi_field_identifier: required(string)
A string which can be used to uniquely identify this snmp alert manager
- protocol: required(one of UDP, TCP, UDP6, TCP6)
- address: (string)
- port: (integer - minimum: 1 - maximum: 65535)
- msg_type: required(one of TRAP, INFORM)
Type of SNMP message to send.
- version: required(one of v1, v2c, v3)
- community: (string)
[sensitive]
- auth_protocol: (one of SHA, MD5)
- auth_password: (string)
[sensitive]
- username: (string)
- engine_id: (string)
- privacy_protocol: (one of AES, DES)
- privacy_password: (string)
[sensitive]
- security_level: (one of noAuthNoPriv, authNoPriv, authPriv)
Example:
{
"snmp_manager": {
"id": "snmp_manager_1",
"multi_field_identifier": "snmp.example.com:167/UDP",
"enabled": true,
"protocol": "UDP",
"community": "secret",
"auth_protocol": "SHA",
"username": "michaelf",
"engine_id": "0x80001f8803555000000000",
"version": "v3",
"privacy_protocol": "DES",
"security_level": "noAuthNoPriv",
"msg_type": "TRAP",
"address": "snmp.example.com",
"port": 167
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Retrieve and configure the SNMP TRAP/INFORM settings.
Get the snmp manager configuration.
Add a new snmp manager.
get /services/snmp_alert_managers
Get the snmp manager configuration.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Query Parameters
- secrets: (one of cleartext, obfuscate, masked - default: cleartext)
Returns sensitive fields displayed as either cleartext, obfuscated or masked values.
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- snmp_alert_managers: required(array of object)
Items: items
- id: required(string)
- multi_field_identifier: required(string)
A string which can be used to uniquely identify this snmp alert manager
- name: (string)
- protocol: required(one of UDP, TCP, UDP6, TCP6)
- address: (string)
- port: (integer - minimum: 1 - maximum: 65535)
- msg_type: required(one of TRAP, INFORM)
Type of SNMP message to send.
- version: required(one of v1, v2c, v3)
- community: (string)
[sensitive]
- auth_protocol: (one of SHA, MD5)
- auth_password: (string)
[sensitive]
- username: (string)
- engine_id: (string)
- privacy_protocol: (one of AES, DES)
- privacy_password: (string)
[sensitive]
- security_level: (one of noAuthNoPriv, authNoPriv, authPriv)
Example:
{
"snmp_alert_managers": [
{
"id": "snmp_manager_1",
"multi_field_identifier": "snmp.example.com:167/UDP",
"enabled": true,
"protocol": "UDP",
"community": "secret",
"auth_protocol": "SHA",
"username": "michaelf",
"engine_id": "0x80001f8803555000000000",
"version": "v3",
"privacy_protocol": "DES",
"security_level": "noAuthNoPriv",
"msg_type": "TRAP",
"address": "snmp.example.com",
"port": 167
}
]
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
post /services/snmp_alert_managers
Add a new snmp manager.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Query Parameters
- secrets: (one of cleartext, obfuscate - default: cleartext)
Accepts sensitive fields as either cleartext or obfuscated values. The response will display the sensitive fields in the same way.
Body
Media type: application/json
Type: object
Properties- snmp_alert_manager: required(object)
- name: (string)
- protocol: required(one of UDP, TCP, UDP6, TCP6)
- address: (string)
- port: (integer - minimum: 1 - maximum: 65535)
- msg_type: required(one of TRAP, INFORM)
Type of SNMP message to send.
- version: required(one of v1, v2c, v3)
- community: (string)
[sensitive]
- auth_protocol: (one of SHA, MD5)
- auth_password: (string)
[sensitive]
- username: (string)
- engine_id: (string)
- privacy_protocol: (one of AES, DES)
- privacy_password: (string)
[sensitive]
- security_level: (one of noAuthNoPriv, authNoPriv, authPriv)
Example:
{
"snmp_alert_manager": {
"name": "A SNMP Alert Manager",
"enabled": true,
"protocol": "UDP",
"community": "secret",
"auth_protocol": "SHA",
"username": "michaelf",
"engine_id": "0x80001f8803555000000000",
"version": "v3",
"privacy_protocol": "DES",
"security_level": "noAuthNoPriv",
"msg_type": "TRAP",
"address": "snmp.example.com",
"port": 167
}
}HTTP status code 200
The snmp manager was added.
Body
Media type: application/json
Type: object
Properties- snmp_alert_manager: required(object)
The SNMP manager configuration
- id: required(string)
- multi_field_identifier: required(string)
A string which can be used to uniquely identify this snmp alert manager
- name: (string)
- protocol: required(one of UDP, TCP, UDP6, TCP6)
- address: (string)
- port: (integer - minimum: 1 - maximum: 65535)
- msg_type: required(one of TRAP, INFORM)
Type of SNMP message to send.
- version: required(one of v1, v2c, v3)
- community: (string)
[sensitive]
- auth_protocol: (one of SHA, MD5)
- auth_password: (string)
[sensitive]
- username: (string)
- engine_id: (string)
- privacy_protocol: (one of AES, DES)
- privacy_password: (string)
[sensitive]
- security_level: (one of noAuthNoPriv, authNoPriv, authPriv)
Example:
{
"snmp_alert_manager": {
"id": "snmp_manager_1",
"multi_field_identifier": "snmp.example.com:167/UDP",
"name": "A SNMP Alert Manager",
"enabled": true,
"protocol": "UDP",
"community": "secret",
"auth_protocol": "SHA",
"username": "michaelf",
"engine_id": "0x80001f8803555000000000",
"version": "v3",
"privacy_protocol": "DES",
"security_level": "noAuthNoPriv",
"msg_type": "TRAP",
"address": "snmp.example.com",
"port": 167
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Get the configuration of an SNMP Manager
Update settings for SNMP Managers on the Operations Manager appliance.
Delete an snmp manager
get /services/snmp_alert_managers/{id}
Get the configuration of an SNMP Manager
Operations Manager base authentication scheme
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Query Parameters
- secrets: (one of cleartext, obfuscate, masked - default: cleartext)
Returns sensitive fields displayed as either cleartext, obfuscated or masked values.
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- snmp_alert_manager: required(object)
The SNMP manager configuration
- id: required(string)
- multi_field_identifier: required(string)
A string which can be used to uniquely identify this snmp alert manager
- name: (string)
- protocol: required(one of UDP, TCP, UDP6, TCP6)
- address: (string)
- port: (integer - minimum: 1 - maximum: 65535)
- msg_type: required(one of TRAP, INFORM)
Type of SNMP message to send.
- version: required(one of v1, v2c, v3)
- community: (string)
[sensitive]
- auth_protocol: (one of SHA, MD5)
- auth_password: (string)
[sensitive]
- username: (string)
- engine_id: (string)
- privacy_protocol: (one of AES, DES)
- privacy_password: (string)
[sensitive]
- security_level: (one of noAuthNoPriv, authNoPriv, authPriv)
Example:
{
"snmp_alert_manager": {
"id": "snmp_manager_1",
"multi_field_identifier": "snmp.example.com:167/UDP",
"name": "A SNMP Alert Manager",
"enabled": true,
"protocol": "UDP",
"community": "secret",
"auth_protocol": "SHA",
"username": "michaelf",
"engine_id": "0x80001f8803555000000000",
"version": "v3",
"privacy_protocol": "DES",
"security_level": "noAuthNoPriv",
"msg_type": "TRAP",
"address": "snmp.example.com",
"port": 167
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /services/snmp_alert_managers/{id}
Update settings for SNMP Managers on the Operations Manager appliance.
Operations Manager base authentication scheme
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Query Parameters
- secrets: (one of cleartext, obfuscate - default: cleartext)
Accepts sensitive fields as either cleartext or obfuscated values. The response will display the sensitive fields in the same way.
Body
Media type: application/json
Type: object
Properties- snmp_alert_manager: required(object)
The SNMP manager configuration
- id: required(string)
- multi_field_identifier: required(string)
A string which can be used to uniquely identify this snmp alert manager
- name: (string)
- protocol: required(one of UDP, TCP, UDP6, TCP6)
- address: (string)
- port: (integer - minimum: 1 - maximum: 65535)
- msg_type: required(one of TRAP, INFORM)
Type of SNMP message to send.
- version: required(one of v1, v2c, v3)
- community: (string)
[sensitive]
- auth_protocol: (one of SHA, MD5)
- auth_password: (string)
[sensitive]
- username: (string)
- engine_id: (string)
- privacy_protocol: (one of AES, DES)
- privacy_password: (string)
[sensitive]
- security_level: (one of noAuthNoPriv, authNoPriv, authPriv)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- snmp_alert_manager: required(object)
The SNMP manager configuration
- id: required(string)
- multi_field_identifier: required(string)
A string which can be used to uniquely identify this snmp alert manager
- name: (string)
- protocol: required(one of UDP, TCP, UDP6, TCP6)
- address: (string)
- port: (integer - minimum: 1 - maximum: 65535)
- msg_type: required(one of TRAP, INFORM)
Type of SNMP message to send.
- version: required(one of v1, v2c, v3)
- community: (string)
[sensitive]
- auth_protocol: (one of SHA, MD5)
- auth_password: (string)
[sensitive]
- username: (string)
- engine_id: (string)
- privacy_protocol: (one of AES, DES)
- privacy_password: (string)
[sensitive]
- security_level: (one of noAuthNoPriv, authNoPriv, authPriv)
Example:
{
"snmp_alert_manager": {
"id": "snmp_manager_1",
"multi_field_identifier": "snmp.example.com:167/UDP-v3-TRAP",
"name": "A SNMP Alert Manager",
"enabled": true,
"protocol": "UDP",
"community": "secret",
"auth_protocol": "SHA",
"username": "michaelf",
"engine_id": "0x80001f8803555000000000",
"version": "v3",
"privacy_protocol": "DES",
"security_level": "noAuthNoPriv",
"msg_type": "TRAP",
"address": "snmp.example.com",
"port": 167
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
delete /services/snmp_alert_managers/{id}
Delete an snmp manager
Operations Manager base authentication scheme
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
snmp manager deleted
HTTP status code 400
Incomplete data
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Retrieve and configure the SNMP Daemon settings.
Get the snmpd configuration.
Update the snmpd configuration.
get /services/snmpd
Get the snmpd configuration.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Query Parameters
- secrets: (one of cleartext, obfuscate, masked - default: cleartext)
Returns sensitive fields displayed as either cleartext, obfuscated or masked values.
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- snmpd: required(object)
- enabled: (boolean - default: false)
- port: (integer - default: 161 - minimum: 1 - maximum: 65535)
- protocol: (one of UDP, TCP - default: UDP)
- enable_legacy_versions: (boolean - default: false)
- rocommunity: (string)
[sensitive]
- rwcommunity: (string)
[sensitive]
- enable_secure_snmp: (boolean - default: false)
- security_level: (one of noauth, auth, priv - default: priv)
- security_name: (string)
- engine_id: (string)
- auth_protocol: (one of SHA, MD5)
- auth_use_plaintext: (boolean - default: false)
- auth_password: (string)
[sensitive]
- auth_localized_key: (string)
- priv_protocol: (one of AES, DES)
- priv_use_plaintext: (boolean - default: false)
- priv_password: (string)
[sensitive]
- priv_localized_key: (string)
Example:
{
"snmpd": {
"enabled": true,
"port": 161,
"protocol": "UDP",
"enable_legacy_versions": true,
"rocommunity": "public",
"rwcommunity": "private",
"enable_secure_snmp": true,
"security_level": "priv",
"security_name": "newuser",
"engine_id": "0x80001f8803555000000000",
"auth_protocol": "MD5",
"auth_use_plaintext": true,
"auth_password": "authPassword",
"auth_localized_key": "0x123456789ABCDEF",
"priv_protocol": "DES",
"priv_use_plaintext": true,
"priv_password": "privPassword",
"priv_localized_key": "0xFEDCBA987654321"
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /services/snmpd
Update the snmpd configuration.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Query Parameters
- secrets: (one of cleartext, obfuscate - default: cleartext)
Accepts sensitive fields as either cleartext or obfuscated values. The response will display the sensitive fields in the same way.
Body
Media type: application/json
Type: object
Properties- snmpd: required(object)
- enabled: (boolean - default: false)
- port: (integer - default: 161 - minimum: 1 - maximum: 65535)
- protocol: (one of UDP, TCP - default: UDP)
- enable_legacy_versions: (boolean - default: false)
- rocommunity: (string)
[sensitive]
- rwcommunity: (string)
[sensitive]
- enable_secure_snmp: (boolean - default: false)
- security_level: (one of noauth, auth, priv - default: priv)
- security_name: (string)
- engine_id: (string)
- auth_protocol: (one of SHA, MD5)
- auth_use_plaintext: (boolean - default: false)
- auth_password: (string)
[sensitive]
- auth_localized_key: (string)
- priv_protocol: (one of AES, DES)
- priv_use_plaintext: (boolean - default: false)
- priv_password: (string)
[sensitive]
- priv_localized_key: (string)
Example:
{
"snmpd": {
"enabled": true,
"port": 161,
"protocol": "UDP",
"enable_legacy_versions": true,
"rocommunity": "public",
"rwcommunity": "private",
"enable_secure_snmp": true,
"security_level": "priv",
"security_name": "newuser",
"engine_id": "0x80001f8803555000000000",
"auth_protocol": "MD5",
"auth_use_plaintext": true,
"auth_password": "authPassword",
"auth_localized_key": "0x123456789ABCDEF",
"priv_protocol": "DES",
"priv_use_plaintext": true,
"priv_password": "privPassword",
"priv_localized_key": "0xFEDCBA987654321"
}
}HTTP status code 200
Body
Media type: application/json
Type: object
Properties- snmpd: required(object)
- enabled: (boolean - default: false)
- port: (integer - default: 161 - minimum: 1 - maximum: 65535)
- protocol: (one of UDP, TCP - default: UDP)
- enable_legacy_versions: (boolean - default: false)
- rocommunity: (string)
[sensitive]
- rwcommunity: (string)
[sensitive]
- enable_secure_snmp: (boolean - default: false)
- security_level: (one of noauth, auth, priv - default: priv)
- security_name: (string)
- engine_id: (string)
- auth_protocol: (one of SHA, MD5)
- auth_use_plaintext: (boolean - default: false)
- auth_password: (string)
[sensitive]
- auth_localized_key: (string)
- priv_protocol: (one of AES, DES)
- priv_use_plaintext: (boolean - default: false)
- priv_password: (string)
[sensitive]
- priv_localized_key: (string)
Example:
{
"snmpd": {
"enabled": true,
"port": 161,
"protocol": "UDP",
"enable_legacy_versions": true,
"rocommunity": "public",
"rwcommunity": "private",
"enable_secure_snmp": true,
"security_level": "priv",
"security_name": "newuser",
"engine_id": "0x80001f8803555000000000",
"auth_protocol": "MD5",
"auth_use_plaintext": true,
"auth_password": "authPassword",
"auth_localized_key": "0x123456789ABCDEF",
"priv_protocol": "DES",
"priv_use_plaintext": true,
"priv_password": "privPassword",
"priv_localized_key": "0xFEDCBA987654321"
}
}HTTP status code 400
Returns an error after the operation failed due to incomplete data.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 4,
"code": 40,
"text": "Required field 'priv_localized_key' was not provided in the request",
"args": {
"param": "priv_localized_key"
},
"level": 1
}
]
}HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Failed to save the configuration.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Fetch the current ssh delimiter.
Update config parameters related to the SSH service.
get /services/ssh
Fetch the current ssh delimiter.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- ssh: required(object)
- ssh_url_delimiter: required(string)
Example:
{
"ssh": {
"ssh_url_delimiter": "+"
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /services/ssh
Update config parameters related to the SSH service.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- ssh: required(object)
- ssh_url_delimiter: (string)
- maxstartups_start: (integer)
- maxstartups_rate: (integer)
- maxstartups_full: (integer)
- unauthenticated_serial_port_access: (boolean)
Example:
{
"ssh": {
"ssh_url_delimiter": "+"
}
}HTTP status code 200
Body
Media type: application/json
Type: object
Properties- ssh: required(object)
- ssh_url_delimiter: required(string)
Example:
{
"ssh": {
"ssh_url_delimiter": "+"
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Fetch the configuration for the available routing daemons.
Update the configuration for the available routing daemons.
get /services/routing
Fetch the configuration for the available routing daemons.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- routing: required(object)
- bgpd: required(object)
Configuration for the bgp routing daemon
- enabled: required(boolean)
Is bdgpd enabled
- enabled: required(boolean)
- ospfd: required(object)
Configuration for the ospf routing daemon
- enabled: required(boolean)
Is ospfd enabled
- enabled: required(boolean)
- isisd: required(object)
Configuration for the isis routing daemon
- enabled: required(boolean)
Is isisd enabled
- enabled: required(boolean)
- ripd: required(object)
Configuration for the rip routing daemon
- enabled: required(boolean)
Is ripd enabled
- enabled: required(boolean)
- bgpd: required(object)
Example:
{
"routing": {
"bgpd": {
"enabled": true
},
"isisd": {
"enabled": false
},
"ripd": {
"enabled": true
},
"ospfd": {
"enabled": false
}
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /services/routing
Update the configuration for the available routing daemons.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- routing: required(object)
- bgpd: required(object)
Configuration for the bgp routing daemon
- enabled: required(boolean)
Is bdgpd enabled
- enabled: required(boolean)
- ospfd: required(object)
Configuration for the ospf routing daemon
- enabled: required(boolean)
Is ospfd enabled
- enabled: required(boolean)
- isisd: required(object)
Configuration for the isis routing daemon
- enabled: required(boolean)
Is isisd enabled
- enabled: required(boolean)
- ripd: required(object)
Configuration for the rip routing daemon
- enabled: required(boolean)
Is ripd enabled
- enabled: required(boolean)
- bgpd: required(object)
Example:
{
"routing": {
"bgpd": {
"enabled": true
},
"isisd": {
"enabled": false
},
"ripd": {
"enabled": true
},
"ospfd": {
"enabled": false
}
}
}HTTP status code 200
Body
Media type: application/json
Type: object
Properties- routing: required(object)
- bgpd: required(object)
Configuration for the bgp routing daemon
- enabled: required(boolean)
Is bdgpd enabled
- enabled: required(boolean)
- ospfd: required(object)
Configuration for the ospf routing daemon
- enabled: required(boolean)
Is ospfd enabled
- enabled: required(boolean)
- isisd: required(object)
Configuration for the isis routing daemon
- enabled: required(boolean)
Is isisd enabled
- enabled: required(boolean)
- ripd: required(object)
Configuration for the rip routing daemon
- enabled: required(boolean)
Is ripd enabled
- enabled: required(boolean)
- bgpd: required(object)
Example:
{
"routing": {
"bgpd": {
"enabled": true
},
"isisd": {
"enabled": false
},
"ripd": {
"enabled": true
},
"ospfd": {
"enabled": false
}
}
}HTTP status code 400
Returns an error after the operation failed due to incomplete data.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 4,
"code": 40,
"text": "Required field 'bgpd' was not provided in the request",
"args": {
"param": "bgpd"
},
"level": 1
}
]
}HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Failed to save the configuration.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
/alerts
Used to configure various types of alerts
Retrieve and configure Authentication Trap Group settings.
Get the authentication trap group settings.
Update the authentication trap group settings.
get /alerts/authentication
Get the authentication trap group settings.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- authentication_trap_group: required(object)
- enabled: required(boolean)
Example:
{
"authentication_trap_group": {
"enabled": true
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /alerts/authentication
Update the authentication trap group settings.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- authentication_trap_group: required(object)
- enabled: required(boolean)
Example:
{
"authentication_trap_group": {
"enabled": true
}
}HTTP status code 200
Body
Media type: application/json
Type: object
Properties- authentication_trap_group: required(object)
- enabled: required(boolean)
Example:
{
"authentication_trap_group": {
"enabled": true
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Retrieve and configure System Trap Group settings.
Get the system trap group settings.
Update the system trap group settings.
get /alerts/system
Get the system trap group settings.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- system_trap_group: required(object)
- enabled: required(boolean)
- power_supply_millivolt_lower: required(integer)
- power_supply_millivolt_upper: required(integer)
Example:
{
"system_trap_group": {
"enabled": true,
"power_supply_millivolt_lower": 11000,
"power_supply_millivolt_upper": 13000
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /alerts/system
Update the system trap group settings.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- system_trap_group: required(object)
- enabled: required(boolean)
- power_supply_millivolt_lower: required(integer)
- power_supply_millivolt_upper: required(integer)
Example:
{
"system_trap_group": {
"enabled": true,
"power_supply_millivolt_lower": 11000,
"power_supply_millivolt_upper": 13000
}
}HTTP status code 200
Body
Media type: application/json
Type: object
Properties- system_trap_group: required(object)
- enabled: required(boolean)
- power_supply_millivolt_lower: required(integer)
- power_supply_millivolt_upper: required(integer)
Example:
{
"system_trap_group": {
"enabled": true,
"power_supply_millivolt_lower": 11000,
"power_supply_millivolt_upper": 13000
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Retrieve and configure Networking Trap Group settings.
Get the networking trap group settings.
Update the networking trap group settings.
get /alerts/networking
Get the networking trap group settings.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- networking_trap_group: required(object)
- enabled: required(boolean)
- signal_strength_threshold_lower: (integer)
- signal_strength_threshold_upper: (integer)
Examples:
example1:
With a cell modem
{
"networking_trap_group": {
"enabled": true,
"signal_strength_threshold_lower": 33,
"signal_strength_threshold_upper": 66
}
}example2:
Without a cell modem
{
"networking_trap_group": {
"enabled": true
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /alerts/networking
Update the networking trap group settings.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- networking_trap_group: required(object)
- enabled: required(boolean)
- signal_strength_threshold_lower: (integer)
- signal_strength_threshold_upper: (integer)
Examples:
example1:
With a cell modem
{
"networking_trap_group": {
"enabled": true,
"signal_strength_threshold_lower": 33,
"signal_strength_threshold_upper": 66
}
}example2:
Without a cell modem
{
"networking_trap_group": {
"enabled": true
}
}HTTP status code 200
Body
Media type: application/json
Type: object
Properties- networking_trap_group: required(object)
- enabled: required(boolean)
- signal_strength_threshold_lower: (integer)
- signal_strength_threshold_upper: (integer)
Examples:
example1:
With a cell modem
{
"networking_trap_group": {
"enabled": true,
"signal_strength_threshold_lower": 33,
"signal_strength_threshold_upper": 66
}
}example2:
Without a cell modem
{
"networking_trap_group": {
"enabled": true
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Retrieve and configure config change trap group settings.
Get the config change trap group settings.
Update the config trap group settings.
get /alerts/config_change
Get the config change trap group settings.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- config_change_trap_group: required(object)
- enabled: required(boolean)
Example:
{
"config_change_trap_group": {
"enabled": true
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /alerts/config_change
Update the config trap group settings.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- config_change_trap_group: required(object)
- enabled: required(boolean)
Example:
{
"config_change_trap_group": {
"enabled": true
}
}HTTP status code 200
Body
Media type: application/json
Type: object
Properties- config_change_trap_group: required(object)
- enabled: required(boolean)
Example:
{
"config_change_trap_group": {
"enabled": true
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
/monitoring
Used to configure various types of monitoring systems
Used to configure various types of alerts
Retrieve and configure Networking Alert Group settings.
Get the networking alert group settings.
Update the networking alert group settings.
get /monitoring/alerts/networking
Get the networking alert group settings.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- networking_alert_group: required(object)
- cell_signal_strength_alert: (object)
- enabled: (boolean - default: false)
- threshold_lower: (integer - default: 33)
- threshold_upper: (integer - default: 66)
- cell_signal_strength_alert: (object)
Examples:
example1:
All network alerts enabled.
{
"networking_alert_group": {
"cell_signal_strength_alert": {
"enabled": true,
"signal_strength_threshold_lower": 33,
"signal_strength_threshold_upper": 66
}
}
}example2:
All network alerts enabled when there is no cell modem (Network link state is enabled under cell_signal_strength_alert).
{
"networking_alert_group": {
"cell_signal_strength_alert": {
"enabled": true
}
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /monitoring/alerts/networking
Update the networking alert group settings.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- networking_alert_group: required(object)
- cell_signal_strength_alert: (object)
- enabled: (boolean - default: false)
- threshold_lower: (integer - default: 33)
- threshold_upper: (integer - default: 66)
- cell_signal_strength_alert: (object)
Examples:
example1:
Enable all network alerts.
{
"networking_alert_group": {
"cell_signal_strength_alert": {
"enabled": true,
"signal_strength_threshold_lower": 33,
"signal_strength_threshold_upper": 66
}
}
}example2:
Enable all network alerts when there is no cell modem (Enables network link state under cell_signal_strength_alert).
{
"networking_alert_group": {
"cell_signal_strength_alert": {
"enabled": true
}
}
}example3:
Disable all network alerts.
{
"networking_alert_group": {}
}HTTP status code 200
Body
Media type: application/json
Type: object
Properties- networking_alert_group: required(object)
- cell_signal_strength_alert: (object)
- enabled: (boolean - default: false)
- threshold_lower: (integer - default: 33)
- threshold_upper: (integer - default: 66)
- cell_signal_strength_alert: (object)
Examples:
example1:
All network alerts enabled.
{
"networking_alert_group": {
"cell_signal_strength_alert": {
"enabled": true,
"signal_strength_threshold_lower": 33,
"signal_strength_threshold_upper": 66
}
}
}example2:
All network alerts enabled when there is no cell modem (Network link state is enabled under cell_signal_strength_alert).
{
"networking_alert_group": {
"cell_signal_strength_alert": {
"enabled": true
}
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Retrieve and configure Power Alert Group settings.
Get the power alert group settings.
Update the power alert group settings.
get /monitoring/alerts/power
Get the power alert group settings.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- power_alert_group: required(object)
- power_supply_voltage_alert: (object)
- enabled: (boolean - default: false)
- millivolt_lower: (integer - default: 11000)
- millivolt_upper: (integer - default: 13000)
- power_supply_voltage_alert: (object)
Example:
{
"power_alert_group": {
"power_supply_voltage_alert": {
"enabled": true,
"millivolt_lower": 11000,
"millivolt_upper": 13000
}
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /monitoring/alerts/power
Update the power alert group settings.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- power_alert_group: required(object)
- power_supply_voltage_alert: (object)
- enabled: (boolean - default: false)
- millivolt_lower: (integer - default: 11000)
- millivolt_upper: (integer - default: 13000)
- power_supply_voltage_alert: (object)
Examples:
example1:
Enable all power alerts.
{
"power_alert_group": {
"power_supply_voltage_alert": {
"enabled": true,
"millivolt_lower": 11000,
"millivolt_upper": 13000
}
}
}example2:
Disable all power alerts.
{
"power_alert_group": {}
}HTTP status code 200
Body
Media type: application/json
Type: object
Properties- power_alert_group: required(object)
- power_supply_voltage_alert: (object)
- enabled: (boolean - default: false)
- millivolt_lower: (integer - default: 11000)
- millivolt_upper: (integer - default: 13000)
- power_supply_voltage_alert: (object)
Example:
{
"power_alert_group": {
"power_supply_voltage_alert": {
"enabled": true,
"millivolt_lower": 11000,
"millivolt_upper": 13000
}
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Retrieve and configure System Alert Group settings.
Get the system alert group settings.
Update the system alert group settings.
get /monitoring/alerts/system
Get the system alert group settings.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- system_alert_group: required(object)
- authentication_alert: (object)
- enabled: (boolean - default: false)
- config_change_alert: (object)
- enabled: (boolean - default: false)
- temperature_alert: (object)
- enabled: (boolean - default: false)
- threshold_lower: (integer)
- threshold_upper: (integer)
- authentication_alert: (object)
Example:
{
"system_alert_group": {
"authentication_alert": {
"enabled": true
},
"config_change_alert": {
"enabled": true
},
"temperature_alert": {
"enabled": true,
"threshold_lower": 35,
"threshold_upper": 67
}
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /monitoring/alerts/system
Update the system alert group settings.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- system_alert_group: required(object)
- authentication_alert: (object)
- enabled: (boolean - default: false)
- config_change_alert: (object)
- enabled: (boolean - default: false)
- temperature_alert: (object)
- enabled: (boolean - default: false)
- threshold_lower: (integer)
- threshold_upper: (integer)
- authentication_alert: (object)
Examples:
example1:
Enable all system alerts.
{
"system_alert_group": {
"authentication_alert": {
"enabled": true
},
"config_change_alert": {
"enabled": true
},
"temperature_alert": {
"enabled": true,
"threshold_lower": 35,
"threshold_upper": 67
}
}
}example2:
Disable all system alerts.
{
"system_alert_group": {}
}HTTP status code 200
Body
Media type: application/json
Type: object
Properties- system_alert_group: required(object)
- authentication_alert: (object)
- enabled: (boolean - default: false)
- config_change_alert: (object)
- enabled: (boolean - default: false)
- temperature_alert: (object)
- enabled: (boolean - default: false)
- threshold_lower: (integer)
- threshold_upper: (integer)
- authentication_alert: (object)
Example:
{
"system_alert_group": {
"authentication_alert": {
"enabled": true
},
"config_change_alert": {
"enabled": true
},
"temperature_alert": {
"enabled": true,
"threshold_lower": 35,
"threshold_upper": 67
}
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
/physifs
Read and manipulate the network physical interfaces on the Operations Manager appliance.
Get a list of the network interfaces on the Operations Manager appliance
Add a new interface to the Operations Manager appliance.
get /physifs
Get a list of the network interfaces on the Operations Manager appliance
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Query Parameters
- secrets: (one of cleartext, obfuscate, mask - default: cleartext)
Returns sensitive fields displayed as either cleartext, obfuscated or masked values.
HTTP status code 200
Body
Media type: application/json
Possible types:
getPhysifList
- physifs: required(array of object)
A network physical interface
Items: items
- enabled: required(boolean)
- name: required(string)
- mtu: (number)
- device: required(string)
- mac_address: (string)
For Ethernet interfaces (including virtual Ethernet-based interfaces), the MAC address is returned in this property. For non-Ethernet interfaces, this property will be absent.
- description: required(string)
- media: required(string)
- id: required(string)
- master: (string)
The UUID of the aggregate physif if this interface belongs to one
- ethernet_setting: (object)
- link_speed: required(string)
- id: required(string)
- cellular_setting: (object)
- apn: (string)
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"apn":"apn"}]}},"since":"10/2020"}
- deprecatedProperty
- username: (string)
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"username":"username"}]}},"since":"10/2020"}
- deprecatedProperty
- password: (string)
[sensitive]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"password":"password"}]}},"since":"10/2020"}
- deprecatedProperty
- iptype: (string)
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"iptype":"IPv4v6"}]}},"since":"10/2020"}
- deprecatedProperty
- id: required(string)
- active_sim: (number - minimum: 1 - maximum: 2)
- sim_failover_policy: (one of never, on_disconnect)
- sim_failover_disconnect_mode: (ping)
- sim_failback_policy: (one of never, delayed, on_disconnect)
- sim_failback_disconnect_mode: (ping)
- sims: required(array of object)
Items: items
- id: required(string)
- slot: required(number - minimum: 1 - maximum: 2)
- apn: (string)
- username: (string)
- password: (string)
[sensitive]
- iptype: (string)
- failback_delay: (number - minimum: 5)
Delay before failback (in minutes)
- fail_probe_address: (string)
Network address to ping for connectivity testing
- fail_probe_interval: (number)
Test interval (in seconds)
- fail_probe_count: (number)
Maximum ping count per test, stopping on the first success
- fail_probe_threshold: (number)
Number of consecutive test failures before failover/failback
- runtime_status: (object)
- id: required(string)
- iccid: (string)
- status: (string)
- apn: (string)
- bond_setting: (object)
- mode: required(one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb)
- poll_interval: (integer)
Specifies the MII link monitoring frequency in milliseconds. This determines how often the link state of each slave is inspected for link failures. A value of zero disables MII link monitoring.
- primary_slave: (string)
Reference to the primary interface which will be added to the bond first. This interface will be the preferred interface for applicable bond modes such as active_backup. Only nil if the bond has no slave interfaces.
- bridge_setting: (object)
- stp_enabled: (boolean)
Enable Spanning Tree Protocol (STP) on the bridge. STP communicates with other switches on the network to prevent bridge loops and allows for backup links to be used.
- primary_slave: (string)
This is a reference to the interface from which the bridge will inherit its MAC address.
- stp_enabled: (boolean)
- vlan_setting: (object)
- parent_physif: required(string)
Reference to the primary interface which will be used for this VLAN interface
- vlan_id: required(integer)
The VLAN tag ID associated with this VLAN interface
- parent_physif: required(string)
- slaves: (array of string)
A list of slave interface references.
- runtime_status: required(object)
- status: required(string)
- carrier: (string)
- id: required(string)
- physifs: required(array of object)
getPhysifList
- physifs: required(array of object)
A network physical interface
Items: items
- enabled: required(boolean)
- name: required(string)
- mtu: (number)
- device: required(string)
- mac_address: (string)
For Ethernet interfaces (including virtual Ethernet-based interfaces), the MAC address is returned in this property. For non-Ethernet interfaces, this property will be absent.
- description: required(string)
- media: required(string)
- id: required(string)
- master: (string)
The UUID of the aggregate physif if this interface belongs to one
- ethernet_setting: (object)
- link_speed: required(string)
- id: required(string)
- cellular_setting: (object)
- apn: (string)
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"apn":"apn"}]}},"since":"10/2020"}
- deprecatedProperty
- username: (string)
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"username":"username"}]}},"since":"10/2020"}
- deprecatedProperty
- password: (string)
[sensitive]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"password":"password"}]}},"since":"10/2020"}
- deprecatedProperty
- iptype: (string)
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"iptype":"IPv4v6"}]}},"since":"10/2020"}
- deprecatedProperty
- id: required(string)
- active_sim: (number - minimum: 1 - maximum: 2)
- sim_failover_policy: (one of never, on_disconnect)
- sim_failover_disconnect_mode: (ping)
- sim_failback_policy: (one of never, delayed, on_disconnect)
- sim_failback_disconnect_mode: (ping)
- sims: required(array of object)
Items: items
- id: required(string)
- slot: required(number - minimum: 1 - maximum: 2)
- apn: (string)
- username: (string)
- password: (string)
[sensitive]
- iptype: (string)
- failback_delay: (number - minimum: 5)
Delay before failback (in minutes)
- fail_probe_address: (string)
Network address to ping for connectivity testing
- fail_probe_interval: (number)
Test interval (in seconds)
- fail_probe_count: (number)
Maximum ping count per test, stopping on the first success
- fail_probe_threshold: (number)
Number of consecutive test failures before failover/failback
- runtime_status: (object)
- id: required(string)
- iccid: (string)
- status: (string)
- apn: (string)
- bond_setting: (object)
- mode: required(one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb)
- poll_interval: (integer)
Specifies the MII link monitoring frequency in milliseconds. This determines how often the link state of each slave is inspected for link failures. A value of zero disables MII link monitoring.
- primary_slave: (nil)
Reference to the primary interface which will be added to the bond first. This interface will be the preferred interface for applicable bond modes such as active_backup. Only nil if the bond has no slave interfaces.
- bridge_setting: (object)
- stp_enabled: (boolean)
Enable Spanning Tree Protocol (STP) on the bridge. STP communicates with other switches on the network to prevent bridge loops and allows for backup links to be used.
- primary_slave: (string)
This is a reference to the interface from which the bridge will inherit its MAC address.
- stp_enabled: (boolean)
- vlan_setting: (object)
- parent_physif: required(string)
Reference to the primary interface which will be used for this VLAN interface
- vlan_id: required(integer)
The VLAN tag ID associated with this VLAN interface
- parent_physif: required(string)
- slaves: (array of string)
A list of slave interface references.
- runtime_status: required(object)
- status: required(string)
- carrier: (string)
- id: required(string)
- physifs: required(array of object)
getPhysifList
- physifs: required(array of object)
A network physical interface
Items: items
- enabled: required(boolean)
- name: required(string)
- mtu: (number)
- device: required(string)
- mac_address: (string)
For Ethernet interfaces (including virtual Ethernet-based interfaces), the MAC address is returned in this property. For non-Ethernet interfaces, this property will be absent.
- description: required(string)
- media: required(string)
- id: required(string)
- master: (string)
The UUID of the aggregate physif if this interface belongs to one
- ethernet_setting: (object)
- link_speed: required(string)
- id: required(string)
- cellular_setting: (object)
- apn: (string)
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"apn":"apn"}]}},"since":"10/2020"}
- deprecatedProperty
- username: (string)
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"username":"username"}]}},"since":"10/2020"}
- deprecatedProperty
- password: (string)
[sensitive]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"password":"password"}]}},"since":"10/2020"}
- deprecatedProperty
- iptype: (string)
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"iptype":"IPv4v6"}]}},"since":"10/2020"}
- deprecatedProperty
- id: required(string)
- active_sim: (number - minimum: 1 - maximum: 2)
- sim_failover_policy: (one of never, on_disconnect)
- sim_failover_disconnect_mode: (ping)
- sim_failback_policy: (one of never, delayed, on_disconnect)
- sim_failback_disconnect_mode: (ping)
- sims: required(array of object)
Items: items
- id: required(string)
- slot: required(number - minimum: 1 - maximum: 2)
- apn: (string)
- username: (string)
- password: (string)
[sensitive]
- iptype: (string)
- failback_delay: (number - minimum: 5)
Delay before failback (in minutes)
- fail_probe_address: (string)
Network address to ping for connectivity testing
- fail_probe_interval: (number)
Test interval (in seconds)
- fail_probe_count: (number)
Maximum ping count per test, stopping on the first success
- fail_probe_threshold: (number)
Number of consecutive test failures before failover/failback
- runtime_status: (object)
- id: required(string)
- iccid: (string)
- status: (string)
- apn: (string)
- bond_setting: (object)
- mode: required(one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb)
- poll_interval: (integer)
Specifies the MII link monitoring frequency in milliseconds. This determines how often the link state of each slave is inspected for link failures. A value of zero disables MII link monitoring.
- primary_slave: (string)
Reference to the primary interface which will be added to the bond first. This interface will be the preferred interface for applicable bond modes such as active_backup. Only nil if the bond has no slave interfaces.
- bridge_setting: (object)
- stp_enabled: (boolean)
Enable Spanning Tree Protocol (STP) on the bridge. STP communicates with other switches on the network to prevent bridge loops and allows for backup links to be used.
- primary_slave: (nil)
This is a reference to the interface from which the bridge will inherit its MAC address.
- stp_enabled: (boolean)
- vlan_setting: (object)
- parent_physif: required(string)
Reference to the primary interface which will be used for this VLAN interface
- vlan_id: required(integer)
The VLAN tag ID associated with this VLAN interface
- parent_physif: required(string)
- slaves: (array of string)
A list of slave interface references.
- runtime_status: required(object)
- status: required(string)
- carrier: (string)
- id: required(string)
- physifs: required(array of object)
getPhysifList
- physifs: required(array of object)
A network physical interface
Items: items
- enabled: required(boolean)
- name: required(string)
- mtu: (number)
- device: required(string)
- mac_address: (string)
For Ethernet interfaces (including virtual Ethernet-based interfaces), the MAC address is returned in this property. For non-Ethernet interfaces, this property will be absent.
- description: required(string)
- media: required(string)
- id: required(string)
- master: (string)
The UUID of the aggregate physif if this interface belongs to one
- ethernet_setting: (object)
- link_speed: required(string)
- id: required(string)
- cellular_setting: (object)
- apn: (string)
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"apn":"apn"}]}},"since":"10/2020"}
- deprecatedProperty
- username: (string)
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"username":"username"}]}},"since":"10/2020"}
- deprecatedProperty
- password: (string)
[sensitive]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"password":"password"}]}},"since":"10/2020"}
- deprecatedProperty
- iptype: (string)
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"iptype":"IPv4v6"}]}},"since":"10/2020"}
- deprecatedProperty
- id: required(string)
- active_sim: (number - minimum: 1 - maximum: 2)
- sim_failover_policy: (one of never, on_disconnect)
- sim_failover_disconnect_mode: (ping)
- sim_failback_policy: (one of never, delayed, on_disconnect)
- sim_failback_disconnect_mode: (ping)
- sims: required(array of object)
Items: items
- id: required(string)
- slot: required(number - minimum: 1 - maximum: 2)
- apn: (string)
- username: (string)
- password: (string)
[sensitive]
- iptype: (string)
- failback_delay: (number - minimum: 5)
Delay before failback (in minutes)
- fail_probe_address: (string)
Network address to ping for connectivity testing
- fail_probe_interval: (number)
Test interval (in seconds)
- fail_probe_count: (number)
Maximum ping count per test, stopping on the first success
- fail_probe_threshold: (number)
Number of consecutive test failures before failover/failback
- runtime_status: (object)
- id: required(string)
- iccid: (string)
- status: (string)
- apn: (string)
- bond_setting: (object)
- mode: required(one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb)
- poll_interval: (integer)
Specifies the MII link monitoring frequency in milliseconds. This determines how often the link state of each slave is inspected for link failures. A value of zero disables MII link monitoring.
- primary_slave: (nil)
Reference to the primary interface which will be added to the bond first. This interface will be the preferred interface for applicable bond modes such as active_backup. Only nil if the bond has no slave interfaces.
- bridge_setting: (object)
- stp_enabled: (boolean)
Enable Spanning Tree Protocol (STP) on the bridge. STP communicates with other switches on the network to prevent bridge loops and allows for backup links to be used.
- primary_slave: (nil)
This is a reference to the interface from which the bridge will inherit its MAC address.
- stp_enabled: (boolean)
- vlan_setting: (object)
- parent_physif: required(string)
Reference to the primary interface which will be used for this VLAN interface
- vlan_id: required(integer)
The VLAN tag ID associated with this VLAN interface
- parent_physif: required(string)
- slaves: (array of string)
A list of slave interface references.
- runtime_status: required(object)
- status: required(string)
- carrier: (string)
- id: required(string)
- physifs: required(array of object)
Example:
{
"physifs": [
{
"enabled": true,
"id": "system_net_physifs-1",
"name": "init_net1",
"media": "ethernet",
"mtu": 1500,
"device": "net1",
"mac_address": "00:00:de:ad:be:f1",
"runtime_status": {
"status": "UP",
"id": "system_net_physifs-1"
},
"ethernet_setting": {
"id": "system_net_physifs-1",
"link_speed": "auto"
},
"description": "NET1 - 10G SFP+"
},
{
"enabled": true,
"id": "system_net_physifs-2",
"name": "init_net2",
"media": "ethernet",
"mtu": 1400,
"device": "net2",
"mac_address": "00:00:de:ad:be:f1",
"runtime_status": {
"status": "UP",
"id": "system_net_physifs-2"
},
"ethernet_setting": {
"id": "system_net_physifs-2",
"link_speed": "auto"
},
"description": "NET2 - 1G Copper/SFP"
},
{
"enabled": false,
"id": "system_net_physifs-3",
"name": "init_cellular",
"media": "cellular",
"device": "wwan0",
"mac_address": "00:00:de:ad:be:f3",
"runtime_status": {
"id": "system_net_physifs-3_runtime_status",
"status": "ENABLED"
},
"cellular_setting": {
"id": "system_net_physifs-3_cellular_setting",
"primary_sim": 2,
"sim_failover_policy": "never",
"sim_failback_policy": "never",
"sims": [
{
"id": "system_net_physifs-3_cellular_setting_sims-1",
"slot": 1,
"apn": "vzwinternet",
"iptype": "IPv4v6",
"runtime_status": {
"id": "system_net_physifs-3_cellular_setting_sims-1_runtime_status",
"status": "DISABLED"
}
},
{
"id": "system_net_physifs-3_cellular_setting_sims-2",
"slot": 2,
"apn": "i2gold",
"iptype": "IPv4v6",
"runtime_status": {
"id": "system_net_physifs-3_cellular_setting_sims-2_runtime_status",
"status": "ENABLED"
}
}
]
},
"description": "Cellular Interface (LTE)"
}
]
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
post /physifs
Add a new interface to the Operations Manager appliance.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Query Parameters
- secrets: (one of cleartext, obfuscate - default: cleartext)
Accepts sensitive fields as either cleartext or obfuscated values. The response will display the sensitive fields in the same way.
Body
Media type: application/json
Possible types:
postPhysif
- physif: required(object)
- enabled: required(boolean)
- mtu: (number)
- description: (string)
- media: required(one of bridge, bond, vlan)
- slaves: (array of string)
A list of physif uuids to become the aggregate slaves. Network connections and other settings from the first slave will be assigned to the aggregate. Network connections and other settings from other slaves will be removed. The first slave is set as the primary interface for a bond.
- bond_setting: (object)
- mode: required(one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb)
- poll_interval: (integer)
Specifies the MII link monitoring frequency in milliseconds. This determines how often the link state of each slave is inspected for link failures. A value of zero disables MII link monitoring.
- primary_slave: (string)
Reference to the primary interface which will be added to the bond first. This interface will be the preferred interface for applicable bond modes such as active_backup. Only nil if the bond has no slave interfaces.
- bridge_setting: (object)
- stp_enabled: (boolean)
Enable Spanning Tree Protocol (STP) on the bridge. STP communicates with other switches on the network to prevent bridge loops and allows for backup links to be used.
- primary_slave: (string)
This is a reference to the interface from which the bridge will inherit its MAC address.
- stp_enabled: (boolean)
- vlan_setting: (object)
- parent_physif: (string)
Primary physical interface used for vlan configuration
- vlan_id: (integer)
The VLAN identifier (VID) for this interface.
- parent_physif: (string)
- physif: required(object)
postPhysif
- physif: required(object)
- enabled: required(boolean)
- mtu: (number)
- description: (string)
- media: required(one of bridge, bond, vlan)
- slaves: (array of string)
A list of physif uuids to become the aggregate slaves. Network connections and other settings from the first slave will be assigned to the aggregate. Network connections and other settings from other slaves will be removed. The first slave is set as the primary interface for a bond.
- bond_setting: (object)
- mode: required(one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb)
- poll_interval: (integer)
Specifies the MII link monitoring frequency in milliseconds. This determines how often the link state of each slave is inspected for link failures. A value of zero disables MII link monitoring.
- primary_slave: (nil)
Reference to the primary interface which will be added to the bond first. This interface will be the preferred interface for applicable bond modes such as active_backup. Only nil if the bond has no slave interfaces.
- bridge_setting: (object)
- stp_enabled: (boolean)
Enable Spanning Tree Protocol (STP) on the bridge. STP communicates with other switches on the network to prevent bridge loops and allows for backup links to be used.
- primary_slave: (string)
This is a reference to the interface from which the bridge will inherit its MAC address.
- stp_enabled: (boolean)
- vlan_setting: (object)
- parent_physif: (string)
Primary physical interface used for vlan configuration
- vlan_id: (integer)
The VLAN identifier (VID) for this interface.
- parent_physif: (string)
- physif: required(object)
postPhysif
- physif: required(object)
- enabled: required(boolean)
- mtu: (number)
- description: (string)
- media: required(one of bridge, bond, vlan)
- slaves: (array of string)
A list of physif uuids to become the aggregate slaves. Network connections and other settings from the first slave will be assigned to the aggregate. Network connections and other settings from other slaves will be removed. The first slave is set as the primary interface for a bond.
- bond_setting: (object)
- mode: required(one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb)
- poll_interval: (integer)
Specifies the MII link monitoring frequency in milliseconds. This determines how often the link state of each slave is inspected for link failures. A value of zero disables MII link monitoring.
- primary_slave: (string)
Reference to the primary interface which will be added to the bond first. This interface will be the preferred interface for applicable bond modes such as active_backup. Only nil if the bond has no slave interfaces.
- bridge_setting: (object)
- stp_enabled: (boolean)
Enable Spanning Tree Protocol (STP) on the bridge. STP communicates with other switches on the network to prevent bridge loops and allows for backup links to be used.
- primary_slave: (nil)
This is a reference to the interface from which the bridge will inherit its MAC address.
- stp_enabled: (boolean)
- vlan_setting: (object)
- parent_physif: (string)
Primary physical interface used for vlan configuration
- vlan_id: (integer)
The VLAN identifier (VID) for this interface.
- parent_physif: (string)
- physif: required(object)
postPhysif
- physif: required(object)
- enabled: required(boolean)
- mtu: (number)
- description: (string)
- media: required(one of bridge, bond, vlan)
- slaves: (array of string)
A list of physif uuids to become the aggregate slaves. Network connections and other settings from the first slave will be assigned to the aggregate. Network connections and other settings from other slaves will be removed. The first slave is set as the primary interface for a bond.
- bond_setting: (object)
- mode: required(one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb)
- poll_interval: (integer)
Specifies the MII link monitoring frequency in milliseconds. This determines how often the link state of each slave is inspected for link failures. A value of zero disables MII link monitoring.
- primary_slave: (nil)
Reference to the primary interface which will be added to the bond first. This interface will be the preferred interface for applicable bond modes such as active_backup. Only nil if the bond has no slave interfaces.
- bridge_setting: (object)
- stp_enabled: (boolean)
Enable Spanning Tree Protocol (STP) on the bridge. STP communicates with other switches on the network to prevent bridge loops and allows for backup links to be used.
- primary_slave: (nil)
This is a reference to the interface from which the bridge will inherit its MAC address.
- stp_enabled: (boolean)
- vlan_setting: (object)
- parent_physif: (string)
Primary physical interface used for vlan configuration
- vlan_id: (integer)
The VLAN identifier (VID) for this interface.
- parent_physif: (string)
- physif: required(object)
Examples:
example1:
{
"physif": {
"enabled": true,
"media": "bridge",
"slaves": [
"net1",
"net2"
]
}
}example2:
{
"physif": {
"enabled": true,
"media": "bond",
"slaves": [
"net1",
"net2"
],
"bond_setting": {
"mode": "balance-rr"
}
}
}HTTP status code 200
The new physif is returned.
Body
Media type: application/json
Possible types:
physifItem
- physif: required(object)
A network physical interface
- enabled: required(boolean)
- name: required(string)
- mtu: (number)
- device: required(string)
- mac_address: (string)
For Ethernet interfaces (including virtual Ethernet-based interfaces), the MAC address is returned in this property. For non-Ethernet interfaces, this property will be absent.
- description: required(string)
- media: required(string)
- id: required(string)
- master: (string)
The UUID of the aggregate physif if this interface belongs to one
- ethernet_setting: (object)
- link_speed: required(string)
- id: required(string)
- cellular_setting: (object)
- apn: (string)
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"apn":"apn"}]}},"since":"10/2020"}
- deprecatedProperty
- username: (string)
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"username":"username"}]}},"since":"10/2020"}
- deprecatedProperty
- password: (string)
[sensitive]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"password":"password"}]}},"since":"10/2020"}
- deprecatedProperty
- iptype: (string)
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"iptype":"IPv4v6"}]}},"since":"10/2020"}
- deprecatedProperty
- id: required(string)
- active_sim: (number - minimum: 1 - maximum: 2)
- sim_failover_policy: (one of never, on_disconnect)
- sim_failover_disconnect_mode: (ping)
- sim_failback_policy: (one of never, delayed, on_disconnect)
- sim_failback_disconnect_mode: (ping)
- sims: required(array of object)
Items: items
- id: required(string)
- slot: required(number - minimum: 1 - maximum: 2)
- apn: (string)
- username: (string)
- password: (string)
[sensitive]
- iptype: (string)
- failback_delay: (number - minimum: 5)
Delay before failback (in minutes)
- fail_probe_address: (string)
Network address to ping for connectivity testing
- fail_probe_interval: (number)
Test interval (in seconds)
- fail_probe_count: (number)
Maximum ping count per test, stopping on the first success
- fail_probe_threshold: (number)
Number of consecutive test failures before failover/failback
- runtime_status: (object)
- id: required(string)
- iccid: (string)
- status: (string)
- apn: (string)
- bond_setting: (object)
- mode: required(one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb)
- poll_interval: (integer)
Specifies the MII link monitoring frequency in milliseconds. This determines how often the link state of each slave is inspected for link failures. A value of zero disables MII link monitoring.
- primary_slave: (string)
Reference to the primary interface which will be added to the bond first. This interface will be the preferred interface for applicable bond modes such as active_backup. Only nil if the bond has no slave interfaces.
- bridge_setting: (object)
- stp_enabled: (boolean)
Enable Spanning Tree Protocol (STP) on the bridge. STP communicates with other switches on the network to prevent bridge loops and allows for backup links to be used.
- primary_slave: (string)
This is a reference to the interface from which the bridge will inherit its MAC address.
- stp_enabled: (boolean)
- vlan_setting: (object)
- parent_physif: required(string)
Reference to the primary interface which will be used for this VLAN interface
- vlan_id: required(integer)
The VLAN tag ID associated with this VLAN interface
- parent_physif: required(string)
- slaves: (array of string)
A list of slave interface references.
- runtime_status: required(object)
- status: required(string)
- carrier: (string)
- id: required(string)
- physif: required(object)
physifItem
- physif: required(object)
A network physical interface
- enabled: required(boolean)
- name: required(string)
- mtu: (number)
- device: required(string)
- mac_address: (string)
For Ethernet interfaces (including virtual Ethernet-based interfaces), the MAC address is returned in this property. For non-Ethernet interfaces, this property will be absent.
- description: required(string)
- media: required(string)
- id: required(string)
- master: (string)
The UUID of the aggregate physif if this interface belongs to one
- ethernet_setting: (object)
- link_speed: required(string)
- id: required(string)
- cellular_setting: (object)
- apn: (string)
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"apn":"apn"}]}},"since":"10/2020"}
- deprecatedProperty
- username: (string)
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"username":"username"}]}},"since":"10/2020"}
- deprecatedProperty
- password: (string)
[sensitive]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"password":"password"}]}},"since":"10/2020"}
- deprecatedProperty
- iptype: (string)
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"iptype":"IPv4v6"}]}},"since":"10/2020"}
- deprecatedProperty
- id: required(string)
- active_sim: (number - minimum: 1 - maximum: 2)
- sim_failover_policy: (one of never, on_disconnect)
- sim_failover_disconnect_mode: (ping)
- sim_failback_policy: (one of never, delayed, on_disconnect)
- sim_failback_disconnect_mode: (ping)
- sims: required(array of object)
Items: items
- id: required(string)
- slot: required(number - minimum: 1 - maximum: 2)
- apn: (string)
- username: (string)
- password: (string)
[sensitive]
- iptype: (string)
- failback_delay: (number - minimum: 5)
Delay before failback (in minutes)
- fail_probe_address: (string)
Network address to ping for connectivity testing
- fail_probe_interval: (number)
Test interval (in seconds)
- fail_probe_count: (number)
Maximum ping count per test, stopping on the first success
- fail_probe_threshold: (number)
Number of consecutive test failures before failover/failback
- runtime_status: (object)
- id: required(string)
- iccid: (string)
- status: (string)
- apn: (string)
- bond_setting: (object)
- mode: required(one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb)
- poll_interval: (integer)
Specifies the MII link monitoring frequency in milliseconds. This determines how often the link state of each slave is inspected for link failures. A value of zero disables MII link monitoring.
- primary_slave: (nil)
Reference to the primary interface which will be added to the bond first. This interface will be the preferred interface for applicable bond modes such as active_backup. Only nil if the bond has no slave interfaces.
- bridge_setting: (object)
- stp_enabled: (boolean)
Enable Spanning Tree Protocol (STP) on the bridge. STP communicates with other switches on the network to prevent bridge loops and allows for backup links to be used.
- primary_slave: (string)
This is a reference to the interface from which the bridge will inherit its MAC address.
- stp_enabled: (boolean)
- vlan_setting: (object)
- parent_physif: required(string)
Reference to the primary interface which will be used for this VLAN interface
- vlan_id: required(integer)
The VLAN tag ID associated with this VLAN interface
- parent_physif: required(string)
- slaves: (array of string)
A list of slave interface references.
- runtime_status: required(object)
- status: required(string)
- carrier: (string)
- id: required(string)
- physif: required(object)
physifItem
- physif: required(object)
A network physical interface
- enabled: required(boolean)
- name: required(string)
- mtu: (number)
- device: required(string)
- mac_address: (string)
For Ethernet interfaces (including virtual Ethernet-based interfaces), the MAC address is returned in this property. For non-Ethernet interfaces, this property will be absent.
- description: required(string)
- media: required(string)
- id: required(string)
- master: (string)
The UUID of the aggregate physif if this interface belongs to one
- ethernet_setting: (object)
- link_speed: required(string)
- id: required(string)
- cellular_setting: (object)
- apn: (string)
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"apn":"apn"}]}},"since":"10/2020"}
- deprecatedProperty
- username: (string)
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"username":"username"}]}},"since":"10/2020"}
- deprecatedProperty
- password: (string)
[sensitive]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"password":"password"}]}},"since":"10/2020"}
- deprecatedProperty
- iptype: (string)
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"iptype":"IPv4v6"}]}},"since":"10/2020"}
- deprecatedProperty
- id: required(string)
- active_sim: (number - minimum: 1 - maximum: 2)
- sim_failover_policy: (one of never, on_disconnect)
- sim_failover_disconnect_mode: (ping)
- sim_failback_policy: (one of never, delayed, on_disconnect)
- sim_failback_disconnect_mode: (ping)
- sims: required(array of object)
Items: items
- id: required(string)
- slot: required(number - minimum: 1 - maximum: 2)
- apn: (string)
- username: (string)
- password: (string)
[sensitive]
- iptype: (string)
- failback_delay: (number - minimum: 5)
Delay before failback (in minutes)
- fail_probe_address: (string)
Network address to ping for connectivity testing
- fail_probe_interval: (number)
Test interval (in seconds)
- fail_probe_count: (number)
Maximum ping count per test, stopping on the first success
- fail_probe_threshold: (number)
Number of consecutive test failures before failover/failback
- runtime_status: (object)
- id: required(string)
- iccid: (string)
- status: (string)
- apn: (string)
- bond_setting: (object)
- mode: required(one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb)
- poll_interval: (integer)
Specifies the MII link monitoring frequency in milliseconds. This determines how often the link state of each slave is inspected for link failures. A value of zero disables MII link monitoring.
- primary_slave: (string)
Reference to the primary interface which will be added to the bond first. This interface will be the preferred interface for applicable bond modes such as active_backup. Only nil if the bond has no slave interfaces.
- bridge_setting: (object)
- stp_enabled: (boolean)
Enable Spanning Tree Protocol (STP) on the bridge. STP communicates with other switches on the network to prevent bridge loops and allows for backup links to be used.
- primary_slave: (nil)
This is a reference to the interface from which the bridge will inherit its MAC address.
- stp_enabled: (boolean)
- vlan_setting: (object)
- parent_physif: required(string)
Reference to the primary interface which will be used for this VLAN interface
- vlan_id: required(integer)
The VLAN tag ID associated with this VLAN interface
- parent_physif: required(string)
- slaves: (array of string)
A list of slave interface references.
- runtime_status: required(object)
- status: required(string)
- carrier: (string)
- id: required(string)
- physif: required(object)
physifItem
- physif: required(object)
A network physical interface
- enabled: required(boolean)
- name: required(string)
- mtu: (number)
- device: required(string)
- mac_address: (string)
For Ethernet interfaces (including virtual Ethernet-based interfaces), the MAC address is returned in this property. For non-Ethernet interfaces, this property will be absent.
- description: required(string)
- media: required(string)
- id: required(string)
- master: (string)
The UUID of the aggregate physif if this interface belongs to one
- ethernet_setting: (object)
- link_speed: required(string)
- id: required(string)
- cellular_setting: (object)
- apn: (string)
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"apn":"apn"}]}},"since":"10/2020"}
- deprecatedProperty
- username: (string)
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"username":"username"}]}},"since":"10/2020"}
- deprecatedProperty
- password: (string)
[sensitive]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"password":"password"}]}},"since":"10/2020"}
- deprecatedProperty
- iptype: (string)
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"iptype":"IPv4v6"}]}},"since":"10/2020"}
- deprecatedProperty
- id: required(string)
- active_sim: (number - minimum: 1 - maximum: 2)
- sim_failover_policy: (one of never, on_disconnect)
- sim_failover_disconnect_mode: (ping)
- sim_failback_policy: (one of never, delayed, on_disconnect)
- sim_failback_disconnect_mode: (ping)
- sims: required(array of object)
Items: items
- id: required(string)
- slot: required(number - minimum: 1 - maximum: 2)
- apn: (string)
- username: (string)
- password: (string)
[sensitive]
- iptype: (string)
- failback_delay: (number - minimum: 5)
Delay before failback (in minutes)
- fail_probe_address: (string)
Network address to ping for connectivity testing
- fail_probe_interval: (number)
Test interval (in seconds)
- fail_probe_count: (number)
Maximum ping count per test, stopping on the first success
- fail_probe_threshold: (number)
Number of consecutive test failures before failover/failback
- runtime_status: (object)
- id: required(string)
- iccid: (string)
- status: (string)
- apn: (string)
- bond_setting: (object)
- mode: required(one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb)
- poll_interval: (integer)
Specifies the MII link monitoring frequency in milliseconds. This determines how often the link state of each slave is inspected for link failures. A value of zero disables MII link monitoring.
- primary_slave: (nil)
Reference to the primary interface which will be added to the bond first. This interface will be the preferred interface for applicable bond modes such as active_backup. Only nil if the bond has no slave interfaces.
- bridge_setting: (object)
- stp_enabled: (boolean)
Enable Spanning Tree Protocol (STP) on the bridge. STP communicates with other switches on the network to prevent bridge loops and allows for backup links to be used.
- primary_slave: (nil)
This is a reference to the interface from which the bridge will inherit its MAC address.
- stp_enabled: (boolean)
- vlan_setting: (object)
- parent_physif: required(string)
Reference to the primary interface which will be used for this VLAN interface
- vlan_id: required(integer)
The VLAN tag ID associated with this VLAN interface
- parent_physif: required(string)
- slaves: (array of string)
A list of slave interface references.
- runtime_status: required(object)
- status: required(string)
- carrier: (string)
- id: required(string)
- physif: required(object)
Example:
{
"physif": {
"id": "system_net_physifs-5",
"enabled": true,
"name": "init_br0",
"media": "bridge",
"device": "br0",
"mac_address": "00:00:de:ad:be:f1",
"description": "BR0 - Aggregate",
"slaves": [
"net1",
"net2"
],
"runtime_status": {
"status": "UP",
"id": "system_net_physifs-5"
}
}
}HTTP status code 400
Validation failure. For example, invalid or missing fields. Slave interfaces not valid.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Get a network interface on the Operations Manager appliance by id.
Update settings for a network interface on the Operations Manager appliance
Delete a network interface by id. Currently only aggregate interfaces can be deleted.
get /physifs/{id}
Get a network interface on the Operations Manager appliance by id.
Operations Manager base authentication scheme
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Query Parameters
- secrets: (one of cleartext, obfuscate, mask - default: cleartext)
Returns sensitive fields displayed as either cleartext, obfuscated or masked values.
HTTP status code 200
Body
Media type: application/json
Possible types:
physifItem
- physif: required(object)
A network physical interface
- enabled: required(boolean)
- name: required(string)
- mtu: (number)
- device: required(string)
- mac_address: (string)
For Ethernet interfaces (including virtual Ethernet-based interfaces), the MAC address is returned in this property. For non-Ethernet interfaces, this property will be absent.
- description: required(string)
- media: required(string)
- id: required(string)
- master: (string)
The UUID of the aggregate physif if this interface belongs to one
- ethernet_setting: (object)
- link_speed: required(string)
- id: required(string)
- cellular_setting: (object)
- apn: (string)
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"apn":"apn"}]}},"since":"10/2020"}
- deprecatedProperty
- username: (string)
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"username":"username"}]}},"since":"10/2020"}
- deprecatedProperty
- password: (string)
[sensitive]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"password":"password"}]}},"since":"10/2020"}
- deprecatedProperty
- iptype: (string)
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"iptype":"IPv4v6"}]}},"since":"10/2020"}
- deprecatedProperty
- id: required(string)
- active_sim: (number - minimum: 1 - maximum: 2)
- sim_failover_policy: (one of never, on_disconnect)
- sim_failover_disconnect_mode: (ping)
- sim_failback_policy: (one of never, delayed, on_disconnect)
- sim_failback_disconnect_mode: (ping)
- sims: required(array of object)
Items: items
- id: required(string)
- slot: required(number - minimum: 1 - maximum: 2)
- apn: (string)
- username: (string)
- password: (string)
[sensitive]
- iptype: (string)
- failback_delay: (number - minimum: 5)
Delay before failback (in minutes)
- fail_probe_address: (string)
Network address to ping for connectivity testing
- fail_probe_interval: (number)
Test interval (in seconds)
- fail_probe_count: (number)
Maximum ping count per test, stopping on the first success
- fail_probe_threshold: (number)
Number of consecutive test failures before failover/failback
- runtime_status: (object)
- id: required(string)
- iccid: (string)
- status: (string)
- apn: (string)
- bond_setting: (object)
- mode: required(one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb)
- poll_interval: (integer)
Specifies the MII link monitoring frequency in milliseconds. This determines how often the link state of each slave is inspected for link failures. A value of zero disables MII link monitoring.
- primary_slave: (string)
Reference to the primary interface which will be added to the bond first. This interface will be the preferred interface for applicable bond modes such as active_backup. Only nil if the bond has no slave interfaces.
- bridge_setting: (object)
- stp_enabled: (boolean)
Enable Spanning Tree Protocol (STP) on the bridge. STP communicates with other switches on the network to prevent bridge loops and allows for backup links to be used.
- primary_slave: (string)
This is a reference to the interface from which the bridge will inherit its MAC address.
- stp_enabled: (boolean)
- vlan_setting: (object)
- parent_physif: required(string)
Reference to the primary interface which will be used for this VLAN interface
- vlan_id: required(integer)
The VLAN tag ID associated with this VLAN interface
- parent_physif: required(string)
- slaves: (array of string)
A list of slave interface references.
- runtime_status: required(object)
- status: required(string)
- carrier: (string)
- id: required(string)
- physif: required(object)
physifItem
- physif: required(object)
A network physical interface
- enabled: required(boolean)
- name: required(string)
- mtu: (number)
- device: required(string)
- mac_address: (string)
For Ethernet interfaces (including virtual Ethernet-based interfaces), the MAC address is returned in this property. For non-Ethernet interfaces, this property will be absent.
- description: required(string)
- media: required(string)
- id: required(string)
- master: (string)
The UUID of the aggregate physif if this interface belongs to one
- ethernet_setting: (object)
- link_speed: required(string)
- id: required(string)
- cellular_setting: (object)
- apn: (string)
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"apn":"apn"}]}},"since":"10/2020"}
- deprecatedProperty
- username: (string)
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"username":"username"}]}},"since":"10/2020"}
- deprecatedProperty
- password: (string)
[sensitive]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"password":"password"}]}},"since":"10/2020"}
- deprecatedProperty
- iptype: (string)
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"iptype":"IPv4v6"}]}},"since":"10/2020"}
- deprecatedProperty
- id: required(string)
- active_sim: (number - minimum: 1 - maximum: 2)
- sim_failover_policy: (one of never, on_disconnect)
- sim_failover_disconnect_mode: (ping)
- sim_failback_policy: (one of never, delayed, on_disconnect)
- sim_failback_disconnect_mode: (ping)
- sims: required(array of object)
Items: items
- id: required(string)
- slot: required(number - minimum: 1 - maximum: 2)
- apn: (string)
- username: (string)
- password: (string)
[sensitive]
- iptype: (string)
- failback_delay: (number - minimum: 5)
Delay before failback (in minutes)
- fail_probe_address: (string)
Network address to ping for connectivity testing
- fail_probe_interval: (number)
Test interval (in seconds)
- fail_probe_count: (number)
Maximum ping count per test, stopping on the first success
- fail_probe_threshold: (number)
Number of consecutive test failures before failover/failback
- runtime_status: (object)
- id: required(string)
- iccid: (string)
- status: (string)
- apn: (string)
- bond_setting: (object)
- mode: required(one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb)
- poll_interval: (integer)
Specifies the MII link monitoring frequency in milliseconds. This determines how often the link state of each slave is inspected for link failures. A value of zero disables MII link monitoring.
- primary_slave: (nil)
Reference to the primary interface which will be added to the bond first. This interface will be the preferred interface for applicable bond modes such as active_backup. Only nil if the bond has no slave interfaces.
- bridge_setting: (object)
- stp_enabled: (boolean)
Enable Spanning Tree Protocol (STP) on the bridge. STP communicates with other switches on the network to prevent bridge loops and allows for backup links to be used.
- primary_slave: (string)
This is a reference to the interface from which the bridge will inherit its MAC address.
- stp_enabled: (boolean)
- vlan_setting: (object)
- parent_physif: required(string)
Reference to the primary interface which will be used for this VLAN interface
- vlan_id: required(integer)
The VLAN tag ID associated with this VLAN interface
- parent_physif: required(string)
- slaves: (array of string)
A list of slave interface references.
- runtime_status: required(object)
- status: required(string)
- carrier: (string)
- id: required(string)
- physif: required(object)
physifItem
- physif: required(object)
A network physical interface
- enabled: required(boolean)
- name: required(string)
- mtu: (number)
- device: required(string)
- mac_address: (string)
For Ethernet interfaces (including virtual Ethernet-based interfaces), the MAC address is returned in this property. For non-Ethernet interfaces, this property will be absent.
- description: required(string)
- media: required(string)
- id: required(string)
- master: (string)
The UUID of the aggregate physif if this interface belongs to one
- ethernet_setting: (object)
- link_speed: required(string)
- id: required(string)
- cellular_setting: (object)
- apn: (string)
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"apn":"apn"}]}},"since":"10/2020"}
- deprecatedProperty
- username: (string)
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"username":"username"}]}},"since":"10/2020"}
- deprecatedProperty
- password: (string)
[sensitive]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"password":"password"}]}},"since":"10/2020"}
- deprecatedProperty
- iptype: (string)
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"iptype":"IPv4v6"}]}},"since":"10/2020"}
- deprecatedProperty
- id: required(string)
- active_sim: (number - minimum: 1 - maximum: 2)
- sim_failover_policy: (one of never, on_disconnect)
- sim_failover_disconnect_mode: (ping)
- sim_failback_policy: (one of never, delayed, on_disconnect)
- sim_failback_disconnect_mode: (ping)
- sims: required(array of object)
Items: items
- id: required(string)
- slot: required(number - minimum: 1 - maximum: 2)
- apn: (string)
- username: (string)
- password: (string)
[sensitive]
- iptype: (string)
- failback_delay: (number - minimum: 5)
Delay before failback (in minutes)
- fail_probe_address: (string)
Network address to ping for connectivity testing
- fail_probe_interval: (number)
Test interval (in seconds)
- fail_probe_count: (number)
Maximum ping count per test, stopping on the first success
- fail_probe_threshold: (number)
Number of consecutive test failures before failover/failback
- runtime_status: (object)
- id: required(string)
- iccid: (string)
- status: (string)
- apn: (string)
- bond_setting: (object)
- mode: required(one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb)
- poll_interval: (integer)
Specifies the MII link monitoring frequency in milliseconds. This determines how often the link state of each slave is inspected for link failures. A value of zero disables MII link monitoring.
- primary_slave: (string)
Reference to the primary interface which will be added to the bond first. This interface will be the preferred interface for applicable bond modes such as active_backup. Only nil if the bond has no slave interfaces.
- bridge_setting: (object)
- stp_enabled: (boolean)
Enable Spanning Tree Protocol (STP) on the bridge. STP communicates with other switches on the network to prevent bridge loops and allows for backup links to be used.
- primary_slave: (nil)
This is a reference to the interface from which the bridge will inherit its MAC address.
- stp_enabled: (boolean)
- vlan_setting: (object)
- parent_physif: required(string)
Reference to the primary interface which will be used for this VLAN interface
- vlan_id: required(integer)
The VLAN tag ID associated with this VLAN interface
- parent_physif: required(string)
- slaves: (array of string)
A list of slave interface references.
- runtime_status: required(object)
- status: required(string)
- carrier: (string)
- id: required(string)
- physif: required(object)
physifItem
- physif: required(object)
A network physical interface
- enabled: required(boolean)
- name: required(string)
- mtu: (number)
- device: required(string)
- mac_address: (string)
For Ethernet interfaces (including virtual Ethernet-based interfaces), the MAC address is returned in this property. For non-Ethernet interfaces, this property will be absent.
- description: required(string)
- media: required(string)
- id: required(string)
- master: (string)
The UUID of the aggregate physif if this interface belongs to one
- ethernet_setting: (object)
- link_speed: required(string)
- id: required(string)
- cellular_setting: (object)
- apn: (string)
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"apn":"apn"}]}},"since":"10/2020"}
- deprecatedProperty
- username: (string)
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"username":"username"}]}},"since":"10/2020"}
- deprecatedProperty
- password: (string)
[sensitive]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"password":"password"}]}},"since":"10/2020"}
- deprecatedProperty
- iptype: (string)
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"iptype":"IPv4v6"}]}},"since":"10/2020"}
- deprecatedProperty
- id: required(string)
- active_sim: (number - minimum: 1 - maximum: 2)
- sim_failover_policy: (one of never, on_disconnect)
- sim_failover_disconnect_mode: (ping)
- sim_failback_policy: (one of never, delayed, on_disconnect)
- sim_failback_disconnect_mode: (ping)
- sims: required(array of object)
Items: items
- id: required(string)
- slot: required(number - minimum: 1 - maximum: 2)
- apn: (string)
- username: (string)
- password: (string)
[sensitive]
- iptype: (string)
- failback_delay: (number - minimum: 5)
Delay before failback (in minutes)
- fail_probe_address: (string)
Network address to ping for connectivity testing
- fail_probe_interval: (number)
Test interval (in seconds)
- fail_probe_count: (number)
Maximum ping count per test, stopping on the first success
- fail_probe_threshold: (number)
Number of consecutive test failures before failover/failback
- runtime_status: (object)
- id: required(string)
- iccid: (string)
- status: (string)
- apn: (string)
- bond_setting: (object)
- mode: required(one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb)
- poll_interval: (integer)
Specifies the MII link monitoring frequency in milliseconds. This determines how often the link state of each slave is inspected for link failures. A value of zero disables MII link monitoring.
- primary_slave: (nil)
Reference to the primary interface which will be added to the bond first. This interface will be the preferred interface for applicable bond modes such as active_backup. Only nil if the bond has no slave interfaces.
- bridge_setting: (object)
- stp_enabled: (boolean)
Enable Spanning Tree Protocol (STP) on the bridge. STP communicates with other switches on the network to prevent bridge loops and allows for backup links to be used.
- primary_slave: (nil)
This is a reference to the interface from which the bridge will inherit its MAC address.
- stp_enabled: (boolean)
- vlan_setting: (object)
- parent_physif: required(string)
Reference to the primary interface which will be used for this VLAN interface
- vlan_id: required(integer)
The VLAN tag ID associated with this VLAN interface
- parent_physif: required(string)
- slaves: (array of string)
A list of slave interface references.
- runtime_status: required(object)
- status: required(string)
- carrier: (string)
- id: required(string)
- physif: required(object)
Example:
{
"physif": {
"enabled": true,
"id": "system_net_physifs-2",
"name": "init_net2",
"media": "ethernet",
"device": "net2",
"mac_address": "00:00:de:ad:be:f0",
"runtime_status": {
"status": "UP",
"id": "system_net_physifs-2"
},
"ethernet_setting": {
"id": "system_net_physifs-2",
"link_speed": "auto"
},
"description": "NET2 - 1G Copper/SFP"
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /physifs/{id}
Update settings for a network interface on the Operations Manager appliance
Operations Manager base authentication scheme
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Query Parameters
- secrets: (one of cleartext, obfuscate - default: cleartext)
Accepts sensitive fields as either cleartext or obfuscated values. The response will display the sensitive fields in the same way.
Body
Media type: application/json
Possible types:
putPhysif
- physif: required(object)
- enabled: required(boolean)
- mtu: (number)
- description: (string)
- ethernet_setting: (object)
- link_speed: required(string)
- cellular_setting: (object)
- apn: (string)
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"apn":"apn"}]}},"since":"10/2020"}
- deprecatedProperty
- username: (string)
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"username":"username"}]}},"since":"10/2020"}
- deprecatedProperty
- password: (string)
[sensitive]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"password":"password"}]}},"since":"10/2020"}
- deprecatedProperty
- iptype: (string)
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"iptype":"IPv4v6"}]}},"since":"10/2020"}
- deprecatedProperty
- id: required(string)
- active_sim: (number - minimum: 1 - maximum: 2)
- sim_failover_policy: (one of never, on_disconnect)
- sim_failover_disconnect_mode: (ping)
- sim_failback_policy: (one of never, delayed, on_disconnect)
- sim_failback_disconnect_mode: (ping)
- sims: required(array of object)
Items: items
- id: required(string)
- slot: (number - minimum: 1 - maximum: 2)
- apn: (string)
- username: (string)
- password: (string)
[sensitive]
- iptype: (string)
- failback_delay: (number - minimum: 5)
Delay before failback (in minutes)
- fail_probe_address: (string)
Network address to ping for connectivity testing
- fail_probe_interval: (number)
Test interval (in seconds)
- fail_probe_count: (number)
Maximum ping count per test, stopping on the first success
- fail_probe_threshold: (number)
Number of consecutive test failures before failover/failback
- apn: (string)
- slaves: (array of string)
A list of slave interface references.
- bond_setting: (object)
- mode: required(one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb)
- poll_interval: (integer)
Specifies the MII link monitoring frequency in milliseconds. This determines how often the link state of each slave is inspected for link failures. A value of zero disables MII link monitoring.
- primary_slave: (string)
Reference to the primary interface which will be added to the bond first. This interface will be the preferred interface for applicable bond modes such as active_backup. Only nil if the bond has no slave interfaces.
- bridge_setting: (object)
- stp_enabled: (boolean)
Enable Spanning Tree Protocol (STP) on the bridge. STP communicates with other switches on the network to prevent bridge loops and allows for backup links to be used.
- primary_slave: (string)
This is a reference to the interface from which the bridge will inherit its MAC address.
- stp_enabled: (boolean)
- vlan_setting: (object)
- parent_physif: (string)
Primary physical interface used for vlan configuration
- vlan_id: (integer)
The VLAN identifier (VID) for this interface.
- parent_physif: (string)
- physif: required(object)
putPhysif
- physif: required(object)
- enabled: required(boolean)
- mtu: (number)
- description: (string)
- ethernet_setting: (object)
- link_speed: required(string)
- cellular_setting: (object)
- apn: (string)
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"apn":"apn"}]}},"since":"10/2020"}
- deprecatedProperty
- username: (string)
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"username":"username"}]}},"since":"10/2020"}
- deprecatedProperty
- password: (string)
[sensitive]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"password":"password"}]}},"since":"10/2020"}
- deprecatedProperty
- iptype: (string)
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"iptype":"IPv4v6"}]}},"since":"10/2020"}
- deprecatedProperty
- id: required(string)
- active_sim: (number - minimum: 1 - maximum: 2)
- sim_failover_policy: (one of never, on_disconnect)
- sim_failover_disconnect_mode: (ping)
- sim_failback_policy: (one of never, delayed, on_disconnect)
- sim_failback_disconnect_mode: (ping)
- sims: required(array of object)
Items: items
- id: required(string)
- slot: (number - minimum: 1 - maximum: 2)
- apn: (string)
- username: (string)
- password: (string)
[sensitive]
- iptype: (string)
- failback_delay: (number - minimum: 5)
Delay before failback (in minutes)
- fail_probe_address: (string)
Network address to ping for connectivity testing
- fail_probe_interval: (number)
Test interval (in seconds)
- fail_probe_count: (number)
Maximum ping count per test, stopping on the first success
- fail_probe_threshold: (number)
Number of consecutive test failures before failover/failback
- apn: (string)
- slaves: (array of string)
A list of slave interface references.
- bond_setting: (object)
- mode: required(one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb)
- poll_interval: (integer)
Specifies the MII link monitoring frequency in milliseconds. This determines how often the link state of each slave is inspected for link failures. A value of zero disables MII link monitoring.
- primary_slave: (nil)
Reference to the primary interface which will be added to the bond first. This interface will be the preferred interface for applicable bond modes such as active_backup. Only nil if the bond has no slave interfaces.
- bridge_setting: (object)
- stp_enabled: (boolean)
Enable Spanning Tree Protocol (STP) on the bridge. STP communicates with other switches on the network to prevent bridge loops and allows for backup links to be used.
- primary_slave: (string)
This is a reference to the interface from which the bridge will inherit its MAC address.
- stp_enabled: (boolean)
- vlan_setting: (object)
- parent_physif: (string)
Primary physical interface used for vlan configuration
- vlan_id: (integer)
The VLAN identifier (VID) for this interface.
- parent_physif: (string)
- physif: required(object)
putPhysif
- physif: required(object)
- enabled: required(boolean)
- mtu: (number)
- description: (string)
- ethernet_setting: (object)
- link_speed: required(string)
- cellular_setting: (object)
- apn: (string)
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"apn":"apn"}]}},"since":"10/2020"}
- deprecatedProperty
- username: (string)
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"username":"username"}]}},"since":"10/2020"}
- deprecatedProperty
- password: (string)
[sensitive]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"password":"password"}]}},"since":"10/2020"}
- deprecatedProperty
- iptype: (string)
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"iptype":"IPv4v6"}]}},"since":"10/2020"}
- deprecatedProperty
- id: required(string)
- active_sim: (number - minimum: 1 - maximum: 2)
- sim_failover_policy: (one of never, on_disconnect)
- sim_failover_disconnect_mode: (ping)
- sim_failback_policy: (one of never, delayed, on_disconnect)
- sim_failback_disconnect_mode: (ping)
- sims: required(array of object)
Items: items
- id: required(string)
- slot: (number - minimum: 1 - maximum: 2)
- apn: (string)
- username: (string)
- password: (string)
[sensitive]
- iptype: (string)
- failback_delay: (number - minimum: 5)
Delay before failback (in minutes)
- fail_probe_address: (string)
Network address to ping for connectivity testing
- fail_probe_interval: (number)
Test interval (in seconds)
- fail_probe_count: (number)
Maximum ping count per test, stopping on the first success
- fail_probe_threshold: (number)
Number of consecutive test failures before failover/failback
- apn: (string)
- slaves: (array of string)
A list of slave interface references.
- bond_setting: (object)
- mode: required(one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb)
- poll_interval: (integer)
Specifies the MII link monitoring frequency in milliseconds. This determines how often the link state of each slave is inspected for link failures. A value of zero disables MII link monitoring.
- primary_slave: (string)
Reference to the primary interface which will be added to the bond first. This interface will be the preferred interface for applicable bond modes such as active_backup. Only nil if the bond has no slave interfaces.
- bridge_setting: (object)
- stp_enabled: (boolean)
Enable Spanning Tree Protocol (STP) on the bridge. STP communicates with other switches on the network to prevent bridge loops and allows for backup links to be used.
- primary_slave: (nil)
This is a reference to the interface from which the bridge will inherit its MAC address.
- stp_enabled: (boolean)
- vlan_setting: (object)
- parent_physif: (string)
Primary physical interface used for vlan configuration
- vlan_id: (integer)
The VLAN identifier (VID) for this interface.
- parent_physif: (string)
- physif: required(object)
putPhysif
- physif: required(object)
- enabled: required(boolean)
- mtu: (number)
- description: (string)
- ethernet_setting: (object)
- link_speed: required(string)
- cellular_setting: (object)
- apn: (string)
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"apn":"apn"}]}},"since":"10/2020"}
- deprecatedProperty
- username: (string)
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"username":"username"}]}},"since":"10/2020"}
- deprecatedProperty
- password: (string)
[sensitive]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"password":"password"}]}},"since":"10/2020"}
- deprecatedProperty
- iptype: (string)
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"iptype":"IPv4v6"}]}},"since":"10/2020"}
- deprecatedProperty
- id: required(string)
- active_sim: (number - minimum: 1 - maximum: 2)
- sim_failover_policy: (one of never, on_disconnect)
- sim_failover_disconnect_mode: (ping)
- sim_failback_policy: (one of never, delayed, on_disconnect)
- sim_failback_disconnect_mode: (ping)
- sims: required(array of object)
Items: items
- id: required(string)
- slot: (number - minimum: 1 - maximum: 2)
- apn: (string)
- username: (string)
- password: (string)
[sensitive]
- iptype: (string)
- failback_delay: (number - minimum: 5)
Delay before failback (in minutes)
- fail_probe_address: (string)
Network address to ping for connectivity testing
- fail_probe_interval: (number)
Test interval (in seconds)
- fail_probe_count: (number)
Maximum ping count per test, stopping on the first success
- fail_probe_threshold: (number)
Number of consecutive test failures before failover/failback
- apn: (string)
- slaves: (array of string)
A list of slave interface references.
- bond_setting: (object)
- mode: required(one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb)
- poll_interval: (integer)
Specifies the MII link monitoring frequency in milliseconds. This determines how often the link state of each slave is inspected for link failures. A value of zero disables MII link monitoring.
- primary_slave: (nil)
Reference to the primary interface which will be added to the bond first. This interface will be the preferred interface for applicable bond modes such as active_backup. Only nil if the bond has no slave interfaces.
- bridge_setting: (object)
- stp_enabled: (boolean)
Enable Spanning Tree Protocol (STP) on the bridge. STP communicates with other switches on the network to prevent bridge loops and allows for backup links to be used.
- primary_slave: (nil)
This is a reference to the interface from which the bridge will inherit its MAC address.
- stp_enabled: (boolean)
- vlan_setting: (object)
- parent_physif: (string)
Primary physical interface used for vlan configuration
- vlan_id: (integer)
The VLAN identifier (VID) for this interface.
- parent_physif: (string)
- physif: required(object)
Example:
{
"physif": {
"enabled": true,
"ethernet_setting": {
"link_speed": "auto"
}
}
}HTTP status code 200
The physif {id} settings was updated.
Body
Media type: application/json
Possible types:
physifItem
- physif: required(object)
A network physical interface
- enabled: required(boolean)
- name: required(string)
- mtu: (number)
- device: required(string)
- mac_address: (string)
For Ethernet interfaces (including virtual Ethernet-based interfaces), the MAC address is returned in this property. For non-Ethernet interfaces, this property will be absent.
- description: required(string)
- media: required(string)
- id: required(string)
- master: (string)
The UUID of the aggregate physif if this interface belongs to one
- ethernet_setting: (object)
- link_speed: required(string)
- id: required(string)
- cellular_setting: (object)
- apn: (string)
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"apn":"apn"}]}},"since":"10/2020"}
- deprecatedProperty
- username: (string)
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"username":"username"}]}},"since":"10/2020"}
- deprecatedProperty
- password: (string)
[sensitive]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"password":"password"}]}},"since":"10/2020"}
- deprecatedProperty
- iptype: (string)
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"iptype":"IPv4v6"}]}},"since":"10/2020"}
- deprecatedProperty
- id: required(string)
- active_sim: (number - minimum: 1 - maximum: 2)
- sim_failover_policy: (one of never, on_disconnect)
- sim_failover_disconnect_mode: (ping)
- sim_failback_policy: (one of never, delayed, on_disconnect)
- sim_failback_disconnect_mode: (ping)
- sims: required(array of object)
Items: items
- id: required(string)
- slot: required(number - minimum: 1 - maximum: 2)
- apn: (string)
- username: (string)
- password: (string)
[sensitive]
- iptype: (string)
- failback_delay: (number - minimum: 5)
Delay before failback (in minutes)
- fail_probe_address: (string)
Network address to ping for connectivity testing
- fail_probe_interval: (number)
Test interval (in seconds)
- fail_probe_count: (number)
Maximum ping count per test, stopping on the first success
- fail_probe_threshold: (number)
Number of consecutive test failures before failover/failback
- runtime_status: (object)
- id: required(string)
- iccid: (string)
- status: (string)
- apn: (string)
- bond_setting: (object)
- mode: required(one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb)
- poll_interval: (integer)
Specifies the MII link monitoring frequency in milliseconds. This determines how often the link state of each slave is inspected for link failures. A value of zero disables MII link monitoring.
- primary_slave: (string)
Reference to the primary interface which will be added to the bond first. This interface will be the preferred interface for applicable bond modes such as active_backup. Only nil if the bond has no slave interfaces.
- bridge_setting: (object)
- stp_enabled: (boolean)
Enable Spanning Tree Protocol (STP) on the bridge. STP communicates with other switches on the network to prevent bridge loops and allows for backup links to be used.
- primary_slave: (string)
This is a reference to the interface from which the bridge will inherit its MAC address.
- stp_enabled: (boolean)
- vlan_setting: (object)
- parent_physif: required(string)
Reference to the primary interface which will be used for this VLAN interface
- vlan_id: required(integer)
The VLAN tag ID associated with this VLAN interface
- parent_physif: required(string)
- slaves: (array of string)
A list of slave interface references.
- runtime_status: required(object)
- status: required(string)
- carrier: (string)
- id: required(string)
- physif: required(object)
physifItem
- physif: required(object)
A network physical interface
- enabled: required(boolean)
- name: required(string)
- mtu: (number)
- device: required(string)
- mac_address: (string)
For Ethernet interfaces (including virtual Ethernet-based interfaces), the MAC address is returned in this property. For non-Ethernet interfaces, this property will be absent.
- description: required(string)
- media: required(string)
- id: required(string)
- master: (string)
The UUID of the aggregate physif if this interface belongs to one
- ethernet_setting: (object)
- link_speed: required(string)
- id: required(string)
- cellular_setting: (object)
- apn: (string)
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"apn":"apn"}]}},"since":"10/2020"}
- deprecatedProperty
- username: (string)
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"username":"username"}]}},"since":"10/2020"}
- deprecatedProperty
- password: (string)
[sensitive]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"password":"password"}]}},"since":"10/2020"}
- deprecatedProperty
- iptype: (string)
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"iptype":"IPv4v6"}]}},"since":"10/2020"}
- deprecatedProperty
- id: required(string)
- active_sim: (number - minimum: 1 - maximum: 2)
- sim_failover_policy: (one of never, on_disconnect)
- sim_failover_disconnect_mode: (ping)
- sim_failback_policy: (one of never, delayed, on_disconnect)
- sim_failback_disconnect_mode: (ping)
- sims: required(array of object)
Items: items
- id: required(string)
- slot: required(number - minimum: 1 - maximum: 2)
- apn: (string)
- username: (string)
- password: (string)
[sensitive]
- iptype: (string)
- failback_delay: (number - minimum: 5)
Delay before failback (in minutes)
- fail_probe_address: (string)
Network address to ping for connectivity testing
- fail_probe_interval: (number)
Test interval (in seconds)
- fail_probe_count: (number)
Maximum ping count per test, stopping on the first success
- fail_probe_threshold: (number)
Number of consecutive test failures before failover/failback
- runtime_status: (object)
- id: required(string)
- iccid: (string)
- status: (string)
- apn: (string)
- bond_setting: (object)
- mode: required(one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb)
- poll_interval: (integer)
Specifies the MII link monitoring frequency in milliseconds. This determines how often the link state of each slave is inspected for link failures. A value of zero disables MII link monitoring.
- primary_slave: (nil)
Reference to the primary interface which will be added to the bond first. This interface will be the preferred interface for applicable bond modes such as active_backup. Only nil if the bond has no slave interfaces.
- bridge_setting: (object)
- stp_enabled: (boolean)
Enable Spanning Tree Protocol (STP) on the bridge. STP communicates with other switches on the network to prevent bridge loops and allows for backup links to be used.
- primary_slave: (string)
This is a reference to the interface from which the bridge will inherit its MAC address.
- stp_enabled: (boolean)
- vlan_setting: (object)
- parent_physif: required(string)
Reference to the primary interface which will be used for this VLAN interface
- vlan_id: required(integer)
The VLAN tag ID associated with this VLAN interface
- parent_physif: required(string)
- slaves: (array of string)
A list of slave interface references.
- runtime_status: required(object)
- status: required(string)
- carrier: (string)
- id: required(string)
- physif: required(object)
physifItem
- physif: required(object)
A network physical interface
- enabled: required(boolean)
- name: required(string)
- mtu: (number)
- device: required(string)
- mac_address: (string)
For Ethernet interfaces (including virtual Ethernet-based interfaces), the MAC address is returned in this property. For non-Ethernet interfaces, this property will be absent.
- description: required(string)
- media: required(string)
- id: required(string)
- master: (string)
The UUID of the aggregate physif if this interface belongs to one
- ethernet_setting: (object)
- link_speed: required(string)
- id: required(string)
- cellular_setting: (object)
- apn: (string)
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"apn":"apn"}]}},"since":"10/2020"}
- deprecatedProperty
- username: (string)
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"username":"username"}]}},"since":"10/2020"}
- deprecatedProperty
- password: (string)
[sensitive]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"password":"password"}]}},"since":"10/2020"}
- deprecatedProperty
- iptype: (string)
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"iptype":"IPv4v6"}]}},"since":"10/2020"}
- deprecatedProperty
- id: required(string)
- active_sim: (number - minimum: 1 - maximum: 2)
- sim_failover_policy: (one of never, on_disconnect)
- sim_failover_disconnect_mode: (ping)
- sim_failback_policy: (one of never, delayed, on_disconnect)
- sim_failback_disconnect_mode: (ping)
- sims: required(array of object)
Items: items
- id: required(string)
- slot: required(number - minimum: 1 - maximum: 2)
- apn: (string)
- username: (string)
- password: (string)
[sensitive]
- iptype: (string)
- failback_delay: (number - minimum: 5)
Delay before failback (in minutes)
- fail_probe_address: (string)
Network address to ping for connectivity testing
- fail_probe_interval: (number)
Test interval (in seconds)
- fail_probe_count: (number)
Maximum ping count per test, stopping on the first success
- fail_probe_threshold: (number)
Number of consecutive test failures before failover/failback
- runtime_status: (object)
- id: required(string)
- iccid: (string)
- status: (string)
- apn: (string)
- bond_setting: (object)
- mode: required(one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb)
- poll_interval: (integer)
Specifies the MII link monitoring frequency in milliseconds. This determines how often the link state of each slave is inspected for link failures. A value of zero disables MII link monitoring.
- primary_slave: (string)
Reference to the primary interface which will be added to the bond first. This interface will be the preferred interface for applicable bond modes such as active_backup. Only nil if the bond has no slave interfaces.
- bridge_setting: (object)
- stp_enabled: (boolean)
Enable Spanning Tree Protocol (STP) on the bridge. STP communicates with other switches on the network to prevent bridge loops and allows for backup links to be used.
- primary_slave: (nil)
This is a reference to the interface from which the bridge will inherit its MAC address.
- stp_enabled: (boolean)
- vlan_setting: (object)
- parent_physif: required(string)
Reference to the primary interface which will be used for this VLAN interface
- vlan_id: required(integer)
The VLAN tag ID associated with this VLAN interface
- parent_physif: required(string)
- slaves: (array of string)
A list of slave interface references.
- runtime_status: required(object)
- status: required(string)
- carrier: (string)
- id: required(string)
- physif: required(object)
physifItem
- physif: required(object)
A network physical interface
- enabled: required(boolean)
- name: required(string)
- mtu: (number)
- device: required(string)
- mac_address: (string)
For Ethernet interfaces (including virtual Ethernet-based interfaces), the MAC address is returned in this property. For non-Ethernet interfaces, this property will be absent.
- description: required(string)
- media: required(string)
- id: required(string)
- master: (string)
The UUID of the aggregate physif if this interface belongs to one
- ethernet_setting: (object)
- link_speed: required(string)
- id: required(string)
- cellular_setting: (object)
- apn: (string)
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"apn":"apn"}]}},"since":"10/2020"}
- deprecatedProperty
- username: (string)
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"username":"username"}]}},"since":"10/2020"}
- deprecatedProperty
- password: (string)
[sensitive]
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"password":"password"}]}},"since":"10/2020"}
- deprecatedProperty
- iptype: (string)
Annotations
- deprecatedProperty
{"replaceWith":{"cellular_setting":{"sims":[{"iptype":"IPv4v6"}]}},"since":"10/2020"}
- deprecatedProperty
- id: required(string)
- active_sim: (number - minimum: 1 - maximum: 2)
- sim_failover_policy: (one of never, on_disconnect)
- sim_failover_disconnect_mode: (ping)
- sim_failback_policy: (one of never, delayed, on_disconnect)
- sim_failback_disconnect_mode: (ping)
- sims: required(array of object)
Items: items
- id: required(string)
- slot: required(number - minimum: 1 - maximum: 2)
- apn: (string)
- username: (string)
- password: (string)
[sensitive]
- iptype: (string)
- failback_delay: (number - minimum: 5)
Delay before failback (in minutes)
- fail_probe_address: (string)
Network address to ping for connectivity testing
- fail_probe_interval: (number)
Test interval (in seconds)
- fail_probe_count: (number)
Maximum ping count per test, stopping on the first success
- fail_probe_threshold: (number)
Number of consecutive test failures before failover/failback
- runtime_status: (object)
- id: required(string)
- iccid: (string)
- status: (string)
- apn: (string)
- bond_setting: (object)
- mode: required(one of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb)
- poll_interval: (integer)
Specifies the MII link monitoring frequency in milliseconds. This determines how often the link state of each slave is inspected for link failures. A value of zero disables MII link monitoring.
- primary_slave: (nil)
Reference to the primary interface which will be added to the bond first. This interface will be the preferred interface for applicable bond modes such as active_backup. Only nil if the bond has no slave interfaces.
- bridge_setting: (object)
- stp_enabled: (boolean)
Enable Spanning Tree Protocol (STP) on the bridge. STP communicates with other switches on the network to prevent bridge loops and allows for backup links to be used.
- primary_slave: (nil)
This is a reference to the interface from which the bridge will inherit its MAC address.
- stp_enabled: (boolean)
- vlan_setting: (object)
- parent_physif: required(string)
Reference to the primary interface which will be used for this VLAN interface
- vlan_id: required(integer)
The VLAN tag ID associated with this VLAN interface
- parent_physif: required(string)
- slaves: (array of string)
A list of slave interface references.
- runtime_status: required(object)
- status: required(string)
- carrier: (string)
- id: required(string)
- physif: required(object)
Example:
{
"physif": {
"enabled": true,
"id": "system_net_physifs-2",
"name": "init_net2",
"media": "ethernet",
"device": "net2",
"mac_address": "00:00:de:ad:be:f0",
"runtime_status": {
"status": "UP",
"id": "system_net_physifs-2"
},
"ethernet_setting": {
"id": "system_net_physifs-2",
"link_speed": "auto"
},
"description": "NET2 - 1G Copper/SFP"
}
}HTTP status code 400
Invalid request: body is not json or does not conform to required json schema. Incomplete data: physif id parameter missing.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}HTTP status code 404
physif {id} does not exist. Attempted to change read only fields. Attempted to change unknown fields.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
delete /physifs/{id}
Delete a network interface by id. Currently only aggregate interfaces can be deleted.
Operations Manager base authentication scheme
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
The aggregate physif {id} was deleted.
HTTP status code 400
Incomplete data
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}HTTP status code 404
physif {id} does not exist. physif {id} is not an aggregate interface.
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
/conns
Read and manipulate the network connections on the Operations Manager appliance.
Get a list of the network connections on the server.
Add a new network connection to the Operations Manager appliance.
get /conns
Get a list of the network connections on the server.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Possible types:
getConnList
- conns: required(array of object)
Items: items
- id: (string)
- description: required(string)
- physif: required(string)
- name: required(string)
- mode: required(string)
- runtime_status: (object)
- status: required(string)
- last_status_change: required(number)
- id: required(string)
- addresses: required(array of object)
Items: conn_return_status_ipv4_address
- id: required(string)
- address: (string)
- netmask: (string)
- gateway: required(string)
- dns1: required(string)
- dns2: required(string)
- ipv4_static_settings: (object)
- id: required(string)
- netmask: required(string)
- address: required(string)
- broadcast: (string)
- gateway: (string)
- dns1: (string)
- dns2: (string)
- ipv6_static_settings: (object)
- id: required(string)
- prefix_length: required(string)
- address: required(string)
- gateway: (string)
- dns1: (string)
- dns2: (string)
- conns: required(array of object)
getConnList
- conns: required(array of object)
Items: items
- id: (string)
- description: required(string)
- physif: required(string)
- name: required(string)
- mode: required(string)
- runtime_status: (object)
- status: required(string)
- last_status_change: required(number)
- id: required(string)
- addresses: required(array of object)
Items: conn_return_status_ipv6_address
- id: required(string)
- address: (string)
- prefix_length: (number)
- gateway: required(string)
- dns1: required(string)
- dns2: required(string)
- ipv4_static_settings: (object)
- id: required(string)
- netmask: required(string)
- address: required(string)
- broadcast: (string)
- gateway: (string)
- dns1: (string)
- dns2: (string)
- ipv6_static_settings: (object)
- id: required(string)
- prefix_length: required(string)
- address: required(string)
- gateway: (string)
- dns1: (string)
- dns2: (string)
- conns: required(array of object)
Example:
{
"conns": [
{
"name": "default-conn-1",
"description": "IPv4 static network connection",
"physif": "net1",
"mode": "static",
"ipv4_static_settings": {
"id": "system_net_conns-1",
"netmask": "255.255.255.0",
"address": "192.168.87.156",
"gateway": "192.168.87.100",
"broadcast": "192.168.87.255",
"dns1": "192.168.87.100",
"dns2": "192.168.87.100"
},
"runtime_status": {
"status": "running",
"last_status_change": 1471506633,
"id": "system_net_conns-1",
"addresses": [
{
"id": "system_net_conns-address-1",
"address": "192.168.87.156",
"netmask": "255.255.255.0"
}
],
"gateway": "192.168.87.254",
"dns1": "8.8.8.8",
"dns2": "192.168.33.254"
},
"id": "system_net_conns-1"
},
{
"name": "default-conn-2",
"description": "IPv6 static network connection",
"physif": "net1",
"mode": "ipv6_static",
"ipv6_static_settings": {
"id": "system_net_conns-1",
"address": "2001:b:c:d::8329",
"prefix_length": "64",
"gateway": "2001:b:c:d::254",
"dns1": "DDDD:0002:3008:8CFD:00AB:0002:3008:AAAA",
"dns2": "DDDD:0002:3008:8CFD:00AB:0002:3008:BBBB"
},
"runtime_status": {
"status": "running",
"last_status_change": 1471506633,
"id": "system_net_conns-2",
"addresses": [
{
"id": "system_net_conns-2-address-1",
"address": "2001:b:c:d::8329",
"prefix_length": 64
},
{
"id": "system_net_conns-2-address-2",
"address": "2001:b:c:d::8320",
"netmask": "64"
}
],
"gateway": "192.168.87.254",
"dns1": "DDDD:0002:3008:8CFD:00AB:0002:3008:AAAA",
"dns2": "DDDD:0002:3008:8CFD:00AB:0002:3008:BBBB"
},
"id": "system_net_conns-3"
}
]
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
post /conns
Add a new network connection to the Operations Manager appliance.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- conn: required(object)
- mode: required(string)
- physif: required(string)
- ipv4_static_settings: (object)
- netmask: required(string)
- address: required(string)
- broadcast: (string)
- gateway: (string)
- dns1: (string)
- dns2: (string)
- ipv6_static_settings: (object)
- prefix_length: required(string)
- address: required(string)
- gateway: (string)
- dns1: (string)
- dns2: (string)
Example:
{
"conn": {
"ipv4_static_settings": {
"netmask": "255.255.255.0",
"address": "192.168.87.156",
"gateway": "192.168.87.100",
"broadcast": "192.168.87.255",
"dns1": "192.168.87.100",
"dns2": "192.168.87.100"
},
"mode": "static",
"physif": "net1"
}
}HTTP status code 200
The conn {id} settings was updated.
Body
Media type: application/json
Possible types:
connItem
- conn: required(object)
- name: (string)
- ipv4_static_settings: (object)
- id: (string)
- netmask: required(string)
- address: required(string)
- broadcast: (string)
- gateway: (string)
- dns1: (string)
- dns2: (string)
- ipv6_static_settings: (object)
- id: required(string)
- prefix_length: required(number)
- address: required(string)
- gateway: (string)
- dns1: (string)
- dns2: (string)
- id: (string)
- mode: required(string)
- description: (string)
- physif: required(string)
- runtime_status: (object)
- status: required(string)
- addresses: required(array of object)
Items: conn_return_status_ipv4_address
- id: required(string)
- address: (string)
- netmask: (string)
- last_status_change: required(number)
- id: required(string)
- conn: required(object)
connItem
- conn: required(object)
- name: (string)
- ipv4_static_settings: (object)
- id: (string)
- netmask: required(string)
- address: required(string)
- broadcast: (string)
- gateway: (string)
- dns1: (string)
- dns2: (string)
- ipv6_static_settings: (object)
- id: required(string)
- prefix_length: required(number)
- address: required(string)
- gateway: (string)
- dns1: (string)
- dns2: (string)
- id: (string)
- mode: required(string)
- description: (string)
- physif: required(string)
- runtime_status: (object)
- status: required(string)
- addresses: required(array of object)
Items: conn_return_status_ipv6_address
- id: required(string)
- address: (string)
- prefix_length: (number)
- last_status_change: required(number)
- id: required(string)
- conn: required(object)
Example:
{
"conn": {
"name": "default-conn-2",
"ipv4_static_settings": {
"netmask": "255.255.255.0",
"address": "192.168.87.156",
"gateway": "192.168.87.100",
"broadcast": "192.168.87.255",
"dns1": "192.168.87.100",
"dns2": "192.168.87.100"
},
"id": "system_net_conns-9",
"mode": "static",
"physif": "net1",
"runtime_status": {
"status": "reloading",
"addresses": [
{
"id": "system_net_conns-9"
}
],
"last_status_change": 1536209633,
"id": "system_net_conns-9"
}
}
}HTTP status code 400
Invalid request: body is not json or does not conform to required json schema. Incomplete data: conn id parameter missing.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}HTTP status code 404
Conn {id} does not exist. Attempted to change read only fields. Attempted to change unknown fields.
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Get the configuration of a network connection on the Operations Manager appliance
Update settings for a network connection on the Operations Manager appliance.
Delete a network connection on the Operations Manager appliance.
get /conns/{id}
Get the configuration of a network connection on the Operations Manager appliance
Operations Manager base authentication scheme
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Possible types:
connItem
- conn: required(object)
- name: (string)
- ipv4_static_settings: (object)
- id: (string)
- netmask: required(string)
- address: required(string)
- broadcast: (string)
- gateway: (string)
- dns1: (string)
- dns2: (string)
- ipv6_static_settings: (object)
- id: required(string)
- prefix_length: required(number)
- address: required(string)
- gateway: (string)
- dns1: (string)
- dns2: (string)
- id: (string)
- mode: required(string)
- description: (string)
- physif: required(string)
- runtime_status: (object)
- status: required(string)
- addresses: required(array of object)
Items: conn_return_status_ipv4_address
- id: required(string)
- address: (string)
- netmask: (string)
- last_status_change: required(number)
- id: required(string)
- conn: required(object)
connItem
- conn: required(object)
- name: (string)
- ipv4_static_settings: (object)
- id: (string)
- netmask: required(string)
- address: required(string)
- broadcast: (string)
- gateway: (string)
- dns1: (string)
- dns2: (string)
- ipv6_static_settings: (object)
- id: required(string)
- prefix_length: required(number)
- address: required(string)
- gateway: (string)
- dns1: (string)
- dns2: (string)
- id: (string)
- mode: required(string)
- description: (string)
- physif: required(string)
- runtime_status: (object)
- status: required(string)
- addresses: required(array of object)
Items: conn_return_status_ipv6_address
- id: required(string)
- address: (string)
- prefix_length: (number)
- last_status_change: required(number)
- id: required(string)
- conn: required(object)
Example:
{
"conn": {
"name": "default-conn-1",
"ipv4_static_settings": {
"id": "system_net_conns-1",
"netmask": "255.255.255.0",
"address": "192.168.87.156",
"gateway": "192.168.87.100",
"broadcast": "192.168.87.255",
"dns1": "192.168.87.100",
"dns2": "192.168.87.100"
},
"id": "system_net_conns-1",
"mode": "static",
"description": "Default static network connection",
"physif": "net1",
"runtime_status": {
"status": "reloading",
"addresses": [
{
"id": "system_net_conns-1"
}
],
"last_status_change": 1536210047,
"id": "system_net_conns-2"
}
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /conns/{id}
Update settings for a network connection on the Operations Manager appliance.
Operations Manager base authentication scheme
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- conn: required(object)
- mode: required(string)
- physif: required(string)
- ipv4_static_settings: (object)
- netmask: required(string)
- address: required(string)
- broadcast: (string)
- gateway: (string)
- dns1: (string)
- dns2: (string)
- ipv6_static_settings: (object)
- prefix_length: required(string)
- address: required(string)
- gateway: (string)
- dns1: (string)
- dns2: (string)
Example:
{
"conn": {
"ipv4_static_settings": {
"netmask": "255.255.255.0",
"address": "192.168.87.156",
"gateway": "192.168.87.100",
"broadcast": "192.168.87.255",
"dns1": "192.168.87.100",
"dns2": "192.168.87.100"
},
"mode": "static",
"physif": "net1"
}
}HTTP status code 200
The conn settings were updated.
Body
Media type: application/json
Possible types:
connItem
- conn: required(object)
- name: (string)
- ipv4_static_settings: (object)
- id: (string)
- netmask: required(string)
- address: required(string)
- broadcast: (string)
- gateway: (string)
- dns1: (string)
- dns2: (string)
- ipv6_static_settings: (object)
- id: required(string)
- prefix_length: required(number)
- address: required(string)
- gateway: (string)
- dns1: (string)
- dns2: (string)
- id: (string)
- mode: required(string)
- description: (string)
- physif: required(string)
- runtime_status: (object)
- status: required(string)
- addresses: required(array of object)
Items: conn_return_status_ipv4_address
- id: required(string)
- address: (string)
- netmask: (string)
- last_status_change: required(number)
- id: required(string)
- conn: required(object)
connItem
- conn: required(object)
- name: (string)
- ipv4_static_settings: (object)
- id: (string)
- netmask: required(string)
- address: required(string)
- broadcast: (string)
- gateway: (string)
- dns1: (string)
- dns2: (string)
- ipv6_static_settings: (object)
- id: required(string)
- prefix_length: required(number)
- address: required(string)
- gateway: (string)
- dns1: (string)
- dns2: (string)
- id: (string)
- mode: required(string)
- description: (string)
- physif: required(string)
- runtime_status: (object)
- status: required(string)
- addresses: required(array of object)
Items: conn_return_status_ipv6_address
- id: required(string)
- address: (string)
- prefix_length: (number)
- last_status_change: required(number)
- id: required(string)
- conn: required(object)
Example:
{
"conn": {
"name": "default-conn-2",
"ipv4_static_settings": {
"broadcast": "192.168.87.255",
"gateway": "192.168.87.100",
"address": "192.168.87.156",
"id": "system_net_conns-2",
"dns2": "192.168.87.100",
"dns1": "192.168.87.100",
"netmask": "255.255.255.0"
},
"id": "system_net_conns-2",
"mode": "static",
"physif": "net1",
"runtime_status": {
"status": "reloading",
"addresses": [
{
"id": "system_net_conns-2"
}
],
"last_status_change": 1536210052,
"id": "system_net_conns-2"
}
}
}HTTP status code 400
Invalid request: body is not json or does not conform to required json schema. Incomplete data: conn id parameter missing.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}HTTP status code 404
Conn {id} does not exist. Attempted to change read only fields. Attempted to change unknown fields.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
delete /conns/{id}
Delete a network connection on the Operations Manager appliance.
Operations Manager base authentication scheme
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Conn deleted
HTTP status code 400
Incomplete data
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}HTTP status code 404
User did not exist
Body
Media type: application/json
Type: object
Example:
{
"error": [
{
"type": 5,
"code": 29,
"text": "Could not find conn with name or id 'system_net_conns-1'",
"args": {
"uuid": "system_net_conns-1"
},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
/static_routes
Configuring and viewing static routes
Get list of static routes
Create a list of static routes. Overwrite existing routes
Add a static route
Delete all static routes
get /static_routes
Get list of static routes
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- static_routes: required(array of object)
The root object
Items: items
- destination_address: required(string)
The destination network/host that the route provides access to.
- destination_netmask: required(integer)
Netmask for IPv4/IPv6 (CIDR format).
- gateway_address: (string)
The IPv4/IPv6 address of the router gateway that will route packets to the destination address. If this property is not provided, the interface property must be given.
- interface: (string)
The network interface to be associated with the route. If this property is not provided, the gateway_address property must be given.
- metric: (integer)
The route metric, which represents the cost of routing packets via this route. Lower metric routes will be used in preference to higher metric routes
- id: required(string)
Unique id of item
- destination_address: required(string)
Examples:
example1:
Gets two static routes
{
"static_routes": [
{
"id": "system_net_static_routes-1",
"destination_address": "192.168.10.0",
"destination_netmask": 24,
"gateway_address": "192.168.0.1",
"interface": "net1",
"metric": 100
},
{
"id": "system_net_static_routes-2",
"destination_address": "192.168.20.0",
"destination_netmask": 24,
"gateway_address": "192.168.0.1",
"interface": "net2",
"metric": 100
}
]
}example2:
No static routes present
{
"static_routes": []
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /static_routes
Create a list of static routes. Overwrite existing routes
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- static_routes: required(array of object)
The root object
Items: items
- destination_address: required(string)
The destination network/host that the route provides access to.
- destination_netmask: required(integer)
Netmask for IPv4/IPv6 (CIDR format).
- gateway_address: (string)
The IPv4/IPv6 address of the router gateway that will route packets to the destination address. If this property is not provided, the interface property must be given.
- interface: (string)
The network interface to be associated with the route. If this property is not provided, the gateway_address property must be given.
- metric: (integer)
The route metric, which represents the cost of routing packets via this route. Lower metric routes will be used in preference to higher metric routes
- destination_address: required(string)
Example:
example1:
Sets two routes
{
"static_routes": [
{
"destination_address": "192.168.10.0",
"destination_netmask": 24,
"gateway_address": "192.168.0.1",
"interface": "net1",
"metric": 100
},
{
"destination_address": "192.168.20.0",
"destination_netmask": 24,
"gateway_address": "192.168.0.1",
"interface": "net2",
"metric": 100
}
]
}HTTP status code 200
List of static routes
Body
Media type: application/json
Type: object
Properties- static_routes: required(array of object)
The root object
Items: items
- destination_address: required(string)
The destination network/host that the route provides access to.
- destination_netmask: required(integer)
Netmask for IPv4/IPv6 (CIDR format).
- gateway_address: (string)
The IPv4/IPv6 address of the router gateway that will route packets to the destination address. If this property is not provided, the interface property must be given.
- interface: (string)
The network interface to be associated with the route. If this property is not provided, the gateway_address property must be given.
- metric: (integer)
The route metric, which represents the cost of routing packets via this route. Lower metric routes will be used in preference to higher metric routes
- id: required(string)
Unique id of item
- destination_address: required(string)
Example:
{
"static_routes": [
{
"id": "system_net_static_routes-1",
"destination_address": "192.168.10.0",
"destination_netmask": 24,
"gateway_address": "192.168.0.1",
"interface": "net1",
"metric": 100
},
{
"id": "system_net_static_routes-2",
"destination_address": "192.168.20.0",
"destination_netmask": 24,
"gateway_address": "192.168.0.1",
"interface": "net2",
"metric": 100
}
]
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
post /static_routes
Add a static route
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- static_route: required(object)
The root object
- destination_address: required(string)
The destination network/host that the route provides access to.
- destination_netmask: required(integer)
Netmask for IPv4/IPv6 (CIDR format).
- gateway_address: (string)
The IPv4/IPv6 address of the router gateway that will route packets to the destination address. If this property is not provided, the interface property must be given.
- interface: (string)
The network interface to be associated with the route. If this property is not provided, the gateway_address property must be given.
- metric: (integer)
The route metric, which represents the cost of routing packets via this route. Lower metric routes will be used in preference to higher metric routes
- destination_address: required(string)
Example:
{
"static_route": {
"destination_address": "192.168.10.0",
"destination_netmask": 24,
"gateway_address": "192.168.0.1",
"interface": "net1",
"metric": 100
}
}HTTP status code 200
Static route was created
Body
Media type: application/json
Type: object
Properties- static_route: required(object)
The root object
- destination_address: required(string)
The destination network/host that the route provides access to.
- destination_netmask: required(integer)
Netmask for IPv4/IPv6 (CIDR format).
- gateway_address: (string)
The IPv4/IPv6 address of the router gateway that will route packets to the destination address. If this property is not provided, the interface property must be given.
- interface: (string)
The network interface to be associated with the route. If this property is not provided, the gateway_address property must be given.
- metric: (integer)
The route metric, which represents the cost of routing packets via this route. Lower metric routes will be used in preference to higher metric routes
- id: required(string)
Unique id of item
- destination_address: required(string)
Example:
{
"static_route": {
"id": "system_net_static_routes-1",
"destination_address": "192.168.10.0",
"destination_netmask": 24,
"gateway_address": "192.168.0.1",
"interface": "net1",
"metric": 100
}
}HTTP status code 400
Failed to create static route
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
delete /static_routes
Delete all static routes
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 204
Static routes were removed
HTTP status code 400
Incomplete data
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Get the configuration of a static route by its id.
Update the configuration of a static route by its id.
Delete a static route
get /static_routes/{id}
Get the configuration of a static route by its id.
Operations Manager base authentication scheme
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
The requested static route configuration.
Body
Media type: application/json
Type: object
Properties- static_route: required(object)
The root object
- destination_address: required(string)
The destination network/host that the route provides access to.
- destination_netmask: required(integer)
Netmask for IPv4/IPv6 (CIDR format).
- gateway_address: (string)
The IPv4/IPv6 address of the router gateway that will route packets to the destination address. If this property is not provided, the interface property must be given.
- interface: (string)
The network interface to be associated with the route. If this property is not provided, the gateway_address property must be given.
- metric: (integer)
The route metric, which represents the cost of routing packets via this route. Lower metric routes will be used in preference to higher metric routes
- id: required(string)
Unique id of item
- destination_address: required(string)
Example:
{
"static_route": {
"id": "system_net_static_routes-1",
"destination_address": "192.168.10.0",
"destination_netmask": 24,
"gateway_address": "192.168.0.1",
"interface": "net1",
"metric": 100
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}HTTP status code 404
The static route doesn't exist.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 5,
"code": 29,
"text": "Could not find static_route with destination_address or id 'system_net_static_routes-1'",
"args": {
"uuid": "system_net_static_routes-1"
},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /static_routes/{id}
Update the configuration of a static route by its id.
Operations Manager base authentication scheme
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- static_route: required(object)
The root object
- destination_address: required(string)
The destination network/host that the route provides access to.
- destination_netmask: required(integer)
Netmask for IPv4/IPv6 (CIDR format).
- gateway_address: (string)
The IPv4/IPv6 address of the router gateway that will route packets to the destination address. If this property is not provided, the interface property must be given.
- interface: (string)
The network interface to be associated with the route. If this property is not provided, the gateway_address property must be given.
- metric: (integer)
The route metric, which represents the cost of routing packets via this route. Lower metric routes will be used in preference to higher metric routes
- destination_address: required(string)
Example:
{
"static_route": {
"destination_address": "192.168.10.0",
"destination_netmask": 24,
"gateway_address": "192.168.0.1",
"interface": "net1",
"metric": 100
}
}HTTP status code 200
The updated static route configuration.
Body
Media type: application/json
Type: object
Properties- static_route: required(object)
The root object
- destination_address: required(string)
The destination network/host that the route provides access to.
- destination_netmask: required(integer)
Netmask for IPv4/IPv6 (CIDR format).
- gateway_address: (string)
The IPv4/IPv6 address of the router gateway that will route packets to the destination address. If this property is not provided, the interface property must be given.
- interface: (string)
The network interface to be associated with the route. If this property is not provided, the gateway_address property must be given.
- metric: (integer)
The route metric, which represents the cost of routing packets via this route. Lower metric routes will be used in preference to higher metric routes
- id: required(string)
Unique id of item
- destination_address: required(string)
Example:
{
"static_route": {
"id": "system_net_static_routes-1",
"destination_address": "192.168.10.0",
"destination_netmask": 24,
"gateway_address": "192.168.0.1",
"interface": "net1",
"metric": 100
}
}HTTP status code 400
Invalid request: Body is not json or does not conform to required json schema.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}HTTP status code 404
The static route doesn't exist.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 5,
"code": 29,
"text": "Could not find static_route with destination_address or id 'system_net_static_routes-1'",
"args": {
"uuid": "system_net_static_routes-1"
},
"level": 1
}
]
}HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
delete /static_routes/{id}
Delete a static route
Operations Manager base authentication scheme
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 204
Static route deleted
HTTP status code 400
Static route does not exist
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
/lighthouse_enrollments
View and control enrollment to a lighthouse
Get the information about the lighthouse enrollments
Create a new lighthouse enrollment
get /lighthouse_enrollments
Get the information about the lighthouse enrollments
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- lighthouse-enrollments: required(array of object)
Items: items
- port: (integer)
- address: required(string)
- id: required(string)
- bundle: (string)
- status: required(string)
Example:
{
"lighthouse-enrollments": [
{
"port": 443,
"address": "192.168.0.1",
"id": "lighthouse_enrollments-1",
"bundle": "bundle",
"status": "Enrolling"
}
]
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
post /lighthouse_enrollments
Create a new lighthouse enrollment
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- lighthouse_enrollment: required(object)
- address: required(string)
- port: (integer)
- bundle: (string)
- token: required(string)
Example:
{
"lighthouse_enrollment": {
"address": "192.168.0.1",
"token": "password",
"bundle": "bundle-1",
"port": 8443
}
}HTTP status code 201
The new lighthouse enrollment was successfully created and callhome enrollment was started.
Body
Media type: application/json
Type: object
Properties- lighthouse_enrollment: required(object)
- port: (integer)
- address: required(string)
- id: required(string)
- bundle: (string)
- status: required(string)
Example:
{
"lighthouse_enrollment": {
"id": "lighthouse_enrollments-1",
"port": 8443,
"status": "Enrolling",
"address": "192.168.0.1"
}
}HTTP status code 400
Invalid request: body is not json or does not conform to required json schema.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Get lighthouse-enrollment information by id.
Delete lighthouse enrollment object and begin unenrollment
get /lighthouse_enrollments/{id}
Get lighthouse-enrollment information by id.
Operations Manager base authentication scheme
URI Parameters
- id: required(string)
ID of the lighthouse-enrollment to fetch
Example:
lighthouse_enrollment-2
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- lighthouse_enrollment: required(object)
- port: (integer)
- address: required(string)
- id: required(string)
- bundle: (string)
- status: required(string)
Example:
{
"lighthouse_enrollment": {
"id": "lighthouse_enrollments-2",
"port": 443,
"status": "Connected",
"address": "192.168.0.1"
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}HTTP status code 404
The lighthouse-enrollment doesn't exist.
Body
Media type: application/json
Type: object
Example:
{
"error": [
{
"type": 5,
"code": 29,
"text": "Could not find lighthouse_enrollment with address or id 'lighthouse_enrollments-6'",
"args": {
"uuid": "lighthouse_enrollments-6"
},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
delete /lighthouse_enrollments/{id}
Delete lighthouse enrollment object and begin unenrollment
Operations Manager base authentication scheme
URI Parameters
- id: required(string)
ID of the lighthouse-enrollment to fetch
Example:
lighthouse_enrollment-2
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Example:
{
"message": "OK"
}HTTP status code 400
Incomplete data
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}HTTP status code 404
Body
Media type: application/json
Type: object
Example:
{
"error": [
{
"type": 5,
"code": 29,
"text": "Could not find lighthouse_enrollment with address or id 'lighthouse_enrollments-20'",
"args": {
"uuid": "lighthouse_enrollments-20"
},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
/registration
Registration endpoint accessed by a Lighthouse to start Lighthouse driven enrollment
Initial contact from Lighthouse to start the Enrollment process
Remove connection to this lighthouse
post /registration
Initial contact from Lighthouse to start the Enrollment process
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- id: required(string)
- package_password: required(string)
- server: required(string)
- server_api_port: (integer)
- lh_ext_eps: (array of object)
Items: items
- server: required(string)
- server_api_port: (integer)
- server_vpn_port: (integer)
Example:
{
"id": "nodes-1",
"server": "192.168.0.1",
"server_api_port": 8443,
"package_password": "password",
"lh_ext_eps": [
{
"server": "162.168.0.1",
"server_api_port": 8443,
"server_vpn_port": 1121
},
{
"server": "162.168.0.2",
"server_api_port": 601,
"server_vpn_port": 1121
}
]
}HTTP status code 201
Body
Media type: application/json
Type: object
Example:
{
"message": "OK"
}HTTP status code 400
Invalid request: body is not json or does not conform to required json schema.
Body
Media type: application/json
Type: object
Example:
{
"error": [
{
"type": 4,
"code": 39,
"text": "Invalid request body",
"args": {},
"level": 1
}
]
}HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
delete /registration
Remove connection to this lighthouse
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Example:
{
"message": "OK"
}HTTP status code 400
Incomplete data
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}HTTP status code 500
Internal Server Error
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Remove a connection to a given Lighthouse by ID
delete /registration/{id}
Operations Manager base authentication scheme
URI Parameters
- id: required(string)
The lighthouse system name
Example:
lighthouse-5633-1563
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Lighthouse connection removed successfully
Body
Media type: application/json
Type: object
Example:
{
"message": "OK"
}HTTP status code 400
Invalid request
Body
Media type: application/json
Type: object
Example:
{
"error": "Parameter 'id' not provided."
}HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}HTTP status code 404
Not found
Body
Media type: application/json
Type: object
HTTP status code 500
Internal server error
Body
Media type: application/json
Type: object
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Update the lhvpn_tunnel server address
put /registration/{id}/server_address
Operations Manager base authentication scheme
URI Parameters
- id: required(string)
The lighthouse system name
Example:
lighthouse-5633-1563
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- address: required(string)
Example:
{
"address": "192.168.0.1"
}HTTP status code 200
Body
Media type: application/json
Type: object
Example:
{
"message": "OK"
}HTTP status code 400
Invalid request: body is not json or does not conform to required json schema.
Body
Media type: application/json
Type: object
Example:
{
"error": [
{
"type": 4,
"code": 39,
"text": "Invalid request body",
"args": {},
"level": 1
}
]
}HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Example:
{
"error": [
{
"type": 5,
"code": 29,
"text": "Could not find element with UUID 'nodes-1'",
"args": {
"uuid": "nodes-1"
},
"level": 1
}
]
}HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
/system
System endpoints are related to configuring and accessing information about the Operations Manager appliance itself.
Retrieve or change the Operations Manager appliance system's hostname.
Get the Operations Manager appliance hostname.
Update the Operations Manager appliance hostname.
get /system/hostname
Get the Operations Manager appliance hostname.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- system_hostname: required(object)
- hostname: required(string)
Example:
{
"system_hostname": {
"hostname": "OM2000"
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /system/hostname
Update the Operations Manager appliance hostname.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- system_hostname: required(object)
- hostname: required(string)
Example:
{
"system_hostname": {
"hostname": "OM2000"
}
}HTTP status code 200
Body
Media type: application/json
Type: object
Properties- system_hostname: required(object)
- hostname: required(string)
Example:
{
"system_hostname": {
"hostname": "OM2000"
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Retrieve or change the Operations Manager appliance system's banner text.
Get the Operations Manager appliance banner text.
Update the Operations Manager appliance banner text.
get /system/banner
Get the Operations Manager appliance banner text.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- system_banner: required(object)
- banner: required(string)
Example:
{
"system_banner": {
"banner": "********************************************************************************\nUNAUTHORIZED ACCESS TO THIS DEVICE IS PROHIBITED\nYou must have explicit, authorized permission to access or configure this\n device. Unauthorized attempts and actions to access or use this system may\n result in civil and/or criminal penalties. All activities performed on this\n device are logged and monitored.\n********************************************************************************"
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /system/banner
Update the Operations Manager appliance banner text.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- system_banner: required(object)
- banner: required(string)
Example:
{
"system_banner": {
"banner": "********************************************************************************\nUNAUTHORIZED ACCESS TO THIS DEVICE IS PROHIBITED\nYou must have explicit, authorized permission to access or configure this\n device. Unauthorized attempts and actions to access or use this system may\n result in civil and/or criminal penalties. All activities performed on this\n device are logged and monitored.\n********************************************************************************"
}
}HTTP status code 200
Body
Media type: application/json
Type: object
Properties- system_banner: required(object)
- banner: required(string)
Example:
{
"system_banner": {
"banner": "A new banner\nWith 2 lines"
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Retrieve or change the Operations Manager appliance WebUI session timeout.
Retrieve the WebUI session timeout (in minutes).
Update the WebUI session timeout (in minutes).
get /system/webui_session_timeout
Retrieve the WebUI session timeout (in minutes).
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- system_webui_session_timeout: required(object)
- timeout: required(integer)
Example:
{
"system_webui_session_timeout": {
"timeout": 20
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /system/webui_session_timeout
Update the WebUI session timeout (in minutes).
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- system_webui_session_timeout: required(object)
- timeout: required(integer)
Example:
{
"system_webui_session_timeout": {
"timeout": 20
}
}HTTP status code 200
Body
Media type: application/json
Type: object
Properties- system_webui_session_timeout: required(object)
- timeout: required(integer)
Example:
{
"system_webui_session_timeout": {
"timeout": 20
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Retrieve or change the Operations Manager appliance CLI
Retrieve the CLI session timeout (in minutes).
Update the CLI session timeout (in minutes).
get /system/cli_session_timeout
Retrieve the CLI session timeout (in minutes).
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- system_cli_session_timeout: required(object)
- timeout: required(integer)
Example:
{
"system_cli_session_timeout": {
"timeout": 0
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /system/cli_session_timeout
Update the CLI session timeout (in minutes).
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- system_cli_session_timeout: required(object)
- timeout: required(integer)
Example:
{
"system_cli_session_timeout": {
"timeout": 20
}
}HTTP status code 200
Body
Media type: application/json
Type: object
Properties- system_cli_session_timeout: required(object)
- timeout: required(integer)
Example:
{
"system_cli_session_timeout": {
"timeout": 20
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Retrieve ssh authorized keys for all users
Add an SSH key for the specified user
get /system/system_authorized_keys
Retrieve ssh authorized keys for all users
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- system_authorized_keys: required(array of )
Examples:
example1:
System that has 2 SSH keys belonging to 2 different users
{
"system_authorized_keys": [
{
"id": "users_ssh_authorized_keys-1",
"key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDTRO6c/1JnaA/Mi3MKONqQJUe75rZC36Z0tH+BefpR2li3F/x7TWQnW0aBSA4y7bGOxS5B+nFd86m6+QWqZMxqIpraG11KKVh2c+ElIliVvPbpN7cL9QKbzDZPCn5TZ28znHDuUSzc7Kt0+33On+7HkMhapKiXkA2ardK89DlpKbE4mSiIZoWG0zepyWsXa86fiKTORqEN8FhRtxnBMcl+WODjQfuBzPNr/zYv75eLaZ0LwUOz6/xm8RkwEhd/kF1ntrXYrwOqhFsR7g0cfqQ5T9vLcUXqe+VDvD16KBkooSL92OTxC907F7HPk7XvQaY4bEWK7ca/vbVhsVzdDhbF /home/root/.ssh/id_rsa\n",
"key_fingerprint": "2048 SHA256:CNem+rkDme6jInbmuzNxmHz46TP3mA37I2XfEGUuDs8 /home/root/.ssh/id_rsa\n (RSA)",
"username": "root"
},
{
"id": "users_ssh_authorized_keys-2",
"key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCb/1mDgaqjrBq1Mnyt1oOxFkmSm6HOCUlETW0KCGpSTpaKppb35I2ec7Pka8H4u40FFUcVQeAtHl2R1JIWo5d+Avb1+W/+uhEiJ2TI9GQTeLiHEJYD0QwhwJLUYXk0FkLPkpvVBag3MwUIh3atun0Aq/2C42EeIhFkcniGQFZsgjDaASw7QEYUTyIYr5AARA2cM1OXWNneJOKsOlOxVwQJPeTBa1tFKjg0cw5ISBXHyqUvUJfwZkI8FCfAyJ2Q7OEjJcKCydL500ZmpmDre+gth3qkgGIiteMvbN3OBmFBLq8pZdzsX7tkT28eyJ7FJTSkvsRkHkHQkZW/gaXPp5PR admin@admin-1",
"key_fingerprint": "2048 SHA256:KXoalyRQfYNhKr3stn3YPvvxuWS7L3LWqsHPInvRgqY admin@admin-1 (RSA)",
"username": "admin"
}
]
}example2:
System that has no SSH keys
{
"system_authorized_keys": []
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
post /system/system_authorized_keys
Add an SSH key for the specified user
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- system_authorized_key: required(object)
- key: required(string)
The SSH key
- username: required(string)
The user associated with the SSH key
- key: required(string)
Example:
{
"system_authorized_key": {
"key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDTRO6c/1JnaA/Mi3MKONqQJUe75rZC36Z0tH+BefpR2li3F/x7TWQnW0aBSA4y7bGOxS5B+nFd86m6+QWqZMxqIpraG11KKVh2c+ElIliVvPbpN7cL9QKbzDZPCn5TZ28znHDuUSzc7Kt0+33On+7HkMhapKiXkA2ardK89DlpKbE4mSiIZoWG0zepyWsXa86fiKTORqEN8FhRtxnBMcl+WODjQfuBzPNr/zYv75eLaZ0LwUOz6/xm8RkwEhd/kF1ntrXYrwOqhFsR7g0cfqQ5T9vLcUXqe+VDvD16KBkooSL92OTxC907F7HPk7XvQaY4bEWK7ca/vbVhsVzdDhbF test",
"username": "root"
}
}HTTP status code 200
Body
Media type: application/json
Type: object
Properties- system_authorized_key: required(object)
- id: required(string)
ID of SSH key
- key: required(string)
The SSH key
- key_fingerprint: required(string)
The fingerprint of the SSH key
- username: required(string)
The user associated with the SSH key
- id: required(string)
Example:
{
"system_authorized_key": {
"id": "users_ssh_authorized_keys-3",
"key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDTRO6c/1JnaA/Mi3MKONqQJUe75rZC36Z0tH+BefpR2li3F/x7TWQnW0aBSA4y7bGOxS5B+nFd86m6+QWqZMxqIpraG11KKVh2c+ElIliVvPbpN7cL9QKbzDZPCn5TZ28znHDuUSzc7Kt0+33On+7HkMhapKiXkA2ardK89DlpKbE4mSiIZoWG0zepyWsXa86fiKTORqEN8FhRtxnBMcl+WODjQfuBzPNr/zYv75eLaZ0LwUOz6/xm8RkwEhd/kF1ntrXYrwOqhFsR7g0cfqQ5T9vLcUXqe+VDvD16KBkooSL92OTxC907F7HPk7XvQaY4bEWK7ca/vbVhsVzdDhbF test",
"key_fingerprint": "2048 SHA256:CNem+rkDme6jInbmuzNxmHz46TP3mA37I2XfEGUuDs8 test (RSA)",
"username": "root"
}
}HTTP status code 400
Invalid SSH key.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 2,
"code": 317,
"text": "Invalid SSH key",
"args": {},
"level": 1
}
]
}HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Delete an SSH key.
delete /system/system_authorized_keys/{key-id}
Delete an SSH key.
Operations Manager base authentication scheme
URI Parameters
- key-id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 204
SSH key deleted.
HTTP status code 400
Incomplete data
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}HTTP status code 403
Failed due to not having permission to delete key.
Body
Media type: application/json
Type: object
Example:
{
"error": [
{
"type": 7,
"code": 47,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}HTTP status code 404
SSH key does not exist.
Body
Media type: application/json
Type: object
Example:
{
"error": [
{
"type": 5,
"code": 29,
"text": "Could not find element with UUID 'users_ssh_authorized_keys-9'",
"args": {
"uuid": "users_ssh_authorized_keys-9"
},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
The SSH port used in Direct SSH links.
Retrieve the system SSH port.
Update the system SSH port.
get /system/ssh_port
Retrieve the system SSH port.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- system_ssh_port: required(object)
- port: required(number)
Example:
{
"system_ssh_port": {
"port": 22
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /system/ssh_port
Update the system SSH port.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- system_ssh_port: required(object)
- port: required(number)
Example:
{
"system_ssh_port": {
"port": 22
}
}HTTP status code 200
Body
Media type: application/json
Type: object
Properties- system_ssh_port: required(object)
- port: required(number)
Example:
{
"system_ssh_port": {
"port": 22
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Retrieve and update the system's timezone.
Retrieves the system timezone.
Update the system timezone.
get /system/timezone
Retrieves the system timezone.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- system_timezone: required(object)
- timezone: required(string)
Example:
{
"system_timezone": {
"timezone": "Australia/Brisbane"
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /system/timezone
Update the system timezone.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- system_timezone: required(object)
- timezone: required(string)
Example:
{
"system_timezone": {
"timezone": "Australia/Brisbane"
}
}HTTP status code 200
Body
Media type: application/json
Type: object
Properties- system_timezone: required(object)
- timezone: required(string)
Example:
{
"system_timezone": {
"timezone": "Australia/Brisbane"
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Retrieve and update the Operations Manager's time.
Retrieve the Operations Manager current time.
Update the Operations Manager current time.
get /system/time
Retrieve the Operations Manager current time.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- time: required(object)
- time: required(string)
Example:
{
"time": {
"time": "16:22 Sep 23, 2016"
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /system/time
Update the Operations Manager current time.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- time: required(object)
- time: required(string)
Example:
{
"time": {
"time": "16:22 Sep 23, 2016"
}
}HTTP status code 200
Body
Media type: application/json
Type: object
Properties- time: required(object)
- time: required(string)
Example:
{
"time": {
"time": "16:22 Sep 23, 2016"
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Delete the configuration effectively performing a system reset. The will reset to factory settings and reboot.
delete /system/config
Delete the configuration effectively performing a system reset. The will reset to factory settings and reboot.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
The factory reset process was started successfully.
HTTP status code 400
Incomplete data
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Wait 10 seconds then perform a system reboot.
post /system/reboot
Wait 10 seconds then perform a system reboot.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
The factory reboot process was started successfully.
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Retrieve or change the Operations Manager appliance system's information (hostname, contact and location).
Get the Operations Manager appliance system information.
Update the Operations Manager appliance system information.
get /system/admin_info
Get the Operations Manager appliance system information.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- system_admin_info: required(object)
- hostname: required(string)
- contact: required(string)
- location: required(string)
Example:
{
"system_admin_info": {
"hostname": "myhost1",
"contact": "admin@example.com",
"location": "USA"
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /system/admin_info
Update the Operations Manager appliance system information.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- system_admin_info: required(object)
- hostname: required(string)
- contact: required(string)
- location: required(string)
Example:
{
"system_admin_info": {
"hostname": "myhost1",
"contact": "admin@example.com",
"location": "USA"
}
}HTTP status code 200
Body
Media type: application/json
Type: object
Properties- system_admin_info: required(object)
- hostname: required(string)
- contact: required(string)
- location: required(string)
Example:
{
"system_admin_info": {
"hostname": "myhost1",
"contact": "admin@example.com",
"location": "USA"
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Retrieve and update info about cellular logging.
Retrieves cellular logging info.
Update cellular logging info
get /system/cellular_logging
Retrieves cellular logging info.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- system_cellular_logging: required(object)
- enabled: required(boolean)
- filter: required(string)
- device: required(string)
Example:
{
"system_cellular_logging": {
"enabled": true,
"filter": "/usr/libexec/sierra/filters/RRC_OTA_0xB0C0.sqf",
"device": "/dev/ttyUSB0"
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /system/cellular_logging
Update cellular logging info
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- system_cellular_logging: required(object)
- enabled: required(boolean)
- filter: required(string)
- device: required(string)
Example:
{
"system_cellular_logging": {
"enabled": true,
"filter": "/usr/libexec/sierra/filters/RRC_OTA_0xB0C0.sqf",
"device": "/dev/ttyUSB0"
}
}HTTP status code 200
Body
Media type: application/json
Type: object
Properties- system_cellular_logging: required(object)
- enabled: required(boolean)
- filter: required(string)
- device: required(string)
Example:
{
"system_cellular_logging": {
"enabled": true,
"filter": "/usr/libexec/sierra/filters/RRC_OTA_0xB0C0.sqf",
"device": "/dev/ttyUSB0"
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Retrieve configuration items related to running the cell reliability test.
Update configuration items related to running the cell reliability test. This allows the user to enable and disable the test, change how frequently it executes, configure the URL to use in the test and configure the alert threshold for signal strength.
get /system/cell_reliability_test
Retrieve configuration items related to running the cell reliability test.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Cell reliability test configuration retrieved successfully.
Body
Media type: application/json
Type: object
Properties- cell_reliability_test: required(object)
- enabled: required(boolean)
- period: required(integer - minimum: 0)
- test_url: required(array of any)
- signal_strength_threshold: required(object)
- lower: required(integer - minimum: 0 - maximum: 100)
- upper: required(integer - minimum: 0 - maximum: 100)
Example:
{
"cell_reliability_test": {
"enabled": true,
"period": 120,
"test_url": [
"https://www.opengear.com/",
"http://[684D:1111:222:3333:4444:5555:6:77]/"
],
"signal_strength_threshold": {
"lower": 25,
"upper": 75
}
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /system/cell_reliability_test
Update configuration items related to running the cell reliability test. This allows the user to enable and disable the test, change how frequently it executes, configure the URL to use in the test and configure the alert threshold for signal strength.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- cell_reliability_test: required(object)
- enabled: required(boolean)
- period: required(integer - minimum: 0)
- test_url: required(array of any)
- signal_strength_threshold: required(object)
- lower: required(integer - minimum: 0 - maximum: 100)
- upper: required(integer - minimum: 0 - maximum: 100)
Example:
{
"cell_reliability_test": {
"enabled": true,
"period": 120,
"test_url": [
"https://www.opengear.com/",
"http://[684D:1111:222:3333:4444:5555:6:77]/"
],
"signal_strength_threshold": {
"lower": 25,
"upper": 75
}
}
}HTTP status code 200
The configuration has been updated.
Body
Media type: application/json
Type: object
Properties- cell_reliability_test: required(object)
- enabled: required(boolean)
- period: required(integer - minimum: 0)
- test_url: required(array of any)
- signal_strength_threshold: required(object)
- lower: required(integer - minimum: 0 - maximum: 100)
- upper: required(integer - minimum: 0 - maximum: 100)
Example:
{
"cell_reliability_test": {
"enabled": true,
"period": 120,
"test_url": [
"https://www.opengear.com/",
"http://[684D:1111:222:3333:4444:5555:6:77]/"
],
"signal_strength_threshold": {
"lower": 25,
"upper": 75
}
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Upgrade the system firmware either by uploading a file or providing a url to download the file from. This endpoint will always return success if the firmware upgrade job was started - it occurs in the background and the state of which should be retrieved from the GET /system/firmware_upgrade_status endpoint. At least 'file' or 'firmware_url' are required.
post /system/firmware_upgrade
Upgrade the system firmware either by uploading a file or providing a url to download the file from. This endpoint will always return success if the firmware upgrade job was started - it occurs in the background and the state of which should be retrieved from the GET /system/firmware_upgrade_status endpoint. At least 'file' or 'firmware_url' are required.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: multipart/form-data
Type: object
Properties- file: (file)
The file to be uploaded.
- firmware_url: (string)
A url for the file to download.
- firmware_options: (string)
Options for the firmware upgrade tool.
HTTP status code 200
The firmware upgrade process was started.
Body
Media type: application/json
Type: object
Properties- system_firmware_upgrade_status: required(object)
- state: required(one of pending, running, error, finished)
- error_message: (one of format_error, download_error, version_error, runtime_error)
Example:
{
"system_firmware_upgrade_status": {
"state": "running"
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Retrieve the status of the most recent firmware upgrade job.
get /system/firmware_upgrade_status
Retrieve the status of the most recent firmware upgrade job.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
The factory reset process was started successfully.
Body
Media type: application/json
Type: object
Properties- system_firmware_upgrade_status: required(object)
- state: required(one of pending, running, error, finished)
- error_message: (one of format_error, download_error, version_error, runtime_error)
Example:
{
"system_firmware_upgrade_status": {
"state": "error",
"error_message": "download_error"
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Retrieve the Operations Manager's most recent firmware and REST API version.
Get the version information.
get /system/version
Get the version information.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- system_version: required(object)
- rest_api_version: required(string)
- firmware_version: required(string)
Example:
{
"system_version": {
"rest_api_version": "v2",
"firmware_version": "18.Q3.0"
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Retrieve the Operations Manager appliance's Serial Number.
Get the Serial Number information.
get /system/serial_number
Get the Serial Number information.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- system_serial_number: required(object)
- serial_number: required(string)
Example:
{
"system_serial_number": {
"serial_number": "409155v03.0001"
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Retrieve the Operations Manager appliance's Model Name.
Get the Model Name information.
get /system/model_name
Get the Model Name information.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- system_model_name: required(object)
- model_name: required(string)
Example:
{
"system_model_name": {
"model_name": "OM2248-DAC"
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
/support_report
A report which will provide information about the state of the Operations Manager appliance. This information can be used to help analyse and understand the state of the system. The report is large and may take in the order of a minute to obtain.
Retrieve the support report data.
get /support_report
Retrieve the support report data.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
System report was successfully generated and returned including a url to a corresponding zip file.
Body
Media type: application/json
Type: object
Properties- support_report: required(object)
- contents: required(string)
A new line delimited dump of the current state of the system.
- zip_file: required(string)
url to a zip file which contains the system report.
- contents: required(string)
Example:
{
"support_report": {
"contents": "*** System time ***\nMon Aug 22 11:27:29 2016\n\n\n*** Firmware Version ***\n$ sysflash_info\nsysflash info\ncurrent copy name: 'root1'\ncurrent config dev: '/dev/sda6'\ncurrent root dev: '/dev/sda5'\ncurrent boot dev: '/dev/sda2'\nother (upgradable) copy name: 'root2'\nother (upgradable) config dev: '/dev/sda8'\nother (upgradable) root dev: '/dev/sda7'\nother (upgradable) boot dev: '/dev/sda3'\nboard name: 'OM-2000'\nboard rev: '1.0'\ncurrent software vendor: 'opengear'\ncurrent software product: 'operations manager'\ncurrent software version: '1.0.0'\ncurrent software variant: 'dev'\n\n*** Uptime ***\n359140.57 715606.84\n\n*** IP Configuration ***\n$ ifconfig\nnet1 Link encap:Ethernet HWaddr 08:00:27:d7:1c:38 \n ",
"zip_file": "/api/v2/support_report?zip=1"
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
/auth
Configure remote authentication, authorization, accounting (AAA) servers.
Retrieve information on AAA servers.
Update the AAA config.
get /auth
Retrieve information on AAA servers.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
A JSON object containing the AAA config is returned.
Body
Media type: application/json
Type: object
Properties- auth: required(object)
- mode: required(one of local, radius, tacacs, ldap)
- policy: (one of remotedownlocal, remotelocal)
The auth policy determines whether to always check local credentials after a remote authentication failure or to only check the local credentials if the remote authentication server is unreachable.
- tacacsMethod: (one of pap, chap, login)
- tacacsService: (string)
- ldapBaseDN: required(string)
[Optional when mode is not ldap]
- ldapBindDN: (string)
- ldapIgnoreReferrals: (boolean)
- ldapUsernameAttribute: required(string)
[Optional when mode is not radius]
- ldapGroupMembershipAttribute: (string)
- radiusAuthenticationServers: required(array of object)
[Optional when mode is not radius]
Items: items
- id: (string)
- hostname: required(string)
- port: (integer)
- radiusAccountingServers: required(array of object)
[Optional when mode is not radius]
Items: items
- id: (string)
- hostname: required(string)
- port: (integer)
- tacacsAuthenticationServers: required(array of object)
[Optional when mode is not tacacs]
Items: items
- id: (string)
- hostname: required(string)
- port: (integer)
- ldapAuthenticationServers: required(array of object)
[Optional when mode is not ldap]
Items: items
- id: (string)
- hostname: required(string)
- port: (integer)
Example:
{
"auth": {
"mode": "tacacs",
"policy": "remotedownlocal",
"radiusAuthenticationServers": [
{
"id": "auth_radius_authenticationServers-2",
"hostname": "192.168.250.1.2"
}
],
"radiusAccountingServers": [
{
"id": "auth_radius_accountingServers-1",
"hostname": "192.168.250.1.2"
}
],
"tacacsService": "raccess",
"tacacsMethod": "pap",
"tacacsAuthenticationServers": [
{
"hostname": "192.168.1.2",
"id": "auth_tacacs_authenticationServers-2"
}
],
"ldapAuthenticationServers": [
{
"id": "auth_ldap_authenticationServers-1",
"hostname": "192.168.1.2"
}
],
"ldapBaseDN": "cn=Users,dc=example,dc=com",
"ldapBindDN": "cn=Administrator,cn=Users,dc=example,dc=com",
"ldapUsernameAttribute": "sAMAccountName"
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /auth
Update the AAA config.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Query Parameters
- secrets: (one of cleartext, obfuscate - default: cleartext)
Accepts sensitive fields as either cleartext or obfuscated values. The response will display the sensitive fields in the same way.
Body
Media type: application/json
Type: object
Properties- auth: required(object)
- mode: required(one of local, radius, tacacs, ldap)
- policy: (one of remotedownlocal, remotelocal)
The auth policy determines whether to always check local credentials after a remote authentication failure or to only check the local credentials if the remote authentication server is unreachable.
- tacacsMethod: (one of pap, chap, login)
- tacacsService: (string)
- ldapBaseDN: required(string)
[Optional when mode is not ldap]
- ldapBindDN: (string)
- ldapIgnoreReferrals: (boolean)
- ldapUsernameAttribute: required(string)
[Optional when mode is not radius]
- ldapGroupMembershipAttribute: (string)
- radiusAuthenticationServers: required(array of object)
[Optional when mode is not radius]
Items: items
- id: (string)
- hostname: required(string)
- port: (integer)
- radiusAccountingServers: required(array of object)
[Optional when mode is not radius]
Items: items
- id: (string)
- hostname: required(string)
- port: (integer)
- tacacsAuthenticationServers: required(array of object)
[Optional when mode is not tacacs]
Items: items
- id: (string)
- hostname: required(string)
- port: (integer)
- ldapAuthenticationServers: required(array of object)
[Optional when mode is not ldap]
Items: items
- id: (string)
- hostname: required(string)
- port: (integer)
- radiusPassword: required(string)
[Optional when mode is not radius, sensitive]
- tacacsPassword: required(string)
[Optional when mode is not tacacs, sensitive]
- ldapBindPassword: required(string)
[Optional when mode is not ldap, sensitive]
Example:
{
"auth": {
"mode": "radius",
"policy": "remotelocal",
"radiusPassword": "hunter2",
"radiusAuthenticationServers": [
{
"hostname": "192.168.250.2"
}
],
"radiusAccountingServers": [
{
"hostname": "192.168.250.2"
}
],
"tacacsAuthenticationServers": [],
"tacacsPassword": "",
"ldapBaseDN": "",
"ldapUsernameAttribute": "",
"ldapBindPassword": "",
"ldapAuthenticationServers": []
}
}HTTP status code 200
A JSON object containing the AAA config is returned.
Body
Media type: application/json
Type: object
Properties- auth: required(object)
- mode: required(one of local, radius, tacacs, ldap)
- policy: (one of remotedownlocal, remotelocal)
The auth policy determines whether to always check local credentials after a remote authentication failure or to only check the local credentials if the remote authentication server is unreachable.
- tacacsMethod: (one of pap, chap, login)
- tacacsService: (string)
- ldapBaseDN: required(string)
[Optional when mode is not ldap]
- ldapBindDN: (string)
- ldapIgnoreReferrals: (boolean)
- ldapUsernameAttribute: required(string)
[Optional when mode is not radius]
- ldapGroupMembershipAttribute: (string)
- radiusAuthenticationServers: required(array of object)
[Optional when mode is not radius]
Items: items
- id: (string)
- hostname: required(string)
- port: (integer)
- radiusAccountingServers: required(array of object)
[Optional when mode is not radius]
Items: items
- id: (string)
- hostname: required(string)
- port: (integer)
- tacacsAuthenticationServers: required(array of object)
[Optional when mode is not tacacs]
Items: items
- id: (string)
- hostname: required(string)
- port: (integer)
- ldapAuthenticationServers: required(array of object)
[Optional when mode is not ldap]
Items: items
- id: (string)
- hostname: required(string)
- port: (integer)
Example:
{
"auth": {
"tacaacsPassword": "",
"tacacsAuthenticationServers": [],
"ldapBaseDN": "",
"ldapUsernameAttribute": "",
"ldapBindPassword": "",
"ldapIgnoreReferrals": false,
"ldapAuthenticationServers": [],
"mode": "radius",
"policy": "remotelocal",
"radiusAuthenticationServers": [
{
"id": "auth_radius_authenticationServers-1",
"port": 1812,
"hostname": "192.168.250.2"
}
],
"radiusAccountingServers": [
{
"id": "auth_radius_accountingServers-1",
"port": 1813,
"hostname": "192.168.250.2"
}
]
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
/local_password_policy
Configure the password policy for local users. This includes expiry and complexity settings.
Retrieve the local password policy.
Update the local password policy.
get /local_password_policy
Retrieve the local password policy.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
A JSON object containing the local password policy is returned.
Body
Media type: application/json
Type: object
Properties- local_password_policy: required(object)
- password_expiry_interval_enabled: required(boolean)
- password_expiry_interval_days: required(integer)
Setting is only applied if Password Expiry is enabled.
- password_complexity_enabled: required(boolean)
- password_minimum_length: required(integer)
Setting is only applied if Password Complexity is enabled.
- password_must_contain_upper_case: required(boolean)
Setting is only applied if Password Complexity is enabled.
- password_must_contain_special: required(boolean)
Setting is only applied if Password Complexity is enabled.
- password_must_contain_number: required(boolean)
Setting is only applied if Password Complexity is enabled.
- password_disallow_username: required(boolean)
Setting is only applied if Password Complexity is enabled.
Example:
{
"local_password_policy": {
"password_expiry_interval_enabled": true,
"password_expiry_interval_days": 1,
"password_complexity_enabled": true,
"password_minimum_length": 10,
"password_must_contain_upper_case": true,
"password_must_contain_special": false,
"password_must_contain_number": true,
"password_disallow_username": false
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /local_password_policy
Update the local password policy.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- local_password_policy: required(object)
- password_expiry_interval_enabled: required(boolean)
- password_expiry_interval_days: required(integer)
Setting is only applied if Password Expiry is enabled.
- password_complexity_enabled: required(boolean)
- password_minimum_length: required(integer)
Setting is only applied if Password Complexity is enabled.
- password_must_contain_upper_case: required(boolean)
Setting is only applied if Password Complexity is enabled.
- password_must_contain_special: required(boolean)
Setting is only applied if Password Complexity is enabled.
- password_must_contain_number: required(boolean)
Setting is only applied if Password Complexity is enabled.
- password_disallow_username: required(boolean)
Setting is only applied if Password Complexity is enabled.
Example:
{
"local_password_policy": {
"password_expiry_interval_enabled": false,
"password_expiry_interval_days": 10,
"password_complexity_enabled": false,
"password_minimum_length": 10,
"password_must_contain_upper_case": false,
"password_must_contain_special": true,
"password_must_contain_number": true,
"password_disallow_username": true
}
}HTTP status code 200
A JSON object containing the local password policy is returned.
Body
Media type: application/json
Type: object
Properties- local_password_policy: required(object)
- password_expiry_interval_enabled: required(boolean)
- password_expiry_interval_days: required(integer)
Setting is only applied if Password Expiry is enabled.
- password_complexity_enabled: required(boolean)
- password_minimum_length: required(integer)
Setting is only applied if Password Complexity is enabled.
- password_must_contain_upper_case: required(boolean)
Setting is only applied if Password Complexity is enabled.
- password_must_contain_special: required(boolean)
Setting is only applied if Password Complexity is enabled.
- password_must_contain_number: required(boolean)
Setting is only applied if Password Complexity is enabled.
- password_disallow_username: required(boolean)
Setting is only applied if Password Complexity is enabled.
Example:
{
"local_password_policy": {
"password_expiry_interval_enabled": false,
"password_expiry_interval_days": 10,
"password_complexity_enabled": true,
"password_minimum_length": 6,
"password_must_contain_upper_case": true,
"password_must_contain_special": true,
"password_must_contain_number": false,
"password_disallow_username": true
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
/users
Retrieve and update user information.
Retrieve a list of users.
Replace current user list with a new one. Used by Lighthouse Template push
Create a new User data in the config.
get /users
Retrieve a list of users.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
A JSON object containing Users Config is returned.
Body
Media type: application/json
Type: object
Properties- users: required(array of object)
Items: items
- username: required(string)
- description: (string)
- enabled: required(boolean)
- id: required(string)
- no_password: required(boolean)
- ssh_password_enabled: required(boolean)
- hashed_password: required(string)
A hashed password compatible with the crypt GNU C Library function.
- rights: required(object)
- delete: required(boolean)
- modify: required(boolean)
- groups: required(array of any)
A list of groups
- groupNames: required(array of any)
A list of group names
- meta: required(object)
- searchId: (string)
- total_pages: (string)
Example:
{
"users": [
{
"username": "root",
"description": "System wide SuperUser account",
"enabled": true,
"id": "users-1",
"no_password": false,
"ssh_password_enabled": true,
"hashed_password": "$5$vqpQsIj./5/2OOBo$tTUYAJaEqbZYf4aipKicPF5bpkkGSEqtBy3t4dylp0/",
"rights": {
"delete": true,
"modify": true
},
"groups": [
"usergrp"
],
"groupNames": [
"g1"
]
},
{
"username": "tu0",
"description": "",
"enabled": true,
"id": "users-2",
"no_password": false,
"ssh_password_enabled": true,
"hashed_password": "$5$vqpQsIj./5/2OOBo$tTUYAJaEqbZYf4aipKicPF5bpkkGSEqtBy3t4dylp0/",
"rights": {
"delete": true,
"modify": true
},
"groups": [
"usergrp"
],
"groupNames": [
"g1"
]
}
],
"meta": {
"total_pages": "1"
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /users
Replace current user list with a new one. Used by Lighthouse Template push
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Query Parameters
- secrets: (one of cleartext, obfuscate - default: cleartext)
Accepts sensitive fields as either cleartext or obfuscated values. The response will display the sensitive fields in the same way.
Body
Media type: application/json
Type: object
Properties- users: required(array of object)
The users to add
Items: items
- username: required(string)
- password: required(string)
The plaintext password to set for the user. [sensitive]
- hashed_password: (string)
A hashed password, compatible with the crypt GNU C Library function, to set for the user.
- description: (string)
- groups: required(array of )
A list of group ids
Example:
{
"users": [
{
"username": "user1",
"description": "An admin user",
"password": "default",
"groups": [
"g1",
"g2",
"g3"
]
},
{
"username": "user2",
"description": "Another user",
"password": "default",
"groups": [
"g1"
]
}
]
}HTTP status code 200
A JSON object containing Users Config is returned.
Body
Media type: application/json
Type: object
Properties- users: required(array of object)
Items: items
- username: required(string)
- description: (string)
- enabled: required(boolean)
- id: required(string)
- no_password: required(boolean)
- ssh_password_enabled: required(boolean)
- hashed_password: required(string)
A hashed password compatible with the crypt GNU C Library function.
- rights: required(object)
- delete: required(boolean)
- modify: required(boolean)
- groups: required(array of any)
A list of groups
- groupNames: required(array of any)
A list of group names
- meta: required(object)
- searchId: (string)
- total_pages: (string)
Example:
{
"users": [
{
"username": "root",
"enabled": true,
"id": "users-1",
"no_password": false,
"ssh_password_enabled": true,
"hashed_password": "$5$vqpQsIj./5/2OOBo$tTUYAJaEqbZYf4aipKicPF5bpkkGSEqtBy3t4dylp0/",
"rights": {
"delete": true,
"modify": true
},
"groups": [
"usergrp",
"admin"
],
"groupNames": [
"g1",
"g2"
]
},
{
"username": "user1",
"enabled": true,
"description": "An admin user",
"id": "users-2",
"no_password": false,
"ssh_password_enabled": true,
"hashed_password": "$5$697qmlbgz79fbNhl$Px.GuCYD1pEdUZUZR9aBKC14OlhQfYldn79tVluNCtD",
"rights": {
"delete": true,
"modify": true
},
"groups": [
"usergrp",
"admin",
"my_group"
],
"groupNames": [
"g1",
"g2",
"g3"
]
},
{
"username": "user2",
"enabled": true,
"description": "Another user",
"id": "users-3",
"no_password": false,
"ssh_password_enabled": true,
"hashed_password": "$5$697qmlbgz79fbNhl$Px.GuCYD1pEdUZUZR9aBKC14OlhQfYldn79tVluNCtD",
"rights": {
"delete": true,
"modify": true
},
"groups": [
"usergrp"
],
"groupNames": [
"g1"
]
}
],
"meta": {
"total_pages": "1"
}
}HTTP status code 400
Failed to initiate user creation due to error in post body.
Body
Media type: application/json
Type: object
Properties- error: required(string)
Example:
{
"error": "Failed to parse request data"
}HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
post /users
Create a new User data in the config.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Query Parameters
- secrets: (one of cleartext, obfuscate - default: cleartext)
Accepts sensitive fields as either cleartext or obfuscated values. The response will display the sensitive fields in the same way.
Body
Media type: application/json
Type: object
Properties- user: required(object)
- username: required(string)
- description: (string)
- enabled: required(boolean)
- password: (string)
The plaintext password to set for the user. [sensitive]
- hashed_password: (string)
A hashed password, compatible with the crypt GNU C Library function, to set for the user.
- no_password: required(boolean)
Remote authentication is used if this flag is set.
- ssh_password_enabled: (boolean)
Whether SSH password access is enabled (default is true). If false a user can only use SSH with SSH keys.
- groups: required(array of )
A list of groups for which this user is a member.
Example:
{
"user": {
"username": "tu1",
"description": "testupdated",
"enabled": true,
"no_password": true,
"groups": [
"admin"
]
}
}HTTP status code 200
Body
Media type: application/json
Type: object
Properties- user: required(object)
- username: required(string)
- description: (string)
- enabled: required(boolean)
- id: required(string)
- no_password: required(boolean)
Remote authentication is used if this flag is set.
- ssh_password_enabled: required(boolean)
Whether SSH password access is enabled (default is true). If false a user can only use SSH with SSH keys.
- hashed_password: required(string)
A hashed password compatible with the crypt GNU C Library function.
- rights: required(object)
- delete: required(boolean)
- modify: required(boolean)
- groups: required(array of )
A list of groups
- groupNames: required(array of )
A list of group names
Example:
{
"user": {
"username": "tu1",
"description": "testupdated",
"enabled": true,
"id": "users-5",
"no_password": true,
"ssh_password_enabled": true,
"hashed_password": "$5$vqpQsIj./5/2OOBo$tTUYAJaEqbZYf4aipKicPF5bpkkGSEqtBy3t4dylp0/",
"rights": {
"delete": true,
"modify": true
},
"groups": [
"admin"
],
"groupNames": [
"g2"
]
}
}HTTP status code 400
Failed to initiate user creation due to error in post body.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 2,
"code": 12,
"text": "Element is below the minimum allowed length of 1 character(s)",
"args": {
"min": "1",
"uuid": "{60e2b0a-aafa-11e6-aca7-cb7fd0646002"
},
"level": 1
},
{
"type": 1,
"code": 33,
"text": "Push command failed",
"args": {},
"level": 1
}
]
}HTTP status code 401
Authentication failed due to invalid session.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"text": "Invalid session ID",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Retrieve the User information by ID.
Update a User data in the config.
Delete a User
get /users/{user-id}
Retrieve the User information by ID.
Operations Manager base authentication scheme
URI Parameters
- user-id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
User exists
Body
Media type: application/json
Type: object
Properties- user: required(object)
- username: required(string)
- description: (string)
- enabled: required(boolean)
- id: required(string)
- no_password: required(boolean)
Remote authentication is used if this flag is set.
- ssh_password_enabled: required(boolean)
Whether SSH password access is enabled (default is true). If false a user can only use SSH with SSH keys.
- hashed_password: required(string)
A hashed password compatible with the crypt GNU C Library function.
- rights: required(object)
- delete: required(boolean)
- modify: required(boolean)
- groups: required(array of )
A list of groups
- groupNames: required(array of )
A list of group names
Example:
{
"user": {
"username": "tu0",
"description": "",
"enabled": true,
"id": "users-2",
"no_password": false,
"ssh_password_enabled": true,
"hashed_password": "$5$vqpQsIj./5/2OOBo$tTUYAJaEqbZYf4aipKicPF5bpkkGSEqtBy3t4dylp0/",
"rights": {
"delete": true,
"modify": true
},
"groups": [
"usergrp"
],
"groupNames": [
"g1"
]
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failed due to invalid session.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}{
"error": [
{
"type": 7,
"code": 42,
"text": "Invalid session ID",
"args": {},
"level": 1
}
]
}HTTP status code 404
User does not exist. User Not Found.
Body
Media type: application/json
Type: object
Example:
{
"error": [
{
"type": 5,
"code": 29,
"text": "Could not find user with username or id 'tu0'",
"args": {
"uuid": "tu0"
},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /users/{user-id}
Update a User data in the config.
Operations Manager base authentication scheme
URI Parameters
- user-id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Query Parameters
- secrets: (one of cleartext, obfuscate - default: cleartext)
Accepts sensitive fields as either cleartext or obfuscated values. The response will display the sensitive fields in the same way.
Body
Media type: application/json
Type: object
Properties- user: required(object)
- username: required(string)
- description: (string)
- enabled: required(boolean)
- password: (string)
The plaintext password to set for the user. [sensitive]
- hashed_password: (string)
A hashed password, compatible with the crypt GNU C Library function, to set for the user.
- no_password: required(boolean)
Remote authentication is used if this flag is set.
- ssh_password_enabled: (boolean)
Whether SSH password access is enabled (default is true). If false a user can only use SSH with SSH keys.
- groups: required(array of )
A list of groups for which this user is a member.
Example:
{
"user": {
"username": "tu1",
"description": "testupdated",
"enabled": true,
"no_password": true,
"ssh_password_enabled": true,
"groups": [
"admin"
]
}
}HTTP status code 200
User has been Updated.
Body
Media type: application/json
Type: object
Properties- user: required(object)
- username: required(string)
- description: (string)
- enabled: required(boolean)
- id: required(string)
- no_password: required(boolean)
Remote authentication is used if this flag is set.
- ssh_password_enabled: required(boolean)
Whether SSH password access is enabled (default is true). If false a user can only use SSH with SSH keys.
- hashed_password: required(string)
A hashed password compatible with the crypt GNU C Library function.
- rights: required(object)
- delete: required(boolean)
- modify: required(boolean)
- groups: required(array of )
A list of groups
- groupNames: required(array of )
A list of group names
Example:
{
"user": {
"username": "tu1",
"description": "testupdated",
"enabled": true,
"no_password": true,
"ssh_password_enabled": true,
"hashed_password": "$5$vqpQsIj./5/2OOBo$tTUYAJaEqbZYf4aipKicPF5bpkkGSEqtBy3t4dylp0/",
"id": "users-5",
"rights": {
"delete": true,
"modify": true
},
"groups": [
"admin"
],
"groupNames": [
"g2"
]
}
}HTTP status code 400
Invalid request
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 4,
"code": 39,
"text": "Invalid request body",
"args": {},
"level": 1
}
]
}HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
delete /users/{user-id}
Delete a User
Operations Manager base authentication scheme
URI Parameters
- user-id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
User deleted
HTTP status code 400
Incomplete data
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}HTTP status code 404
User did not exist
Body
Media type: application/json
Type: object
Example:
{
"error": [
{
"type": 5,
"code": 29,
"text": "Could not find user with username or id 'tu0'",
"args": {
"uuid": "tu0"
},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Retrieve ssh authorized keys for a user
Add an SSH key for a user
get /users/{user-id}/ssh/authorized_keys
Retrieve ssh authorized keys for a user
Operations Manager base authentication scheme
URI Parameters
- user-id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- authorized_keys: required(array of )
Examples:
example1:
User with 2 keys
{
"authorized_keys": [
{
"id": "users_ssh_authorized_keys-1",
"key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDTRO6c/1JnaA/Mi3MKONqQJUe75rZC36Z0tH+BefpR2li3F/x7TWQnW0aBSA4y7bGOxS5B+nFd86m6+QWqZMxqIpraG11KKVh2c+ElIliVvPbpN7cL9QKbzDZPCn5TZ28znHDuUSzc7Kt0+33On+7HkMhapKiXkA2ardK89DlpKbE4mSiIZoWG0zepyWsXa86fiKTORqEN8FhRtxnBMcl+WODjQfuBzPNr/zYv75eLaZ0LwUOz6/xm8RkwEhd/kF1ntrXYrwOqhFsR7g0cfqQ5T9vLcUXqe+VDvD16KBkooSL92OTxC907F7HPk7XvQaY4bEWK7ca/vbVhsVzdDhbF /home/lincolnr/.ssh/id_rsa\n",
"key_fingerprint": "2048 SHA256:CNem+rkDme6jInbmuzNxmHz46TP3mA37I2XfEGUuDs8 /home/lincolnr/.ssh/id_rsa\n (RSA)"
},
{
"id": "users_ssh_authorized_keys-2",
"key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAACAQDcsp/AQJKLsinT822ZXAnyXpSykeRXPlOvvOH3zi7QkYLz4+VBbTqJO/R2AJp8Cd0MrGMwuzzbwM25bAb7mesni+RRUAcNPqDD8/z8PKKKRzU1aKRqi/Za3FDRxPAOPJ/Wy1F1lGG6BSKe3gH9QHkPpy5ZPkDcs0S9+qoUYwNCAaB2tcK1jp/L6RXuJ3yLhRBIMpYicRwYcXDOX7QFt4BhnKMrR1ufcU08CGRLYLxnsd2RuiPn2jAz8OHJN7GUvrQ6VK+k47vEj0YLBuP27ZbFKwAJd3dhdezlhjlDDGrVrrXZgwxR+LeOuTnkqUVHOXkYVuiWQZqGS/hC76wJEt2xHinW5+4GuN69qBeY//jCYT+DHe9qJ0MEB5xNjVoWXxb9C7Pc1+/3y+p84X2Oa2nYJm3Vsn8u/S2Mbu1epf16i2qnLEInXkbBF/3T06NZAR+8in51MYE+kQkWq7dlkX20b5l28Ugu8VYYrcxxg0AREfqaL5FbyPS1OHaEb5zvabN23JTPpG8LBnXSjNu8AIpbfM8PaXT+7c5nSSQ+y0G1kZsP9MberstvExJOOYl8eviShb41RuApZL3ik/gY1pZKhBNQbx7eD84q1f2cXtyAw554WWrnM4BlFZB86/M7rrX+GkHRbgv57dc/j5pID08MZ5w/52Tj9KpApYKcQkNFSQ== root@root-1",
"key_fingerprint": "4096 SHA256:a3MIQdLMB/kOUYcHSnlqHagOfHdlv4A/RCaTUr8o6MY root@root-1 (RSA)"
}
]
}example2:
User with no keys
{
"authorized_keys": []
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
post /users/{user-id}/ssh/authorized_keys
Add an SSH key for a user
Operations Manager base authentication scheme
URI Parameters
- user-id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- authorized_key: required(object)
- key: required(string)
Example:
{
"authorized_key": {
"key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDTRO6c/1JnaA/Mi3MKONqQJUe75rZC36Z0tH+BefpR2li3F/x7TWQnW0aBSA4y7bGOxS5B+nFd86m6+QWqZMxqIpraG11KKVh2c+ElIliVvPbpN7cL9QKbzDZPCn5TZ28znHDuUSzc7Kt0+33On+7HkMhapKiXkA2ardK89DlpKbE4mSiIZoWG0zepyWsXa86fiKTORqEN8FhRtxnBMcl+WODjQfuBzPNr/zYv75eLaZ0LwUOz6/xm8RkwEhd/kF1ntrXYrwOqhFsR7g0cfqQ5T9vLcUXqe+VDvD16KBkooSL92OTxC907F7HPk7XvQaY4bEWK7ca/vbVhsVzdDhbF test"
}
}HTTP status code 200
Body
Media type: application/json
Type: object
Properties- authorized_key: required(object)
- id: required(string)
ID of SSH key
- key: required(string)
The SSH key
- key_fingerprint: required(string)
The fingerprint of the SSH key
- id: required(string)
Example:
{
"authorized_key": {
"id": "users_ssh_authorized_keys-3",
"key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDTRO6c/1JnaA/Mi3MKONqQJUe75rZC36Z0tH+BefpR2li3F/x7TWQnW0aBSA4y7bGOxS5B+nFd86m6+QWqZMxqIpraG11KKVh2c+ElIliVvPbpN7cL9QKbzDZPCn5TZ28znHDuUSzc7Kt0+33On+7HkMhapKiXkA2ardK89DlpKbE4mSiIZoWG0zepyWsXa86fiKTORqEN8FhRtxnBMcl+WODjQfuBzPNr/zYv75eLaZ0LwUOz6/xm8RkwEhd/kF1ntrXYrwOqhFsR7g0cfqQ5T9vLcUXqe+VDvD16KBkooSL92OTxC907F7HPk7XvQaY4bEWK7ca/vbVhsVzdDhbF test",
"key_fingerprint": "2048 SHA256:CNem+rkDme6jInbmuzNxmHz46TP3mA37I2XfEGUuDs8 test (RSA)"
}
}HTTP status code 400
Invalid SSH key.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 2,
"code": 317,
"text": "Invalid SSH key",
"args": {},
"level": 1
}
]
}HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Delete an SSH key for a user.
delete /users/{user-id}/ssh/authorized_keys/{key-id}
Delete an SSH key for a user.
Operations Manager base authentication scheme
URI Parameters
- user-id: required(string)
- key-id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 204
SSH key deleted.
HTTP status code 400
Incomplete data
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}HTTP status code 403
Failed due to not having permission to delete key.
Body
Media type: application/json
Type: object
Example:
{
"error": [
{
"type": 7,
"code": 47,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}HTTP status code 404
SSH key does not exist.
Body
Media type: application/json
Type: object
Example:
{
"error": [
{
"type": 5,
"code": 29,
"text": "Could not find ssh/authorized_key with key or id 'users_ssh_authorized_keys-9'",
"args": {
"uuid": "users_ssh_authorized_keys-9"
},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
/groups
Retrieve or update group information.
Retrieve a list of groups.
Replace current groups list with a new one. Used by Lighthouse Template push
Create a new Group in the config.
get /groups
Retrieve a list of groups.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
A JSON object containing Groups config is returned.
Body
Media type: application/json
Type: object
Properties- groups: required(array of object)
Items: items
- id: required(string)
- enabled: required(boolean)
- groupname: required(string)
- mode: required(string)
- role: required(string)
- description: (string)
- members: required(array of string)
- ports: (array of string)
- rights: required(object)
- delete: required(boolean)
- modify: required(boolean)
- meta: required(object)
- searchId: (string)
- total_pages: (string)
Example:
{
"groups": [
{
"id": "groups-1",
"enabled": true,
"groupname": "usergrp",
"mode": "scoped",
"role": "ConsoleUser",
"description": "The ConsoleUser group",
"members": [
"root",
"tu0"
],
"ports": [
"serial/by-opengear-id/port01",
"serial/by-opengear-id/port02",
"serial/by-opengear-id/port03"
],
"rights": {
"delete": true,
"modify": false
}
},
{
"id": "groups-2",
"enabled": true,
"groupname": "admin",
"mode": "global",
"role": "Administrator",
"description": "Administrator",
"members": [
"root",
"tu0"
],
"rights": {
"delete": true,
"modify": true
}
}
],
"meta": {
"total_pages": "1"
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /groups
Replace current groups list with a new one. Used by Lighthouse Template push
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- groups: required(array of object)
The groups to add
Items: items
- name: required(string)
- description: (string)
- roles: required(array of string)
- ports: required(array of boolean)
Example:
{
"groups": [
{
"name": "group1",
"description": "an admin group",
"roles": [
"admin"
],
"ports": []
},
{
"name": "group2",
"description": "an unrestricted consoleUser",
"roles": [
"all_ports_user",
"ConsoleUser"
],
"ports": []
},
{
"name": "group1",
"description": "a restricted consoleUser",
"roles": [
"basic_webui_user",
"ConsoleUser"
],
"ports": [
true,
false,
true,
true,
false
]
}
]
}HTTP status code 200
A JSON object containing Groups Config is returned.
Body
Media type: application/json
Type: object
Properties- groups: required(array of object)
Items: items
- id: required(string)
- enabled: required(boolean)
- groupname: required(string)
- mode: required(string)
- role: required(string)
- description: (string)
- members: required(array of string)
- ports: (array of string)
- rights: required(object)
- delete: required(boolean)
- modify: required(boolean)
- meta: required(object)
- searchId: (string)
- total_pages: (string)
Example:
{
"groups": [
{
"enabled": true,
"id": "groups-1",
"groupname": "usergrp",
"description": "The consoleUser group",
"mode": "scoped",
"role": "consoleUser",
"members": [
"root",
"tu0"
],
"ports": [
"serial/by-opengear-id/port01",
"serial/by-opengear-id/port02",
"serial/by-opengear-id/port03"
],
"rights": {
"delete": true,
"modify": true
}
},
{
"enabled": true,
"id": "groups-2",
"groupname": "admin",
"description": "Administrator",
"mode": "global",
"role": "admin",
"members": [
"root",
"tu0"
],
"rights": {
"delete": true,
"modify": true
}
}
],
"meta": {
"total_pages": "1"
}
}HTTP status code 400
Failed to initiate user creation due to error in post body.
Body
Media type: application/json
Type: object
Properties- error: required(string)
Example:
{
"error": "Failed to parse request data"
}HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
post /groups
Create a new Group in the config.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- group: required(object)
- groupname: required(string)
- enabled: required(boolean)
- mode: required(string)
- role: required(string)
- description: (string)
- ports: (array of string)
Examples:
group_for_admin:
{
"group": {
"groupname": "local_admin",
"enabled": true,
"mode": "global",
"role": "Administrator"
}
}group_for_users:
{
"group": {
"groupname": "my_group",
"enabled": true,
"mode": "scoped",
"role": "ConsoleUser",
"ports": [
"serial/by-opengear-id/port01",
"serial/by-opengear-id/port02",
"serial/by-opengear-id/port03"
]
}
}HTTP status code 201
Body
Media type: application/json
Type: object
Properties- group: required(object)
- id: required(string)
- enabled: required(boolean)
- groupname: required(string)
- mode: required(string)
- role: required(string)
- description: (string)
- members: required(array of string)
- ports: (array of string)
- rights: required(object)
- delete: required(boolean)
- modify: required(boolean)
Examples:
admin_group:
{
"group": {
"id": "groups-1",
"enabled": true,
"groupname": "local-admin",
"mode": "global",
"role": "Administrator",
"members": [],
"ports": [],
"rights": {
"delete": true,
"modify": true
}
}
}ConsoleUser_group:
{
"group": {
"id": "groups-3",
"enabled": true,
"groupname": "my_group",
"mode": "scoped",
"role": "ConsoleUser",
"description": "Group for ConsoleUser",
"members": [],
"ports": [
"serial/by-opengear-id/port01",
"serial/by-opengear-id/port02",
"serial/by-opengear-id/port03"
],
"rights": {
"delete": true,
"modify": false
}
}
}HTTP status code 400
Failed to initiate group creation due to error in post body.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 2,
"code": 26,
"level": 1,
"text": "Duplicate 'groupname' fields with value 'netgrp'",
"args": {
"value": "netgrp",
"uuid": "root-1-@groups",
"field": "groupname"
}
},
{
"type": 1,
"code": 33,
"level": 1,
"text": "Push command failed",
"args": {}
}
]
}HTTP status code 401
Authentication failed due to invalid session.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"text": "Invalid session ID",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Retrieve the Group information by ID.
Update a Group data in the config.
Delete a Group
get /groups/{id}
Retrieve the Group information by ID.
Operations Manager base authentication scheme
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Group exists
Body
Media type: application/json
Type: object
Properties- group: required(object)
- id: required(string)
- enabled: required(boolean)
- groupname: required(string)
- mode: required(string)
- role: required(string)
- description: (string)
- members: required(array of string)
- ports: (array of string)
- rights: required(object)
- delete: required(boolean)
- modify: required(boolean)
Example:
{
"group": {
"id": "groups-6",
"enabled": true,
"groupname": "netgrp2",
"mode": "scoped",
"role": "ConsoleUser",
"members": [
"root",
"tu0"
],
"ports": [
"serial/by-opengear-id/port01",
"serial/by-opengear-id/port02",
"serial/by-opengear-id/port03"
],
"rights": {
"delete": true,
"modify": false
}
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failed due to invalid session.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}{
"error": [
{
"type": 7,
"code": 42,
"text": "Invalid session ID",
"args": {},
"level": 1
}
]
}HTTP status code 404
Group does not exist. Group Not Found.
Body
Media type: application/json
Type: object
Example:
{
"error": [
{
"type": 5,
"code": 29,
"text": "Could not find group with groupname or id 'group59'",
"args": {
"uuid": "group59"
},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /groups/{id}
Update a Group data in the config.
Operations Manager base authentication scheme
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- group: required(object)
- groupname: required(string)
- enabled: required(boolean)
- mode: required(string)
- role: required(string)
- description: (string)
- ports: (array of string)
Example:
{
"group": {
"enabled": true,
"groupname": "netgrp2",
"mode": "scoped",
"role": "ConsoleUser",
"description": "Group for ConsoleUser role",
"ports": [
"serial/by-opengear-id/port01",
"serial/by-opengear-id/port02",
"serial/by-opengear-id/port03"
]
}
}HTTP status code 200
Group has been updated.
Body
Media type: application/json
Type: object
Properties- group: required(object)
- id: required(string)
- enabled: required(boolean)
- groupname: required(string)
- mode: required(string)
- role: required(string)
- description: (string)
- members: required(array of string)
- ports: (array of string)
- rights: required(object)
- delete: required(boolean)
- modify: required(boolean)
Example:
{
"group": {
"id": "groups-6",
"enabled": true,
"groupname": "netgrp2",
"mode": "scoped",
"role": "ConsoleUser",
"description": "Group for ConsoleUser role",
"members": [
"root",
"tu0"
],
"ports": [
"serial/by-opengear-id/port01",
"serial/by-opengear-id/port02",
"serial/by-opengear-id/port03"
],
"rights": {
"delete": true,
"modify": false
}
}
}HTTP status code 400
Invalid request
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 4,
"code": 39,
"text": "Invalid request body",
"args": {},
"level": 1
}
]
}HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
delete /groups/{id}
Delete a Group
Operations Manager base authentication scheme
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 204
Group deleted
HTTP status code 400
Incomplete data
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}HTTP status code 404
Group did not exist
Body
Media type: application/json
Type: object
Example:
{
"error": [
{
"type": 5,
"code": 29,
"text": "Could not find group with groupname or id 'group6'",
"args": {
"uuid": "group6"
},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
/scripts
The scripts endpoint is used to upload and execute custom user scripts on the appliance and to retrieve the status of currently executing scripts
Upload a shell script to be executed on the node
Retrieve the status of a script executing on the node, as in GET /scripts?execution_id={id}, where id is the value for execution_id returned in the 200 response to the POST /scripts request.
post /scripts
Upload a shell script to be executed on the node
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: multipart/form-data
Type: object
Properties- script_metadata: required(object)
JSON object containing script_timeout in minutes and the script_checksum (SHA1).
- script_timeout: required(integer)
The number of minutes that the script is allowed to run
- script_checksum: required(string)
The SHA1 checksum of the script
- script_timeout: required(integer)
- file: required(file)
The file to be uploaded.
HTTP status code 200
Successful request
Body
Media type: application/json
Type: object
Properties- info: required(string)
- execution_id: required(integer)
Example:
{
"info": "Script execution started successfully",
"execution_id": 23
}HTTP status code 400
Invalid request
Body
Media type: application/json
Type: object
Example:
{
"error": "Invalid script metadata"
}HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
get /scripts
Retrieve the status of a script executing on the node, as in GET /scripts?execution_id={id}, where id is the value for execution_id returned in the 200 response to the POST /scripts request.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Query Parameters
- execution_id: required(string)
The execution_id returned from a /scripts POST request
HTTP status code 200
Successful request
Body
Media type: application/json
Type: object
Properties- script_status: required(one of in_progress, timed_out, completed)
Example:
{
"script_status": "in_progress"
}HTTP status code 400
Invalid request
Body
Media type: application/json
Type: object
Example:
{
"error": "Script execution ID not provided"
}HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}HTTP status code 500
Unexpected error
Body
Media type: application/json
Type: object
Example:
{
"error": "Script exit code not found"
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
/firewall
Firewall endpoints are related to configuring and accessing information about the firewall running on the appliance.
Collection of custom services defined for the appliance's firewall. A service is a named grouping of one or more TCP or UDP ports for a particular networking protocol. For example, the 'https' service refers to TCP port 443. The appliance includes many predefined services for common protocols (see /firewall/predefined_services). This collection contains only custom services which have been defined by the administrator.
Retrieve a list of custom services defined for the appliance.
Create a new custom service in the config.
get /firewall/services
Retrieve a list of custom services defined for the appliance.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
The list of custom services.
Body
Media type: application/json
Type: object
Properties- firewall_services: required(array of object)
Items: items
- id: required(string)
- name: required(string)
- label: required(string)
- ports: required(array of object)
Items: items
- protocol: required(string)
- port: required(integer)
- meta: required(object)
- searchId: (string)
- total_pages: (string)
Example:
{
"firewall_services": [
{
"id": "firewall-services-0",
"name": "http",
"label": "HTTP",
"ports": [
{
"protocol": "tcp",
"port": 80
}
]
},
{
"id": "firewall-services-1",
"name": "https",
"label": "HTTPS",
"ports": [
{
"protocol": "tcp",
"port": 443
}
]
}
],
"meta": {
"total_pages": "1"
}
}HTTP status code 400
Invalid request, missing or incorrect page/per_page
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 4,
"code": 39,
"level": 1,
"text": "Invalid request body",
"args": {}
}
]
}HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
post /firewall/services
Create a new custom service in the config.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- firewall_service: required(object)
- name: required(string)
- label: required(string)
- ports: required(array of object)
Items: items
- protocol: required(string)
- port: required(integer)
Example:
{
"firewall_service": {
"name": "https",
"label": "HTTPS",
"ports": [
{
"protocol": "tcp",
"port": 443
}
]
}
}HTTP status code 200
Service was added.
Body
Media type: application/json
Type: object
Properties- firewall_service: required(object)
A firewall service
- id: required(string)
- name: required(string)
- label: required(string)
- ports: required(array of object)
Items: items
- protocol: required(string)
- port: required(integer)
Example:
{
"firewall_service": {
"id": "firewall-services-1",
"name": "https",
"label": "HTTPS",
"ports": [
{
"protocol": "tcp",
"port": 443
}
]
}
}HTTP status code 400
Failed due to error in post body.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 2,
"code": 12,
"text": "Element is below the minimum allowed length of 1 character(s)",
"args": {
"min": "1",
"uuid": "{60e2b0a-aafa-11e6-aca7-cb7fd0646002"
},
"level": 1
},
{
"type": 1,
"code": 33,
"text": "Push command failed",
"args": {},
"level": 1
}
]
}HTTP status code 401
Authentication failed due to invalid session.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"text": "Invalid session ID",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Retrieve the custom service by ID.
Update a service in the config.
Delete a service.
get /firewall/services/{id}
Retrieve the custom service by ID.
Operations Manager base authentication scheme
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Service exists.
Body
Media type: application/json
Type: object
Properties- firewall_service: required(object)
A firewall service
- id: required(string)
- name: required(string)
- label: required(string)
- ports: required(array of object)
Items: items
- protocol: required(string)
- port: required(integer)
Example:
{
"firewall_service": {
"id": "firewall-services-1",
"name": "https",
"label": "HTTPS",
"ports": [
{
"protocol": "tcp",
"port": 443
}
]
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failed due to invalid session.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}{
"error": [
{
"type": 7,
"code": 42,
"text": "Invalid session ID",
"args": {},
"level": 1
}
]
}HTTP status code 404
Service does not exist.
Body
Media type: application/json
Type: object
Example:
{
"error": [
{
"type": 5,
"code": 29,
"text": "Could not find user with username or id 'tu0'",
"args": {
"uuid": "tu0"
},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /firewall/services/{id}
Update a service in the config.
Operations Manager base authentication scheme
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- firewall_service: required(object)
- name: required(string)
- label: required(string)
- ports: required(array of object)
Items: items
- protocol: required(string)
- port: required(integer)
Example:
{
"firewall_service": {
"name": "https",
"label": "HTTPS",
"ports": [
{
"protocol": "tcp",
"port": 443
}
]
}
}HTTP status code 200
Service has been updated.
Body
Media type: application/json
Type: object
Properties- firewall_service: required(object)
A firewall service
- id: required(string)
- name: required(string)
- label: required(string)
- ports: required(array of object)
Items: items
- protocol: required(string)
- port: required(integer)
Example:
{
"firewall_service": {
"id": "firewall-services-1",
"name": "https",
"label": "HTTPS",
"ports": [
{
"protocol": "tcp",
"port": 443
}
]
}
}HTTP status code 400
Invalid request
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 4,
"code": 39,
"text": "Invalid request body",
"args": {},
"level": 1
}
]
}HTTP status code 401
Authentication failed due to invalid session.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"text": "Invalid session ID",
"args": {},
"level": 1
}
]
}HTTP status code 404
Service does not exist.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 5,
"code": 29,
"text": "Could not find firewall/service with name or id 'tu0'",
"args": {
"uuid": "tu0"
},
"level": 1
}
]
}HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
delete /firewall/services/{id}
Delete a service.
Operations Manager base authentication scheme
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 204
Service deleted.
HTTP status code 400
Incomplete data
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failed due to invalid session.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"text": "Invalid session ID",
"args": {},
"level": 1
}
]
}HTTP status code 404
Service does not exist.
Body
Media type: application/json
Type: object
Example:
{
"error": [
{
"type": 5,
"code": 29,
"text": "Could not find firewall/service with name or id 'tu0'",
"args": {
"uuid": "tu0"
},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Collection of zones defined for the appliance's firewall. A zone includes 1 or more interfaces.
Retrieve a list of zones defined for the appliance.
Create a new zone in the config.
get /firewall/zones
Retrieve a list of zones defined for the appliance.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
The list of zones.
Body
Media type: application/json
Type: object
Properties- firewall_zones: required(array of object)
Items: items
- id: required(string)
- name: required(string)
- label: required(string)
- description: required(string)
- physifs: required(array of string)
- permit_all_traffic: required(boolean)
- masquerade: required(boolean)
- permitted_services: required(array of string)
- port_forwarding_rules: required(array of object)
Items: items
- protocol: required(string)
- from_port: required(string)
- to_port: required(integer)
- to_address: (string)
- custom_rules: required(array of object)
Items: items
- rule_content: required(string)
Additional rich rules to be applied to this zone using firewalld 'rich language'. see https://firewalld.org/documentation/man-pages/firewalld.richlanguage.html
- description: (string)
Human-readable description (optional)for this rich rule item.
- rule_content: required(string)
- meta: required(object)
- searchId: (string)
- total_pages: (string)
Example:
{
"firewall_zones": [
{
"id": "firewall-zones-0",
"name": "lan",
"label": "LAN",
"description": "Local Network",
"physifs": [
"net1"
],
"permit_all_traffic": false,
"masquerade": false,
"permitted_services": [
"telnet",
"https",
"http"
],
"port_forwarding_rules": [
{
"protocol": "tcp",
"from_port": "33",
"to_port": 44
}
],
"custom_rules": [
{
"rule_content": "rule family='ipv4' source address='192.168.67.101/32' service name='telnet' accept",
"description": "allow rule"
}
]
},
{
"id": "firewall-zones-1",
"name": "lan2",
"label": "LAN 2",
"description": "Backup Network",
"physifs": [
"net1"
],
"permit_all_traffic": false,
"masquerade": false,
"permitted_services": [],
"port_forwarding_rules": [],
"custom_rules": []
}
],
"meta": {
"total_pages": "1"
}
}HTTP status code 400
Invalid request, missing or incorrect page/per_page
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 4,
"code": 39,
"level": 1,
"text": "Invalid request body",
"args": {}
}
]
}HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
post /firewall/zones
Create a new zone in the config.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- firewall_zone: required(object)
- name: required(string)
- label: required(string)
- description: required(string)
- physifs: required(array of string)
- permit_all_traffic: required(boolean)
- masquerade: required(boolean)
- permitted_services: (array of string)
- port_forwarding_rules: (array of object)
Items: items
- protocol: required(string)
- from_port: required(string)
- to_port: required(integer)
- to_address: (string)
- custom_rules: (array of object)
Items: items
- rule_content: required(string)
Additional rich rules to be applied to this zone using firewalld 'rich language'. see https://firewalld.org/documentation/man-pages/firewalld.richlanguage.html
- description: (string)
Human-readable description (optional)for this rich rule item.
- rule_content: required(string)
Example:
{
"firewall_zone": {
"name": "lan",
"label": "LAN",
"description": "Local Network",
"physifs": [
"net1"
],
"permit_all_traffic": false,
"masquerade": false,
"permitted_services": [
"https",
"ssh"
]
}
}HTTP status code 200
Zone was added.
Body
Media type: application/json
Type: object
Properties- firewall_zone: required(object)
A firewall zone
- id: required(string)
- name: required(string)
- label: required(string)
- description: required(string)
- physifs: required(array of string)
- permit_all_traffic: required(boolean)
- masquerade: required(boolean)
- permitted_services: required(array of string)
- port_forwarding_rules: required(array of object)
Items: items
- protocol: required(string)
- from_port: required(string)
- to_port: required(integer)
- to_address: (string)
- custom_rules: required(array of object)
Items: items
- rule_content: required(string)
Additional rich rules to be applied to this zone using firewalld 'rich language'. see https://firewalld.org/documentation/man-pages/firewalld.richlanguage.html
- description: (string)
Human-readable description (optional)for this rich rule item.
- rule_content: required(string)
Example:
{
"firewall_zone": {
"id": "firewall-zones-0",
"name": "lan",
"label": "LAN",
"description": "Local Network",
"physifs": [
"net1"
],
"permit_all_traffic": false,
"masquerade": false,
"permitted_services": [
"https",
"ssh"
],
"port_forwarding_rules": [
{
"protocol": "tcp",
"from_port": "33",
"to_port": 44
}
],
"custom_rules": []
}
}HTTP status code 400
Failed due to error in post body.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 2,
"code": 12,
"text": "Element is below the minimum allowed length of 1 character(s)",
"args": {
"min": "1",
"uuid": "{60e2b0a-aafa-11e6-aca7-cb7fd0646002"
},
"level": 1
},
{
"type": 1,
"code": 33,
"text": "Push command failed",
"args": {},
"level": 1
}
]
}HTTP status code 401
Authentication failed due to invalid session.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"text": "Invalid session ID",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Retrieve the zone by ID.
Update a zone in the config.
Delete a zone.
get /firewall/zones/{id}
Retrieve the zone by ID.
Operations Manager base authentication scheme
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Zone exists.
Body
Media type: application/json
Type: object
Properties- firewall_zone: required(object)
A firewall zone
- id: required(string)
- name: required(string)
- label: required(string)
- description: required(string)
- physifs: required(array of string)
- permit_all_traffic: required(boolean)
- masquerade: required(boolean)
- permitted_services: required(array of string)
- port_forwarding_rules: required(array of object)
Items: items
- protocol: required(string)
- from_port: required(string)
- to_port: required(integer)
- to_address: (string)
- custom_rules: required(array of object)
Items: items
- rule_content: required(string)
Additional rich rules to be applied to this zone using firewalld 'rich language'. see https://firewalld.org/documentation/man-pages/firewalld.richlanguage.html
- description: (string)
Human-readable description (optional)for this rich rule item.
- rule_content: required(string)
Example:
{
"firewall_zone": {
"id": "firewall-zones-0",
"name": "lan",
"label": "LAN",
"description": "Local Network",
"physifs": [
"net1"
],
"permit_all_traffic": false,
"masquerade": false,
"permitted_services": [
"telnet",
"https",
"http"
],
"port_forwarding_rules": [
{
"protocol": "tcp",
"from_port": "33",
"to_port": 44
}
],
"custom_rules": []
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failed due to invalid session.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}{
"error": [
{
"type": 7,
"code": 42,
"text": "Invalid session ID",
"args": {},
"level": 1
}
]
}HTTP status code 404
Zone does not exist.
Body
Media type: application/json
Type: object
Example:
{
"error": [
{
"type": 5,
"code": 29,
"text": "Could not find firewall/zone with name or id 'tu0'",
"args": {
"uuid": "tu0"
},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /firewall/zones/{id}
Update a zone in the config.
Operations Manager base authentication scheme
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- firewall_zone: required(object)
- name: required(string)
- label: required(string)
- description: required(string)
- physifs: required(array of string)
- permit_all_traffic: required(boolean)
- masquerade: required(boolean)
- permitted_services: (array of string)
- port_forwarding_rules: (array of object)
Items: items
- protocol: required(string)
- from_port: required(string)
- to_port: required(integer)
- to_address: (string)
- custom_rules: (array of object)
Items: items
- rule_content: required(string)
Additional rich rules to be applied to this zone using firewalld 'rich language'. see https://firewalld.org/documentation/man-pages/firewalld.richlanguage.html
- description: (string)
Human-readable description (optional)for this rich rule item.
- rule_content: required(string)
Example:
{
"firewall_zone": {
"name": "lan",
"label": "LAN",
"description": "Local Network",
"physifs": [
"net1"
],
"permit_all_traffic": false,
"masquerade": false,
"permitted_services": [
"https",
"ssh"
]
}
}HTTP status code 200
Zone has been updated.
Body
Media type: application/json
Type: object
Properties- firewall_zone: required(object)
A firewall zone
- id: required(string)
- name: required(string)
- label: required(string)
- description: required(string)
- physifs: required(array of string)
- permit_all_traffic: required(boolean)
- masquerade: required(boolean)
- permitted_services: required(array of string)
- port_forwarding_rules: required(array of object)
Items: items
- protocol: required(string)
- from_port: required(string)
- to_port: required(integer)
- to_address: (string)
- custom_rules: required(array of object)
Items: items
- rule_content: required(string)
Additional rich rules to be applied to this zone using firewalld 'rich language'. see https://firewalld.org/documentation/man-pages/firewalld.richlanguage.html
- description: (string)
Human-readable description (optional)for this rich rule item.
- rule_content: required(string)
Example:
{
"firewall_zone": {
"id": "firewall-zones-1",
"name": "lan2",
"label": "LAN 2",
"description": "Backup Network",
"physifs": [
"net1"
],
"permit_all_traffic": true,
"masquerade": true,
"permitted_services": [
"https",
"ssh"
],
"port_forwarding_rules": [
{
"protocol": "tcp",
"from_port": "33",
"to_port": 44
}
],
"custom_rules": []
}
}HTTP status code 400
Invalid request
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 4,
"code": 39,
"text": "Invalid request body",
"args": {},
"level": 1
}
]
}HTTP status code 401
Authentication failed due to invalid session.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"text": "Invalid session ID",
"args": {},
"level": 1
}
]
}HTTP status code 404
Zone does not exist.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 5,
"code": 29,
"text": "Could not find firewall/zone with name or id 'tu0'",
"args": {
"uuid": "tu0"
},
"level": 1
}
]
}HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
delete /firewall/zones/{id}
Delete a zone.
Operations Manager base authentication scheme
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 204
Zone deleted.
HTTP status code 400
Incomplete data
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failed due to invalid session.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"text": "Invalid session ID",
"args": {},
"level": 1
}
]
}HTTP status code 404
Zone does not exist.
Body
Media type: application/json
Type: object
Example:
{
"error": [
{
"type": 5,
"code": 29,
"text": "Could not find firewall/zone with name or id 'tu0'",
"args": {
"uuid": "tu0"
},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Collection of rules defined for the appliance's firewall. A rule maps a service to a zone.
Retrieve a list of rules defined for the appliance.
Create a new rule in the config.
Bulk delete a list of rules defined for the appliance.
get /firewall/rules
Retrieve a list of rules defined for the appliance.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
The list of rules.
Body
Media type: application/json
Type: object
Properties- firewall_rules: required(array of object)
Items: items
- id: required(string)
- multi_field_identifier: required(string)
A string which can be used to uniquely identify this firewall rule
- service: required(string)
- zone: required(string)
- meta: required(object)
- searchId: (string)
- total_pages: (string)
Example:
{
"firewall_rules": [
{
"id": "firewall-rules-0",
"multi_field_identifier": "wan-http",
"service": "http",
"zone": "wan"
},
{
"id": "firewall-rules-1",
"multi_field_identifier": "lan-https",
"service": "https",
"zone": "lan"
}
],
"meta": {
"total_pages": "1"
}
}HTTP status code 400
Invalid request, missing or incorrect page/per_page
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 4,
"code": 39,
"level": 1,
"text": "Invalid request body",
"args": {}
}
]
}HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
post /firewall/rules
Create a new rule in the config.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- firewall_rule: required(object)
- service: required(string)
- zone: required(string)
Example:
{
"firewall_rule": {
"multi_field_identifier": "wan-http",
"service": "https",
"zone": "wan"
}
}HTTP status code 200
Rule was added.
Body
Media type: application/json
Type: object
Properties- firewall_rule: required(object)
A firewall rule
- id: required(string)
- multi_field_identifier: required(string)
A string which can be used to uniquely identify this firewall rule
- service: required(string)
- zone: required(string)
Example:
{
"firewall_rule": {
"id": "firewall-rules-1",
"multi_field_identifier": "wan-https",
"service": "https",
"zone": "wan"
}
}HTTP status code 400
Failed due to error in post body.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 2,
"code": 12,
"text": "Element is below the minimum allowed length of 1 character(s)",
"args": {
"min": "1",
"uuid": "{60e2b0a-aafa-11e6-aca7-cb7fd0646002"
},
"level": 1
},
{
"type": 1,
"code": 33,
"text": "Push command failed",
"args": {},
"level": 1
}
]
}HTTP status code 401
Authentication failed due to invalid session.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"text": "Invalid session ID",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
delete /firewall/rules
Bulk delete a list of rules defined for the appliance.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- firewall_rules: required(array of string)
Example:
{
"firewall_rules": [
"firewall_rules-1",
"firewall_rules-5"
]
}HTTP status code 204
All rules were deleted successfully.
HTTP status code 400
Invalid request, missing or incorrect page/per_page
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 4,
"code": 39,
"level": 1,
"text": "Invalid request body",
"args": {}
}
]
}HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}HTTP status code 404
Rule(s) do not exist.
Body
Media type: application/json
Type: object
Example:
{
"error": [
{
"type": 5,
"code": 29,
"text": "Could not find element with UUID 'firewall_rules-5'",
"args": {
"uuid": "firewall_rules-5"
},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Retrieve the rule by ID.
Update a rule in the config.
Delete a rule.
get /firewall/rules/{id}
Retrieve the rule by ID.
Operations Manager base authentication scheme
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Rule exists.
Body
Media type: application/json
Type: object
Properties- firewall_rule: required(object)
A firewall rule
- id: required(string)
- multi_field_identifier: required(string)
A string which can be used to uniquely identify this firewall rule
- service: required(string)
- zone: required(string)
Example:
{
"firewall_rule": {
"id": "firewall-rules-1",
"multi_field_identifier": "wan-https",
"service": "https",
"zone": "wan"
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failed due to invalid session.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}{
"error": [
{
"type": 7,
"code": 42,
"text": "Invalid session ID",
"args": {},
"level": 1
}
]
}HTTP status code 404
Rule does not exist.
Body
Media type: application/json
Type: object
Example:
{
"error": [
{
"type": 5,
"code": 29,
"text": "Could not find element with UUID 'tu0'",
"args": {
"uuid": "tu0"
},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /firewall/rules/{id}
Update a rule in the config.
Operations Manager base authentication scheme
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- firewall_rule: required(object)
- service: required(string)
- zone: required(string)
Example:
{
"firewall_rule": {
"multi_field_identifier": "wan-https",
"service": "https",
"zone": "wan"
}
}HTTP status code 200
Rule has been updated.
Body
Media type: application/json
Type: object
Properties- firewall_rule: required(object)
A firewall rule
- id: required(string)
- multi_field_identifier: required(string)
A string which can be used to uniquely identify this firewall rule
- service: required(string)
- zone: required(string)
Example:
{
"firewall_rule": {
"id": "firewall-rules-1",
"multi_field_identifier": "wan-https",
"service": "https",
"zone": "wan"
}
}HTTP status code 400
Invalid request
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 4,
"code": 39,
"text": "Invalid request body",
"args": {},
"level": 1
}
]
}HTTP status code 401
Authentication failed due to invalid session.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"text": "Invalid session ID",
"args": {},
"level": 1
}
]
}HTTP status code 404
Rule does not exist.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 5,
"code": 29,
"text": "Could not find element with UUID 'tu0'",
"args": {
"uuid": "tu0"
},
"level": 1
}
]
}HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
delete /firewall/rules/{id}
Delete a rule.
Operations Manager base authentication scheme
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 204
Rule deleted.
HTTP status code 400
Incomplete data
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failed due to invalid session.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"text": "Invalid session ID",
"args": {},
"level": 1
}
]
}HTTP status code 404
Rule does not exist.
Body
Media type: application/json
Type: object
Example:
{
"error": [
{
"type": 5,
"code": 29,
"text": "Could not find element with UUID 'tu0'",
"args": {
"uuid": "tu0"
},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Collection of predefined services defined for the appliance's firewall. A service is a named grouping of one or more TCP or UDP ports for a particular networking protocol. For example, the 'https' service refers to TCP port 443. This collection contains predefined services for common protocols and doesn't include the services added by the administrator.
Retrieve a list of predefined services defined for the appliance.
get /firewall/predefined_services
Retrieve a list of predefined services defined for the appliance.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
The list of predefined services.
Body
Media type: application/json
Type: object
Properties- predefined_firewall_services: required(array of object)
Items: items
- name: required(string)
- label: required(string)
- ports: required(array of object)
Items: items
- protocol: required(string)
- port: required(string)
Can be a numeric port number or a range such as 5900-5903
- meta: required(object)
- searchId: (string)
- total_pages: (string)
Example:
{
"predefined_firewall_services": [
{
"name": "http",
"label": "HTTP",
"ports": [
{
"protocol": "tcp",
"port": "80"
}
]
},
{
"name": "https",
"label": "HTTPS",
"ports": [
{
"protocol": "tcp",
"port": "443"
}
]
}
],
"meta": {
"total_pages": "1"
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Collection of policies defined for the appliance's firewall. A policy specifies which zones traffic is allowed to route between.
Retrieve a list of policies defined for the appliance.
Create a new policy in the config.
get /firewall/policies
Retrieve a list of policies defined for the appliance.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
The list of policies.
Body
Media type: application/json
Type: object
Properties- firewall_policies: required(array of object)
Items: items
- id: required(string)
- name: required(string)
- description: (string)
- ingress_zones: required(array of string)
- egress_zones: required(array of string)
- meta: required(object)
- searchId: (string)
- total_pages: (string)
Example:
{
"firewall_policies": [
{
"id": "firewall_policies-1",
"name": "lan_to_wan",
"description": "LAN --> WAN",
"ingress_zones": [
"lan"
],
"egress_zones": [
"wan"
]
},
{
"id": "firewall_policies-2",
"name": "wan_to_lan",
"ingress_zones": [
"wan"
],
"egress_zones": [
"lan"
]
}
],
"meta": {
"total_pages": "1"
}
}HTTP status code 400
Invalid request, missing or incorrect page/per_page
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 4,
"code": 39,
"level": 1,
"text": "Invalid request body",
"args": {}
}
]
}HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
post /firewall/policies
Create a new policy in the config.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- firewall_policy: required(object)
- name: required(string)
- description: (string)
- ingress_zones: required(array of string)
- egress_zones: required(array of string)
Example:
{
"firewall_policy": {
"name": "lan_to_wan",
"description": "LAN --> WAN",
"ingress_zones": [
"lan"
],
"egress_zones": [
"wan",
"lhvpn"
]
}
}HTTP status code 201
Policy was added.
Body
Media type: application/json
Type: object
Properties- firewall_policy: required(object)
A firewall policy
- id: required(string)
- name: required(string)
- description: (string)
- ingress_zones: required(array of string)
- egress_zones: required(array of string)
Example:
{
"firewall_policy": {
"id": "firewall_policies-1",
"name": "lan_to_wan",
"description": "LAN --> WAN",
"ingress_zones": [
"lan"
],
"egress_zones": [
"wan",
"lhvpn"
]
}
}HTTP status code 400
Failed due to error in post body.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 2,
"code": 12,
"text": "Element is below the minimum allowed length of 1 character(s)",
"args": {
"min": "1",
"uuid": "{60e2b0a-aafa-11e6-aca7-cb7fd0646002"
},
"level": 1
},
{
"type": 1,
"code": 33,
"text": "Push command failed",
"args": {},
"level": 1
}
]
}HTTP status code 401
Authentication failed due to invalid session.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"text": "Invalid session ID",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Retrieve the policy by ID.
Update a policy in the config.
Delete a policy.
get /firewall/policies/{id}
Retrieve the policy by ID.
Operations Manager base authentication scheme
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Policy exists.
Body
Media type: application/json
Type: object
Properties- firewall_policy: required(object)
A firewall policy
- id: required(string)
- name: required(string)
- description: (string)
- ingress_zones: required(array of string)
- egress_zones: required(array of string)
Example:
{
"firewall_policy": {
"id": "firewall_policies-1",
"name": "lan_to_wan",
"description": "LAN --> WAN",
"ingress_zones": [
"lan"
],
"egress_zones": [
"wan"
]
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failed due to invalid session.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}{
"error": [
{
"type": 7,
"code": 42,
"text": "Invalid session ID",
"args": {},
"level": 1
}
]
}HTTP status code 404
Policy does not exist.
Body
Media type: application/json
Type: object
Example:
{
"error": [
{
"type": 5,
"code": 29,
"text": "Could not find firewall/policy with name or id 'firewall_policies-2'",
"args": {
"uuid": "firewall_policies-2"
},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /firewall/policies/{id}
Update a policy in the config.
Operations Manager base authentication scheme
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- firewall_policy: required(object)
- name: required(string)
- description: (string)
- ingress_zones: required(array of string)
- egress_zones: required(array of string)
Example:
{
"firewall_policy": {
"name": "lan_to_wan",
"description": "LAN --> WAN",
"ingress_zones": [
"lan"
],
"egress_zones": [
"wan"
]
}
}HTTP status code 200
Policy has been updated.
Body
Media type: application/json
Type: object
Properties- firewall_policy: required(object)
A firewall policy
- id: required(string)
- name: required(string)
- description: (string)
- ingress_zones: required(array of string)
- egress_zones: required(array of string)
Example:
{
"firewall_policy": {
"id": "firewall_policies-1",
"name": "lan_to_wan",
"description": "LAN --> WAN",
"ingress_zones": [
"lan"
],
"egress_zones": [
"wan"
]
}
}HTTP status code 400
Invalid request
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 4,
"code": 39,
"text": "Invalid request body",
"args": {},
"level": 1
}
]
}HTTP status code 401
Authentication failed due to invalid session.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"text": "Invalid session ID",
"args": {},
"level": 1
}
]
}HTTP status code 404
Policy does not exist.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 5,
"code": 29,
"text": "Could not find firewall/policy with name or id 'firewall_policies-2'",
"args": {
"uuid": "firewall_policies-2"
},
"level": 1
}
]
}HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
delete /firewall/policies/{id}
Delete a policy.
Operations Manager base authentication scheme
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 204
Policy deleted.
HTTP status code 400
Incomplete data
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failed due to invalid session.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"text": "Invalid session ID",
"args": {},
"level": 1
}
]
}HTTP status code 404
Policy does not exist.
Body
Media type: application/json
Type: object
Example:
{
"error": [
{
"type": 5,
"code": 29,
"text": "Could not find firewall/policy with name or id 'firewall_policies-2'",
"args": {
"uuid": "firewall_policies-2"
},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
/cellfw
The cellfw endpoints are related to checking, upgrading and scheduling upgrades for modem firmware.
Retrieve modem version and related info
get /cellfw/info
Retrieve modem version and related info
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- cellfw_info: required(object)
- firmware: required(string)
- operating_mode: required(string)
Example:
{
"cellfw_info": {
"firmware": "Model: EM7565\nBoot version: SWI9X50C_01.08.04.00\nAMSS version: SWI9X50C_01.08.04.00\n\tSKU ID: 1103520\nPackage ID: unknown\nCarrier ID: 1\nConfig version: 002.012_000",
"operating_mode": "Mode: 'online'\nHW restricted: 'no'"
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
/export
Retrieve system configuration for the Operations Manager.
get /export
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- export: required(object)
HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
/failover
Failover endpoint is to check failover status and retrieve / change failover settings.
failover/settings endpoint is to check and update failover settings.
Retrieve the current failover settings.
Set the failover settings.
get /failover/settings
Retrieve the current failover settings.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Returns the current failover settings.
Body
Media type: application/json
Type: object
Properties- failover_settings: required(object)
- enabled: required(boolean - default: false)
- probe_physif: required(string)
A Failover event occurs if the probe_address is not reachable on this network interface.
- probe_address: required(string)
Probe address can be an IPv4 address, IPv6 address or a hostname. Be aware that hostnames may not resolve during Failover depending on DNS settings.
Example:
{
"failover_settings": {
"enabled": true,
"probe_physif": "net1",
"probe_address": "8.8.8.8"
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /failover/settings
Set the failover settings.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- failover_settings: required(object)
- probe_physif: required(string)
[Optional when Failover is disabled]
A Failover event occurs if the probe_address is not reachable on this network interface. - enabled: required(boolean - default: false)
- probe_address: required(string)
Probe address can be an IPv4 address, IPv6 address or a hostname. Be aware that hostnames may not resolve during Failover depending on DNS settings.
- probe_physif: required(string)
Examples:
example1:
{
"failover_settings": {
"enabled": true,
"probe_physif": "net1",
"probe_address": "8.8.8.8"
}
}example2:
{
"failover_settings": {
"enabled": false,
"probe_physif": "net2",
"probe_address": "192.168.0.1"
}
}HTTP status code 200
Returns the current failover settings.
Body
Media type: application/json
Type: object
Properties- failover_settings: required(object)
- enabled: required(boolean - default: false)
- probe_physif: required(string)
A Failover event occurs if the probe_address is not reachable on this network interface.
- probe_address: required(string)
Probe address can be an IPv4 address, IPv6 address or a hostname. Be aware that hostnames may not resolve during Failover depending on DNS settings.
Examples:
example1:
{
"failover_settings": {
"enabled": true,
"probe_physif": "net1",
"probe_address": "8.8.8.8"
}
}example2:
{
"failover_settings": {
"enabled": false,
"probe_physif": "net2",
"probe_address": "192.168.0.1"
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
failover/status endpoint is to check current failover status.
Retrieve the current failover status.
get /failover/status
Retrieve the current failover status.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Returns the current failover settings.
Body
Media type: application/json
Type: object
Properties- failover_status: required(object)
- status: required(one of primary_starting, primary_complete, primary_stopping, failover_starting, failover_complete, failover_stopping, disabled, unknown)
Failover status
- status: required(one of primary_starting, primary_complete, primary_stopping, failover_starting, failover_complete, failover_stopping, disabled, unknown)
Example:
{
"failover_status": {
"status": "failover_complete"
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
/cellmodem
Retrieve information about the cell modem.
This endpoint is used to retrieve status data about the cellular modem in the device
get /cellmodem
This endpoint is used to retrieve status data about the cellular modem in the device
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
A JSON object containing cellmodem information.
Body
Media type: application/json
Type: object
Properties- cellmodem: required(object)
- enabled: required(boolean)
Is the cell modem currently enabled
- device: required(string)
Device name
- up: required(boolean)
Is this cell modem currently connected
- signalStrength: required(integer)
Signal quality (%) (backwards compatable)
- signal_quality: required(integer)
Signal quality (%)
- rssi: required(integer)
Received Signal Strength Indicator (RSSI)
- technology: required(string)
Access technology
- modem_status: required(string)
Modem status
- failure_reason: required(string)
Failure reason
- ipv4_addresses: required(array of string)
IPv4 addresses of the cell modem
- ipv6_addresses: required(array of string)
IPv6 addresses of the cell modem
- failover: (object)
Details about whether failover is enabled on the cell modem
- enabled: required(boolean)
Is Failover enabled
- active: required(boolean)
Is Failover active
- dormant: required(boolean)
Does the interface stay up when not failed-over to
- enabled: required(boolean)
- sims: (object)
Details about the current SIM cards
- active_sim: required(number)
The current selected SIM
- failover_status: required(one of disabled, enabled, failing_over, failed_over, failing_back, unknown)
The current SIM failover state
- sim1: required(object)
Details about SIM1
- iccid: required(string)
SIM ICCID
- carrier: required(string)
SIM Carrier
- apn: required(string)
SIM APN
- ip_type: required(string)
SIM IP-Type
- username: required(string)
SIM User
- imsi: required(string)
SIM IMSI
- state: required(string)
Current state of the SIM
- last_active: required(number)
The time-stamp of the last time this SIM became active
- last_update: required(number)
The time-stamp of the last update
- signal_strength: required(number)
Signal strength of the modem connection with this SIM
- iccid: required(string)
- sim2: required(object)
Details about SIM2
- iccid: required(string)
SIM ICCID
- carrier: required(string)
SIM Carrier
- apn: required(string)
SIM APN
- ip_type: required(string)
SIM IP-Type
- username: required(string)
SIM User
- imsi: required(string)
SIM IMSI
- state: required(string)
Current state of the SIM
- last_active: required(number)
The time-stamp of the last time this SIM became active
- last_update: required(number)
The time-stamp of the last update
- signal_strength: required(number)
Signal strength of the modem connection with this SIM
- iccid: required(string)
- active_sim: required(number)
- enabled: required(boolean)
Example:
{
"cellmodem": {
"enabled": true,
"device": "wwan0",
"up": true,
"signalStrength": 89,
"signal_quality": 89,
"rssi": -67,
"technology": "lte, cdma",
"modem_status": "connected",
"failure_reason": "none",
"ipv4_addresses": [
"123.127.198.4"
],
"ipv6_addresses": [
"fe80::69dc:654f:f1e5:ff12"
],
"failover": {
"enabled": false,
"dormant": false,
"active": false
},
"sims": {
"active_sim": 2,
"failover_status": "enabled",
"sim1": {
"iccid": "89148000004743232368",
"carrier": "Verizon Wireless",
"apn": "VZWINTERNET",
"ip_type": "ipv4v6",
"username": "",
"imsi": "",
"state": "present",
"last_active": 1598222515038,
"last_update": 1598222515038,
"signal_strength": 94
},
"sim2": {
"iccid": "89014103278929156118",
"carrier": "AT&T Wireless Inc",
"apn": "i2gold",
"ip_type": "ipv4v6",
"username": "",
"imsi": "310410892915611",
"state": "present",
"last_active": 1598222515038,
"last_update": 1598222515038,
"signal_strength": 93
}
}
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}HTTP status code 404
Cellular modem was not found.
Body
Media type: application/json
Type: object
Properties- error: required(string)
Example:
{
"error": "No Cellular Modem detected"
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Cell modem SIM status
Retrieve the current SIM status.
get /cellmodem/sims
Retrieve the current SIM status.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Returns the current SIM status.
Body
Media type: application/json
Type: object
Properties- cellmodem_sims: required(array of object)
Items: items
- id: required(string)
- active: required(boolean)
This SIM is the currently selected SIM
- slot: required(number)
SIM Slot
- iccid: required(string)
SIM ICCID
- carrier: required(string)
SIM Carrier
- apn: required(string)
SIM APN
- ip_type: required(string)
SIM IP-Type
- username: required(string)
SIM User
- imsi: required(string)
SIM IMSI
- state: required(string)
Current state of the SIM
- last_active: required(number)
The time-stamp of the last time this SIM became active
- last_update: required(number)
The time-stamp of the last update
- signal_strength: required(number)
Signal strength of the modem connection with this SIM
Example:
{
"cellmodem_sims": [
{
"id": "cellmodem-sim-1",
"active": true,
"slot": 1,
"iccid": "89148000004743232368",
"carrier": "Verizon Wireless",
"apn": "VZWINTERNET",
"ip_type": "ipv4v6",
"username": "",
"imsi": "",
"state": "present",
"last_active": 1598222515038,
"last_update": 1598222515038,
"signal_strength": 94
},
{
"id": "cellmodem-sim-2",
"active": false,
"slot": 2,
"iccid": "89014103278929156118",
"carrier": "AT&T Wireless Inc",
"apn": "i2gold",
"ip_type": "ipv4v6",
"username": "",
"imsi": "310410892915611",
"state": "present",
"last_active": 1598222515038,
"last_update": 1598222515038,
"signal_strength": 93
}
]
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}HTTP status code 404
Cellular modem was not found.
Body
Media type: application/json
Type: object
Properties- error: required(string)
Example:
{
"error": "No Cellular Modem detected"
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
/ipsec_tunnels
Read and manipulate the IPsec tunnels on the Operations Manager appliance.
Get a list of the IPsec tunnels.
Add a new network tunnel to the Operations Manager appliance.
get /ipsec_tunnels
Get a list of the IPsec tunnels.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Query Parameters
- secrets: (one of cleartext, obfuscate, mask - default: cleartext)
Returns sensitive fields displayed as either cleartext, obfuscated or masked values.
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- ipsec_tunnels: required(array of object)
Items: items
- id: required(string)
Database ID for this IPsec tunnel.
- name: required(string)
Each IPsec tunnel must have a unique symbolic name. The name can contain letters, digits, and hyphens. It will appear in log messages when the tunnel is being established. Use this to distinguish between multiple tunnels on the device.
- enabled: required(boolean)
- initiate: required(boolean)
When true, the device will actively initiate the tunnel by sending IKE negotiation packets to the remote end. If false, the tunnel will only be activated when an IKE negotiation is initiated by the remote end.
- version: required(string)
An IPsec tunnel can use either the IKEv1 or IKEv2 protocol. IKEv1 also provides the ability to run in aggressive mode which is not applicable to IKEv2
- keying_tries: required(integer)
The number of attempts that should be made to negotiate a connection before giving up. The default value of 0 means 'never give up'.
- dpd_enabled: (boolean)
- dpd_action: (string)
Determines the action to perform on timeout.
- dpd_delay: (integer)
Defines the time interval between keep-alive exchanges sent to the peer.
- dpd_timeout: required(integer)
Defines the timeout period for a connection.
- phase1_rekey_time: (integer)
Controls the time between key material refreshes for the IKE. This is only valid for IKEv2 and 0s translates to disabled.
- phase1_rekey_unit: (string)
Determines the units for phase1_rekey_time.
- phase1_reauth_time: (integer)
Controls the time between IKE reauthentication. 0s translates to disabled.
- phase1_reauth_unit: (string)
Determines the units for phase1_reauth_time.
- phase1_random_time: (integer)
Time range from which to choose a random value to subtract from IKE rekey/reauth times. Is used to avoid both peers initiating the process simultaneously.
- phase1_random_unit: (string)
Determines the units for phase1_random_time.
- phase1_over_time: (integer)
The hard IKE SA lifetime if rekey/reauth does not complete. The default value is 10% of phase1_rekey_time or phase1_reauth_time, whichever is greater. The expiry of an IKE SA is calculated using this value plus phase1_rekey_time or phase1_reauth_time.
- phase1_over_unit: (string)
Determines the units for phase1_over_time.
- phase2_rekey_time: (integer)
Controls the time between key material refreshes for the CHILD_SA. 0s translates to disabled.
- phase2_rekey_unit: (string)
Determines the units for phase2_rekey_time.
- phase2_random_time: (integer)
Time range from which to choose a random value to subtract from IKE rekey/reauth times. Is used to avoid both peers initiating the process simultaneously.
- phase2_random_unit: (string)
Determines the units for phase2_random_time.
- phase2_life_time: (integer)
The maximum lifetime before an IPsec SA gets closed. The default value is 110% of phase2_rekey_time. The expiry of an IPsec SA is equivalent to this value.
- phase2_life_unit: (string)
Determines the units for phase2_life_time.
- proposal: required(string)
Algorithm to be used for Key Exchange for establishing this tunnel
Annotations
- deprecatedProperty
{"since":"03/2021"}
- deprecatedProperty
- phase1_proposal: required(string)
Algorithms to be used for Key Exchange (Phase 1) for establishing this tunnel
- phase2_proposal: required(string)
Algorithms to be used for IPsec/Child SA (Phase 2) for this tunnel
- phase2_proposal_type: required(one of esp, ah)
IPsec/Child SA proposal type. ESP protocol or AH protocol can be selected
- local_id: required(string)
Local IKE identity to use for authentication.
- remote_id: required(string)
Remote IKE identity to expect for authentication.
- local_address: (string)
Local address to be used for this IPsec tunnel. If left blank, this address will be automatically filled during key negotiation.
- remote_address: (string)
Remote address to be used for this IKE negotiation of this tunnel. If the local device does not initiate the tunnel, incoming requests must match this address.
- encap: (boolean)
Force encapsulation
- local_subnet: required(string)
Local subnet traffic selector to be used for this tunnel. When left blank, this will be replaced by the outer local address of the tunnel upon negotiation.
- remote_subnet: required(string)
Remote subnet traffic selector to be used for this tunnel. When left blank, this will be replaced by the outer remote address of the tunnel upon negotiation.
- auth_mode: required(one of psk, pki - default: psk)
Authentication type for this tunnel, psk (Pre-Shared Key) or pki (Public Key Infrastructure).
- shared_secret: (string)
For the pre-shared key authentication mode, both ends of the tunnel must use the same key. This is required for auth_mode psk. [sensitive]
- runtime_status: required(object)
- established: required(boolean)
This value is reported as true when the tunnel has been negotiated successfully and is currently active.
- established: required(boolean)
- id: required(string)
Example:
{
"ipsec_tunnels": [
{
"id": "0",
"name": "tunnel",
"enabled": true,
"initiate": false,
"version": "IKEv2",
"keying_tries": 5,
"dpd_enabled": true,
"dpd_action": "hold",
"dpd_delay": 20,
"dpd_timeout": 80,
"phase1_rekey_time": 4,
"phase1_rekey_unit": "days",
"phase1_reauth_time": 4,
"phase1_reauth_unit": "weeks",
"phase1_random_time": 2,
"phase1_random_unit": "minutes",
"phase1_over_time": 10,
"phase1_over_unit": "hours",
"phase2_rekey_time": 1,
"phase2_rekey_unit": "weeks",
"phase2_random_time": 70,
"phase2_random_unit": "seconds",
"phase2_life_time": 22,
"phase2_life_unit": "hours",
"proposal": "default-pfs",
"phase1_proposal": "default",
"phase2_proposal": "aes128-aes192-aes256-sha256-sha384-sha512-sha1-aesxcbc-modp2048-modp3072-modp4096-modp6144-modp8192-ecp224-ecp256-ecp384-ecp521",
"phase2_proposal_type": "esp",
"local_id": "",
"remote_id": "",
"local_address": "192.168.126.77",
"remote_address": "192.168.121.5",
"encap": true,
"local_subnet": "",
"remote_subnet": "",
"auth_mode": "psk",
"shared_secret": "default",
"runtime_status": {
"established": false
}
},
{
"id": "1",
"name": "remote-site-tunnel",
"enabled": false,
"initiate": false,
"version": "IKEv2",
"keying_tries": 15,
"dpd_enabled": true,
"dpd_action": "clear",
"dpd_delay": 40,
"dpd_timeout": 70,
"phase1_rekey_time": 2,
"phase1_rekey_unit": "days",
"phase1_reauth_time": 5,
"phase1_reauth_unit": "weeks",
"phase2_rekey_time": 2,
"phase2_rekey_unit": "weeks",
"proposal": "3des-sha-modp1024",
"phase1_proposal": "3des-sha-modp1024",
"phase2_proposal": "3des-sha-modp1024",
"phase2_proposal_type": "esp",
"local_id": "",
"remote_id": "",
"local_address": "",
"remote_address": "192.168.126.77",
"encap": true,
"local_subnet": "",
"remote_subnet": "",
"auth_mode": "psk",
"shared_secret": "password2",
"runtime_status": {
"established": true
}
},
{
"id": "2",
"name": "remote-site-tunnel-pki",
"enabled": false,
"initiate": false,
"version": "IKEv2",
"keying_tries": 15,
"dpd_enabled": true,
"dpd_action": "clear",
"dpd_delay": 40,
"dpd_timeout": 70,
"phase1_rekey_time": 2,
"phase1_rekey_unit": "days",
"phase1_reauth_time": 5,
"phase1_reauth_unit": "weeks",
"phase2_rekey_time": 2,
"proposal": "3des-sha-modp1024",
"phase1_proposal": "3des-sha-modp1024",
"phase2_proposal": "3des-sha-modp1024",
"phase2_proposal_type": "esp",
"local_id": "",
"remote_id": "",
"local_address": "",
"remote_address": "192.168.126.78",
"encap": true,
"local_subnet": "",
"remote_subnet": "",
"auth_mode": "pki",
"runtime_status": {
"established": true
}
}
]
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
post /ipsec_tunnels
Add a new network tunnel to the Operations Manager appliance.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Query Parameters
- secrets: (one of cleartext, obfuscate - default: cleartext)
Accepts sensitive fields as either cleartext or obfuscated values. The response will display the sensitive fields in the same way.
Body
Media type: application/json
Type: object
Properties- ipsec_tunnel: required(object)
This object contains configuration information for an IPsec tunnel.
- name: required(string)
Each IPsec tunnel must have a unique symbolic name. The name can contain letters, digits, and hyphens. It will appear in log messages when the tunnel is being established. Use this to distinguish between multiple tunnels on the device.
- enabled: required(boolean)
- initiate: required(boolean)
When true, the device will actively initiate the tunnel by sending IKE negotiation packets to the remote end. If false, the tunnel will only be activated when an IKE negotiation is initiated by the remote end.
- version: required(string)
An IPsec tunnel can use either the IKEv1 or IKEv2 protocol. IKEv1 also provides the ability to run in aggressive mode which is not applicable to IKEv2
- keying_tries: (integer)
The number of attempts that should be made to negotiate a connection before giving up. The default value of 0 means 'never give up'.
- dpd_enabled: (boolean)
- dpd_action: (string)
Determines the action to perform on timeout.
- dpd_delay: (integer)
Defines the time interval between keep-alive exchanges sent to the peer.
- dpd_timeout: (integer)
Defines the timeout period for a connection.
- phase1_rekey_time: (integer)
Controls the time between key material refreshes for the IKE. This is only valid for IKEv2 and 0s translates to disabled.
- phase1_rekey_unit: (string)
Determines the units for phase1_rekey_time.
- phase1_reauth_time: (integer)
Controls the time between IKE reauthentication. 0s translates to disabled.
- phase1_reauth_unit: (string)
Determines the units for phase1_reauth_time.
- phase1_random_time: (integer)
Time range from which to choose a random value to subtract from IKE rekey/reauth times. Is used to avoid both peers initiating the process simultaneously.
- phase1_random_unit: (string)
Determines the units for phase1_random_time.
- phase1_over_time: (integer)
The hard IKE SA lifetime if rekey/reauth does not complete. The default value is 10% of phase1_rekey_time or phase1_reauth_time, whichever is greater. The expiry of an IKE SA is calculated using this value plus phase1_rekey_time or phase1_reauth_time.
- phase1_over_unit: (string)
Determines the units for phase1_over_time.
- phase2_rekey_time: (integer)
Controls the time between key material refreshes for the CHILD_SA. 0s translates to disabled.
- phase2_rekey_unit: (string)
Determines the units for phase2_rekey_time.
- phase2_random_time: (integer)
Time range from which to choose a random value to subtract from IKE rekey/reauth times. Is used to avoid both peers initiating the process simultaneously.
- phase2_random_unit: (string)
Determines the units for phase2_random_time.
- phase2_life_time: (integer)
The maximum lifetime before an IPsec SA gets closed. The default value is 110% of phase2_rekey_time. The expiry of an IPsec SA is equivalent to this value.
- phase2_life_unit: (string)
Determines the units for phase2_life_time.
- proposal: (string)
Algorithm to be used for Key Exchange for establishing this tunnel
Annotations
- deprecatedProperty
{"replaceWith":{"phase1_proposal":"ike_proposals","phase2_proposal":"ipsec_proposals"},"since":"03/2021"}
- deprecatedProperty
- phase1_proposal: (string)
Algorithm proposals to be used for Key Exchange (Phase 1) for establishing this tunnel. A proposal is a set of algorithms. For non-AEAD algorithms, this includes for IKE an encryption algorithm, an integrity algorithm, a pseudo random function and a Diffie-Hellman group. For AEAD algorithms, instead of encryption and integrity algorithms, a combined algorithm is used.
See the following pages to check which algorithms are supported by strongswan.
- IKEv1 Cipher Suites: https://wiki.strongswan.org/projects/strongswan/wiki/IKEv1CipherSuites
- IKEv2 Cipher Suites: https://wiki.strongswan.org/projects/strongswan/wiki/IKEv2CipherSuites
Multiple proposals may be provided through a comma-separated string.
- example: aes128-sha256-ecp256,aes128-sha256-modp2048 Multiple algorithm types may be present in a single proposal (natively supported in IKEv2 and our backend will split it for IKEv1 cases).
- example: aes128-aes256-sha256-sha384-ecp256-modp2048 (single proposal with 2 encryption algorithms, 2 integrigity algorithms and 2 DH groups)
See also swanctl.conf connections.
.proposals field: https://wiki.strongswan.org/projects/strongswan/wiki/Swanctlconf - phase2_proposal: (string)
Algorithm proposals to be used for IPsec/Child SA (Phase 2) for this tunnel.
See phase1_proposal's description to for more information about proposals.
See also swanctl.conf ah_proposals and esp_proposals fields: https://wiki.strongswan.org/projects/strongswan/wiki/Swanctlconf
- phase2_proposal_type: (one of esp, ah - default: esp)
IPsec/Child SA proposal type. ESP protocol or AH protocol can be selected
- local_id: (string)
Local IKE identity to use for authentication.
- remote_id: (string)
Remote IKE identity to expect for authentication.
- local_address: (string)
Local address to be used for this IPsec tunnel. If left blank, this address will be automatically filled during key negotiation.
- remote_address: (string)
Remote address to be used for this IKE negotiation of this tunnel. If the local device does not initiate the tunnel, incoming requests must match this address.
- encap: (boolean)
Force encapsulation
- local_subnet: (string)
Local subnet traffic selector to be used for this tunnel. When left blank, this will be replaced by the outer local address of the tunnel upon negotiation.
- remote_subnet: (string)
Remote subnet traffic selector to be used for this tunnel. When left blank, this will be replaced by the outer remote address of the tunnel upon negotiation.
- auth_mode: (one of psk, pki - default: psk)
Authentication type for this tunnel, psk (Pre-Shared Key) or pki (Public Key Infrastructure).
- shared_secret: (string)
For the pre-shared key authentication mode, both ends of the tunnel must use the same key. This is required for auth_mode psk. [sensitive]
- name: required(string)
Example:
{
"ipsec_tunnel": {
"name": "tunnel",
"enabled": true,
"initiate": false,
"version": "IKEv1",
"local_address": "192.168.126.77",
"remote_address": "192.168.121.5",
"shared_secret": "default"
}
}HTTP status code 200
The tunnel {id} settings was updated.
Body
Media type: application/json
Type: object
Properties- ipsec_tunnel: required(object)
This object contains configuration information for an IPsec tunnel.
- id: required(string)
Database ID for this IPsec tunnel.
- name: required(string)
Each IPsec tunnel must have a unique symbolic name. The name can contain letters, digits, and hyphens. It will appear in log messages when the tunnel is being established. Use this to distinguish between multiple tunnels on the device.
- enabled: required(boolean)
- initiate: required(boolean)
When true, the device will actively initiate the tunnel by sending IKE negotiation packets to the remote end. If false, the tunnel will only be activated when an IKE negotiation is initiated by the remote end.
- version: required(string)
An IPsec tunnel can use either the IKEv1 or IKEv2 protocol. IKEv1 also provides the ability to run in aggressive mode which is not applicable to IKEv2
- keying_tries: required(integer)
The number of attempts that should be made to negotiate a connection before giving up. The default value of 0 means 'never give up'.
- dpd_enabled: (boolean)
- dpd_action: (string)
Determines the action to perform on timeout.
- dpd_delay: (integer)
Defines the time interval between keep-alive exchanges sent to the peer.
- dpd_timeout: required(integer)
Defines the timeout period for a connection.
- phase1_rekey_time: (integer)
Controls the time between key material refreshes for the IKE. This is only valid for IKEv2 and 0s translates to disabled.
- phase1_rekey_unit: (string)
Determines the units for phase1_rekey_time.
- phase1_reauth_time: (integer)
Controls the time between IKE reauthentication. 0s translates to disabled.
- phase1_reauth_unit: (string)
Determines the units for phase1_reauth_time.
- phase1_random_time: (integer)
Time range from which to choose a random value to subtract from IKE rekey/reauth times. Is used to avoid both peers initiating the process simultaneously.
- phase1_random_unit: (string)
Determines the units for phase1_random_time.
- phase1_over_time: (integer)
The hard IKE SA lifetime if rekey/reauth does not complete. The default value is 10% of phase1_rekey_time or phase1_reauth_time, whichever is greater. The expiry of an IKE SA is calculated using this value plus phase1_rekey_time or phase1_reauth_time.
- phase1_over_unit: (string)
Determines the units for phase1_over_time.
- phase2_rekey_time: (integer)
Controls the time between key material refreshes for the CHILD_SA. 0s translates to disabled.
- phase2_rekey_unit: (string)
Determines the units for phase2_rekey_time.
- phase2_random_time: (integer)
Time range from which to choose a random value to subtract from IKE rekey/reauth times. Is used to avoid both peers initiating the process simultaneously.
- phase2_random_unit: (string)
Determines the units for phase2_random_time.
- phase2_life_time: (integer)
The maximum lifetime before an IPsec SA gets closed. The default value is 110% of phase2_rekey_time. The expiry of an IPsec SA is equivalent to this value.
- phase2_life_unit: (string)
Determines the units for phase2_life_time.
- proposal: required(string)
Algorithm to be used for Key Exchange for establishing this tunnel
Annotations
- deprecatedProperty
{"since":"03/2021"}
- deprecatedProperty
- phase1_proposal: required(string)
Algorithms to be used for Key Exchange (Phase 1) for establishing this tunnel
- phase2_proposal: required(string)
Algorithms to be used for IPsec/Child SA (Phase 2) for this tunnel
- phase2_proposal_type: required(one of esp, ah)
IPsec/Child SA proposal type. ESP protocol or AH protocol can be selected
- local_id: required(string)
Local IKE identity to use for authentication.
- remote_id: required(string)
Remote IKE identity to expect for authentication.
- local_address: (string)
Local address to be used for this IPsec tunnel. If left blank, this address will be automatically filled during key negotiation.
- remote_address: (string)
Remote address to be used for this IKE negotiation of this tunnel. If the local device does not initiate the tunnel, incoming requests must match this address.
- encap: (boolean)
Force encapsulation
- local_subnet: required(string)
Local subnet traffic selector to be used for this tunnel. When left blank, this will be replaced by the outer local address of the tunnel upon negotiation.
- remote_subnet: required(string)
Remote subnet traffic selector to be used for this tunnel. When left blank, this will be replaced by the outer remote address of the tunnel upon negotiation.
- auth_mode: required(one of psk, pki - default: psk)
Authentication type for this tunnel, psk (Pre-Shared Key) or pki (Public Key Infrastructure).
- shared_secret: (string)
For the pre-shared key authentication mode, both ends of the tunnel must use the same key. This is required for auth_mode psk. [sensitive]
- runtime_status: required(object)
- established: required(boolean)
This value is reported as true when the tunnel has been negotiated successfully and is currently active.
- established: required(boolean)
- id: required(string)
Example:
{
"ipsec_tunnel": {
"id": "0",
"name": "tunnel",
"enabled": true,
"initiate": false,
"version": "IKEv1",
"keying_tries": 0,
"dpd_enabled": true,
"dpd_action": "restart",
"dpd_delay": 60,
"dpd_timeout": 90,
"phase1_rekey_time": 4,
"phase1_rekey_unit": "hours",
"phase1_reauth_time": 0,
"phase1_reauth_unit": "seconds",
"phase2_rekey_time": 1,
"phase2_rekey_unit": "hours",
"proposal": "default",
"phase1_proposal": "default",
"phase2_proposal": "default",
"phase2_proposal_type": "esp",
"local_id": "",
"remote_id": "",
"local_address": "192.168.126.77",
"remote_address": "192.168.121.5",
"local_subnet": "",
"remote_subnet": "",
"auth_mode": "psk",
"shared_secret": "default",
"runtime_status": {
"established": false
}
}
}HTTP status code 400
Invalid request: body is not json or does not conform to required json schema. Incomplete data: tunnel id parameter missing.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}HTTP status code 404
Tunnel {id} does not exist. Attempted to change read only fields. Attempted to change unknown fields.
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Get the configuration of an IPsec tunnel on the Operations Manager appliance
Update settings for an IPsec tunnel on the Operations Manager appliance.
Delete an IPsec tunnel on the Operations Manager appliance
get /ipsec_tunnels/{id}
Get the configuration of an IPsec tunnel on the Operations Manager appliance
Operations Manager base authentication scheme
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Query Parameters
- secrets: (one of cleartext, obfuscate, mask - default: cleartext)
Returns sensitive fields displayed as either cleartext, obfuscated or masked values.
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- ipsec_tunnel: required(object)
This object contains configuration information for an IPsec tunnel.
- id: required(string)
Database ID for this IPsec tunnel.
- name: required(string)
Each IPsec tunnel must have a unique symbolic name. The name can contain letters, digits, and hyphens. It will appear in log messages when the tunnel is being established. Use this to distinguish between multiple tunnels on the device.
- enabled: required(boolean)
- initiate: required(boolean)
When true, the device will actively initiate the tunnel by sending IKE negotiation packets to the remote end. If false, the tunnel will only be activated when an IKE negotiation is initiated by the remote end.
- version: required(string)
An IPsec tunnel can use either the IKEv1 or IKEv2 protocol. IKEv1 also provides the ability to run in aggressive mode which is not applicable to IKEv2
- keying_tries: required(integer)
The number of attempts that should be made to negotiate a connection before giving up. The default value of 0 means 'never give up'.
- dpd_enabled: (boolean)
- dpd_action: (string)
Determines the action to perform on timeout.
- dpd_delay: (integer)
Defines the time interval between keep-alive exchanges sent to the peer.
- dpd_timeout: required(integer)
Defines the timeout period for a connection.
- phase1_rekey_time: (integer)
Controls the time between key material refreshes for the IKE. This is only valid for IKEv2 and 0s translates to disabled.
- phase1_rekey_unit: (string)
Determines the units for phase1_rekey_time.
- phase1_reauth_time: (integer)
Controls the time between IKE reauthentication. 0s translates to disabled.
- phase1_reauth_unit: (string)
Determines the units for phase1_reauth_time.
- phase1_random_time: (integer)
Time range from which to choose a random value to subtract from IKE rekey/reauth times. Is used to avoid both peers initiating the process simultaneously.
- phase1_random_unit: (string)
Determines the units for phase1_random_time.
- phase1_over_time: (integer)
The hard IKE SA lifetime if rekey/reauth does not complete. The default value is 10% of phase1_rekey_time or phase1_reauth_time, whichever is greater. The expiry of an IKE SA is calculated using this value plus phase1_rekey_time or phase1_reauth_time.
- phase1_over_unit: (string)
Determines the units for phase1_over_time.
- phase2_rekey_time: (integer)
Controls the time between key material refreshes for the CHILD_SA. 0s translates to disabled.
- phase2_rekey_unit: (string)
Determines the units for phase2_rekey_time.
- phase2_random_time: (integer)
Time range from which to choose a random value to subtract from IKE rekey/reauth times. Is used to avoid both peers initiating the process simultaneously.
- phase2_random_unit: (string)
Determines the units for phase2_random_time.
- phase2_life_time: (integer)
The maximum lifetime before an IPsec SA gets closed. The default value is 110% of phase2_rekey_time. The expiry of an IPsec SA is equivalent to this value.
- phase2_life_unit: (string)
Determines the units for phase2_life_time.
- proposal: required(string)
Algorithm to be used for Key Exchange for establishing this tunnel
Annotations
- deprecatedProperty
{"since":"03/2021"}
- deprecatedProperty
- phase1_proposal: required(string)
Algorithms to be used for Key Exchange (Phase 1) for establishing this tunnel
- phase2_proposal: required(string)
Algorithms to be used for IPsec/Child SA (Phase 2) for this tunnel
- phase2_proposal_type: required(one of esp, ah)
IPsec/Child SA proposal type. ESP protocol or AH protocol can be selected
- local_id: required(string)
Local IKE identity to use for authentication.
- remote_id: required(string)
Remote IKE identity to expect for authentication.
- local_address: (string)
Local address to be used for this IPsec tunnel. If left blank, this address will be automatically filled during key negotiation.
- remote_address: (string)
Remote address to be used for this IKE negotiation of this tunnel. If the local device does not initiate the tunnel, incoming requests must match this address.
- encap: (boolean)
Force encapsulation
- local_subnet: required(string)
Local subnet traffic selector to be used for this tunnel. When left blank, this will be replaced by the outer local address of the tunnel upon negotiation.
- remote_subnet: required(string)
Remote subnet traffic selector to be used for this tunnel. When left blank, this will be replaced by the outer remote address of the tunnel upon negotiation.
- auth_mode: required(one of psk, pki - default: psk)
Authentication type for this tunnel, psk (Pre-Shared Key) or pki (Public Key Infrastructure).
- shared_secret: (string)
For the pre-shared key authentication mode, both ends of the tunnel must use the same key. This is required for auth_mode psk. [sensitive]
- runtime_status: required(object)
- established: required(boolean)
This value is reported as true when the tunnel has been negotiated successfully and is currently active.
- established: required(boolean)
- id: required(string)
Example:
{
"ipsec_tunnel": {
"id": "0",
"name": "tunnel",
"enabled": true,
"initiate": false,
"version": "IKEv1-aggressive",
"keying_tries": 10,
"dpd_enabled": true,
"dpd_action": "clear",
"dpd_delay": 40,
"dpd_timeout": 100,
"phase1_rekey_time": 3,
"phase1_rekey_unit": "hours",
"phase1_reauth_time": 0,
"phase1_reauth_unit": "seconds",
"phase2_rekey_time": 2,
"phase2_rekey_unit": "hours",
"proposal": "3des-md5-modp768",
"phase1_proposal": "3des-md5-modp768",
"phase2_proposal": "3des-md5-modp768",
"phase2_proposal_type": "esp",
"local_id": "me@test.net",
"remote_id": "",
"local_address": "192.168.126.77",
"remote_address": "192.168.121.5",
"local_subnet": "",
"remote_subnet": "",
"auth_mode": "psk",
"shared_secret": "default",
"runtime_status": {
"established": false
}
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /ipsec_tunnels/{id}
Update settings for an IPsec tunnel on the Operations Manager appliance.
Operations Manager base authentication scheme
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Query Parameters
- secrets: (one of cleartext, obfuscate - default: cleartext)
Accepts sensitive fields as either cleartext or obfuscated values. The response will display the sensitive fields in the same way.
Body
Media type: application/json
Type: object
Properties- ipsec_tunnel: required(object)
This object contains configuration information for an IPsec tunnel.
- name: required(string)
Each IPsec tunnel must have a unique symbolic name. The name can contain letters, digits, and hyphens. It will appear in log messages when the tunnel is being established. Use this to distinguish between multiple tunnels on the device.
- enabled: required(boolean)
- initiate: required(boolean)
When true, the device will actively initiate the tunnel by sending IKE negotiation packets to the remote end. If false, the tunnel will only be activated when an IKE negotiation is initiated by the remote end.
- version: required(string)
An IPsec tunnel can use either the IKEv1 or IKEv2 protocol. IKEv1 also provides the ability to run in aggressive mode which is not applicable to IKEv2
- keying_tries: (integer)
The number of attempts that should be made to negotiate a connection before giving up. The default value of 0 means 'never give up'.
- dpd_enabled: (boolean)
- dpd_action: (string)
Determines the action to perform on timeout.
- dpd_delay: (integer)
Defines the time interval between keep-alive exchanges sent to the peer.
- dpd_timeout: (integer)
Defines the timeout period for a connection.
- phase1_rekey_time: (integer)
Controls the time between key material refreshes for the IKE. This is only valid for IKEv2 and 0s translates to disabled.
- phase1_rekey_unit: (string)
Determines the units for phase1_rekey_time.
- phase1_reauth_time: (integer)
Controls the time between IKE reauthentication. 0s translates to disabled.
- phase1_reauth_unit: (string)
Determines the units for phase1_reauth_time.
- phase1_random_time: (integer)
Time range from which to choose a random value to subtract from IKE rekey/reauth times. Is used to avoid both peers initiating the process simultaneously.
- phase1_random_unit: (string)
Determines the units for phase1_random_time.
- phase1_over_time: (integer)
The hard IKE SA lifetime if rekey/reauth does not complete. The default value is 10% of phase1_rekey_time or phase1_reauth_time, whichever is greater. The expiry of an IKE SA is calculated using this value plus phase1_rekey_time or phase1_reauth_time.
- phase1_over_unit: (string)
Determines the units for phase1_over_time.
- phase2_rekey_time: (integer)
Controls the time between key material refreshes for the CHILD_SA. 0s translates to disabled.
- phase2_rekey_unit: (string)
Determines the units for phase2_rekey_time.
- phase2_random_time: (integer)
Time range from which to choose a random value to subtract from IKE rekey/reauth times. Is used to avoid both peers initiating the process simultaneously.
- phase2_random_unit: (string)
Determines the units for phase2_random_time.
- phase2_life_time: (integer)
The maximum lifetime before an IPsec SA gets closed. The default value is 110% of phase2_rekey_time. The expiry of an IPsec SA is equivalent to this value.
- phase2_life_unit: (string)
Determines the units for phase2_life_time.
- proposal: (string)
Algorithm to be used for Key Exchange for establishing this tunnel
Annotations
- deprecatedProperty
{"replaceWith":{"phase1_proposal":"ike_proposals","phase2_proposal":"ipsec_proposals"},"since":"03/2021"}
- deprecatedProperty
- phase1_proposal: (string)
Algorithm proposals to be used for Key Exchange (Phase 1) for establishing this tunnel. A proposal is a set of algorithms. For non-AEAD algorithms, this includes for IKE an encryption algorithm, an integrity algorithm, a pseudo random function and a Diffie-Hellman group. For AEAD algorithms, instead of encryption and integrity algorithms, a combined algorithm is used.
See the following pages to check which algorithms are supported by strongswan.
- IKEv1 Cipher Suites: https://wiki.strongswan.org/projects/strongswan/wiki/IKEv1CipherSuites
- IKEv2 Cipher Suites: https://wiki.strongswan.org/projects/strongswan/wiki/IKEv2CipherSuites
Multiple proposals may be provided through a comma-separated string.
- example: aes128-sha256-ecp256,aes128-sha256-modp2048 Multiple algorithm types may be present in a single proposal (natively supported in IKEv2 and our backend will split it for IKEv1 cases).
- example: aes128-aes256-sha256-sha384-ecp256-modp2048 (single proposal with 2 encryption algorithms, 2 integrigity algorithms and 2 DH groups)
See also swanctl.conf connections.
.proposals field: https://wiki.strongswan.org/projects/strongswan/wiki/Swanctlconf - phase2_proposal: (string)
Algorithm proposals to be used for IPsec/Child SA (Phase 2) for this tunnel.
See phase1_proposal's description to for more information about proposals.
See also swanctl.conf ah_proposals and esp_proposals fields: https://wiki.strongswan.org/projects/strongswan/wiki/Swanctlconf
- phase2_proposal_type: (one of esp, ah - default: esp)
IPsec/Child SA proposal type. ESP protocol or AH protocol can be selected
- local_id: (string)
Local IKE identity to use for authentication.
- remote_id: (string)
Remote IKE identity to expect for authentication.
- local_address: (string)
Local address to be used for this IPsec tunnel. If left blank, this address will be automatically filled during key negotiation.
- remote_address: (string)
Remote address to be used for this IKE negotiation of this tunnel. If the local device does not initiate the tunnel, incoming requests must match this address.
- encap: (boolean)
Force encapsulation
- local_subnet: (string)
Local subnet traffic selector to be used for this tunnel. When left blank, this will be replaced by the outer local address of the tunnel upon negotiation.
- remote_subnet: (string)
Remote subnet traffic selector to be used for this tunnel. When left blank, this will be replaced by the outer remote address of the tunnel upon negotiation.
- auth_mode: (one of psk, pki - default: psk)
Authentication type for this tunnel, psk (Pre-Shared Key) or pki (Public Key Infrastructure).
- shared_secret: (string)
For the pre-shared key authentication mode, both ends of the tunnel must use the same key. This is required for auth_mode psk. [sensitive]
- name: required(string)
Example:
{
"ipsec_tunnel": {
"name": "tunnel",
"enabled": true,
"initiate": false,
"version": "IKEv1",
"local_address": "192.168.126.77",
"remote_address": "192.168.121.5",
"local_subnet": "",
"remote_subnet": "",
"shared_secret": "default"
}
}HTTP status code 200
The tunnel settings were updated.
Body
Media type: application/json
Type: object
Properties- ipsec_tunnel: required(object)
This object contains configuration information for an IPsec tunnel.
- id: required(string)
Database ID for this IPsec tunnel.
- name: required(string)
Each IPsec tunnel must have a unique symbolic name. The name can contain letters, digits, and hyphens. It will appear in log messages when the tunnel is being established. Use this to distinguish between multiple tunnels on the device.
- enabled: required(boolean)
- initiate: required(boolean)
When true, the device will actively initiate the tunnel by sending IKE negotiation packets to the remote end. If false, the tunnel will only be activated when an IKE negotiation is initiated by the remote end.
- version: required(string)
An IPsec tunnel can use either the IKEv1 or IKEv2 protocol. IKEv1 also provides the ability to run in aggressive mode which is not applicable to IKEv2
- keying_tries: required(integer)
The number of attempts that should be made to negotiate a connection before giving up. The default value of 0 means 'never give up'.
- dpd_enabled: (boolean)
- dpd_action: (string)
Determines the action to perform on timeout.
- dpd_delay: (integer)
Defines the time interval between keep-alive exchanges sent to the peer.
- dpd_timeout: required(integer)
Defines the timeout period for a connection.
- phase1_rekey_time: (integer)
Controls the time between key material refreshes for the IKE. This is only valid for IKEv2 and 0s translates to disabled.
- phase1_rekey_unit: (string)
Determines the units for phase1_rekey_time.
- phase1_reauth_time: (integer)
Controls the time between IKE reauthentication. 0s translates to disabled.
- phase1_reauth_unit: (string)
Determines the units for phase1_reauth_time.
- phase1_random_time: (integer)
Time range from which to choose a random value to subtract from IKE rekey/reauth times. Is used to avoid both peers initiating the process simultaneously.
- phase1_random_unit: (string)
Determines the units for phase1_random_time.
- phase1_over_time: (integer)
The hard IKE SA lifetime if rekey/reauth does not complete. The default value is 10% of phase1_rekey_time or phase1_reauth_time, whichever is greater. The expiry of an IKE SA is calculated using this value plus phase1_rekey_time or phase1_reauth_time.
- phase1_over_unit: (string)
Determines the units for phase1_over_time.
- phase2_rekey_time: (integer)
Controls the time between key material refreshes for the CHILD_SA. 0s translates to disabled.
- phase2_rekey_unit: (string)
Determines the units for phase2_rekey_time.
- phase2_random_time: (integer)
Time range from which to choose a random value to subtract from IKE rekey/reauth times. Is used to avoid both peers initiating the process simultaneously.
- phase2_random_unit: (string)
Determines the units for phase2_random_time.
- phase2_life_time: (integer)
The maximum lifetime before an IPsec SA gets closed. The default value is 110% of phase2_rekey_time. The expiry of an IPsec SA is equivalent to this value.
- phase2_life_unit: (string)
Determines the units for phase2_life_time.
- proposal: required(string)
Algorithm to be used for Key Exchange for establishing this tunnel
Annotations
- deprecatedProperty
{"since":"03/2021"}
- deprecatedProperty
- phase1_proposal: required(string)
Algorithms to be used for Key Exchange (Phase 1) for establishing this tunnel
- phase2_proposal: required(string)
Algorithms to be used for IPsec/Child SA (Phase 2) for this tunnel
- phase2_proposal_type: required(one of esp, ah)
IPsec/Child SA proposal type. ESP protocol or AH protocol can be selected
- local_id: required(string)
Local IKE identity to use for authentication.
- remote_id: required(string)
Remote IKE identity to expect for authentication.
- local_address: (string)
Local address to be used for this IPsec tunnel. If left blank, this address will be automatically filled during key negotiation.
- remote_address: (string)
Remote address to be used for this IKE negotiation of this tunnel. If the local device does not initiate the tunnel, incoming requests must match this address.
- encap: (boolean)
Force encapsulation
- local_subnet: required(string)
Local subnet traffic selector to be used for this tunnel. When left blank, this will be replaced by the outer local address of the tunnel upon negotiation.
- remote_subnet: required(string)
Remote subnet traffic selector to be used for this tunnel. When left blank, this will be replaced by the outer remote address of the tunnel upon negotiation.
- auth_mode: required(one of psk, pki - default: psk)
Authentication type for this tunnel, psk (Pre-Shared Key) or pki (Public Key Infrastructure).
- shared_secret: (string)
For the pre-shared key authentication mode, both ends of the tunnel must use the same key. This is required for auth_mode psk. [sensitive]
- runtime_status: required(object)
- established: required(boolean)
This value is reported as true when the tunnel has been negotiated successfully and is currently active.
- established: required(boolean)
- id: required(string)
Example:
{
"ipsec_tunnel": {
"id": "0",
"name": "tunnel",
"enabled": true,
"initiate": false,
"version": "IKEv1",
"keying_tries": 0,
"dpd_enabled": true,
"dpd_action": "restart",
"dpd_delay": 60,
"dpd_timeout": 90,
"phase1_rekey_time": 4,
"phase1_rekey_unit": "hours",
"phase1_reauth_time": 0,
"phase1_reauth_unit": "seconds",
"phase2_rekey_time": 1,
"phase2_rekey_unit": "hours",
"proposal": "default",
"phase1_proposal": "default",
"phase2_proposal": "default",
"phase2_proposal_type": "esp",
"local_id": "",
"remote_id": "",
"local_address": "192.168.126.77",
"remote_address": "192.168.121.5",
"local_subnet": "",
"remote_subnet": "",
"auth_mode": "psk",
"shared_secret": "default",
"runtime_status": {
"established": false
}
}
}HTTP status code 400
Invalid request: body is not json or does not conform to required json schema. Incomplete data: tunnel id parameter missing.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}HTTP status code 404
tunnel {id} does not exist. Attempted to change read only fields. Attempted to change unknown fields.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
delete /ipsec_tunnels/{id}
Delete an IPsec tunnel on the Operations Manager appliance
Operations Manager base authentication scheme
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Tunnel deleted
HTTP status code 400
Incomplete data
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}HTTP status code 404
Tunnel did not exist
Body
Media type: application/json
Type: object
Example:
{
"error": [
{
"type": 5,
"code": 29,
"text": "Could not find ipsec_tunnel with name or id 'system_net_ipsec-1'",
"args": {
"uuid": "system_net_ipsec-1"
},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
/ipsec
Read and manipulate files that are used by IPsec tunnels using Public Key Infrastructure (PKI) for authentication.
An x509 bundle is a collection of certificates stored in PKCS12 format. This bundle removes the need to upload individual certificates.
Get a list of x509 bundles stored on the device.
Configure a new x509 bundle.
get /ipsec/x509_bundles
Get a list of x509 bundles stored on the device.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Query Parameters
- secrets: (one of cleartext, obfuscate, mask - default: cleartext)
Returns sensitive fields displayed as either cleartext, obfuscated or masked values.
HTTP status code 200
The list of x509 bundles.
Body
Media type: application/json
Type: object
Properties- x509_bundles: required(array of object)
Items: items
- name: required(string)
The files name.
- content: required(string)
The base64 encoded binary content of the file.
- password: (string)
An optional password that can be used to decrypt the file. [sensitive]
- timestamp: required(string)
The original time the file was uploaded in rfc3339 format.
- name: required(string)
Example:
{
"x509_bundles": [
{
"id": "system_net_ipsec_files_x509_bundles-1",
"name": "bundle_1.p12",
"content": "MIIMyQIBAzCCDI8GCSqGSIb3DQEHAaCCDIAEggx8MIIMeDCCBy8GCSqGSIb3DQEHBqCCByAwggccAgEAMIIHFQYJKoZIhvcNAQcBMBwGCiqGSIb3DQEMAQYwDgQIeJSe0WDoL8MCAggAgIIG6C3LA4m3OrKwWUEmZm4okKJnUSydP6uMMufkhNPf2/ntbC1GqsJO9DwyjEhAsKNqoXacAnR+W4DfZ3z8xu5SQ19wV9fmCYdYpAzsLwu4eMiV7fLR0ARzN/ngytxaDbtuIGt9+2xudJ/ESGtjVs8MPzEe234gv/k3lFMtQcM2iZBANfxF31Ozyb/aidW3mUWJPNl4Wb3gCE4rxPt5hjdOP/Fd9JAPxfHqWGyeMm7FWsbOHm6zWTrNtJGoXyePF6/p0sj9tpOVuckSdceIz2RIvTFIB/S7G7v45MyTFzCyNotL4kPIchkRuURJ11mh6votK8gfnDt18e7spe8HfMgQJWrNUJPh7niEjSOUFkhttG3V4VhI+cpPTQBhFyKL3hD3d8w1ifGFZy93LnVJURTRBqjUYukCi/OfE1NfgAPAkW8G4g5Pay6NmGpmtirIs3nYEH36MKP9EVh2CUFXfrL3WP+X/WzzrfntshISuEiQcBSNWL3wMBsOuQyJGoqAJM9d4OEkV+RXI3sHYZmO2uZkT7AUEZ6okFoFpwjcbzPo1/Yr0+GWugcjltdLtxC17CmfwNorYots0y+eKUFsihHLjreGNeDtwFRfhT+cj5crWggIGi7KyCVVsgi7d8hmbgk7tOMTfvSEMkZ869rZnt+a3Ta90KTgjUbaRw5DCKw44BuC27oDitJr37fhQB5g0BrwHjB/+yHKTBtcGy2yfflC6q8cdZgrQHCZAzK92eY6/BlnQB0uxjAgAOOh59RlOpsQ1ddzlvwEBiAm+pYl5VcYjUudqVIDq/61io0q8rWgDNu+VpqPi0ITtqgOD4s+iZDRI+kztK1rleJh9OUnzk01E9uOeZ7EeenygroEgeMn6sE9MWbYHntHf8Je2ljYSz0hHUUkqQQTf1JxXXbuM7ACopgrJIMJWH6Um333VhBTCFQ995Keview/VkQhyITKQks1+ndWeVTfHuSTd2NQQ/gwZLFCG+NZrNMr9vWe7joIIShbKyO4NrosTJkYGX5DJxXBC+pRsn9ugERjKdnn5p69ovKFXYA5y9F07iqGvU5+actdaSxTGx/6LMYT/lcqm6VvpcNEn/Sc7beuvjZfsWsxQvYm2SxQToqZzKmYh1vI6/HC8bDqDvWEI9FvV43HmMyENTXERl8ADhJcTjymzxTH7ZY9k69XvbkL4W9FFgtKglbINAyQo7L4277+C/dMTZMEE59PZnNIbuzUXZ3AJZDU+j6rtvUZdbefRtVEqs0bMmApVskMr+iuSIwCHTIymnJM6d6I44t32gb18v9mQLfyvkqgHjcEFLnB3c2wB9b7y1CpKJPVxPBteL3Gd2RIlOdyg57lJa4k0B1xOuwsqYYJugWQgBIHMjqxhmYcQ71o1QCLjJ5n8euZd/KsX6MvYcgDP2EYupfnM8m6kOKHPUMQC8JxcEY/Tjm2mcUyRyEo22sRyCBH7zk+IPDFZ5ww5PWjltNUMkayWf+GxdLsmbAYawpVCriGHC7V7L2gt2dhuVzjYL05S+TsDCsGQMOQI/NLmMKbKSJjEBYU/e8GK7xGguF95b/TMediw0nGWLmLbm9NFmAoiBNILqWZLrQeZYQy2rMFWB0R+OpFyFiexpVvxN+2k0U2D9EzwDriCiyDi+mRooC7Chvoj4ldrCH6XPS/PkWvWS1gh+mShKphT7eHsWSc9irAtUfi1L11OvxSbXEPtd62hmJjE4TQ+Y5TvjNeBN2YooO2zWNak0ouLYjHufU5Bx0nE/nBYRudtRFriCmraW0ucH7Tywysez7Ckwhk3fFKuAlUgFJP3xLjeFXS8x+FfAyddwLOHLJVwDrkC1my5Y3jfn9vaab7ywHxquWTfDSWEQdDf+Yu7/D+hqsAi2qSHwPgGFGRpua3YhFoCfKF9UDhNfJBZYbiYl7duQfkiU3whF5ABCid0XMMpM1x7EUeoQsmbNd4k/E+9p1SIfZ+9Ax4oDnL/AtcfapcBQ2dPnjLuF1AswtTSHIAv5FsDGSaPCHk+pD2S77jL9ln6KIZmxzw/8pzdLSvby0ANE0m+nTNBVavjz4EU20WbUEVXVJvWHa64/QR/1WDSM6EqT/9bnC5/EtFG2MGLbyt8tNQjujUffowS1BVU/QKtO1mKP6wkqq3BFpTt4VU8nZnHnWTv9l0d11qbCOvrXbVnKu21fQF8G0cFonZGuQxCs/9O99ffn5sDN1HxPa0a2UYczhImL8K/uJT8J7JpIhKRZm4VkdJM/fM/Jaek0n+9u1pXGb0Ikl71r7iXKdwxBngcUveWBsT3p4/1ySa+qrT4AmyRoOgHNx4WBW9RMfY3fwEtvpX1UxI7I7LkWiuGJ43sF5jcdUT7SeW0cwggVBBgkqhkiG9w0BBwGgggUyBIIFLjCCBSowggUmBgsqhkiG9w0BDAoBAqCCBO4wggTqMBwGCiqGSIb3DQEMAQMwDgQI1W0hhU1AvikCAggABIIEyL5K7kZIU4Vb56/FqdrS0e4di5dal6VciBwGFstJVEMORkMEUgveaSInZbQGlO9rJSfk5crFMfI0SfznEdKOBQpYvyQYntm/YrJpp5pCXpo2FZh9luseGeh2wA38Gsq59dn4OWs7UGJSKGjSNcI9bGON9L2L25pbJCEFDPbxOJwDAad1gmSLydADaA8Yc0KTb9c0XrhtT8TZ8Ez+wKT6VGTLLinPClOnpD3JMLfcnxBQCzVs20Am8t0UXgaHlenWyh36zkpl6PfxqQJ4TEoDq1kjQASV3aPe0NwR3puI7za8wW7fLggyO0fC8FVMXPR/RmRNGBLi5+OpLwhTm/DI34CEYA2v78Nsb6g0HWX58qfeDrHfkHKjKv0uPcc6W1WmiMOJnylZ2WlKGk8Y+w/ehJqgZCpa16QzlT3/TJ3s8Twm9msFzMFK/6lHmCXtOA9YvFhp/D+hhZh16hsNzS9TuQ7d3HMAb2N1O610XiMOO6i5Mf6XyH5fVCw571A0oCnE+ieZCZoYyQaOSWd0r0qkPHFr9BlACrpkdgHVKCGji1oI10+QhLeUuVJgPbATavzQxKgrk/KXG4inH/gtKbdZ2sH35uZj22JrO/LAPQ608rfvQM28v/0dbY7/Ge8Oa49t82JJNMJwxQMG3wNTraj51+CnYMx9GsMoy+NAiMVkjrVP4RiawMk2M/mAqf4gbYb6q1l8iCearG1oNAK/6zdxH8b/uLq/PhxWPaT0BniJPbasEKyrzTJB2wlswwESROfiREDUClWG1djzsKI73Bn1NAtmKZUkQEFiozE69SBYRwXC/XqP5FZSY8bXZIdMm94aOkrohjxbeRRx+52Tu+uXe3S61G6vBowzuEbkqeXeFSOpXR62MYaOsVaniB9u2TwKUFliD5jpX+Z479wX6c4rHkNIiLerIYRg5iHC7/H9BbewGCZ9rbw00mOkTpOWf6C0ni2L7kmbxLl5IaHqyavNCSQkEuelK8YOq65U9TXWwBwfb8GCZOVMOWayG/nO4c0M1LfgsprYhbJUoF1V+4amrLrJbgEouUStEEgg5gHI//+2LiHX2gU2EydB9ne6m+h6lLpNDZjVgKhuJdHBy6jf4jGEpR694z341GEv6M4HZ4p4AVAx7LIvgS4FT2++GbPVThpZvzY/EL8M/yt0wUhWpOWnqO9YGqUapxCoGttSg24skTDsUfbU2ltf2giOSqFgOMIc9DgsKKqb5L6x+FTA0JzQrrSOSdfdKHM8Vus8uEF0REDFouH7CkbmtwRdHFjQuFeWRwnxtXnkhHA3riC21JJSt9awTK3CehbvpAd6iV2emFMmXDWtRVB5JGXKsfleb8ctVbcPArqX6Hv+uBZtFRdZC2yUVMvacaSylEZdNfSLC7BMRW1bQ6U1fcxrOy2Xrl5M2SlF3CpQ1u5eAOsWhIuwKqKBCZssDXxXgnKHgMPrInwLNm+pRI+/P7choUZUmPd9w+/WjpsMWBKLlTTzCHtfA3S6QMvTJor02TyGwETga2Lfe/FUHxRqd2cS8/oe70zQNVb47Lx4Rv0p+E6JaUm3SQZ//pCK/4c5so69y5BCazHPlON6o0WV8EcQNyjdrXn5XO3ZY06kBibZfnXzXRROKMz7YsthNzElMCMGCSqGSIb3DQEJFTEWBBTsTioxPc2KkCi5ohjqjZsUFRMlCDAxMCEwCQYFKw4DAhoFAAQUGenOqzXKjdA6z0DTAwsG/40AwrgECEigJt/JI2HMAgIIAA==",
"password": "TkcxJAAAABDz14VOkQ5K7qU+HmxBn6BCBmh3XIDOI0NuoYnqtWDVBA==",
"timestamp": "2021-05-31T22:57:25+00:00"
},
{
"id": "system_net_ipsec_files_x509_bundles-2",
"name": "bundle_2.p12",
"content": "MIIMyQIBAzCCDI8GCSqGSIb3DQEHAaCCDIAEggx8MIIMeDCCBy8GCSqGSIb3DQEHBqCCByAwggccAgEAMIIHFQYJKoZIhvcNAQcBMBwGCiqGSIb3DQEMAQYwDgQIeJSe0WDoL8MCAggAgIIG6C3LA4m3OrKwWUEmZm4okKJnUSydP6uMMufkhNPf2/ntbC1GqsJO9DwyjEhAsKNqoXacAnR+W4DfZ3z8xu5SQ19wV9fmCYdYpAzsLwu4eMiV7fLR0ARzN/ngytxaDbtuIGt9+2xudJ/ESGtjVs8MPzEe234gv/k3lFMtQcM2iZBANfxF31Ozyb/aidW3mUWJPNl4Wb3gCE4rxPt5hjdOP/Fd9JAPxfHqWGyeMm7FWsbOHm6zWTrNtJGoXyePF6/p0sj9tpOVuckSdceIz2RIvTFIB/S7G7v45MyTFzCyNotL4kPIchkRuURJ11mh6votK8gfnDt18e7spe8HfMgQJWrNUJPh7niEjSOUFkhttG3V4VhI+cpPTQBhFyKL3hD3d8w1ifGFZy93LnVJURTRBqjUYukCi/OfE1NfgAPAkW8G4g5Pay6NmGpmtirIs3nYEH36MKP9EVh2CUFXfrL3WP+X/WzzrfntshISuEiQcBSNWL3wMBsOuQyJGoqAJM9d4OEkV+RXI3sHYZmO2uZkT7AUEZ6okFoFpwjcbzPo1/Yr0+GWugcjltdLtxC17CmfwNorYots0y+eKUFsihHLjreGNeDtwFRfhT+cj5crWggIGi7KyCVVsgi7d8hmbgk7tOMTfvSEMkZ869rZnt+a3Ta90KTgjUbaRw5DCKw44BuC27oDitJr37fhQB5g0BrwHjB/+yHKTBtcGy2yfflC6q8cdZgrQHCZAzK92eY6/BlnQB0uxjAgAOOh59RlOpsQ1ddzlvwEBiAm+pYl5VcYjUudqVIDq/61io0q8rWgDNu+VpqPi0ITtqgOD4s+iZDRI+kztK1rleJh9OUnzk01E9uOeZ7EeenygroEgeMn6sE9MWbYHntHf8Je2ljYSz0hHUUkqQQTf1JxXXbuM7ACopgrJIMJWH6Um333VhBTCFQ995Keview/VkQhyITKQks1+ndWeVTfHuSTd2NQQ/gwZLFCG+NZrNMr9vWe7joIIShbKyO4NrosTJkYGX5DJxXBC+pRsn9ugERjKdnn5p69ovKFXYA5y9F07iqGvU5+actdaSxTGx/6LMYT/lcqm6VvpcNEn/Sc7beuvjZfsWsxQvYm2SxQToqZzKmYh1vI6/HC8bDqDvWEI9FvV43HmMyENTXERl8ADhJcTjymzxTH7ZY9k69XvbkL4W9FFgtKglbINAyQo7L4277+C/dMTZMEE59PZnNIbuzUXZ3AJZDU+j6rtvUZdbefRtVEqs0bMmApVskMr+iuSIwCHTIymnJM6d6I44t32gb18v9mQLfyvkqgHjcEFLnB3c2wB9b7y1CpKJPVxPBteL3Gd2RIlOdyg57lJa4k0B1xOuwsqYYJugWQgBIHMjqxhmYcQ71o1QCLjJ5n8euZd/KsX6MvYcgDP2EYupfnM8m6kOKHPUMQC8JxcEY/Tjm2mcUyRyEo22sRyCBH7zk+IPDFZ5ww5PWjltNUMkayWf+GxdLsmbAYawpVCriGHC7V7L2gt2dhuVzjYL05S+TsDCsGQMOQI/NLmMKbKSJjEBYU/e8GK7xGguF95b/TMediw0nGWLmLbm9NFmAoiBNILqWZLrQeZYQy2rMFWB0R+OpFyFiexpVvxN+2k0U2D9EzwDriCiyDi+mRooC7Chvoj4ldrCH6XPS/PkWvWS1gh+mShKphT7eHsWSc9irAtUfi1L11OvxSbXEPtd62hmJjE4TQ+Y5TvjNeBN2YooO2zWNak0ouLYjHufU5Bx0nE/nBYRudtRFriCmraW0ucH7Tywysez7Ckwhk3fFKuAlUgFJP3xLjeFXS8x+FfAyddwLOHLJVwDrkC1my5Y3jfn9vaab7ywHxquWTfDSWEQdDf+Yu7/D+hqsAi2qSHwPgGFGRpua3YhFoCfKF9UDhNfJBZYbiYl7duQfkiU3whF5ABCid0XMMpM1x7EUeoQsmbNd4k/E+9p1SIfZ+9Ax4oDnL/AtcfapcBQ2dPnjLuF1AswtTSHIAv5FsDGSaPCHk+pD2S77jL9ln6KIZmxzw/8pzdLSvby0ANE0m+nTNBVavjz4EU20WbUEVXVJvWHa64/QR/1WDSM6EqT/9bnC5/EtFG2MGLbyt8tNQjujUffowS1BVU/QKtO1mKP6wkqq3BFpTt4VU8nZnHnWTv9l0d11qbCOvrXbVnKu21fQF8G0cFonZGuQxCs/9O99ffn5sDN1HxPa0a2UYczhImL8K/uJT8J7JpIhKRZm4VkdJM/fM/Jaek0n+9u1pXGb0Ikl71r7iXKdwxBngcUveWBsT3p4/1ySa+qrT4AmyRoOgHNx4WBW9RMfY3fwEtvpX1UxI7I7LkWiuGJ43sF5jcdUT7SeW0cwggVBBgkqhkiG9w0BBwGgggUyBIIFLjCCBSowggUmBgsqhkiG9w0BDAoBAqCCBO4wggTqMBwGCiqGSIb3DQEMAQMwDgQI1W0hhU1AvikCAggABIIEyL5K7kZIU4Vb56/FqdrS0e4di5dal6VciBwGFstJVEMORkMEUgveaSInZbQGlO9rJSfk5crFMfI0SfznEdKOBQpYvyQYntm/YrJpp5pCXpo2FZh9luseGeh2wA38Gsq59dn4OWs7UGJSKGjSNcI9bGON9L2L25pbJCEFDPbxOJwDAad1gmSLydADaA8Yc0KTb9c0XrhtT8TZ8Ez+wKT6VGTLLinPClOnpD3JMLfcnxBQCzVs20Am8t0UXgaHlenWyh36zkpl6PfxqQJ4TEoDq1kjQASV3aPe0NwR3puI7za8wW7fLggyO0fC8FVMXPR/RmRNGBLi5+OpLwhTm/DI34CEYA2v78Nsb6g0HWX58qfeDrHfkHKjKv0uPcc6W1WmiMOJnylZ2WlKGk8Y+w/ehJqgZCpa16QzlT3/TJ3s8Twm9msFzMFK/6lHmCXtOA9YvFhp/D+hhZh16hsNzS9TuQ7d3HMAb2N1O610XiMOO6i5Mf6XyH5fVCw571A0oCnE+ieZCZoYyQaOSWd0r0qkPHFr9BlACrpkdgHVKCGji1oI10+QhLeUuVJgPbATavzQxKgrk/KXG4inH/gtKbdZ2sH35uZj22JrO/LAPQ608rfvQM28v/0dbY7/Ge8Oa49t82JJNMJwxQMG3wNTraj51+CnYMx9GsMoy+NAiMVkjrVP4RiawMk2M/mAqf4gbYb6q1l8iCearG1oNAK/6zdxH8b/uLq/PhxWPaT0BniJPbasEKyrzTJB2wlswwESROfiREDUClWG1djzsKI73Bn1NAtmKZUkQEFiozE69SBYRwXC/XqP5FZSY8bXZIdMm94aOkrohjxbeRRx+52Tu+uXe3S61G6vBowzuEbkqeXeFSOpXR62MYaOsVaniB9u2TwKUFliD5jpX+Z479wX6c4rHkNIiLerIYRg5iHC7/H9BbewGCZ9rbw00mOkTpOWf6C0ni2L7kmbxLl5IaHqyavNCSQkEuelK8YOq65U9TXWwBwfb8GCZOVMOWayG/nO4c0M1LfgsprYhbJUoF1V+4amrLrJbgEouUStEEgg5gHI//+2LiHX2gU2EydB9ne6m+h6lLpNDZjVgKhuJdHBy6jf4jGEpR694z341GEv6M4HZ4p4AVAx7LIvgS4FT2++GbPVThpZvzY/EL8M/yt0wUhWpOWnqO9YGqUapxCoGttSg24skTDsUfbU2ltf2giOSqFgOMIc9DgsKKqb5L6x+FTA0JzQrrSOSdfdKHM8Vus8uEF0REDFouH7CkbmtwRdHFjQuFeWRwnxtXnkhHA3riC21JJSt9awTK3CehbvpAd6iV2emFMmXDWtRVB5JGXKsfleb8ctVbcPArqX6Hv+uBZtFRdZC2yUVMvacaSylEZdNfSLC7BMRW1bQ6U1fcxrOy2Xrl5M2SlF3CpQ1u5eAOsWhIuwKqKBCZssDXxXgnKHgMPrInwLNm+pRI+/P7choUZUmPd9w+/WjpsMWBKLlTTzCHtfA3S6QMvTJor02TyGwETga2Lfe/FUHxRqd2cS8/oe70zQNVb47Lx4Rv0p+E6JaUm3SQZ//pCK/4c5so69y5BCazHPlON6o0WV8EcQNyjdrXn5XO3ZY06kBibZfnXzXRROKMz7YsthNzElMCMGCSqGSIb3DQEJFTEWBBTsTioxPc2KkCi5ohjqjZsUFRMlCDAxMCEwCQYFKw4DAhoFAAQUGenOqzXKjdA6z0DTAwsG/40AwrgECEigJt/JI2HMAgIIAA==",
"password": "TkcxJAAAABDz14VOkQ5K7qU+HmxBn6BCj3iQ7nfaHR6qU8MBGapj4g==",
"timestamp": "2021-05-31T22:57:25+00:00"
}
]
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
post /ipsec/x509_bundles
Configure a new x509 bundle.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Query Parameters
- secrets: (one of cleartext, obfuscate - default: cleartext)
Accepts sensitive fields as either cleartext or obfuscated values. The response will display the sensitive fields in the same way.
Body
Media type: application/json
Type: object
Properties- x509_bundle: required(object)
This object contains information for an IPsec bundle file.
- name: required(string)
The files name.
- content: required(string)
The base64 encoded binary content of the file. [sensitive]
- password: (string)
An optional password that can be used to decrypt the file. [sensitive]
- name: required(string)
Example:
{
"x509_bundle": {
"name": "bundle.p12",
"content": "MIIMyQIBAzCCDI8GCSqGSIb3DQEHAaCCDIAEggx8MIIMeDCCBy8GCSqGSIb3DQEHBqCCByAwggccAgEAMIIHFQYJKoZIhvcNAQcBMBwGCiqGSIb3DQEMAQYwDgQIeJSe0WDoL8MCAggAgIIG6C3LA4m3OrKwWUEmZm4okKJnUSydP6uMMufkhNPf2/ntbC1GqsJO9DwyjEhAsKNqoXacAnR+W4DfZ3z8xu5SQ19wV9fmCYdYpAzsLwu4eMiV7fLR0ARzN/ngytxaDbtuIGt9+2xudJ/ESGtjVs8MPzEe234gv/k3lFMtQcM2iZBANfxF31Ozyb/aidW3mUWJPNl4Wb3gCE4rxPt5hjdOP/Fd9JAPxfHqWGyeMm7FWsbOHm6zWTrNtJGoXyePF6/p0sj9tpOVuckSdceIz2RIvTFIB/S7G7v45MyTFzCyNotL4kPIchkRuURJ11mh6votK8gfnDt18e7spe8HfMgQJWrNUJPh7niEjSOUFkhttG3V4VhI+cpPTQBhFyKL3hD3d8w1ifGFZy93LnVJURTRBqjUYukCi/OfE1NfgAPAkW8G4g5Pay6NmGpmtirIs3nYEH36MKP9EVh2CUFXfrL3WP+X/WzzrfntshISuEiQcBSNWL3wMBsOuQyJGoqAJM9d4OEkV+RXI3sHYZmO2uZkT7AUEZ6okFoFpwjcbzPo1/Yr0+GWugcjltdLtxC17CmfwNorYots0y+eKUFsihHLjreGNeDtwFRfhT+cj5crWggIGi7KyCVVsgi7d8hmbgk7tOMTfvSEMkZ869rZnt+a3Ta90KTgjUbaRw5DCKw44BuC27oDitJr37fhQB5g0BrwHjB/+yHKTBtcGy2yfflC6q8cdZgrQHCZAzK92eY6/BlnQB0uxjAgAOOh59RlOpsQ1ddzlvwEBiAm+pYl5VcYjUudqVIDq/61io0q8rWgDNu+VpqPi0ITtqgOD4s+iZDRI+kztK1rleJh9OUnzk01E9uOeZ7EeenygroEgeMn6sE9MWbYHntHf8Je2ljYSz0hHUUkqQQTf1JxXXbuM7ACopgrJIMJWH6Um333VhBTCFQ995Keview/VkQhyITKQks1+ndWeVTfHuSTd2NQQ/gwZLFCG+NZrNMr9vWe7joIIShbKyO4NrosTJkYGX5DJxXBC+pRsn9ugERjKdnn5p69ovKFXYA5y9F07iqGvU5+actdaSxTGx/6LMYT/lcqm6VvpcNEn/Sc7beuvjZfsWsxQvYm2SxQToqZzKmYh1vI6/HC8bDqDvWEI9FvV43HmMyENTXERl8ADhJcTjymzxTH7ZY9k69XvbkL4W9FFgtKglbINAyQo7L4277+C/dMTZMEE59PZnNIbuzUXZ3AJZDU+j6rtvUZdbefRtVEqs0bMmApVskMr+iuSIwCHTIymnJM6d6I44t32gb18v9mQLfyvkqgHjcEFLnB3c2wB9b7y1CpKJPVxPBteL3Gd2RIlOdyg57lJa4k0B1xOuwsqYYJugWQgBIHMjqxhmYcQ71o1QCLjJ5n8euZd/KsX6MvYcgDP2EYupfnM8m6kOKHPUMQC8JxcEY/Tjm2mcUyRyEo22sRyCBH7zk+IPDFZ5ww5PWjltNUMkayWf+GxdLsmbAYawpVCriGHC7V7L2gt2dhuVzjYL05S+TsDCsGQMOQI/NLmMKbKSJjEBYU/e8GK7xGguF95b/TMediw0nGWLmLbm9NFmAoiBNILqWZLrQeZYQy2rMFWB0R+OpFyFiexpVvxN+2k0U2D9EzwDriCiyDi+mRooC7Chvoj4ldrCH6XPS/PkWvWS1gh+mShKphT7eHsWSc9irAtUfi1L11OvxSbXEPtd62hmJjE4TQ+Y5TvjNeBN2YooO2zWNak0ouLYjHufU5Bx0nE/nBYRudtRFriCmraW0ucH7Tywysez7Ckwhk3fFKuAlUgFJP3xLjeFXS8x+FfAyddwLOHLJVwDrkC1my5Y3jfn9vaab7ywHxquWTfDSWEQdDf+Yu7/D+hqsAi2qSHwPgGFGRpua3YhFoCfKF9UDhNfJBZYbiYl7duQfkiU3whF5ABCid0XMMpM1x7EUeoQsmbNd4k/E+9p1SIfZ+9Ax4oDnL/AtcfapcBQ2dPnjLuF1AswtTSHIAv5FsDGSaPCHk+pD2S77jL9ln6KIZmxzw/8pzdLSvby0ANE0m+nTNBVavjz4EU20WbUEVXVJvWHa64/QR/1WDSM6EqT/9bnC5/EtFG2MGLbyt8tNQjujUffowS1BVU/QKtO1mKP6wkqq3BFpTt4VU8nZnHnWTv9l0d11qbCOvrXbVnKu21fQF8G0cFonZGuQxCs/9O99ffn5sDN1HxPa0a2UYczhImL8K/uJT8J7JpIhKRZm4VkdJM/fM/Jaek0n+9u1pXGb0Ikl71r7iXKdwxBngcUveWBsT3p4/1ySa+qrT4AmyRoOgHNx4WBW9RMfY3fwEtvpX1UxI7I7LkWiuGJ43sF5jcdUT7SeW0cwggVBBgkqhkiG9w0BBwGgggUyBIIFLjCCBSowggUmBgsqhkiG9w0BDAoBAqCCBO4wggTqMBwGCiqGSIb3DQEMAQMwDgQI1W0hhU1AvikCAggABIIEyL5K7kZIU4Vb56/FqdrS0e4di5dal6VciBwGFstJVEMORkMEUgveaSInZbQGlO9rJSfk5crFMfI0SfznEdKOBQpYvyQYntm/YrJpp5pCXpo2FZh9luseGeh2wA38Gsq59dn4OWs7UGJSKGjSNcI9bGON9L2L25pbJCEFDPbxOJwDAad1gmSLydADaA8Yc0KTb9c0XrhtT8TZ8Ez+wKT6VGTLLinPClOnpD3JMLfcnxBQCzVs20Am8t0UXgaHlenWyh36zkpl6PfxqQJ4TEoDq1kjQASV3aPe0NwR3puI7za8wW7fLggyO0fC8FVMXPR/RmRNGBLi5+OpLwhTm/DI34CEYA2v78Nsb6g0HWX58qfeDrHfkHKjKv0uPcc6W1WmiMOJnylZ2WlKGk8Y+w/ehJqgZCpa16QzlT3/TJ3s8Twm9msFzMFK/6lHmCXtOA9YvFhp/D+hhZh16hsNzS9TuQ7d3HMAb2N1O610XiMOO6i5Mf6XyH5fVCw571A0oCnE+ieZCZoYyQaOSWd0r0qkPHFr9BlACrpkdgHVKCGji1oI10+QhLeUuVJgPbATavzQxKgrk/KXG4inH/gtKbdZ2sH35uZj22JrO/LAPQ608rfvQM28v/0dbY7/Ge8Oa49t82JJNMJwxQMG3wNTraj51+CnYMx9GsMoy+NAiMVkjrVP4RiawMk2M/mAqf4gbYb6q1l8iCearG1oNAK/6zdxH8b/uLq/PhxWPaT0BniJPbasEKyrzTJB2wlswwESROfiREDUClWG1djzsKI73Bn1NAtmKZUkQEFiozE69SBYRwXC/XqP5FZSY8bXZIdMm94aOkrohjxbeRRx+52Tu+uXe3S61G6vBowzuEbkqeXeFSOpXR62MYaOsVaniB9u2TwKUFliD5jpX+Z479wX6c4rHkNIiLerIYRg5iHC7/H9BbewGCZ9rbw00mOkTpOWf6C0ni2L7kmbxLl5IaHqyavNCSQkEuelK8YOq65U9TXWwBwfb8GCZOVMOWayG/nO4c0M1LfgsprYhbJUoF1V+4amrLrJbgEouUStEEgg5gHI//+2LiHX2gU2EydB9ne6m+h6lLpNDZjVgKhuJdHBy6jf4jGEpR694z341GEv6M4HZ4p4AVAx7LIvgS4FT2++GbPVThpZvzY/EL8M/yt0wUhWpOWnqO9YGqUapxCoGttSg24skTDsUfbU2ltf2giOSqFgOMIc9DgsKKqb5L6x+FTA0JzQrrSOSdfdKHM8Vus8uEF0REDFouH7CkbmtwRdHFjQuFeWRwnxtXnkhHA3riC21JJSt9awTK3CehbvpAd6iV2emFMmXDWtRVB5JGXKsfleb8ctVbcPArqX6Hv+uBZtFRdZC2yUVMvacaSylEZdNfSLC7BMRW1bQ6U1fcxrOy2Xrl5M2SlF3CpQ1u5eAOsWhIuwKqKBCZssDXxXgnKHgMPrInwLNm+pRI+/P7choUZUmPd9w+/WjpsMWBKLlTTzCHtfA3S6QMvTJor02TyGwETga2Lfe/FUHxRqd2cS8/oe70zQNVb47Lx4Rv0p+E6JaUm3SQZ//pCK/4c5so69y5BCazHPlON6o0WV8EcQNyjdrXn5XO3ZY06kBibZfnXzXRROKMz7YsthNzElMCMGCSqGSIb3DQEJFTEWBBTsTioxPc2KkCi5ohjqjZsUFRMlCDAxMCEwCQYFKw4DAhoFAAQUGenOqzXKjdA6z0DTAwsG/40AwrgECEigJt/JI2HMAgIIAA==",
"password": "TkcxJAAAABDz14VOkQ5K7qU+HmxBn6BCj3iQ7nfaHR6qU8MBGapj4g=="
}
}HTTP status code 201
The x509 bundle /{id} settings was updated.
Body
Media type: application/json
Type: object
Properties- x509_bundle: required(object)
This object contains information for an IPsec bundle file.
- name: required(string)
The files name.
- content: required(string)
The base64 encoded binary content of the file.
- password: (string)
An optional password that can be used to decrypt the file. [sensitive]
- timestamp: required(string)
The original time the file was uploaded in rfc3339 format.
- name: required(string)
Example:
{
"x509_bundle": {
"id": "system_net_ipsec_files_x509_bundles-1",
"name": "bundle.p12",
"content": "MIIMyQIBAzCCDI8GCSqGSIb3DQEHAaCCDIAEggx8MIIMeDCCBy8GCSqGSIb3DQEHBqCCByAwggccAgEAMIIHFQYJKoZIhvcNAQcBMBwGCiqGSIb3DQEMAQYwDgQIeJSe0WDoL8MCAggAgIIG6C3LA4m3OrKwWUEmZm4okKJnUSydP6uMMufkhNPf2/ntbC1GqsJO9DwyjEhAsKNqoXacAnR+W4DfZ3z8xu5SQ19wV9fmCYdYpAzsLwu4eMiV7fLR0ARzN/ngytxaDbtuIGt9+2xudJ/ESGtjVs8MPzEe234gv/k3lFMtQcM2iZBANfxF31Ozyb/aidW3mUWJPNl4Wb3gCE4rxPt5hjdOP/Fd9JAPxfHqWGyeMm7FWsbOHm6zWTrNtJGoXyePF6/p0sj9tpOVuckSdceIz2RIvTFIB/S7G7v45MyTFzCyNotL4kPIchkRuURJ11mh6votK8gfnDt18e7spe8HfMgQJWrNUJPh7niEjSOUFkhttG3V4VhI+cpPTQBhFyKL3hD3d8w1ifGFZy93LnVJURTRBqjUYukCi/OfE1NfgAPAkW8G4g5Pay6NmGpmtirIs3nYEH36MKP9EVh2CUFXfrL3WP+X/WzzrfntshISuEiQcBSNWL3wMBsOuQyJGoqAJM9d4OEkV+RXI3sHYZmO2uZkT7AUEZ6okFoFpwjcbzPo1/Yr0+GWugcjltdLtxC17CmfwNorYots0y+eKUFsihHLjreGNeDtwFRfhT+cj5crWggIGi7KyCVVsgi7d8hmbgk7tOMTfvSEMkZ869rZnt+a3Ta90KTgjUbaRw5DCKw44BuC27oDitJr37fhQB5g0BrwHjB/+yHKTBtcGy2yfflC6q8cdZgrQHCZAzK92eY6/BlnQB0uxjAgAOOh59RlOpsQ1ddzlvwEBiAm+pYl5VcYjUudqVIDq/61io0q8rWgDNu+VpqPi0ITtqgOD4s+iZDRI+kztK1rleJh9OUnzk01E9uOeZ7EeenygroEgeMn6sE9MWbYHntHf8Je2ljYSz0hHUUkqQQTf1JxXXbuM7ACopgrJIMJWH6Um333VhBTCFQ995Keview/VkQhyITKQks1+ndWeVTfHuSTd2NQQ/gwZLFCG+NZrNMr9vWe7joIIShbKyO4NrosTJkYGX5DJxXBC+pRsn9ugERjKdnn5p69ovKFXYA5y9F07iqGvU5+actdaSxTGx/6LMYT/lcqm6VvpcNEn/Sc7beuvjZfsWsxQvYm2SxQToqZzKmYh1vI6/HC8bDqDvWEI9FvV43HmMyENTXERl8ADhJcTjymzxTH7ZY9k69XvbkL4W9FFgtKglbINAyQo7L4277+C/dMTZMEE59PZnNIbuzUXZ3AJZDU+j6rtvUZdbefRtVEqs0bMmApVskMr+iuSIwCHTIymnJM6d6I44t32gb18v9mQLfyvkqgHjcEFLnB3c2wB9b7y1CpKJPVxPBteL3Gd2RIlOdyg57lJa4k0B1xOuwsqYYJugWQgBIHMjqxhmYcQ71o1QCLjJ5n8euZd/KsX6MvYcgDP2EYupfnM8m6kOKHPUMQC8JxcEY/Tjm2mcUyRyEo22sRyCBH7zk+IPDFZ5ww5PWjltNUMkayWf+GxdLsmbAYawpVCriGHC7V7L2gt2dhuVzjYL05S+TsDCsGQMOQI/NLmMKbKSJjEBYU/e8GK7xGguF95b/TMediw0nGWLmLbm9NFmAoiBNILqWZLrQeZYQy2rMFWB0R+OpFyFiexpVvxN+2k0U2D9EzwDriCiyDi+mRooC7Chvoj4ldrCH6XPS/PkWvWS1gh+mShKphT7eHsWSc9irAtUfi1L11OvxSbXEPtd62hmJjE4TQ+Y5TvjNeBN2YooO2zWNak0ouLYjHufU5Bx0nE/nBYRudtRFriCmraW0ucH7Tywysez7Ckwhk3fFKuAlUgFJP3xLjeFXS8x+FfAyddwLOHLJVwDrkC1my5Y3jfn9vaab7ywHxquWTfDSWEQdDf+Yu7/D+hqsAi2qSHwPgGFGRpua3YhFoCfKF9UDhNfJBZYbiYl7duQfkiU3whF5ABCid0XMMpM1x7EUeoQsmbNd4k/E+9p1SIfZ+9Ax4oDnL/AtcfapcBQ2dPnjLuF1AswtTSHIAv5FsDGSaPCHk+pD2S77jL9ln6KIZmxzw/8pzdLSvby0ANE0m+nTNBVavjz4EU20WbUEVXVJvWHa64/QR/1WDSM6EqT/9bnC5/EtFG2MGLbyt8tNQjujUffowS1BVU/QKtO1mKP6wkqq3BFpTt4VU8nZnHnWTv9l0d11qbCOvrXbVnKu21fQF8G0cFonZGuQxCs/9O99ffn5sDN1HxPa0a2UYczhImL8K/uJT8J7JpIhKRZm4VkdJM/fM/Jaek0n+9u1pXGb0Ikl71r7iXKdwxBngcUveWBsT3p4/1ySa+qrT4AmyRoOgHNx4WBW9RMfY3fwEtvpX1UxI7I7LkWiuGJ43sF5jcdUT7SeW0cwggVBBgkqhkiG9w0BBwGgggUyBIIFLjCCBSowggUmBgsqhkiG9w0BDAoBAqCCBO4wggTqMBwGCiqGSIb3DQEMAQMwDgQI1W0hhU1AvikCAggABIIEyL5K7kZIU4Vb56/FqdrS0e4di5dal6VciBwGFstJVEMORkMEUgveaSInZbQGlO9rJSfk5crFMfI0SfznEdKOBQpYvyQYntm/YrJpp5pCXpo2FZh9luseGeh2wA38Gsq59dn4OWs7UGJSKGjSNcI9bGON9L2L25pbJCEFDPbxOJwDAad1gmSLydADaA8Yc0KTb9c0XrhtT8TZ8Ez+wKT6VGTLLinPClOnpD3JMLfcnxBQCzVs20Am8t0UXgaHlenWyh36zkpl6PfxqQJ4TEoDq1kjQASV3aPe0NwR3puI7za8wW7fLggyO0fC8FVMXPR/RmRNGBLi5+OpLwhTm/DI34CEYA2v78Nsb6g0HWX58qfeDrHfkHKjKv0uPcc6W1WmiMOJnylZ2WlKGk8Y+w/ehJqgZCpa16QzlT3/TJ3s8Twm9msFzMFK/6lHmCXtOA9YvFhp/D+hhZh16hsNzS9TuQ7d3HMAb2N1O610XiMOO6i5Mf6XyH5fVCw571A0oCnE+ieZCZoYyQaOSWd0r0qkPHFr9BlACrpkdgHVKCGji1oI10+QhLeUuVJgPbATavzQxKgrk/KXG4inH/gtKbdZ2sH35uZj22JrO/LAPQ608rfvQM28v/0dbY7/Ge8Oa49t82JJNMJwxQMG3wNTraj51+CnYMx9GsMoy+NAiMVkjrVP4RiawMk2M/mAqf4gbYb6q1l8iCearG1oNAK/6zdxH8b/uLq/PhxWPaT0BniJPbasEKyrzTJB2wlswwESROfiREDUClWG1djzsKI73Bn1NAtmKZUkQEFiozE69SBYRwXC/XqP5FZSY8bXZIdMm94aOkrohjxbeRRx+52Tu+uXe3S61G6vBowzuEbkqeXeFSOpXR62MYaOsVaniB9u2TwKUFliD5jpX+Z479wX6c4rHkNIiLerIYRg5iHC7/H9BbewGCZ9rbw00mOkTpOWf6C0ni2L7kmbxLl5IaHqyavNCSQkEuelK8YOq65U9TXWwBwfb8GCZOVMOWayG/nO4c0M1LfgsprYhbJUoF1V+4amrLrJbgEouUStEEgg5gHI//+2LiHX2gU2EydB9ne6m+h6lLpNDZjVgKhuJdHBy6jf4jGEpR694z341GEv6M4HZ4p4AVAx7LIvgS4FT2++GbPVThpZvzY/EL8M/yt0wUhWpOWnqO9YGqUapxCoGttSg24skTDsUfbU2ltf2giOSqFgOMIc9DgsKKqb5L6x+FTA0JzQrrSOSdfdKHM8Vus8uEF0REDFouH7CkbmtwRdHFjQuFeWRwnxtXnkhHA3riC21JJSt9awTK3CehbvpAd6iV2emFMmXDWtRVB5JGXKsfleb8ctVbcPArqX6Hv+uBZtFRdZC2yUVMvacaSylEZdNfSLC7BMRW1bQ6U1fcxrOy2Xrl5M2SlF3CpQ1u5eAOsWhIuwKqKBCZssDXxXgnKHgMPrInwLNm+pRI+/P7choUZUmPd9w+/WjpsMWBKLlTTzCHtfA3S6QMvTJor02TyGwETga2Lfe/FUHxRqd2cS8/oe70zQNVb47Lx4Rv0p+E6JaUm3SQZ//pCK/4c5so69y5BCazHPlON6o0WV8EcQNyjdrXn5XO3ZY06kBibZfnXzXRROKMz7YsthNzElMCMGCSqGSIb3DQEJFTEWBBTsTioxPc2KkCi5ohjqjZsUFRMlCDAxMCEwCQYFKw4DAhoFAAQUGenOqzXKjdA6z0DTAwsG/40AwrgECEigJt/JI2HMAgIIAA==",
"password": "TkcxJAAAABDz14VOkQ5K7qU+HmxBn6BCj3iQ7nfaHR6qU8MBGapj4g==",
"timestamp": "2021-05-31T22:57:25+00:00"
}
}HTTP status code 400
Invalid request: Body is not json or does not conform to required json schema. Incomplete data: x509 bundle parameter missing.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Get a single configured x509 bundle by its ID.
Update a single configured x509 bundle.
Delete an x509 Bundle.
get /ipsec/x509_bundles/{id}
Get a single configured x509 bundle by its ID.
Operations Manager base authentication scheme
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Query Parameters
- secrets: (one of cleartext, obfuscate, mask - default: cleartext)
Returns sensitive fields displayed as either cleartext, obfuscated or masked values.
HTTP status code 200
Get an x509 bundle.
Body
Media type: application/json
Type: object
Properties- x509_bundle: required(object)
This object contains information for an IPsec bundle file.
- name: required(string)
The files name.
- content: required(string)
The base64 encoded binary content of the file.
- password: (string)
An optional password that can be used to decrypt the file. [sensitive]
- timestamp: required(string)
The original time the file was uploaded in rfc3339 format.
- name: required(string)
Example:
{
"x509_bundle": {
"id": "system_net_ipsec_files_x509_bundles-1",
"name": "bundle.p12",
"content": "MIIMyQIBAzCCDI8GCSqGSIb3DQEHAaCCDIAEggx8MIIMeDCCBy8GCSqGSIb3DQEHBqCCByAwggccAgEAMIIHFQYJKoZIhvcNAQcBMBwGCiqGSIb3DQEMAQYwDgQIeJSe0WDoL8MCAggAgIIG6C3LA4m3OrKwWUEmZm4okKJnUSydP6uMMufkhNPf2/ntbC1GqsJO9DwyjEhAsKNqoXacAnR+W4DfZ3z8xu5SQ19wV9fmCYdYpAzsLwu4eMiV7fLR0ARzN/ngytxaDbtuIGt9+2xudJ/ESGtjVs8MPzEe234gv/k3lFMtQcM2iZBANfxF31Ozyb/aidW3mUWJPNl4Wb3gCE4rxPt5hjdOP/Fd9JAPxfHqWGyeMm7FWsbOHm6zWTrNtJGoXyePF6/p0sj9tpOVuckSdceIz2RIvTFIB/S7G7v45MyTFzCyNotL4kPIchkRuURJ11mh6votK8gfnDt18e7spe8HfMgQJWrNUJPh7niEjSOUFkhttG3V4VhI+cpPTQBhFyKL3hD3d8w1ifGFZy93LnVJURTRBqjUYukCi/OfE1NfgAPAkW8G4g5Pay6NmGpmtirIs3nYEH36MKP9EVh2CUFXfrL3WP+X/WzzrfntshISuEiQcBSNWL3wMBsOuQyJGoqAJM9d4OEkV+RXI3sHYZmO2uZkT7AUEZ6okFoFpwjcbzPo1/Yr0+GWugcjltdLtxC17CmfwNorYots0y+eKUFsihHLjreGNeDtwFRfhT+cj5crWggIGi7KyCVVsgi7d8hmbgk7tOMTfvSEMkZ869rZnt+a3Ta90KTgjUbaRw5DCKw44BuC27oDitJr37fhQB5g0BrwHjB/+yHKTBtcGy2yfflC6q8cdZgrQHCZAzK92eY6/BlnQB0uxjAgAOOh59RlOpsQ1ddzlvwEBiAm+pYl5VcYjUudqVIDq/61io0q8rWgDNu+VpqPi0ITtqgOD4s+iZDRI+kztK1rleJh9OUnzk01E9uOeZ7EeenygroEgeMn6sE9MWbYHntHf8Je2ljYSz0hHUUkqQQTf1JxXXbuM7ACopgrJIMJWH6Um333VhBTCFQ995Keview/VkQhyITKQks1+ndWeVTfHuSTd2NQQ/gwZLFCG+NZrNMr9vWe7joIIShbKyO4NrosTJkYGX5DJxXBC+pRsn9ugERjKdnn5p69ovKFXYA5y9F07iqGvU5+actdaSxTGx/6LMYT/lcqm6VvpcNEn/Sc7beuvjZfsWsxQvYm2SxQToqZzKmYh1vI6/HC8bDqDvWEI9FvV43HmMyENTXERl8ADhJcTjymzxTH7ZY9k69XvbkL4W9FFgtKglbINAyQo7L4277+C/dMTZMEE59PZnNIbuzUXZ3AJZDU+j6rtvUZdbefRtVEqs0bMmApVskMr+iuSIwCHTIymnJM6d6I44t32gb18v9mQLfyvkqgHjcEFLnB3c2wB9b7y1CpKJPVxPBteL3Gd2RIlOdyg57lJa4k0B1xOuwsqYYJugWQgBIHMjqxhmYcQ71o1QCLjJ5n8euZd/KsX6MvYcgDP2EYupfnM8m6kOKHPUMQC8JxcEY/Tjm2mcUyRyEo22sRyCBH7zk+IPDFZ5ww5PWjltNUMkayWf+GxdLsmbAYawpVCriGHC7V7L2gt2dhuVzjYL05S+TsDCsGQMOQI/NLmMKbKSJjEBYU/e8GK7xGguF95b/TMediw0nGWLmLbm9NFmAoiBNILqWZLrQeZYQy2rMFWB0R+OpFyFiexpVvxN+2k0U2D9EzwDriCiyDi+mRooC7Chvoj4ldrCH6XPS/PkWvWS1gh+mShKphT7eHsWSc9irAtUfi1L11OvxSbXEPtd62hmJjE4TQ+Y5TvjNeBN2YooO2zWNak0ouLYjHufU5Bx0nE/nBYRudtRFriCmraW0ucH7Tywysez7Ckwhk3fFKuAlUgFJP3xLjeFXS8x+FfAyddwLOHLJVwDrkC1my5Y3jfn9vaab7ywHxquWTfDSWEQdDf+Yu7/D+hqsAi2qSHwPgGFGRpua3YhFoCfKF9UDhNfJBZYbiYl7duQfkiU3whF5ABCid0XMMpM1x7EUeoQsmbNd4k/E+9p1SIfZ+9Ax4oDnL/AtcfapcBQ2dPnjLuF1AswtTSHIAv5FsDGSaPCHk+pD2S77jL9ln6KIZmxzw/8pzdLSvby0ANE0m+nTNBVavjz4EU20WbUEVXVJvWHa64/QR/1WDSM6EqT/9bnC5/EtFG2MGLbyt8tNQjujUffowS1BVU/QKtO1mKP6wkqq3BFpTt4VU8nZnHnWTv9l0d11qbCOvrXbVnKu21fQF8G0cFonZGuQxCs/9O99ffn5sDN1HxPa0a2UYczhImL8K/uJT8J7JpIhKRZm4VkdJM/fM/Jaek0n+9u1pXGb0Ikl71r7iXKdwxBngcUveWBsT3p4/1ySa+qrT4AmyRoOgHNx4WBW9RMfY3fwEtvpX1UxI7I7LkWiuGJ43sF5jcdUT7SeW0cwggVBBgkqhkiG9w0BBwGgggUyBIIFLjCCBSowggUmBgsqhkiG9w0BDAoBAqCCBO4wggTqMBwGCiqGSIb3DQEMAQMwDgQI1W0hhU1AvikCAggABIIEyL5K7kZIU4Vb56/FqdrS0e4di5dal6VciBwGFstJVEMORkMEUgveaSInZbQGlO9rJSfk5crFMfI0SfznEdKOBQpYvyQYntm/YrJpp5pCXpo2FZh9luseGeh2wA38Gsq59dn4OWs7UGJSKGjSNcI9bGON9L2L25pbJCEFDPbxOJwDAad1gmSLydADaA8Yc0KTb9c0XrhtT8TZ8Ez+wKT6VGTLLinPClOnpD3JMLfcnxBQCzVs20Am8t0UXgaHlenWyh36zkpl6PfxqQJ4TEoDq1kjQASV3aPe0NwR3puI7za8wW7fLggyO0fC8FVMXPR/RmRNGBLi5+OpLwhTm/DI34CEYA2v78Nsb6g0HWX58qfeDrHfkHKjKv0uPcc6W1WmiMOJnylZ2WlKGk8Y+w/ehJqgZCpa16QzlT3/TJ3s8Twm9msFzMFK/6lHmCXtOA9YvFhp/D+hhZh16hsNzS9TuQ7d3HMAb2N1O610XiMOO6i5Mf6XyH5fVCw571A0oCnE+ieZCZoYyQaOSWd0r0qkPHFr9BlACrpkdgHVKCGji1oI10+QhLeUuVJgPbATavzQxKgrk/KXG4inH/gtKbdZ2sH35uZj22JrO/LAPQ608rfvQM28v/0dbY7/Ge8Oa49t82JJNMJwxQMG3wNTraj51+CnYMx9GsMoy+NAiMVkjrVP4RiawMk2M/mAqf4gbYb6q1l8iCearG1oNAK/6zdxH8b/uLq/PhxWPaT0BniJPbasEKyrzTJB2wlswwESROfiREDUClWG1djzsKI73Bn1NAtmKZUkQEFiozE69SBYRwXC/XqP5FZSY8bXZIdMm94aOkrohjxbeRRx+52Tu+uXe3S61G6vBowzuEbkqeXeFSOpXR62MYaOsVaniB9u2TwKUFliD5jpX+Z479wX6c4rHkNIiLerIYRg5iHC7/H9BbewGCZ9rbw00mOkTpOWf6C0ni2L7kmbxLl5IaHqyavNCSQkEuelK8YOq65U9TXWwBwfb8GCZOVMOWayG/nO4c0M1LfgsprYhbJUoF1V+4amrLrJbgEouUStEEgg5gHI//+2LiHX2gU2EydB9ne6m+h6lLpNDZjVgKhuJdHBy6jf4jGEpR694z341GEv6M4HZ4p4AVAx7LIvgS4FT2++GbPVThpZvzY/EL8M/yt0wUhWpOWnqO9YGqUapxCoGttSg24skTDsUfbU2ltf2giOSqFgOMIc9DgsKKqb5L6x+FTA0JzQrrSOSdfdKHM8Vus8uEF0REDFouH7CkbmtwRdHFjQuFeWRwnxtXnkhHA3riC21JJSt9awTK3CehbvpAd6iV2emFMmXDWtRVB5JGXKsfleb8ctVbcPArqX6Hv+uBZtFRdZC2yUVMvacaSylEZdNfSLC7BMRW1bQ6U1fcxrOy2Xrl5M2SlF3CpQ1u5eAOsWhIuwKqKBCZssDXxXgnKHgMPrInwLNm+pRI+/P7choUZUmPd9w+/WjpsMWBKLlTTzCHtfA3S6QMvTJor02TyGwETga2Lfe/FUHxRqd2cS8/oe70zQNVb47Lx4Rv0p+E6JaUm3SQZ//pCK/4c5so69y5BCazHPlON6o0WV8EcQNyjdrXn5XO3ZY06kBibZfnXzXRROKMz7YsthNzElMCMGCSqGSIb3DQEJFTEWBBTsTioxPc2KkCi5ohjqjZsUFRMlCDAxMCEwCQYFKw4DAhoFAAQUGenOqzXKjdA6z0DTAwsG/40AwrgECEigJt/JI2HMAgIIAA==",
"password": "TkcxJAAAABDz14VOkQ5K7qU+HmxBn6BCj3iQ7nfaHR6qU8MBGapj4g==",
"timestamp": "2021-05-31T22:57:25+00:00"
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /ipsec/x509_bundles/{id}
Update a single configured x509 bundle.
Operations Manager base authentication scheme
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Query Parameters
- secrets: (one of cleartext, obfuscate - default: cleartext)
Accepts sensitive fields as either cleartext or obfuscated values. The response will display the sensitive fields in the same way.
Body
Media type: application/json
Type: object
Properties- x509_bundle: required(object)
This object contains information for an IPsec bundle file.
- name: required(string)
The files name.
- content: required(string)
The base64 encoded binary content of the file. [sensitive]
- password: (string)
An optional password that can be used to decrypt the file. [sensitive]
- name: required(string)
Example:
{
"x509_bundle": {
"name": "bundle.p12",
"content": "MIIMyQIBAzCCDI8GCSqGSIb3DQEHAaCCDIAEggx8MIIMeDCCBy8GCSqGSIb3DQEHBqCCByAwggccAgEAMIIHFQYJKoZIhvcNAQcBMBwGCiqGSIb3DQEMAQYwDgQIeJSe0WDoL8MCAggAgIIG6C3LA4m3OrKwWUEmZm4okKJnUSydP6uMMufkhNPf2/ntbC1GqsJO9DwyjEhAsKNqoXacAnR+W4DfZ3z8xu5SQ19wV9fmCYdYpAzsLwu4eMiV7fLR0ARzN/ngytxaDbtuIGt9+2xudJ/ESGtjVs8MPzEe234gv/k3lFMtQcM2iZBANfxF31Ozyb/aidW3mUWJPNl4Wb3gCE4rxPt5hjdOP/Fd9JAPxfHqWGyeMm7FWsbOHm6zWTrNtJGoXyePF6/p0sj9tpOVuckSdceIz2RIvTFIB/S7G7v45MyTFzCyNotL4kPIchkRuURJ11mh6votK8gfnDt18e7spe8HfMgQJWrNUJPh7niEjSOUFkhttG3V4VhI+cpPTQBhFyKL3hD3d8w1ifGFZy93LnVJURTRBqjUYukCi/OfE1NfgAPAkW8G4g5Pay6NmGpmtirIs3nYEH36MKP9EVh2CUFXfrL3WP+X/WzzrfntshISuEiQcBSNWL3wMBsOuQyJGoqAJM9d4OEkV+RXI3sHYZmO2uZkT7AUEZ6okFoFpwjcbzPo1/Yr0+GWugcjltdLtxC17CmfwNorYots0y+eKUFsihHLjreGNeDtwFRfhT+cj5crWggIGi7KyCVVsgi7d8hmbgk7tOMTfvSEMkZ869rZnt+a3Ta90KTgjUbaRw5DCKw44BuC27oDitJr37fhQB5g0BrwHjB/+yHKTBtcGy2yfflC6q8cdZgrQHCZAzK92eY6/BlnQB0uxjAgAOOh59RlOpsQ1ddzlvwEBiAm+pYl5VcYjUudqVIDq/61io0q8rWgDNu+VpqPi0ITtqgOD4s+iZDRI+kztK1rleJh9OUnzk01E9uOeZ7EeenygroEgeMn6sE9MWbYHntHf8Je2ljYSz0hHUUkqQQTf1JxXXbuM7ACopgrJIMJWH6Um333VhBTCFQ995Keview/VkQhyITKQks1+ndWeVTfHuSTd2NQQ/gwZLFCG+NZrNMr9vWe7joIIShbKyO4NrosTJkYGX5DJxXBC+pRsn9ugERjKdnn5p69ovKFXYA5y9F07iqGvU5+actdaSxTGx/6LMYT/lcqm6VvpcNEn/Sc7beuvjZfsWsxQvYm2SxQToqZzKmYh1vI6/HC8bDqDvWEI9FvV43HmMyENTXERl8ADhJcTjymzxTH7ZY9k69XvbkL4W9FFgtKglbINAyQo7L4277+C/dMTZMEE59PZnNIbuzUXZ3AJZDU+j6rtvUZdbefRtVEqs0bMmApVskMr+iuSIwCHTIymnJM6d6I44t32gb18v9mQLfyvkqgHjcEFLnB3c2wB9b7y1CpKJPVxPBteL3Gd2RIlOdyg57lJa4k0B1xOuwsqYYJugWQgBIHMjqxhmYcQ71o1QCLjJ5n8euZd/KsX6MvYcgDP2EYupfnM8m6kOKHPUMQC8JxcEY/Tjm2mcUyRyEo22sRyCBH7zk+IPDFZ5ww5PWjltNUMkayWf+GxdLsmbAYawpVCriGHC7V7L2gt2dhuVzjYL05S+TsDCsGQMOQI/NLmMKbKSJjEBYU/e8GK7xGguF95b/TMediw0nGWLmLbm9NFmAoiBNILqWZLrQeZYQy2rMFWB0R+OpFyFiexpVvxN+2k0U2D9EzwDriCiyDi+mRooC7Chvoj4ldrCH6XPS/PkWvWS1gh+mShKphT7eHsWSc9irAtUfi1L11OvxSbXEPtd62hmJjE4TQ+Y5TvjNeBN2YooO2zWNak0ouLYjHufU5Bx0nE/nBYRudtRFriCmraW0ucH7Tywysez7Ckwhk3fFKuAlUgFJP3xLjeFXS8x+FfAyddwLOHLJVwDrkC1my5Y3jfn9vaab7ywHxquWTfDSWEQdDf+Yu7/D+hqsAi2qSHwPgGFGRpua3YhFoCfKF9UDhNfJBZYbiYl7duQfkiU3whF5ABCid0XMMpM1x7EUeoQsmbNd4k/E+9p1SIfZ+9Ax4oDnL/AtcfapcBQ2dPnjLuF1AswtTSHIAv5FsDGSaPCHk+pD2S77jL9ln6KIZmxzw/8pzdLSvby0ANE0m+nTNBVavjz4EU20WbUEVXVJvWHa64/QR/1WDSM6EqT/9bnC5/EtFG2MGLbyt8tNQjujUffowS1BVU/QKtO1mKP6wkqq3BFpTt4VU8nZnHnWTv9l0d11qbCOvrXbVnKu21fQF8G0cFonZGuQxCs/9O99ffn5sDN1HxPa0a2UYczhImL8K/uJT8J7JpIhKRZm4VkdJM/fM/Jaek0n+9u1pXGb0Ikl71r7iXKdwxBngcUveWBsT3p4/1ySa+qrT4AmyRoOgHNx4WBW9RMfY3fwEtvpX1UxI7I7LkWiuGJ43sF5jcdUT7SeW0cwggVBBgkqhkiG9w0BBwGgggUyBIIFLjCCBSowggUmBgsqhkiG9w0BDAoBAqCCBO4wggTqMBwGCiqGSIb3DQEMAQMwDgQI1W0hhU1AvikCAggABIIEyL5K7kZIU4Vb56/FqdrS0e4di5dal6VciBwGFstJVEMORkMEUgveaSInZbQGlO9rJSfk5crFMfI0SfznEdKOBQpYvyQYntm/YrJpp5pCXpo2FZh9luseGeh2wA38Gsq59dn4OWs7UGJSKGjSNcI9bGON9L2L25pbJCEFDPbxOJwDAad1gmSLydADaA8Yc0KTb9c0XrhtT8TZ8Ez+wKT6VGTLLinPClOnpD3JMLfcnxBQCzVs20Am8t0UXgaHlenWyh36zkpl6PfxqQJ4TEoDq1kjQASV3aPe0NwR3puI7za8wW7fLggyO0fC8FVMXPR/RmRNGBLi5+OpLwhTm/DI34CEYA2v78Nsb6g0HWX58qfeDrHfkHKjKv0uPcc6W1WmiMOJnylZ2WlKGk8Y+w/ehJqgZCpa16QzlT3/TJ3s8Twm9msFzMFK/6lHmCXtOA9YvFhp/D+hhZh16hsNzS9TuQ7d3HMAb2N1O610XiMOO6i5Mf6XyH5fVCw571A0oCnE+ieZCZoYyQaOSWd0r0qkPHFr9BlACrpkdgHVKCGji1oI10+QhLeUuVJgPbATavzQxKgrk/KXG4inH/gtKbdZ2sH35uZj22JrO/LAPQ608rfvQM28v/0dbY7/Ge8Oa49t82JJNMJwxQMG3wNTraj51+CnYMx9GsMoy+NAiMVkjrVP4RiawMk2M/mAqf4gbYb6q1l8iCearG1oNAK/6zdxH8b/uLq/PhxWPaT0BniJPbasEKyrzTJB2wlswwESROfiREDUClWG1djzsKI73Bn1NAtmKZUkQEFiozE69SBYRwXC/XqP5FZSY8bXZIdMm94aOkrohjxbeRRx+52Tu+uXe3S61G6vBowzuEbkqeXeFSOpXR62MYaOsVaniB9u2TwKUFliD5jpX+Z479wX6c4rHkNIiLerIYRg5iHC7/H9BbewGCZ9rbw00mOkTpOWf6C0ni2L7kmbxLl5IaHqyavNCSQkEuelK8YOq65U9TXWwBwfb8GCZOVMOWayG/nO4c0M1LfgsprYhbJUoF1V+4amrLrJbgEouUStEEgg5gHI//+2LiHX2gU2EydB9ne6m+h6lLpNDZjVgKhuJdHBy6jf4jGEpR694z341GEv6M4HZ4p4AVAx7LIvgS4FT2++GbPVThpZvzY/EL8M/yt0wUhWpOWnqO9YGqUapxCoGttSg24skTDsUfbU2ltf2giOSqFgOMIc9DgsKKqb5L6x+FTA0JzQrrSOSdfdKHM8Vus8uEF0REDFouH7CkbmtwRdHFjQuFeWRwnxtXnkhHA3riC21JJSt9awTK3CehbvpAd6iV2emFMmXDWtRVB5JGXKsfleb8ctVbcPArqX6Hv+uBZtFRdZC2yUVMvacaSylEZdNfSLC7BMRW1bQ6U1fcxrOy2Xrl5M2SlF3CpQ1u5eAOsWhIuwKqKBCZssDXxXgnKHgMPrInwLNm+pRI+/P7choUZUmPd9w+/WjpsMWBKLlTTzCHtfA3S6QMvTJor02TyGwETga2Lfe/FUHxRqd2cS8/oe70zQNVb47Lx4Rv0p+E6JaUm3SQZ//pCK/4c5so69y5BCazHPlON6o0WV8EcQNyjdrXn5XO3ZY06kBibZfnXzXRROKMz7YsthNzElMCMGCSqGSIb3DQEJFTEWBBTsTioxPc2KkCi5ohjqjZsUFRMlCDAxMCEwCQYFKw4DAhoFAAQUGenOqzXKjdA6z0DTAwsG/40AwrgECEigJt/JI2HMAgIIAA==",
"password": "TkcxJAAAABDz14VOkQ5K7qU+HmxBn6BCj3iQ7nfaHR6qU8MBGapj4g==",
"timestamp": "2021-05-31T22:57:25+00:00"
}
}HTTP status code 200
The x509 bundle settings were updated.
Body
Media type: application/json
Type: object
Properties- x509_bundle: required(object)
This object contains information for an IPsec bundle file.
- name: required(string)
The files name.
- content: required(string)
The base64 encoded binary content of the file.
- password: (string)
An optional password that can be used to decrypt the file. [sensitive]
- timestamp: required(string)
The original time the file was uploaded in rfc3339 format.
- name: required(string)
Example:
{
"x509_bundle": {
"id": "system_net_ipsec_files_x509_bundles-1",
"name": "bundle.p12",
"content": "MIIMyQIBAzCCDI8GCSqGSIb3DQEHAaCCDIAEggx8MIIMeDCCBy8GCSqGSIb3DQEHBqCCByAwggccAgEAMIIHFQYJKoZIhvcNAQcBMBwGCiqGSIb3DQEMAQYwDgQIeJSe0WDoL8MCAggAgIIG6C3LA4m3OrKwWUEmZm4okKJnUSydP6uMMufkhNPf2/ntbC1GqsJO9DwyjEhAsKNqoXacAnR+W4DfZ3z8xu5SQ19wV9fmCYdYpAzsLwu4eMiV7fLR0ARzN/ngytxaDbtuIGt9+2xudJ/ESGtjVs8MPzEe234gv/k3lFMtQcM2iZBANfxF31Ozyb/aidW3mUWJPNl4Wb3gCE4rxPt5hjdOP/Fd9JAPxfHqWGyeMm7FWsbOHm6zWTrNtJGoXyePF6/p0sj9tpOVuckSdceIz2RIvTFIB/S7G7v45MyTFzCyNotL4kPIchkRuURJ11mh6votK8gfnDt18e7spe8HfMgQJWrNUJPh7niEjSOUFkhttG3V4VhI+cpPTQBhFyKL3hD3d8w1ifGFZy93LnVJURTRBqjUYukCi/OfE1NfgAPAkW8G4g5Pay6NmGpmtirIs3nYEH36MKP9EVh2CUFXfrL3WP+X/WzzrfntshISuEiQcBSNWL3wMBsOuQyJGoqAJM9d4OEkV+RXI3sHYZmO2uZkT7AUEZ6okFoFpwjcbzPo1/Yr0+GWugcjltdLtxC17CmfwNorYots0y+eKUFsihHLjreGNeDtwFRfhT+cj5crWggIGi7KyCVVsgi7d8hmbgk7tOMTfvSEMkZ869rZnt+a3Ta90KTgjUbaRw5DCKw44BuC27oDitJr37fhQB5g0BrwHjB/+yHKTBtcGy2yfflC6q8cdZgrQHCZAzK92eY6/BlnQB0uxjAgAOOh59RlOpsQ1ddzlvwEBiAm+pYl5VcYjUudqVIDq/61io0q8rWgDNu+VpqPi0ITtqgOD4s+iZDRI+kztK1rleJh9OUnzk01E9uOeZ7EeenygroEgeMn6sE9MWbYHntHf8Je2ljYSz0hHUUkqQQTf1JxXXbuM7ACopgrJIMJWH6Um333VhBTCFQ995Keview/VkQhyITKQks1+ndWeVTfHuSTd2NQQ/gwZLFCG+NZrNMr9vWe7joIIShbKyO4NrosTJkYGX5DJxXBC+pRsn9ugERjKdnn5p69ovKFXYA5y9F07iqGvU5+actdaSxTGx/6LMYT/lcqm6VvpcNEn/Sc7beuvjZfsWsxQvYm2SxQToqZzKmYh1vI6/HC8bDqDvWEI9FvV43HmMyENTXERl8ADhJcTjymzxTH7ZY9k69XvbkL4W9FFgtKglbINAyQo7L4277+C/dMTZMEE59PZnNIbuzUXZ3AJZDU+j6rtvUZdbefRtVEqs0bMmApVskMr+iuSIwCHTIymnJM6d6I44t32gb18v9mQLfyvkqgHjcEFLnB3c2wB9b7y1CpKJPVxPBteL3Gd2RIlOdyg57lJa4k0B1xOuwsqYYJugWQgBIHMjqxhmYcQ71o1QCLjJ5n8euZd/KsX6MvYcgDP2EYupfnM8m6kOKHPUMQC8JxcEY/Tjm2mcUyRyEo22sRyCBH7zk+IPDFZ5ww5PWjltNUMkayWf+GxdLsmbAYawpVCriGHC7V7L2gt2dhuVzjYL05S+TsDCsGQMOQI/NLmMKbKSJjEBYU/e8GK7xGguF95b/TMediw0nGWLmLbm9NFmAoiBNILqWZLrQeZYQy2rMFWB0R+OpFyFiexpVvxN+2k0U2D9EzwDriCiyDi+mRooC7Chvoj4ldrCH6XPS/PkWvWS1gh+mShKphT7eHsWSc9irAtUfi1L11OvxSbXEPtd62hmJjE4TQ+Y5TvjNeBN2YooO2zWNak0ouLYjHufU5Bx0nE/nBYRudtRFriCmraW0ucH7Tywysez7Ckwhk3fFKuAlUgFJP3xLjeFXS8x+FfAyddwLOHLJVwDrkC1my5Y3jfn9vaab7ywHxquWTfDSWEQdDf+Yu7/D+hqsAi2qSHwPgGFGRpua3YhFoCfKF9UDhNfJBZYbiYl7duQfkiU3whF5ABCid0XMMpM1x7EUeoQsmbNd4k/E+9p1SIfZ+9Ax4oDnL/AtcfapcBQ2dPnjLuF1AswtTSHIAv5FsDGSaPCHk+pD2S77jL9ln6KIZmxzw/8pzdLSvby0ANE0m+nTNBVavjz4EU20WbUEVXVJvWHa64/QR/1WDSM6EqT/9bnC5/EtFG2MGLbyt8tNQjujUffowS1BVU/QKtO1mKP6wkqq3BFpTt4VU8nZnHnWTv9l0d11qbCOvrXbVnKu21fQF8G0cFonZGuQxCs/9O99ffn5sDN1HxPa0a2UYczhImL8K/uJT8J7JpIhKRZm4VkdJM/fM/Jaek0n+9u1pXGb0Ikl71r7iXKdwxBngcUveWBsT3p4/1ySa+qrT4AmyRoOgHNx4WBW9RMfY3fwEtvpX1UxI7I7LkWiuGJ43sF5jcdUT7SeW0cwggVBBgkqhkiG9w0BBwGgggUyBIIFLjCCBSowggUmBgsqhkiG9w0BDAoBAqCCBO4wggTqMBwGCiqGSIb3DQEMAQMwDgQI1W0hhU1AvikCAggABIIEyL5K7kZIU4Vb56/FqdrS0e4di5dal6VciBwGFstJVEMORkMEUgveaSInZbQGlO9rJSfk5crFMfI0SfznEdKOBQpYvyQYntm/YrJpp5pCXpo2FZh9luseGeh2wA38Gsq59dn4OWs7UGJSKGjSNcI9bGON9L2L25pbJCEFDPbxOJwDAad1gmSLydADaA8Yc0KTb9c0XrhtT8TZ8Ez+wKT6VGTLLinPClOnpD3JMLfcnxBQCzVs20Am8t0UXgaHlenWyh36zkpl6PfxqQJ4TEoDq1kjQASV3aPe0NwR3puI7za8wW7fLggyO0fC8FVMXPR/RmRNGBLi5+OpLwhTm/DI34CEYA2v78Nsb6g0HWX58qfeDrHfkHKjKv0uPcc6W1WmiMOJnylZ2WlKGk8Y+w/ehJqgZCpa16QzlT3/TJ3s8Twm9msFzMFK/6lHmCXtOA9YvFhp/D+hhZh16hsNzS9TuQ7d3HMAb2N1O610XiMOO6i5Mf6XyH5fVCw571A0oCnE+ieZCZoYyQaOSWd0r0qkPHFr9BlACrpkdgHVKCGji1oI10+QhLeUuVJgPbATavzQxKgrk/KXG4inH/gtKbdZ2sH35uZj22JrO/LAPQ608rfvQM28v/0dbY7/Ge8Oa49t82JJNMJwxQMG3wNTraj51+CnYMx9GsMoy+NAiMVkjrVP4RiawMk2M/mAqf4gbYb6q1l8iCearG1oNAK/6zdxH8b/uLq/PhxWPaT0BniJPbasEKyrzTJB2wlswwESROfiREDUClWG1djzsKI73Bn1NAtmKZUkQEFiozE69SBYRwXC/XqP5FZSY8bXZIdMm94aOkrohjxbeRRx+52Tu+uXe3S61G6vBowzuEbkqeXeFSOpXR62MYaOsVaniB9u2TwKUFliD5jpX+Z479wX6c4rHkNIiLerIYRg5iHC7/H9BbewGCZ9rbw00mOkTpOWf6C0ni2L7kmbxLl5IaHqyavNCSQkEuelK8YOq65U9TXWwBwfb8GCZOVMOWayG/nO4c0M1LfgsprYhbJUoF1V+4amrLrJbgEouUStEEgg5gHI//+2LiHX2gU2EydB9ne6m+h6lLpNDZjVgKhuJdHBy6jf4jGEpR694z341GEv6M4HZ4p4AVAx7LIvgS4FT2++GbPVThpZvzY/EL8M/yt0wUhWpOWnqO9YGqUapxCoGttSg24skTDsUfbU2ltf2giOSqFgOMIc9DgsKKqb5L6x+FTA0JzQrrSOSdfdKHM8Vus8uEF0REDFouH7CkbmtwRdHFjQuFeWRwnxtXnkhHA3riC21JJSt9awTK3CehbvpAd6iV2emFMmXDWtRVB5JGXKsfleb8ctVbcPArqX6Hv+uBZtFRdZC2yUVMvacaSylEZdNfSLC7BMRW1bQ6U1fcxrOy2Xrl5M2SlF3CpQ1u5eAOsWhIuwKqKBCZssDXxXgnKHgMPrInwLNm+pRI+/P7choUZUmPd9w+/WjpsMWBKLlTTzCHtfA3S6QMvTJor02TyGwETga2Lfe/FUHxRqd2cS8/oe70zQNVb47Lx4Rv0p+E6JaUm3SQZ//pCK/4c5so69y5BCazHPlON6o0WV8EcQNyjdrXn5XO3ZY06kBibZfnXzXRROKMz7YsthNzElMCMGCSqGSIb3DQEJFTEWBBTsTioxPc2KkCi5ohjqjZsUFRMlCDAxMCEwCQYFKw4DAhoFAAQUGenOqzXKjdA6z0DTAwsG/40AwrgECEigJt/JI2HMAgIIAA==",
"password": "TkcxJAAAABDz14VOkQ5K7qU+HmxBn6BCj3iQ7nfaHR6qU8MBGapj4g==",
"timestamp": "2021-05-31T22:57:25+00:00"
}
}HTTP status code 400
Invalid request: body is not json or does not conform to required json schema. Incomplete data: x509_bundle parameter missing.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}HTTP status code 404
x509_bundle {id} does not exist.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
delete /ipsec/x509_bundles/{id}
Delete an x509 Bundle.
Operations Manager base authentication scheme
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
x509 bundle deleted.
HTTP status code 400
Incomplete data
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}HTTP status code 404
x509 bundle did not exist
Body
Media type: application/json
Type: object
Example:
{
"error": [
{
"type": 5,
"code": 29,
"text": "Could not find x509_bundle with name or id 'system_net_ipsec_files_x509_bundles-1'",
"args": {
"uuid": "system_net_ipsec_files_x509_bundles-1"
},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Read, add, modify and delete Certificate Authority (CA) certificates used by IPsec tunnels using Public Key Infrastructure (PKI) for authentication
Get a list of all configured CA certificates
Configure a new CA certificate
get /ipsec/x509_ca_certificates
Get a list of all configured CA certificates
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- x509_ca_certificates: required(array of object)
Items: items
- name: required(string)
The files name.
- content: required(string)
The content of the file stored either in plaintext PEM format or base64 encoded binary.
- timestamp: required(string)
The original time the file was uploaded in rfc3339 format.
- name: required(string)
Example:
{
"x509_ca_certificates": [
{
"name": "512b-rsa-example-request.pem",
"content": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURSBSRVFVRVNULS0tLS0KTUlJQkJEQ0Jyd0lCQURCS01Rc3dDUVlEVlFRR0V3SktVREVPTUF3R0ExVUVDQXdGVkc5cmVXOHhFVEFQQmdOVgpCQW9NQ0VaeVlXNXJORVJFTVJnd0ZnWURWUVFEREE5M2QzY3VaWGhoYlhCc1pTNWpiMjB3WERBTkJna3Foa2lHCjl3MEJBUUVGQUFOTEFEQklBa0VBbS94bWtIbUVRcnVyRS8wcmUvamVGUkxsOFpQakJvcDd1TEhobmlhN2xRRy8KNXpEdFpJVUMzUlZwcURTd0J1dy9OVHdlR3l1UCtvOEFHOThIeHF4VEJ3SURBUUFCb0FBd0RRWUpLb1pJaHZjTgpBUUVGQlFBRFFRQnlPVjUyWTE3eTh4dzFWL3h2cnUzckxQclZ4WUFYUzVTZ3ZOcGZCc2ozOGxOVnRUdnVIL01nCnJvQmdtalNwbnFLcUJpQkRrb1kyWVVFVDJxbUdqQXU5Ci0tLS0tRU5EIENFUlRJRklDQVRFIFJFUVVFU1QtLS0tLQo=",
"timestamp": "2020-04-06 04:16:49.179388+00:00",
"id": "system_net_ipsec_x509_ca_certificate-1"
},
{
"name": "512b-rsa-example-request.der",
"content": "-----BEGIN CERTIFICATE----- MIIEFzCCAv+gAwIBAgIUETRacm1rXeNxAVKbjv1eKzV55KowDQYJKoZIhvcNAQEL BQAwgZoxCzAJBgNVBAYTAkFVMRMwEQYDVQQIDApRdWVlbnNsYW5kMREwDwYDVQQH DAhCcmlzYmFuZTEZMBcGA1UECgwQT3BlbmdlYXIgUHR5IEx0ZDENMAsGA1UECwwE TkdDUzEUMBIGA1UEAwwLRGF2aWQgQnVybnMxIzAhBgkqhkiG9w0BCQEWFGRhdmlk LmJ1cm5zQGRpZ2kuY29tMB4XDTIxMDUxMTAwMDY0OFoXDTIyMDUxMTAwMDY0OFow gZoxCzAJBgNVBAYTAkFVMRMwEQYDVQQIDApRdWVlbnNsYW5kMREwDwYDVQQHDAhC cmlzYmFuZTEZMBcGA1UECgwQT3BlbmdlYXIgUHR5IEx0ZDENMAsGA1UECwwETkdD UzEUMBIGA1UEAwwLRGF2aWQgQnVybnMxIzAhBgkqhkiG9w0BCQEWFGRhdmlkLmJ1 cm5zQGRpZ2kuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA5LV/ qA57gwiDGHEw1wRKqpOuprPypX4giu3RBEzW6+nrlmK/08sgNOLHbjR8nQLfanGI hQHImGpW11hWNbI9na5XSYjbiAaGaasCfm67NQu+mdQrDAQ3q6LZ7s2afdex5XOw nzQvgbfvKdCKmeMll0DHe88u/FDi5FquFE2/NLqqFNx1WkDP/YFd8ZRWcyjSEcG6 IcKErsY6iZFW6ouoUXJlFB8FztYN8/+E4w96G7GGZTxDesDYUqQr0voeo7PK/njp 7GR8zINU7Msah0TWRPymUwCgCdJ6bMtWTEpCsCmtNpil4UombiNB+zFCayHpivfP EnP8M/XFt/UE9UPXAQIDAQABo1MwUTAdBgNVHQ4EFgQUQGvvNmeHR2GY2IJxxYHm mZilZh0wHwYDVR0jBBgwFoAUQGvvNmeHR2GY2IJxxYHmmZilZh0wDwYDVR0TAQH/ BAUwAwEB/zANBgkqhkiG9w0BAQsFAAOCAQEARXJRnC623g3IgOPwftW4bWxAtghO jmlN/b9rn1Ka5hAJ2AlqJjeuIgDMd3cAXGsZ/LvqyTz4Z6ZDEg2uqsH5BXlUYt7Q 6SB6DYbnIxhw8PgDG5Je1TQerSJcOM87oMyO28ZiaDwQsjISML9BEK783FQ2mGj+ dXizJ5O2KonxJH9hkC2k0AI9YT7Xolb1CLQTqOsE4aYMQyU39Df3dFChOKeqBW8i HCMw+NKuKRJnW11lxIVS8YODx3kiGFroWBbfN99Wl9tCSoLmX2Myy9wflFOeIocE vo3lO39INFK+WdmP5z0YJ9U3I3Mowkvlu/KcvpZF+y7hVLmt67zOhXE/Kg== -----END CERTIFICATE-----",
"timestamp": "2021-03-12T20:43:39+00:00",
"id": "system_net_ipsec_x509_ca_certificate-2"
}
]
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
post /ipsec/x509_ca_certificates
Configure a new CA certificate
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- x509_ca_certificate: required(object)
This object contains information for an IPsec tunnel file.
- name: required(string)
The files name.
- content: required(string)
The content of the file stored either in plaintext PEM format or base64 encoded binary.
- name: required(string)
Example:
{
"x509_ca_certificate": {
"name": "512b-rsa-example-request.pem",
"content": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURSBSRVFVRVNULS0tLS0KTUlJQkJEQ0Jyd0lCQURCS01Rc3dDUVlEVlFRR0V3SktVREVPTUF3R0ExVUVDQXdGVkc5cmVXOHhFVEFQQmdOVgpCQW9NQ0VaeVlXNXJORVJFTVJnd0ZnWURWUVFEREE5M2QzY3VaWGhoYlhCc1pTNWpiMjB3WERBTkJna3Foa2lHCjl3MEJBUUVGQUFOTEFEQklBa0VBbS94bWtIbUVRcnVyRS8wcmUvamVGUkxsOFpQakJvcDd1TEhobmlhN2xRRy8KNXpEdFpJVUMzUlZwcURTd0J1dy9OVHdlR3l1UCtvOEFHOThIeHF4VEJ3SURBUUFCb0FBd0RRWUpLb1pJaHZjTgpBUUVGQlFBRFFRQnlPVjUyWTE3eTh4dzFWL3h2cnUzckxQclZ4WUFYUzVTZ3ZOcGZCc2ozOGxOVnRUdnVIL01nCnJvQmdtalNwbnFLcUJpQkRrb1kyWVVFVDJxbUdqQXU5Ci0tLS0tRU5EIENFUlRJRklDQVRFIFJFUVVFU1QtLS0tLQo="
}
}HTTP status code 201
Body
Media type: application/json
Type: object
Properties- x509_ca_certificate: required(object)
This object contains information for an IPsec tunnel file.
- name: required(string)
The files name.
- content: required(string)
The content of the file stored either in plaintext PEM format or base64 encoded binary.
- timestamp: required(string)
The original time the file was uploaded in rfc3339 format.
- name: required(string)
Example:
{
"x509_ca_certificate": {
"name": "512b-rsa-example-request.pem",
"content": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURSBSRVFVRVNULS0tLS0KTUlJQkJEQ0Jyd0lCQURCS01Rc3dDUVlEVlFRR0V3SktVREVPTUF3R0ExVUVDQXdGVkc5cmVXOHhFVEFQQmdOVgpCQW9NQ0VaeVlXNXJORVJFTVJnd0ZnWURWUVFEREE5M2QzY3VaWGhoYlhCc1pTNWpiMjB3WERBTkJna3Foa2lHCjl3MEJBUUVGQUFOTEFEQklBa0VBbS94bWtIbUVRcnVyRS8wcmUvamVGUkxsOFpQakJvcDd1TEhobmlhN2xRRy8KNXpEdFpJVUMzUlZwcURTd0J1dy9OVHdlR3l1UCtvOEFHOThIeHF4VEJ3SURBUUFCb0FBd0RRWUpLb1pJaHZjTgpBUUVGQlFBRFFRQnlPVjUyWTE3eTh4dzFWL3h2cnUzckxQclZ4WUFYUzVTZ3ZOcGZCc2ozOGxOVnRUdnVIL01nCnJvQmdtalNwbnFLcUJpQkRrb1kyWVVFVDJxbUdqQXU5Ci0tLS0tRU5EIENFUlRJRklDQVRFIFJFUVVFU1QtLS0tLQo=",
"timestamp": "2020-04-06 04:16:49.179388+00:00",
"id": "system_net_ipsec_x509_ca_certificate-1"
}
}HTTP status code 400
Invalid request: Body is not json or does not conform to required json schema.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Get a single configured CA by it ID
Update a single configured CA
Delete a CA
get /ipsec/x509_ca_certificates/{id}
Get a single configured CA by it ID
URI Parameters
- id: required(string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- x509_ca_certificate: required(object)
This object contains information for an IPsec tunnel file.
- name: required(string)
The files name.
- content: required(string)
The content of the file stored either in plaintext PEM format or base64 encoded binary.
- timestamp: required(string)
The original time the file was uploaded in rfc3339 format.
- name: required(string)
Example:
{
"x509_ca_certificate": {
"name": "512b-rsa-example-request.pem",
"content": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURSBSRVFVRVNULS0tLS0KTUlJQkJEQ0Jyd0lCQURCS01Rc3dDUVlEVlFRR0V3SktVREVPTUF3R0ExVUVDQXdGVkc5cmVXOHhFVEFQQmdOVgpCQW9NQ0VaeVlXNXJORVJFTVJnd0ZnWURWUVFEREE5M2QzY3VaWGhoYlhCc1pTNWpiMjB3WERBTkJna3Foa2lHCjl3MEJBUUVGQUFOTEFEQklBa0VBbS94bWtIbUVRcnVyRS8wcmUvamVGUkxsOFpQakJvcDd1TEhobmlhN2xRRy8KNXpEdFpJVUMzUlZwcURTd0J1dy9OVHdlR3l1UCtvOEFHOThIeHF4VEJ3SURBUUFCb0FBd0RRWUpLb1pJaHZjTgpBUUVGQlFBRFFRQnlPVjUyWTE3eTh4dzFWL3h2cnUzckxQclZ4WUFYUzVTZ3ZOcGZCc2ozOGxOVnRUdnVIL01nCnJvQmdtalNwbnFLcUJpQkRrb1kyWVVFVDJxbUdqQXU5Ci0tLS0tRU5EIENFUlRJRklDQVRFIFJFUVVFU1QtLS0tLQo=",
"timestamp": "2020-04-06 04:16:49.179388+00:00",
"id": "system_net_ipsec_x509_ca_certificate-3"
}
}HTTP status code 404
CA did not exist
Body
Media type: application/json
Type: object
Example:
{
"error": [
{
"type": 5,
"code": 29,
"text": "Could not find ipsec_x509_ca_certificate with name or id 'system_net_ipsec_x509_ca_certificate-1'",
"args": {
"uuid": "system_net_ipsec_x509_ca_certificate-1"
},
"level": 1
}
]
}put /ipsec/x509_ca_certificates/{id}
Update a single configured CA
URI Parameters
- id: required(string)
Body
Media type: application/json
Type: object
Properties- x509_ca_certificate: required(object)
This object contains information for an IPsec tunnel file.
- name: required(string)
The files name.
- content: required(string)
The content of the file stored either in plaintext PEM format or base64 encoded binary.
- name: required(string)
Example:
{
"x509_ca_certificate": {
"name": "512b-rsa-example-request.pem",
"content": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURSBSRVFVRVNULS0tLS0KTUlJQkJEQ0Jyd0lCQURCS01Rc3dDUVlEVlFRR0V3SktVREVPTUF3R0ExVUVDQXdGVkc5cmVXOHhFVEFQQmdOVgpCQW9NQ0VaeVlXNXJORVJFTVJnd0ZnWURWUVFEREE5M2QzY3VaWGhoYlhCc1pTNWpiMjB3WERBTkJna3Foa2lHCjl3MEJBUUVGQUFOTEFEQklBa0VBbS94bWtIbUVRcnVyRS8wcmUvamVGUkxsOFpQakJvcDd1TEhobmlhN2xRRy8KNXpEdFpJVUMzUlZwcURTd0J1dy9OVHdlR3l1UCtvOEFHOThIeHF4VEJ3SURBUUFCb0FBd0RRWUpLb1pJaHZjTgpBUUVGQlFBRFFRQnlPVjUyWTE3eTh4dzFWL3h2cnUzckxQclZ4WUFYUzVTZ3ZOcGZCc2ozOGxOVnRUdnVIL01nCnJvQmdtalNwbnFLcUJpQkRrb1kyWVVFVDJxbUdqQXU5Ci0tLS0tRU5EIENFUlRJRklDQVRFIFJFUVVFU1QtLS0tLQo="
}
}HTTP status code 200
Body
Media type: application/json
Type: object
Properties- x509_ca_certificate: required(object)
This object contains information for an IPsec tunnel file.
- name: required(string)
The files name.
- content: required(string)
The content of the file stored either in plaintext PEM format or base64 encoded binary.
- timestamp: required(string)
The original time the file was uploaded in rfc3339 format.
- name: required(string)
Example:
{
"x509_ca_certificate": {
"name": "512b-rsa-example-request.pem",
"content": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURSBSRVFVRVNULS0tLS0KTUlJQkJEQ0Jyd0lCQURCS01Rc3dDUVlEVlFRR0V3SktVREVPTUF3R0ExVUVDQXdGVkc5cmVXOHhFVEFQQmdOVgpCQW9NQ0VaeVlXNXJORVJFTVJnd0ZnWURWUVFEREE5M2QzY3VaWGhoYlhCc1pTNWpiMjB3WERBTkJna3Foa2lHCjl3MEJBUUVGQUFOTEFEQklBa0VBbS94bWtIbUVRcnVyRS8wcmUvamVGUkxsOFpQakJvcDd1TEhobmlhN2xRRy8KNXpEdFpJVUMzUlZwcURTd0J1dy9OVHdlR3l1UCtvOEFHOThIeHF4VEJ3SURBUUFCb0FBd0RRWUpLb1pJaHZjTgpBUUVGQlFBRFFRQnlPVjUyWTE3eTh4dzFWL3h2cnUzckxQclZ4WUFYUzVTZ3ZOcGZCc2ozOGxOVnRUdnVIL01nCnJvQmdtalNwbnFLcUJpQkRrb1kyWVVFVDJxbUdqQXU5Ci0tLS0tRU5EIENFUlRJRklDQVRFIFJFUVVFU1QtLS0tLQo=",
"timestamp": "2020-04-06 04:16:49.179388+00:00",
"id": "system_net_ipsec_x509_ca_certificate-5"
}
}HTTP status code 400
Invalid request: Body is not json or does not conform to required json schema.
HTTP status code 404
CA did not exist
Body
Media type: application/json
Type: object
Example:
{
"error": [
{
"type": 5,
"code": 29,
"text": "Could not find ipsec_x509_ca_certificate with name or id 'system_net_ipsec_x509_ca_certificate-1'",
"args": {
"uuid": "system_net_ipsec_x509_ca_certificate-1"
},
"level": 1
}
]
}delete /ipsec/x509_ca_certificates/{id}
Delete a CA
URI Parameters
- id: required(string)
HTTP status code 200
CA deleted
HTTP status code 404
CA did not exist
Body
Media type: application/json
Type: object
Example:
{
"error": [
{
"type": 5,
"code": 29,
"text": "Could not find ipsec_x509_ca_certificate with name or id 'system_net_ipsec_x509_ca_certificate-1'",
"args": {
"uuid": "system_net_ipsec_x509_ca_certificate-1"
},
"level": 1
}
]
}Read, add, modify and delete Certificate Revocation Lists for use by ipsec tunnels using Public Key Infrastucture (PKI) for authentication.
Get a list of all configured CRLs
Configure a new CRL file
get /ipsec/x509_crls
Get a list of all configured CRLs
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- x509_crls: required(array of object)
Items: items
- name: required(string)
The files name.
- content: required(string)
The content of the file stored either in plaintext PEM format or base64 encoded binary.
- timestamp: required(string)
The original time the file was uploaded in rfc3339 format.
- name: required(string)
Example:
{
"x509_crls": [
{
"name": "512b-rsa-example-request.pem",
"content": "-----BEGIN X509 CRL----- MIIBtjCBnwIBATANBgkqhkiG9w0BAQsFADA6MQswCQYDVQQGEwJDSDETMBEGA1UE ChMKc3Ryb25nU3dhbjEWMBQGA1UEAxMNVHVubmVsIFBLSSBDQRcNMjEwNjA0MDYx MTU1WhcNMjEwNjE5MDYxMTU1WjAAoC8wLTAfBgNVHSMEGDAWgBTCsezxD76B2m0e vLTp+AX42Tw7lTAKBgNVHRQEAwIBATANBgkqhkiG9w0BAQsFAAOCAQEAkJvZSk3X cnf423IVzJC1kwM8lMZJfX8Duz+PyqjPEOGW5U2kBkJn6fStXRRh/LnyvNAABfpk /51Iz8IJTEPwlcLnFvLQqqqJDsmSlZC4V3VwctcMg77gQLAm5oD1ljgv8RGTtGgZ flu1oQjvOVst0lw8lktH0ijjEFPkTfLOb5iCRSlG7+rCPrHjnzo1S20MCB/zOSbF z0gVAmTPCA8PMvsqnnZsN+1j8dwmF4h0hqiKAoB95xaHnUmuudvaNEGAyg3D9rqE YzIVOh2Ec47fomPc6d9rWPMb/Jjz04gGHUTLtmQEY3l2LNcxaMAGXOU2eykxrF8L F5Qi0ZjK1rXcEg== -----END X509 CRL-----",
"timestamp": "2020-04-06 04:16:49.179388+00:00",
"id": "system_net_ipsec_files_x509_crl-1"
},
{
"name": "512b-rsa-example-request.der",
"content": "MIIBBDCBrwIBADBKMQswCQYDVQQGEwJKUDEOMAwGA1UECAwFVG9reW8xETAPBgNVBAoMCEZyYW5rNEREMRgwFgYDVQQDDA93d3cuZXhhbXBsZS5jb20wXDANBgkqhkiG9w0BAQEFAANLADBIAkEAm/xmkHmEQrurE/0re/jeFRLl8ZPjBop7uLHhnia7lQG/5zDtZIUC3RVpqDSwBuw/NTweGyuP+o8AG98HxqxTBwIDAQABoAAwDQYJKoZIhvcNAQEFBQADQQByOV52Y17y8xw1V/xvru3rLPrVxYAXS5SgvNpfBsj38lNVtTvuH/MgroBgmjSpnqKqBiBDkoY2YUET2qmGjAu9Cg==",
"timestamp": "2021-03-12T20:43:39+00:00",
"id": "system_net_ipsec_files_x509_crl-2"
}
]
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
post /ipsec/x509_crls
Configure a new CRL file
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- x509_crl: required(object)
This object contains information for an IPsec tunnel file.
- name: required(string)
The files name.
- content: required(string)
The content of the file stored either in plaintext PEM format or base64 encoded binary.
- name: required(string)
Example:
{
"x509_crl": {
"name": "512b-rsa-example-request.pem",
"content": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURSBSRVFVRVNULS0tLS0KTUlJQkJEQ0Jyd0lCQURCS01Rc3dDUVlEVlFRR0V3SktVREVPTUF3R0ExVUVDQXdGVkc5cmVXOHhFVEFQQmdOVgpCQW9NQ0VaeVlXNXJORVJFTVJnd0ZnWURWUVFEREE5M2QzY3VaWGhoYlhCc1pTNWpiMjB3WERBTkJna3Foa2lHCjl3MEJBUUVGQUFOTEFEQklBa0VBbS94bWtIbUVRcnVyRS8wcmUvamVGUkxsOFpQakJvcDd1TEhobmlhN2xRRy8KNXpEdFpJVUMzUlZwcURTd0J1dy9OVHdlR3l1UCtvOEFHOThIeHF4VEJ3SURBUUFCb0FBd0RRWUpLb1pJaHZjTgpBUUVGQlFBRFFRQnlPVjUyWTE3eTh4dzFWL3h2cnUzckxQclZ4WUFYUzVTZ3ZOcGZCc2ozOGxOVnRUdnVIL01nCnJvQmdtalNwbnFLcUJpQkRrb1kyWVVFVDJxbUdqQXU5Ci0tLS0tRU5EIENFUlRJRklDQVRFIFJFUVVFU1QtLS0tLQo="
}
}HTTP status code 201
Body
Media type: application/json
Type: object
Properties- x509_crl: required(object)
This object contains information for an IPsec tunnel file.
- name: required(string)
The files name.
- content: required(string)
The content of the file stored either in plaintext PEM format or base64 encoded binary.
- timestamp: required(string)
The original time the file was uploaded in rfc3339 format.
- name: required(string)
Example:
{
"x509_crl": {
"name": "512b-rsa-example-request.pem",
"content": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURSBSRVFVRVNULS0tLS0KTUlJQkJEQ0Jyd0lCQURCS01Rc3dDUVlEVlFRR0V3SktVREVPTUF3R0ExVUVDQXdGVkc5cmVXOHhFVEFQQmdOVgpCQW9NQ0VaeVlXNXJORVJFTVJnd0ZnWURWUVFEREE5M2QzY3VaWGhoYlhCc1pTNWpiMjB3WERBTkJna3Foa2lHCjl3MEJBUUVGQUFOTEFEQklBa0VBbS94bWtIbUVRcnVyRS8wcmUvamVGUkxsOFpQakJvcDd1TEhobmlhN2xRRy8KNXpEdFpJVUMzUlZwcURTd0J1dy9OVHdlR3l1UCtvOEFHOThIeHF4VEJ3SURBUUFCb0FBd0RRWUpLb1pJaHZjTgpBUUVGQlFBRFFRQnlPVjUyWTE3eTh4dzFWL3h2cnUzckxQclZ4WUFYUzVTZ3ZOcGZCc2ozOGxOVnRUdnVIL01nCnJvQmdtalNwbnFLcUJpQkRrb1kyWVVFVDJxbUdqQXU5Ci0tLS0tRU5EIENFUlRJRklDQVRFIFJFUVVFU1QtLS0tLQo=",
"timestamp": "2020-04-06 04:16:49.179388+00:00",
"id": "system_net_ipsec_files_x509_crl-3"
}
}HTTP status code 400
Invalid request: Body is not json or does not conform to required json schema.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Get a single configured CRL by it ID
Update a single configured CRL
Delete a CRL
get /ipsec/x509_crls/{id}
Get a single configured CRL by it ID
URI Parameters
- id: required(string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- x509_crl: required(object)
This object contains information for an IPsec tunnel file.
- name: required(string)
The files name.
- content: required(string)
The content of the file stored either in plaintext PEM format or base64 encoded binary.
- timestamp: required(string)
The original time the file was uploaded in rfc3339 format.
- name: required(string)
Example:
{
"x509_crl": {
"name": "512b-rsa-example-request.pem",
"content": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURSBSRVFVRVNULS0tLS0KTUlJQkJEQ0Jyd0lCQURCS01Rc3dDUVlEVlFRR0V3SktVREVPTUF3R0ExVUVDQXdGVkc5cmVXOHhFVEFQQmdOVgpCQW9NQ0VaeVlXNXJORVJFTVJnd0ZnWURWUVFEREE5M2QzY3VaWGhoYlhCc1pTNWpiMjB3WERBTkJna3Foa2lHCjl3MEJBUUVGQUFOTEFEQklBa0VBbS94bWtIbUVRcnVyRS8wcmUvamVGUkxsOFpQakJvcDd1TEhobmlhN2xRRy8KNXpEdFpJVUMzUlZwcURTd0J1dy9OVHdlR3l1UCtvOEFHOThIeHF4VEJ3SURBUUFCb0FBd0RRWUpLb1pJaHZjTgpBUUVGQlFBRFFRQnlPVjUyWTE3eTh4dzFWL3h2cnUzckxQclZ4WUFYUzVTZ3ZOcGZCc2ozOGxOVnRUdnVIL01nCnJvQmdtalNwbnFLcUJpQkRrb1kyWVVFVDJxbUdqQXU5Ci0tLS0tRU5EIENFUlRJRklDQVRFIFJFUVVFU1QtLS0tLQo=",
"timestamp": "2020-04-06 04:16:49.179388+00:00",
"id": "system_net_ipsec_files_x509_crl-1"
}
}HTTP status code 404
CRL did not exist
Body
Media type: application/json
Type: object
Example:
{
"error": [
{
"type": 5,
"code": 29,
"text": "Could not find ipsec_x509_crl with name or id 'system_net_ipsec_files_x509_crl-1'",
"args": {
"uuid": "system_net_ipsec_files_x509_crl-1"
},
"level": 1
}
]
}put /ipsec/x509_crls/{id}
Update a single configured CRL
URI Parameters
- id: required(string)
Body
Media type: application/json
Type: object
Properties- x509_crl: required(object)
This object contains information for an IPsec tunnel file.
- name: required(string)
The files name.
- content: required(string)
The content of the file stored either in plaintext PEM format or base64 encoded binary.
- name: required(string)
Example:
{
"x509_crl": {
"name": "512b-rsa-example-request.pem",
"content": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURSBSRVFVRVNULS0tLS0KTUlJQkJEQ0Jyd0lCQURCS01Rc3dDUVlEVlFRR0V3SktVREVPTUF3R0ExVUVDQXdGVkc5cmVXOHhFVEFQQmdOVgpCQW9NQ0VaeVlXNXJORVJFTVJnd0ZnWURWUVFEREE5M2QzY3VaWGhoYlhCc1pTNWpiMjB3WERBTkJna3Foa2lHCjl3MEJBUUVGQUFOTEFEQklBa0VBbS94bWtIbUVRcnVyRS8wcmUvamVGUkxsOFpQakJvcDd1TEhobmlhN2xRRy8KNXpEdFpJVUMzUlZwcURTd0J1dy9OVHdlR3l1UCtvOEFHOThIeHF4VEJ3SURBUUFCb0FBd0RRWUpLb1pJaHZjTgpBUUVGQlFBRFFRQnlPVjUyWTE3eTh4dzFWL3h2cnUzckxQclZ4WUFYUzVTZ3ZOcGZCc2ozOGxOVnRUdnVIL01nCnJvQmdtalNwbnFLcUJpQkRrb1kyWVVFVDJxbUdqQXU5Ci0tLS0tRU5EIENFUlRJRklDQVRFIFJFUVVFU1QtLS0tLQo="
}
}HTTP status code 200
Body
Media type: application/json
Type: object
Properties- x509_crl: required(object)
This object contains information for an IPsec tunnel file.
- name: required(string)
The files name.
- content: required(string)
The content of the file stored either in plaintext PEM format or base64 encoded binary.
- timestamp: required(string)
The original time the file was uploaded in rfc3339 format.
- name: required(string)
Example:
{
"x509_crl": {
"name": "512b-rsa-example-request.pem",
"content": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURSBSRVFVRVNULS0tLS0KTUlJQkJEQ0Jyd0lCQURCS01Rc3dDUVlEVlFRR0V3SktVREVPTUF3R0ExVUVDQXdGVkc5cmVXOHhFVEFQQmdOVgpCQW9NQ0VaeVlXNXJORVJFTVJnd0ZnWURWUVFEREE5M2QzY3VaWGhoYlhCc1pTNWpiMjB3WERBTkJna3Foa2lHCjl3MEJBUUVGQUFOTEFEQklBa0VBbS94bWtIbUVRcnVyRS8wcmUvamVGUkxsOFpQakJvcDd1TEhobmlhN2xRRy8KNXpEdFpJVUMzUlZwcURTd0J1dy9OVHdlR3l1UCtvOEFHOThIeHF4VEJ3SURBUUFCb0FBd0RRWUpLb1pJaHZjTgpBUUVGQlFBRFFRQnlPVjUyWTE3eTh4dzFWL3h2cnUzckxQclZ4WUFYUzVTZ3ZOcGZCc2ozOGxOVnRUdnVIL01nCnJvQmdtalNwbnFLcUJpQkRrb1kyWVVFVDJxbUdqQXU5Ci0tLS0tRU5EIENFUlRJRklDQVRFIFJFUVVFU1QtLS0tLQo=",
"timestamp": "2020-04-06 04:16:49.179388+00:00",
"id": "system_net_ipsec_files_x509_crl-2"
}
}HTTP status code 400
Invalid request: Body is not json or does not conform to required json schema.
HTTP status code 404
CRL did not exist
Body
Media type: application/json
Type: object
Example:
{
"error": [
{
"type": 5,
"code": 29,
"text": "Could not find ipsec_x509_crl with name or id 'system_net_ipsec_files_x509_crl-1'",
"args": {
"uuid": "system_net_ipsec_files_x509_crl-1"
},
"level": 1
}
]
}delete /ipsec/x509_crls/{id}
Delete a CRL
URI Parameters
- id: required(string)
HTTP status code 200
CRL deleted
HTTP status code 404
CRL did not exist
Body
Media type: application/json
Type: object
Example:
{
"error": [
{
"type": 5,
"code": 29,
"text": "Could not find ipsec_files_x509_crl with name or id 'system_net_ipsec_files_x509_crl-1'",
"args": {
"uuid": "system_net_ipsec_files_x509_crl-1"
},
"level": 1
}
]
}Read, add, modify and delete private keys.
Get a list of the configured private keys.
Configure a new private key.
get /ipsec/private_keys
Get a list of the configured private keys.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Query Parameters
- secrets: (one of cleartext, obfuscate, mask - default: cleartext)
Returns sensitive fields displayed as either cleartext, obfuscated or masked values.
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- private_keys: required(array of object)
Items: items
- name: required(string)
The files name.
- content: required(string)
The content of the file stored either in plaintext PEM format or base64 encoded binary. [sensitive]
- password: (string)
An optional password that can be used to decrypt the file. [sensitive]
- timestamp: required(string)
The original time the file was uploaded in rfc3339 format.
- name: required(string)
Example:
{
"private_keys": [
{
"name": "512b-rsa-example-key.der",
"content": "MIIBOwIBAAJBAJv8ZpB5hEK7qxP9K3v43hUS5fGT4waKe7ix4Z4mu5UBv+cw7WSFAt0Vaag0sAbsPzU8Hhsrj/qPABvfB8asUwcCAwEAAQJAG0r3ezH35WFG1tGGaUOrQA61cyaII53ZdgCR1IU8bx7AUevmkFtBf+aqMWusWVOWJvGu2r5VpHVAIl8nF6DSkQIhAMjEJ3zVYa2/Mo4ey+iU9J9Vd+WoyXDQD4EEtwmyG1PpAiEAxuZlvhDIbbce7o5BvOhnCZ2N7kYb1ZC57g3F+cbJyW8CIQCbsDGHBto2qJyFxbAO7uQ8Y0UVHa0JBO/g900SAcJbcQIgRtEljIShOB8pDjrsQPxmI1BLhnjD1EhRSubwhDw5AFUCIQCNA24pDtdOHydwtSB5+zFqFLfmVZplQM/g5kb4so70Ywo=",
"password": "myprivatekeyspassword",
"timestamp": "2021-03-12T20:43:39+00:00"
},
{
"name": "512b-rsa-example-key.pem",
"content": "-----BEGIN RSA PRIVATE KEY----- MIIBOwIBAAJBAJv8ZpB5hEK7qxP9K3v43hUS5fGT4waKe7ix4Z4mu5UBv+cw7WSF At0Vaag0sAbsPzU8Hhsrj/qPABvfB8asUwcCAwEAAQJAG0r3ezH35WFG1tGGaUOr QA61cyaII53ZdgCR1IU8bx7AUevmkFtBf+aqMWusWVOWJvGu2r5VpHVAIl8nF6DS kQIhAMjEJ3zVYa2/Mo4ey+iU9J9Vd+WoyXDQD4EEtwmyG1PpAiEAxuZlvhDIbbce 7o5BvOhnCZ2N7kYb1ZC57g3F+cbJyW8CIQCbsDGHBto2qJyFxbAO7uQ8Y0UVHa0J BO/g900SAcJbcQIgRtEljIShOB8pDjrsQPxmI1BLhnjD1EhRSubwhDw5AFUCIQCN A24pDtdOHydwtSB5+zFqFLfmVZplQM/g5kb4so70Yw== -----END RSA PRIVATE KEY-----",
"timestamp": "2021-03-12T20:43:39+00:00"
}
]
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
post /ipsec/private_keys
Configure a new private key.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Query Parameters
- secrets: (one of cleartext, obfuscate - default: cleartext)
Accepts sensitive fields as either cleartext or obfuscated values. The response will display the sensitive fields in the same way.
Body
Media type: application/json
Type: object
Properties- private_key: required(object)
This object contains information for an IPsec tunnel file.
- name: required(string)
The files name.
- content: required(string)
The content of the file stored either in plaintext PEM format or base64 encoded binary. [sensitive]
- password: (string)
An optional password that can be used to decrypt the file. [sensitive]
- name: required(string)
Example:
{
"private_key": {
"name": "512b-rsa-example-key.der",
"content": "MIIBOwIBAAJBAJv8ZpB5hEK7qxP9K3v43hUS5fGT4waKe7ix4Z4mu5UBv+cw7WSFAt0Vaag0sAbsPzU8Hhsrj/qPABvfB8asUwcCAwEAAQJAG0r3ezH35WFG1tGGaUOrQA61cyaII53ZdgCR1IU8bx7AUevmkFtBf+aqMWusWVOWJvGu2r5VpHVAIl8nF6DSkQIhAMjEJ3zVYa2/Mo4ey+iU9J9Vd+WoyXDQD4EEtwmyG1PpAiEAxuZlvhDIbbce7o5BvOhnCZ2N7kYb1ZC57g3F+cbJyW8CIQCbsDGHBto2qJyFxbAO7uQ8Y0UVHa0JBO/g900SAcJbcQIgRtEljIShOB8pDjrsQPxmI1BLhnjD1EhRSubwhDw5AFUCIQCNA24pDtdOHydwtSB5+zFqFLfmVZplQM/g5kb4so70Ywo=",
"password": "myprivatekeyspassword"
}
}HTTP status code 201
Body
Media type: application/json
Type: object
Properties- private_key: required(object)
This object contains information for an IPsec tunnel file.
- name: required(string)
The files name.
- content: required(string)
The content of the file stored either in plaintext PEM format or base64 encoded binary. [sensitive]
- password: (string)
An optional password that can be used to decrypt the file. [sensitive]
- timestamp: required(string)
The original time the file was uploaded in rfc3339 format.
- name: required(string)
Example:
{
"private_key": {
"name": "512b-rsa-example-key.der",
"content": "MIIBOwIBAAJBAJv8ZpB5hEK7qxP9K3v43hUS5fGT4waKe7ix4Z4mu5UBv+cw7WSFAt0Vaag0sAbsPzU8Hhsrj/qPABvfB8asUwcCAwEAAQJAG0r3ezH35WFG1tGGaUOrQA61cyaII53ZdgCR1IU8bx7AUevmkFtBf+aqMWusWVOWJvGu2r5VpHVAIl8nF6DSkQIhAMjEJ3zVYa2/Mo4ey+iU9J9Vd+WoyXDQD4EEtwmyG1PpAiEAxuZlvhDIbbce7o5BvOhnCZ2N7kYb1ZC57g3F+cbJyW8CIQCbsDGHBto2qJyFxbAO7uQ8Y0UVHa0JBO/g900SAcJbcQIgRtEljIShOB8pDjrsQPxmI1BLhnjD1EhRSubwhDw5AFUCIQCNA24pDtdOHydwtSB5+zFqFLfmVZplQM/g5kb4so70Ywo=",
"password": "myprivatekeyspassword",
"timestamp": "2021-03-12T20:43:39+00:00"
}
}HTTP status code 400
Invalid request: body is not json or does not conform to required json schema. Incomplete data: private key parameter missing.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Get a single configured private key by its ID.
Update a single configured private key.
Delete a private key.
get /ipsec/private_keys/{id}
Get a single configured private key by its ID.
URI Parameters
- id: required(string)
Query Parameters
- secrets: (one of cleartext, obfuscate, mask - default: cleartext)
Returns sensitive fields displayed as either cleartext, obfuscated or masked values.
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- private_key: required(object)
This object contains information for an IPsec tunnel file.
- name: required(string)
The files name.
- content: required(string)
The content of the file stored either in plaintext PEM format or base64 encoded binary. [sensitive]
- password: (string)
An optional password that can be used to decrypt the file. [sensitive]
- timestamp: required(string)
The original time the file was uploaded in rfc3339 format.
- name: required(string)
Example:
{
"private_key": {
"name": "512b-rsa-example-key.der",
"content": "MIIBOwIBAAJBAJv8ZpB5hEK7qxP9K3v43hUS5fGT4waKe7ix4Z4mu5UBv+cw7WSFAt0Vaag0sAbsPzU8Hhsrj/qPABvfB8asUwcCAwEAAQJAG0r3ezH35WFG1tGGaUOrQA61cyaII53ZdgCR1IU8bx7AUevmkFtBf+aqMWusWVOWJvGu2r5VpHVAIl8nF6DSkQIhAMjEJ3zVYa2/Mo4ey+iU9J9Vd+WoyXDQD4EEtwmyG1PpAiEAxuZlvhDIbbce7o5BvOhnCZ2N7kYb1ZC57g3F+cbJyW8CIQCbsDGHBto2qJyFxbAO7uQ8Y0UVHa0JBO/g900SAcJbcQIgRtEljIShOB8pDjrsQPxmI1BLhnjD1EhRSubwhDw5AFUCIQCNA24pDtdOHydwtSB5+zFqFLfmVZplQM/g5kb4so70Ywo=",
"password": "myprivatekeyspassword",
"timestamp": "2021-03-12T20:43:39+00:00"
}
}put /ipsec/private_keys/{id}
Update a single configured private key.
URI Parameters
- id: required(string)
Query Parameters
- secrets: (one of cleartext, obfuscate - default: cleartext)
Accepts sensitive fields as either cleartext or obfuscated values. The response will display the sensitive fields in the same way.
Body
Media type: application/json
Type: object
Properties- private_key: required(object)
This object contains information for an IPsec tunnel file.
- name: required(string)
The files name.
- content: required(string)
The content of the file stored either in plaintext PEM format or base64 encoded binary. [sensitive]
- password: (string)
An optional password that can be used to decrypt the file. [sensitive]
- name: required(string)
Example:
{
"private_key": {
"name": "512b-rsa-example-key.der",
"content": "MIIBOwIBAAJBAJv8ZpB5hEK7qxP9K3v43hUS5fGT4waKe7ix4Z4mu5UBv+cw7WSFAt0Vaag0sAbsPzU8Hhsrj/qPABvfB8asUwcCAwEAAQJAG0r3ezH35WFG1tGGaUOrQA61cyaII53ZdgCR1IU8bx7AUevmkFtBf+aqMWusWVOWJvGu2r5VpHVAIl8nF6DSkQIhAMjEJ3zVYa2/Mo4ey+iU9J9Vd+WoyXDQD4EEtwmyG1PpAiEAxuZlvhDIbbce7o5BvOhnCZ2N7kYb1ZC57g3F+cbJyW8CIQCbsDGHBto2qJyFxbAO7uQ8Y0UVHa0JBO/g900SAcJbcQIgRtEljIShOB8pDjrsQPxmI1BLhnjD1EhRSubwhDw5AFUCIQCNA24pDtdOHydwtSB5+zFqFLfmVZplQM/g5kb4so70Ywo=",
"password": "myprivatekeyspassword"
}
}HTTP status code 200
Body
Media type: application/json
Type: object
Properties- private_key: required(object)
This object contains information for an IPsec tunnel file.
- name: required(string)
The files name.
- content: required(string)
The content of the file stored either in plaintext PEM format or base64 encoded binary. [sensitive]
- password: (string)
An optional password that can be used to decrypt the file. [sensitive]
- timestamp: required(string)
The original time the file was uploaded in rfc3339 format.
- name: required(string)
Example:
{
"private_key": {
"name": "512b-rsa-example-key.der",
"content": "MIIBOwIBAAJBAJv8ZpB5hEK7qxP9K3v43hUS5fGT4waKe7ix4Z4mu5UBv+cw7WSFAt0Vaag0sAbsPzU8Hhsrj/qPABvfB8asUwcCAwEAAQJAG0r3ezH35WFG1tGGaUOrQA61cyaII53ZdgCR1IU8bx7AUevmkFtBf+aqMWusWVOWJvGu2r5VpHVAIl8nF6DSkQIhAMjEJ3zVYa2/Mo4ey+iU9J9Vd+WoyXDQD4EEtwmyG1PpAiEAxuZlvhDIbbce7o5BvOhnCZ2N7kYb1ZC57g3F+cbJyW8CIQCbsDGHBto2qJyFxbAO7uQ8Y0UVHa0JBO/g900SAcJbcQIgRtEljIShOB8pDjrsQPxmI1BLhnjD1EhRSubwhDw5AFUCIQCNA24pDtdOHydwtSB5+zFqFLfmVZplQM/g5kb4so70Ywo=",
"password": "myprivatekeyspassword",
"timestamp": "2021-03-12T20:43:39+00:00"
}
}HTTP status code 400
Invalid request: body is not json or does not conform to required json schema. Incomplete data: Private key parameter missing.
HTTP status code 404
Private key {id} does not exist.
delete /ipsec/private_keys/{id}
Delete a private key.
URI Parameters
- id: required(string)
HTTP status code 200
Private key deleted..
HTTP status code 404
Private key did not exist.
Body
Media type: application/json
Type: object
Example:
{
"error": [
{
"type": 5,
"code": 29,
"text": "Could not find ipsec_private_key with name or id 'system_net_ipsec_private_key-1'",
"args": {
"uuid": "system_net_ipsec_private_key-1"
},
"level": 1
}
]
}Read, add, modify and delete x509 certificates (also known as Entity Certificates).
Get a list of the configured x509 certificates.
Configure a new x509 certificate.
get /ipsec/x509_certificates
Get a list of the configured x509 certificates.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- x509_certificates: required(array of object)
Items: items
- name: required(string)
The files name.
- content: required(string)
The content of the file stored either in plaintext PEM format or base64 encoded binary.
- timestamp: required(string)
The original time the file was uploaded in rfc3339 format.
- name: required(string)
Example:
{
"x509_certificates": [
{
"id": "system_net_ipsec_files_x509_certificates-1",
"name": "512b-rsa-example-cert-base64.pem",
"content": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUNFakNDQVhzQ0FnMzZNQTBHQ1NxR1NJYjNEUUVCQlFVQU1JR2JNUXN3Q1FZRFZRUUdFd0pLVURFT01Bd0cKQTFVRUNCTUZWRzlyZVc4eEVEQU9CZ05WQkFjVEIwTm9kVzh0YTNVeEVUQVBCZ05WQkFvVENFWnlZVzVyTkVSRQpNUmd3RmdZRFZRUUxFdzlYWldKRFpYSjBJRk4xY0hCdmNuUXhHREFXQmdOVkJBTVREMFp5WVc1ck5FUkVJRmRsCllpQkRRVEVqTUNFR0NTcUdTSWIzRFFFSkFSWVVjM1Z3Y0c5eWRFQm1jbUZ1YXpSa1pDNWpiMjB3SGhjTk1USXcKT0RJeU1EVXlOalUwV2hjTk1UY3dPREl4TURVeU5qVTBXakJLTVFzd0NRWURWUVFHRXdKS1VERU9NQXdHQTFVRQpDQXdGVkc5cmVXOHhFVEFQQmdOVkJBb01DRVp5WVc1ck5FUkVNUmd3RmdZRFZRUUREQTkzZDNjdVpYaGhiWEJzClpTNWpiMjB3WERBTkJna3Foa2lHOXcwQkFRRUZBQU5MQURCSUFrRUFtL3hta0htRVFydXJFLzByZS9qZUZSTGwKOFpQakJvcDd1TEhobmlhN2xRRy81ekR0WklVQzNSVnBxRFN3QnV3L05Ud2VHeXVQK284QUc5OEh4cXhUQndJRApBUUFCTUEwR0NTcUdTSWIzRFFFQkJRVUFBNEdCQUJTMlRMdUJlVFBtY2FUYVVXL0xDQjJOWU95OEdNZHpSMW14CjhpQkl1Mkg2L0UydGlZM1JJZXZWMk9XNjFxWTIvWFJRZzdZUHh4M2ZmZVV1Z1g5RjRKL2lQbm51MXpBeHh5QnkKMlZndUt2NFNXalJGb1JrSWZJbEhYMHFWdmlNaFNsTnkyaW9GTHk3SmNQWmIrdjNmdERHeXdVcWNCaVZEb2VhMApIbitHbXhaQQotLS0tLUVORCBDRVJUSUZJQ0FURS0tLS0tCg==",
"timestamp": "2021-03-12T20:43:39+00:00"
},
{
"id": "system_net_ipsec_files_x509_certificates-2",
"name": "512b-rsa-example-cert-base64.der",
"content": "MIICEjCCAXsCAg36MA0GCSqGSIb3DQEBBQUAMIGbMQswCQYDVQQGEwJKUDEOMAwGA1UECBMFVG9reW8xEDAOBgNVBAcTB0NodW8ta3UxETAPBgNVBAoTCEZyYW5rNEREMRgwFgYDVQQLEw9XZWJDZXJ0IFN1cHBvcnQxGDAWBgNVBAMTD0ZyYW5rNEREIFdlYiBDQTEjMCEGCSqGSIb3DQEJARYUc3VwcG9ydEBmcmFuazRkZC5jb20wHhcNMTIwODIyMDUyNjU0WhcNMTcwODIxMDUyNjU0WjBKMQswCQYDVQQGEwJKUDEOMAwGA1UECAwFVG9reW8xETAPBgNVBAoMCEZyYW5rNEREMRgwFgYDVQQDDA93d3cuZXhhbXBsZS5jb20wXDANBgkqhkiG9w0BAQEFAANLADBIAkEAm/xmkHmEQrurE/0re/jeFRLl8ZPjBop7uLHhnia7lQG/5zDtZIUC3RVpqDSwBuw/NTweGyuP+o8AG98HxqxTBwIDAQABMA0GCSqGSIb3DQEBBQUAA4GBABS2TLuBeTPmcaTaUW/LCB2NYOy8GMdzR1mx8iBIu2H6/E2tiY3RIevV2OW61qY2/XRQg7YPxx3ffeUugX9F4J/iPnnu1zAxxyBy2VguKv4SWjRFoRkIfIlHX0qVviMhSlNy2ioFLy7JcPZb+v3ftDGywUqcBiVDoea0Hn+GmxZACg==",
"timestamp": "2021-03-12T20:43:39+00:00"
},
{
"id": "system_net_ipsec_files_x509_certificates-3",
"name": "512b-rsa-example-cert.pem",
"content": "-----BEGIN CERTIFICATE----- MIICEjCCAXsCAg36MA0GCSqGSIb3DQEBBQUAMIGbMQswCQYDVQQGEwJKUDEOMAwG A1UECBMFVG9reW8xEDAOBgNVBAcTB0NodW8ta3UxETAPBgNVBAoTCEZyYW5rNERE MRgwFgYDVQQLEw9XZWJDZXJ0IFN1cHBvcnQxGDAWBgNVBAMTD0ZyYW5rNEREIFdl YiBDQTEjMCEGCSqGSIb3DQEJARYUc3VwcG9ydEBmcmFuazRkZC5jb20wHhcNMTIw ODIyMDUyNjU0WhcNMTcwODIxMDUyNjU0WjBKMQswCQYDVQQGEwJKUDEOMAwGA1UE CAwFVG9reW8xETAPBgNVBAoMCEZyYW5rNEREMRgwFgYDVQQDDA93d3cuZXhhbXBs ZS5jb20wXDANBgkqhkiG9w0BAQEFAANLADBIAkEAm/xmkHmEQrurE/0re/jeFRLl 8ZPjBop7uLHhnia7lQG/5zDtZIUC3RVpqDSwBuw/NTweGyuP+o8AG98HxqxTBwID AQABMA0GCSqGSIb3DQEBBQUAA4GBABS2TLuBeTPmcaTaUW/LCB2NYOy8GMdzR1mx 8iBIu2H6/E2tiY3RIevV2OW61qY2/XRQg7YPxx3ffeUugX9F4J/iPnnu1zAxxyBy 2VguKv4SWjRFoRkIfIlHX0qVviMhSlNy2ioFLy7JcPZb+v3ftDGywUqcBiVDoea0 Hn+GmxZA -----END CERTIFICATE-----",
"timestamp": "2021-03-12T20:43:39+00:00"
}
]
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
post /ipsec/x509_certificates
Configure a new x509 certificate.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- x509_certificate: required(object)
This object contains information for an IPsec tunnel file.
- name: required(string)
The files name.
- content: required(string)
The content of the file stored either in plaintext PEM format or base64 encoded binary.
- name: required(string)
Example:
{
"x509_certificate": {
"name": "512b-rsa-example-request.pem",
"content": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURSBSRVFVRVNULS0tLS0KTUlJQkJEQ0Jyd0lCQURCS01Rc3dDUVlEVlFRR0V3SktVREVPTUF3R0ExVUVDQXdGVkc5cmVXOHhFVEFQQmdOVgpCQW9NQ0VaeVlXNXJORVJFTVJnd0ZnWURWUVFEREE5M2QzY3VaWGhoYlhCc1pTNWpiMjB3WERBTkJna3Foa2lHCjl3MEJBUUVGQUFOTEFEQklBa0VBbS94bWtIbUVRcnVyRS8wcmUvamVGUkxsOFpQakJvcDd1TEhobmlhN2xRRy8KNXpEdFpJVUMzUlZwcURTd0J1dy9OVHdlR3l1UCtvOEFHOThIeHF4VEJ3SURBUUFCb0FBd0RRWUpLb1pJaHZjTgpBUUVGQlFBRFFRQnlPVjUyWTE3eTh4dzFWL3h2cnUzckxQclZ4WUFYUzVTZ3ZOcGZCc2ozOGxOVnRUdnVIL01nCnJvQmdtalNwbnFLcUJpQkRrb1kyWVVFVDJxbUdqQXU5Ci0tLS0tRU5EIENFUlRJRklDQVRFIFJFUVVFU1QtLS0tLQo="
}
}HTTP status code 201
Body
Media type: application/json
Type: object
Properties- x509_certificate: required(object)
This object contains information for an IPsec tunnel file.
- name: required(string)
The files name.
- content: required(string)
The content of the file stored either in plaintext PEM format or base64 encoded binary.
- timestamp: required(string)
The original time the file was uploaded in rfc3339 format.
- name: required(string)
Example:
{
"x509_certificate": {
"id": "system_net_ipsec_files_x509_certificates-1",
"name": "512b-rsa-example-request.pem",
"content": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURSBSRVFVRVNULS0tLS0KTUlJQkJEQ0Jyd0lCQURCS01Rc3dDUVlEVlFRR0V3SktVREVPTUF3R0ExVUVDQXdGVkc5cmVXOHhFVEFQQmdOVgpCQW9NQ0VaeVlXNXJORVJFTVJnd0ZnWURWUVFEREE5M2QzY3VaWGhoYlhCc1pTNWpiMjB3WERBTkJna3Foa2lHCjl3MEJBUUVGQUFOTEFEQklBa0VBbS94bWtIbUVRcnVyRS8wcmUvamVGUkxsOFpQakJvcDd1TEhobmlhN2xRRy8KNXpEdFpJVUMzUlZwcURTd0J1dy9OVHdlR3l1UCtvOEFHOThIeHF4VEJ3SURBUUFCb0FBd0RRWUpLb1pJaHZjTgpBUUVGQlFBRFFRQnlPVjUyWTE3eTh4dzFWL3h2cnUzckxQclZ4WUFYUzVTZ3ZOcGZCc2ozOGxOVnRUdnVIL01nCnJvQmdtalNwbnFLcUJpQkRrb1kyWVVFVDJxbUdqQXU5Ci0tLS0tRU5EIENFUlRJRklDQVRFIFJFUVVFU1QtLS0tLQo=",
"timestamp": "2020-04-06 04:16:49.179388+00:00"
}
}HTTP status code 400
Invalid request: body is not json or does not conform to required json schema. Incomplete data: x509 certificate parameter missing.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Get a single configured x509 certificate by its ID.
Update a single configured x509 certificate.
Delete an x509 certificate.
get /ipsec/x509_certificates/{id}
Get a single configured x509 certificate by its ID.
URI Parameters
- id: required(string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- x509_certificate: required(object)
This object contains information for an IPsec tunnel file.
- name: required(string)
The files name.
- content: required(string)
The content of the file stored either in plaintext PEM format or base64 encoded binary.
- timestamp: required(string)
The original time the file was uploaded in rfc3339 format.
- name: required(string)
Example:
{
"x509_certificate": {
"id": "system_net_ipsec_files_x509_certificates-1",
"name": "512b-rsa-example-request.pem",
"content": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURSBSRVFVRVNULS0tLS0KTUlJQkJEQ0Jyd0lCQURCS01Rc3dDUVlEVlFRR0V3SktVREVPTUF3R0ExVUVDQXdGVkc5cmVXOHhFVEFQQmdOVgpCQW9NQ0VaeVlXNXJORVJFTVJnd0ZnWURWUVFEREE5M2QzY3VaWGhoYlhCc1pTNWpiMjB3WERBTkJna3Foa2lHCjl3MEJBUUVGQUFOTEFEQklBa0VBbS94bWtIbUVRcnVyRS8wcmUvamVGUkxsOFpQakJvcDd1TEhobmlhN2xRRy8KNXpEdFpJVUMzUlZwcURTd0J1dy9OVHdlR3l1UCtvOEFHOThIeHF4VEJ3SURBUUFCb0FBd0RRWUpLb1pJaHZjTgpBUUVGQlFBRFFRQnlPVjUyWTE3eTh4dzFWL3h2cnUzckxQclZ4WUFYUzVTZ3ZOcGZCc2ozOGxOVnRUdnVIL01nCnJvQmdtalNwbnFLcUJpQkRrb1kyWVVFVDJxbUdqQXU5Ci0tLS0tRU5EIENFUlRJRklDQVRFIFJFUVVFU1QtLS0tLQo=",
"timestamp": "2020-04-06 04:16:49.179388+00:00"
}
}put /ipsec/x509_certificates/{id}
Update a single configured x509 certificate.
URI Parameters
- id: required(string)
Body
Media type: application/json
Type: object
Properties- x509_certificate: required(object)
This object contains information for an IPsec tunnel file.
- name: required(string)
The files name.
- content: required(string)
The content of the file stored either in plaintext PEM format or base64 encoded binary.
- name: required(string)
Example:
{
"x509_certificate": {
"name": "512b-rsa-example-request.pem",
"content": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURSBSRVFVRVNULS0tLS0KTUlJQkJEQ0Jyd0lCQURCS01Rc3dDUVlEVlFRR0V3SktVREVPTUF3R0ExVUVDQXdGVkc5cmVXOHhFVEFQQmdOVgpCQW9NQ0VaeVlXNXJORVJFTVJnd0ZnWURWUVFEREE5M2QzY3VaWGhoYlhCc1pTNWpiMjB3WERBTkJna3Foa2lHCjl3MEJBUUVGQUFOTEFEQklBa0VBbS94bWtIbUVRcnVyRS8wcmUvamVGUkxsOFpQakJvcDd1TEhobmlhN2xRRy8KNXpEdFpJVUMzUlZwcURTd0J1dy9OVHdlR3l1UCtvOEFHOThIeHF4VEJ3SURBUUFCb0FBd0RRWUpLb1pJaHZjTgpBUUVGQlFBRFFRQnlPVjUyWTE3eTh4dzFWL3h2cnUzckxQclZ4WUFYUzVTZ3ZOcGZCc2ozOGxOVnRUdnVIL01nCnJvQmdtalNwbnFLcUJpQkRrb1kyWVVFVDJxbUdqQXU5Ci0tLS0tRU5EIENFUlRJRklDQVRFIFJFUVVFU1QtLS0tLQo="
}
}HTTP status code 200
Body
Media type: application/json
Type: object
Properties- x509_certificate: required(object)
This object contains information for an IPsec tunnel file.
- name: required(string)
The files name.
- content: required(string)
The content of the file stored either in plaintext PEM format or base64 encoded binary.
- timestamp: required(string)
The original time the file was uploaded in rfc3339 format.
- name: required(string)
Example:
{
"x509_certificate": {
"id": "system_net_ipsec_files_x509_certificates-1",
"name": "512b-rsa-example-request.pem",
"content": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURSBSRVFVRVNULS0tLS0KTUlJQkJEQ0Jyd0lCQURCS01Rc3dDUVlEVlFRR0V3SktVREVPTUF3R0ExVUVDQXdGVkc5cmVXOHhFVEFQQmdOVgpCQW9NQ0VaeVlXNXJORVJFTVJnd0ZnWURWUVFEREE5M2QzY3VaWGhoYlhCc1pTNWpiMjB3WERBTkJna3Foa2lHCjl3MEJBUUVGQUFOTEFEQklBa0VBbS94bWtIbUVRcnVyRS8wcmUvamVGUkxsOFpQakJvcDd1TEhobmlhN2xRRy8KNXpEdFpJVUMzUlZwcURTd0J1dy9OVHdlR3l1UCtvOEFHOThIeHF4VEJ3SURBUUFCb0FBd0RRWUpLb1pJaHZjTgpBUUVGQlFBRFFRQnlPVjUyWTE3eTh4dzFWL3h2cnUzckxQclZ4WUFYUzVTZ3ZOcGZCc2ozOGxOVnRUdnVIL01nCnJvQmdtalNwbnFLcUJpQkRrb1kyWVVFVDJxbUdqQXU5Ci0tLS0tRU5EIENFUlRJRklDQVRFIFJFUVVFU1QtLS0tLQo=",
"timestamp": "2020-04-06 04:16:49.179388+00:00"
}
}HTTP status code 400
Invalid request: body is not json or does not conform to required json schema. Incomplete data: X509 certificate parameter missing.
HTTP status code 404
X509 Certificate {id} does not exist.
delete /ipsec/x509_certificates/{id}
Delete an x509 certificate.
URI Parameters
- id: required(string)
HTTP status code 200
X509 certificate deleted.
HTTP status code 404
X509 certificate did not exist.
Body
Media type: application/json
Type: object
Example:
{
"error": [
{
"type": 5,
"code": 29,
"text": "Could not find ipsec_x509_certificate with name or id 'system_net_ipsec_x509_certificate-1'",
"args": {
"uuid": "system_net_ipsec_x509_certificate-1"
},
"level": 1
}
]
}/pdus
Configure, monitor and control PDUs connected to the device.
Get a list of all configured PDUs.
Add a new PDU.
get /pdus
Get a list of all configured PDUs.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Query Parameters
- secrets: (one of cleartext, obfuscate, mask - default: cleartext)
Returns sensitive fields displayed as either cleartext, obfuscated or masked values.
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- pdus: required(array of object)
Items: items
- name: required(string)
A unique user specified name for the PDU.
- driver: required(string)
The driver to use to control and monitor the PDU.
- method: required(string)
The method to used to access the PDU, can be 'snmp', 'powerman' or 'shell'.
- monitor: required(boolean)
If true the pdu outlets are monitored for any change in status.
- id: required(string)
The unique id of the PDU.
- outlet_count: (integer)
The number of outlets on the PDU.
- powerman: (object)
The serial specific settings for a PDU.
- id: required(string)
- username: (string)
- password: (string)
[sensitive]
- port: required(string)
- shell: (object)
The serial specific settings for a PDU.
- id: required(string)
- username: (string)
- password: (string)
[sensitive]
- port: required(string)
- snmp: (object)
The SNMP configuration to access the PDU.
- id: required(string)
- protocol: required(one of UDP, TCP)
- address: required(string)
- port: (integer - minimum: 1 - maximum: 65535)
- version: required(one of v1, v2c, v3)
- community: (string)
- auth_protocol: (one of SHA, MD5)
- auth_password: (string)
[sensitive]
- username: (string)
- engine_id: (string)
- privacy_protocol: (one of AES, DES)
- privacy_password: (string)
[sensitive]
- security_level: (one of noAuthNoPriv, authNoPriv, authPriv)
- outlets: required(array of object)
Items: items
- id: required(string)
- number: required(integer)
- name: (string)
- port: (string)
- status: (string)
- status_timestamp: (string)
- last_action: (string)
- last_action_timestamp: (string)
- name: required(string)
Example:
{
"pdus": [
{
"id": "pdus-1",
"name": "ServerTech PDU",
"driver": "servertech",
"monitor": true,
"method": "snmp",
"outlet_count": 2,
"outlets": [
{
"id": "outlets-1",
"number": 1,
"name": "servertech outlet 1",
"port": "serial/by-opengear-id/port07",
"status": "on",
"status_timestamp": "2020-04-06 04:16:49.179388+00:00",
"last_action": "on",
"last_action_timestamp": "2020-04-06 04:15:09.149994+00:00"
},
{
"id": "outlets-2",
"number": 2,
"name": "servertech outlet 2",
"port": "serial/by-opengear-id/port08",
"status": "off",
"status_timestamp": "2020-04-06 04:16:49.179388+00:00",
"last_action": "off",
"last_action_timestamp": "2020-04-06 04:15:09.149994+00:00"
}
],
"snmp": {
"id": "snmp-1",
"protocol": "UDP",
"community": "secret",
"auth_protocol": "SHA",
"username": "michaelf",
"engine_id": "0x80001f8803555000000000",
"version": "v3",
"privacy_protocol": "DES",
"security_level": "noAuthNoPriv",
"address": "snmp.example.com",
"port": 167
}
},
{
"id": "pdus-2",
"name": "apc PDU",
"driver": "apc",
"monitor": true,
"method": "powerman",
"outlet_count": 2,
"outlets": [
{
"id": "outlets-3",
"number": 1,
"name": "apc outlet 1",
"port": "serial/by-opengear-id/port08",
"status": "on",
"status_timestamp": "2020-04-06 04:16:49.179388+00:00",
"last_action": "on",
"last_action_timestamp": "2020-04-06 04:15:09.149994+00:00"
},
{
"id": "outlets-4",
"number": 2,
"name": "apc outlet 2",
"port": "serial/by-opengear-id/port09",
"status": "off",
"status_timestamp": "2020-04-06 04:16:49.179388+00:00",
"last_action": "off",
"last_action_timestamp": "2020-04-06 04:15:09.149994+00:00"
}
],
"powerman": {
"id": "powerman-1",
"username": "admin",
"password": "password",
"port": "serial/by-opengear-id/port01"
}
},
{
"id": "pdus-2",
"name": "shell PDU",
"monitor": true,
"driver": "shell",
"method": "shell",
"outlet_count": 2,
"outlets": [
{
"id": "outlets-5",
"number": 1,
"name": "shell outlet 1",
"port": "serial/by-opengear-id/port03",
"status": "on",
"status_timestamp": "2020-04-06 04:16:49.179388+00:00",
"last_action": "on",
"last_action_timestamp": "2020-04-06 04:15:09.149994+00:00"
},
{
"id": "outlets-4",
"number": 2,
"name": "shell outlet 2",
"port": "serial/by-opengear-id/port04",
"status": "off",
"status_timestamp": "2020-04-06 04:16:49.179388+00:00",
"last_action": "off",
"last_action_timestamp": "2020-04-06 04:15:09.149994+00:00"
}
],
"shell": {
"id": "shell-1",
"username": "admin",
"password": "password",
"port": "serial/by-opengear-id/port02"
}
}
]
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
post /pdus
Add a new PDU.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Query Parameters
- secrets: (one of cleartext, obfuscate - default: cleartext)
Accepts sensitive fields as either cleartext or obfuscated values. The response will display the sensitive fields in the same way.
Body
Media type: application/json
Type: object
Properties- pdu: required(object)
- name: required(string)
A unique user specified name for the PDU.
- driver: required(string)
The driver to use to control and monitor the PDU.
- method: required(string)
The method to used to access the PDU, can be 'snmp', 'powerman' or 'shell'.
- monitor: required(boolean)
If true the pdu outlets are monitored for any change in status.
- powerman: (object)
The serial specific settings for a PDU.
- id: required(string)
- username: (string)
- password: (string)
[sensitive]
- port: required(string)
- shell: (object)
The serial specific settings for a PDU.
- id: required(string)
- username: (string)
- password: (string)
[sensitive]
- port: required(string)
- snmp: (object)
The SNMP configuration to access the PDU.
- id: required(string)
- protocol: required(one of UDP, TCP)
- address: required(string)
- port: (integer - minimum: 1 - maximum: 65535)
- version: required(one of v1, v2c, v3)
- community: (string)
- auth_protocol: (one of SHA, MD5)
- auth_password: (string)
[sensitive]
- username: (string)
- engine_id: (string)
- privacy_protocol: (one of AES, DES)
- privacy_password: (string)
[sensitive]
- security_level: (one of noAuthNoPriv, authNoPriv, authPriv)
- name: required(string)
Example:
{
"pdu": {
"name": "example",
"driver": "apc_24_port_(ap7998)",
"monitor": true,
"method": "powerman",
"powerman": {
"id": "powerman-1",
"username": "user1",
"password": "password",
"port": "serial/by-opengear-id/port01"
}
}
}HTTP status code 200
Body
Media type: application/json
Type: object
Properties- pdu: required(object)
Get a PDU specified by ID.
- name: required(string)
A unique user specified name for the PDU.
- driver: required(string)
The driver to use to control and monitor the PDU.
- method: required(string)
The method to used to access the PDU, can be 'snmp', 'powerman' or 'shell'.
- monitor: required(boolean)
If true the pdu outlets are monitored for any change in status.
- id: required(string)
The unique id of the PDU.
- outlet_count: (integer)
The number of outlets on the PDU.
- powerman: (object)
The serial specific settings for a PDU.
- id: required(string)
- username: (string)
- password: (string)
[sensitive]
- port: required(string)
- shell: (object)
The serial specific settings for a PDU.
- id: required(string)
- username: (string)
- password: (string)
[sensitive]
- port: required(string)
- snmp: (object)
The SNMP configuration to access the PDU.
- id: required(string)
- protocol: required(one of UDP, TCP)
- address: required(string)
- port: (integer - minimum: 1 - maximum: 65535)
- version: required(one of v1, v2c, v3)
- community: (string)
- auth_protocol: (one of SHA, MD5)
- auth_password: (string)
[sensitive]
- username: (string)
- engine_id: (string)
- privacy_protocol: (one of AES, DES)
- privacy_password: (string)
[sensitive]
- security_level: (one of noAuthNoPriv, authNoPriv, authPriv)
- outlets: required(array of object)
Items: items
- id: required(string)
- number: required(integer)
- name: (string)
- port: (string)
- status: (string)
- status_timestamp: (string)
- last_action: (string)
- last_action_timestamp: (string)
- name: required(string)
Example:
{
"pdu": {
"id": "pdus-1",
"name": "example",
"driver": "apc_24_port_(ap7998)",
"monitor": true,
"method": "powerman",
"powerman": {
"id": "powerman-1",
"username": "user1",
"password": "password",
"port": "serial/by-opengear-id/port01"
},
"outlets": [
{
"id": "outlets-1",
"number": 1,
"name": "shell outlet 1",
"port": "serial/by-opengear-id/port03",
"status": "on",
"status_timestamp": "2020-04-06 04:16:49.179388+00:00",
"last_action": "on",
"last_action_timestamp": "2020-04-06 04:15:09.149994+00:00"
},
{
"id": "outlets-2",
"number": 2,
"name": "shell outlet 2",
"port": "serial/by-opengear-id/port04",
"status": "off",
"status_timestamp": "2020-04-06 04:16:49.179388+00:00"
}
]
}
}HTTP status code 400
Invalid request: Body is not json or does not conform to required json schema.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Get a PDU by id.
Update an existing PDU.
Delete a PDU.
get /pdus/{id}
Get a PDU by id.
URI Parameters
- id: required(string)
Query Parameters
- secrets: (one of cleartext, obfuscate, mask - default: cleartext)
Returns sensitive fields displayed as either cleartext, obfuscated or masked values.
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- pdu: required(object)
Get a PDU specified by ID.
- name: required(string)
A unique user specified name for the PDU.
- driver: required(string)
The driver to use to control and monitor the PDU.
- method: required(string)
The method to used to access the PDU, can be 'snmp', 'powerman' or 'shell'.
- monitor: required(boolean)
If true the pdu outlets are monitored for any change in status.
- id: required(string)
The unique id of the PDU.
- outlet_count: (integer)
The number of outlets on the PDU.
- powerman: (object)
The serial specific settings for a PDU.
- id: required(string)
- username: (string)
- password: (string)
[sensitive]
- port: required(string)
- shell: (object)
The serial specific settings for a PDU.
- id: required(string)
- username: (string)
- password: (string)
[sensitive]
- port: required(string)
- snmp: (object)
The SNMP configuration to access the PDU.
- id: required(string)
- protocol: required(one of UDP, TCP)
- address: required(string)
- port: (integer - minimum: 1 - maximum: 65535)
- version: required(one of v1, v2c, v3)
- community: (string)
- auth_protocol: (one of SHA, MD5)
- auth_password: (string)
[sensitive]
- username: (string)
- engine_id: (string)
- privacy_protocol: (one of AES, DES)
- privacy_password: (string)
[sensitive]
- security_level: (one of noAuthNoPriv, authNoPriv, authPriv)
- outlets: required(array of object)
Items: items
- id: required(string)
- number: required(integer)
- name: (string)
- port: (string)
- status: (string)
- status_timestamp: (string)
- last_action: (string)
- last_action_timestamp: (string)
- name: required(string)
Example:
{
"pdu": {
"id": "pdus-1",
"name": "ServerTech PDU",
"driver": "servertech",
"monitor": true,
"method": "snmp",
"outlet_count": 2,
"outlets": [
{
"id": "outlets-1",
"number": 1,
"name": "servertech outlet 1",
"port": "serial/by-opengear-id/port07",
"status": "on",
"status_timestamp": "2020-04-06 04:16:49.179388+00:00",
"last_action": "on",
"last_action_timestamp": "2020-04-06 04:15:09.149994+00:00"
},
{
"id": "outlets-2",
"number": 2,
"name": "servertech outlet 2",
"port": "serial/by-opengear-id/port08",
"status": "off",
"status_timestamp": "2020-04-06 04:16:49.179388+00:00",
"last_action": "off",
"last_action_timestamp": "2020-04-06 04:15:09.149994+00:00"
}
],
"snmp": {
"id": "snmp-1",
"protocol": "UDP",
"community": "secret",
"auth_protocol": "SHA",
"username": "michaelf",
"engine_id": "0x80001f8803555000000000",
"version": "v3",
"privacy_protocol": "DES",
"security_level": "noAuthNoPriv",
"address": "snmp.example.com",
"port": 167
}
}
}HTTP status code 404
No PDU found with that ID.
put /pdus/{id}
Update an existing PDU.
URI Parameters
- id: required(string)
Query Parameters
- secrets: (one of cleartext, obfuscate - default: cleartext)
Accepts sensitive fields as either cleartext or obfuscated values. The response will display the sensitive fields in the same way.
Body
Media type: application/json
Type: object
Properties- pdu: required(object)
- name: required(string)
A unique user specified name for the PDU.
- driver: required(string)
The driver to use to control and monitor the PDU.
- method: required(string)
The method to used to access the PDU, can be 'snmp', 'powerman' or 'shell'.
- monitor: required(boolean)
If true the pdu outlets are monitored for any change in status.
- powerman: (object)
The serial specific settings for a PDU.
- id: required(string)
- username: (string)
- password: (string)
[sensitive]
- port: required(string)
- shell: (object)
The serial specific settings for a PDU.
- id: required(string)
- username: (string)
- password: (string)
[sensitive]
- port: required(string)
- snmp: (object)
The SNMP configuration to access the PDU.
- id: required(string)
- protocol: required(one of UDP, TCP)
- address: required(string)
- port: (integer - minimum: 1 - maximum: 65535)
- version: required(one of v1, v2c, v3)
- community: (string)
- auth_protocol: (one of SHA, MD5)
- auth_password: (string)
[sensitive]
- username: (string)
- engine_id: (string)
- privacy_protocol: (one of AES, DES)
- privacy_password: (string)
[sensitive]
- security_level: (one of noAuthNoPriv, authNoPriv, authPriv)
- name: required(string)
Example:
{
"pdu": {
"name": "example",
"driver": "apc_24_port_(ap7998)",
"monitor": true,
"method": "powerman",
"powerman": {
"id": "powerman-1",
"username": "user1",
"password": "password",
"port": "serial/by-opengear-id/port01"
},
"outlets": [
{
"name": "new name",
"port": "serial/by-opengear-id/port10"
},
{
"name": "change",
"port": "serial/by-opengear-id/port04"
}
]
}
}HTTP status code 200
Body
Media type: application/json
Type: object
Properties- pdu: required(object)
Get a PDU specified by ID.
- name: required(string)
A unique user specified name for the PDU.
- driver: required(string)
The driver to use to control and monitor the PDU.
- method: required(string)
The method to used to access the PDU, can be 'snmp', 'powerman' or 'shell'.
- monitor: required(boolean)
If true the pdu outlets are monitored for any change in status.
- id: required(string)
The unique id of the PDU.
- outlet_count: (integer)
The number of outlets on the PDU.
- powerman: (object)
The serial specific settings for a PDU.
- id: required(string)
- username: (string)
- password: (string)
[sensitive]
- port: required(string)
- shell: (object)
The serial specific settings for a PDU.
- id: required(string)
- username: (string)
- password: (string)
[sensitive]
- port: required(string)
- snmp: (object)
The SNMP configuration to access the PDU.
- id: required(string)
- protocol: required(one of UDP, TCP)
- address: required(string)
- port: (integer - minimum: 1 - maximum: 65535)
- version: required(one of v1, v2c, v3)
- community: (string)
- auth_protocol: (one of SHA, MD5)
- auth_password: (string)
[sensitive]
- username: (string)
- engine_id: (string)
- privacy_protocol: (one of AES, DES)
- privacy_password: (string)
[sensitive]
- security_level: (one of noAuthNoPriv, authNoPriv, authPriv)
- outlets: required(array of object)
Items: items
- id: required(string)
- number: required(integer)
- name: (string)
- port: (string)
- status: (string)
- status_timestamp: (string)
- last_action: (string)
- last_action_timestamp: (string)
- name: required(string)
Example:
{
"pdu": {
"id": "pdu-1",
"name": "example",
"driver": "apc_24_port_(ap7998)",
"monitor": true,
"method": "powerman",
"powerman": {
"id": "powerman-1",
"username": "user1",
"password": "passwords",
"port": "serial/by-opengear-id/port01"
},
"outlets": [
{
"id": "outlets-1",
"number": 1,
"name": "shell outlet 1\"",
"port": "serial/by-opengear-id/port03",
"status": "on",
"status_timestamp": "2020-04-06 04:16:49.179388+00:00"
},
{
"id": "outlets-2",
"number": 2,
"name": "shell outlet 2\"",
"port": "serial/by-opengear-id/port04",
"status": "off",
"status_timestamp": "2020-04-06 04:16:49.179388+00:00"
}
]
}
}HTTP status code 400
Invalid request: Body is not json or does not conform to required json schema. Incomplete data: PDU id parameter missing.
HTTP status code 404
PDU did not exist
Body
Media type: application/json
Type: object
Example:
{
"error": [
{
"type": 5,
"code": 29,
"text": "Could not find pdu with name or id 'pdu-1'",
"args": {
"uuid": "pdu-1"
},
"level": 1
}
]
}delete /pdus/{id}
Delete a PDU.
/auto_response
Read and manipulate information pertaining to the Auto-Response system running on the Operations Manager appliance.
Read and manipulate the Auto-Response beacons on the Operations Manager appliance.
Get a list of the Auto-Response Beacons.
Add a new Auto-Response beacon to the Operations Manager appliance.
Bulk delete a list of beacons defined for the appliance.
get /auto_response/beacons
Get a list of the Auto-Response Beacons.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- beacons: required(array of object)
Items: items
- id: required(string)
Database ID for this Auto-Response Beacon.
- name: required(string)
Each Auto-Response Beacon must have a unique symbolic name. Use this to distinguish between multiple beacons on the device.
- description: (string)
Each Auto-Response Beacon may have an optional description.
- module: required(one of btmp, cell_connection, cell_signal_strength, curl, custom_cmd, load, mem, network, ping, serial_login, serial_pattern, serial_signal, cell_message, wtmp)
The corresponding 'salt' Auto-Response module this Beacon will use.
- interval: (number)
Interval in seconds between running the Auto-Response Beacon
- enable: required(boolean)
Turn on this Auto-Response Beacon
- cell_signal_strength: (object)
- threshold: required(number - minimum: 0 - maximum: 99)
- on_change_only: required(boolean)
- emit_at_startup: required(boolean)
- cell_message: (object)
- message_pattern: required(string)
- phone_numbers: required(array of any)
- curl: (object)
- urls: required(array of any)
- request: required(string)
- on_change_only: required(boolean - default: true)
- data: (string)
- max_time: (number)
- custom_cmd: (object)
- shell_command: required(string)
- timeout: required(number)
- load: (object)
- one_minute: required(object)
- low: required(string - pattern: ^(([1-9][0-9]*)|[0])[.]([0-9]{4})$)
- high: required(string - pattern: ^(([1-9][0-9]*)|[0])[.]([0-9]{4})$)
- five_minute: required(object)
- low: required(string - pattern: ^(([1-9][0-9]*)|[0])[.]([0-9]{4})$)
- high: required(string - pattern: ^(([1-9][0-9]*)|[0])[.]([0-9]{4})$)
- fifteen_minute: required(object)
- low: required(string - pattern: ^(([1-9][0-9]*)|[0])[.]([0-9]{4})$)
- high: required(string - pattern: ^(([1-9][0-9]*)|[0])[.]([0-9]{4})$)
- emit_at_startup: required(boolean)
- on_change_only: required(boolean)
- one_minute: required(object)
- mem: (object)
- percent: required(string - pattern: ^(([1-9][0-9]*)|[0])[.]([0-9]{4})$)
- on_change_only: required(boolean)
- network: (object)
- coalesce: required(string)
- interfaces: required(array of object)
Items: items
- interface: required(string)
Reference to a physif ID
- attributes: required(array of string)
A list of attributes to monitor
- interface: required(string)
- ping: (object)
- interface: required(string)
Reference to a physif ID
- destination: required(string)
- on_change_only: required(boolean)
- interface: required(string)
- serial_login: (object)
- check_login: required(boolean - default: true)
- check_logout: required(boolean - default: true)
- ports: required(array of string)
- serial_signal: (object)
- ports: required(array of string)
- signals: required(array of string)
- serial_pattern: (object)
- pattern: required(string)
- disconnect: required(boolean - default: false)
- trigger_rx: required(boolean - default: true)
- trigger_tx: required(boolean - default: true)
- ports: required(array of string)
- wtmp: (object)
- login: required(boolean)
- logout: required(boolean)
- actions: required(array of object)
The list of references to actions along with the resolution values to use for that action
Items: items
- action: required(string)
- resolution_values: required(array of string)
- dependant_keys_any: required(array of any)
A list of keys that are or'd to determine the Auto-Response Beacon state
- dependant_keys_all: required(array of any)
A list of keys that are and'd to determine the Auto-Response Beacon state
- id: required(string)
- meta: required(object)
- searchId: (string)
- total_pages: (string)
Example:
{
"beacons": [
{
"id": "0",
"name": "wtmp-beacon",
"description": "Description for the wtmp beacon",
"module": "wtmp",
"interval": 60,
"enable": true,
"wtmp": {
"login": true,
"logout": true
},
"actions": [],
"dependant_keys_any": [],
"dependant_keys_all": []
},
{
"id": "1",
"name": "custom-beacon",
"module": "custom_cmd",
"interval": 60,
"enable": true,
"custom_cmd": {
"shell_command": "/usr/bin/top -n 5 | grep ssh",
"timeout": 5
},
"actions": [
{
"action": "auto_response_reactions-7",
"resolution_values": [
"trigger",
"resolve"
]
}
],
"dependant_keys_any": [],
"dependant_keys_all": []
}
],
"meta": {
"total_pages": "1"
}
}HTTP status code 400
Invalid request, missing or incorrect page/per_page
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 4,
"code": 39,
"level": 1,
"text": "Invalid request body",
"args": {}
}
]
}HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
post /auto_response/beacons
Add a new Auto-Response beacon to the Operations Manager appliance.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- auto_response_beacon: required(object)
- name: required(string)
Each Auto-Response Beacon must have a unique symbolic name. Use this to distinguish between multiple beacons on the device.
- description: (string)
Each Auto-Response Beacon may have an optional description.
- module: required(one of btmp, cell_connection, cell_signal_strength, curl, custom_cmd, load, mem, network, ping, serial_login, serial_pattern, serial_signal, cell_message, wtmp)
The corresponding 'salt' Auto-Response module this Beacon will use.
- interval: (number)
Interval in seconds between running the Auto-Response Beacon
- enable: (boolean - default: false)
Turn on this Auto-Response Beacon
- cell_signal_strength: (object)
- threshold: required(number - minimum: 1 - maximum: 99)
- on_change_only: (boolean - default: true)
- emit_at_startup: (boolean - default: true)
- cell_message: (object)
- message_pattern: required(string)
- phone_numbers: required(array of any)
- curl: (object)
- urls: required(array of any)
- request: (string - default: GET)
- on_change_only: (boolean - default: true)
- data: (string)
- max_time: (number)
- custom_cmd: (object)
- shell_command: required(string)
- timeout: (number - default: 10 - minimum: 1)
- load: (object)
- one_minute: required(object)
- low: required(string - pattern: ^(([1-9][0-9]*)|[0])[.]([0-9]{4})$)
- high: required(string - pattern: ^(([1-9][0-9]*)|[0])[.]([0-9]{4})$)
- five_minute: required(object)
- low: required(string - pattern: ^(([1-9][0-9]*)|[0])[.]([0-9]{4})$)
- high: required(string - pattern: ^(([1-9][0-9]*)|[0])[.]([0-9]{4})$)
- fifteen_minute: required(object)
- low: required(string - pattern: ^(([1-9][0-9]*)|[0])[.]([0-9]{4})$)
- high: required(string - pattern: ^(([1-9][0-9]*)|[0])[.]([0-9]{4})$)
- emit_at_startup: (boolean - default: true)
- on_change_only: (boolean - default: false)
- one_minute: required(object)
- mem: (object)
- percent: required(string - pattern: ^(([1-9][0-9]*)|[0])[.]([0-9]{4})$)
- on_change_only: (boolean - default: false)
- network: (object)
- interfaces: required(array of object)
Items: items
- interface: required(string)
Reference to a physif ID
- attributes: required(array of string)
A list of attributes to monitor
- interface: required(string)
- coalesce: required(boolean)
- interfaces: required(array of object)
- ping: (object)
- interface: required(string)
Reference to a physif ID
- destination: required(string)
- on_change_only: (boolean - default: true)
- interface: required(string)
- serial_login: (object)
- check_login: (boolean - default: true)
- check_logout: (boolean - default: true)
- ports: required(array of string)
- serial_signal: (object)
- ports: required(array of string)
- signals: required(array of string)
- serial_pattern: (object)
- pattern: required(string)
- disconnect: (boolean - default: false)
- trigger_rx: (boolean - default: true)
- trigger_tx: (boolean - default: true)
- ports: required(array of string)
- wtmp: (object)
- login: required(boolean - default: true)
- logout: required(boolean - default: true)
- actions: required(array of object)
The list of references to actions along with the resolution values to use for that action
Items: items
- action: required(string)
- resolution_values: required(array of string)
- dependant_keys_any: required(array of any)
A list of keys that are or'd to determine the Auto-Response Beacon state
- dependant_keys_all: required(array of any)
A list of keys that are and'd to determine the Auto-Response Beacon state
- name: required(string)
Example:
{
"auto_response_beacon": {
"name": "wtmp-beacon",
"description": "The description for this wtmp beacon",
"module": "wtmp",
"interval": 60,
"enable": true,
"wtmp": {
"login": true,
"logout": true
},
"actions": [
{
"action": "auto_response_reactions-7",
"resolution_values": [
"trigger",
"resolve"
]
}
],
"dependant_keys_any": [],
"dependant_keys_all": []
}
}HTTP status code 200
The beacon was added.
Body
Media type: application/json
Type: object
Properties- auto_response_beacon: required(object)
An Auto-Response Beacon
- id: required(string)
Database ID for this Auto-Response Beacon.
- name: required(string)
Each Auto-Response Beacon must have a unique symbolic name. Use this to distinguish between multiple beacons on the device.
- description: (string)
Each Auto-Response Beacon may have an optional description.
- module: required(one of btmp, cell_connection, cell_signal_strength, curl, custom_cmd, load, mem, network, ping, serial_login, serial_pattern, serial_signal, cell_message, wtmp)
The corresponding 'salt' Auto-Response module this Beacon will use.
- interval: (number)
Interval in seconds between running the Auto-Response Beacon
- enable: required(boolean)
Turn on this Auto-Response Beacon
- cell_signal_strength: (object)
- threshold: required(number - minimum: 0 - maximum: 99)
- on_change_only: required(boolean)
- emit_at_startup: required(boolean)
- cell_message: (object)
- message_pattern: required(string)
- phone_numbers: required(array of any)
- curl: (object)
- urls: required(array of any)
- request: required(string)
- on_change_only: required(boolean - default: true)
- data: (string)
- max_time: (number)
- custom_cmd: (object)
- shell_command: required(string)
- timeout: required(number)
- load: (object)
- one_minute: required(object)
- low: required(string - pattern: ^(([1-9][0-9]*)|[0])[.]([0-9]{4})$)
- high: required(string - pattern: ^(([1-9][0-9]*)|[0])[.]([0-9]{4})$)
- five_minute: required(object)
- low: required(string - pattern: ^(([1-9][0-9]*)|[0])[.]([0-9]{4})$)
- high: required(string - pattern: ^(([1-9][0-9]*)|[0])[.]([0-9]{4})$)
- fifteen_minute: required(object)
- low: required(string - pattern: ^(([1-9][0-9]*)|[0])[.]([0-9]{4})$)
- high: required(string - pattern: ^(([1-9][0-9]*)|[0])[.]([0-9]{4})$)
- emit_at_startup: required(boolean)
- on_change_only: required(boolean)
- one_minute: required(object)
- mem: (object)
- percent: required(string - pattern: ^(([1-9][0-9]*)|[0])[.]([0-9]{4})$)
- on_change_only: required(boolean)
- network: (object)
- coalesce: required(string)
- interfaces: required(array of object)
Items: items
- interface: required(string)
Reference to a physif ID
- attributes: required(array of string)
A list of attributes to monitor
- interface: required(string)
- ping: (object)
- interface: required(string)
Reference to a physif ID
- destination: required(string)
- on_change_only: required(boolean)
- interface: required(string)
- serial_login: (object)
- check_login: required(boolean - default: true)
- check_logout: required(boolean - default: true)
- ports: required(array of string)
- serial_signal: (object)
- ports: required(array of string)
- signals: required(array of string)
- serial_pattern: (object)
- pattern: required(string)
- disconnect: required(boolean - default: false)
- trigger_rx: required(boolean - default: true)
- trigger_tx: required(boolean - default: true)
- ports: required(array of string)
- wtmp: (object)
- login: required(boolean)
- logout: required(boolean)
- actions: required(array of object)
The list of references to actions along with the resolution values to use for that action
Items: items
- action: required(string)
- resolution_values: required(array of string)
- dependant_keys_any: required(array of any)
A list of keys that are or'd to determine the Auto-Response Beacon state
- dependant_keys_all: required(array of any)
A list of keys that are and'd to determine the Auto-Response Beacon state
- id: required(string)
Example:
{
"auto_response_beacon": {
"id": "0",
"name": "wtmp-beacon",
"description": "The description for this wtmp beacon",
"module": "wtmp",
"interval": 60,
"enable": true,
"wtmp": {
"login": true,
"logout": true
},
"actions": [],
"dependant_keys_any": [],
"dependant_keys_all": []
}
}HTTP status code 400
Invalid request: body is not json or does not conform to required json schema. Incomplete data: beacon id parameter missing.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}HTTP status code 404
Beacon {id} does not exist. Attempted to change read only fields. Attempted to change unknown fields.
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
delete /auto_response/beacons
Bulk delete a list of beacons defined for the appliance.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- auto_response_beacon: required(array of string)
Example:
{
"auto_response_beacon": [
"auto_response_beacon-1",
"auto_response_beacon-5"
]
}HTTP status code 204
All beacons were deleted successfully.
HTTP status code 400
Invalid request
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 4,
"code": 39,
"level": 1,
"text": "Invalid request body",
"args": {}
}
]
}HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}HTTP status code 404
Beacon(s) do not exist.
Body
Media type: application/json
Type: object
Example:
{
"error": [
{
"type": 5,
"code": 29,
"text": "Could not find auto_response/beacon with name or id 'auto_response_beacon-5'",
"args": {
"uuid": "auto_response_beacon-5"
},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Get the configuration of an Auto-Response beacon on the Operations Manager appliance
Update settings for an Auto-Response beacon on the Operations Manager appliance.
Delete an Auto-Response beacon on the Operations Manager appliance
get /auto_response/beacons/{id}
Get the configuration of an Auto-Response beacon on the Operations Manager appliance
Operations Manager base authentication scheme
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- auto_response_beacon: required(object)
An Auto-Response Beacon
- id: required(string)
Database ID for this Auto-Response Beacon.
- name: required(string)
Each Auto-Response Beacon must have a unique symbolic name. Use this to distinguish between multiple beacons on the device.
- description: (string)
Each Auto-Response Beacon may have an optional description.
- module: required(one of btmp, cell_connection, cell_signal_strength, curl, custom_cmd, load, mem, network, ping, serial_login, serial_pattern, serial_signal, cell_message, wtmp)
The corresponding 'salt' Auto-Response module this Beacon will use.
- interval: (number)
Interval in seconds between running the Auto-Response Beacon
- enable: required(boolean)
Turn on this Auto-Response Beacon
- cell_signal_strength: (object)
- threshold: required(number - minimum: 0 - maximum: 99)
- on_change_only: required(boolean)
- emit_at_startup: required(boolean)
- cell_message: (object)
- message_pattern: required(string)
- phone_numbers: required(array of any)
- curl: (object)
- urls: required(array of any)
- request: required(string)
- on_change_only: required(boolean - default: true)
- data: (string)
- max_time: (number)
- custom_cmd: (object)
- shell_command: required(string)
- timeout: required(number)
- load: (object)
- one_minute: required(object)
- low: required(string - pattern: ^(([1-9][0-9]*)|[0])[.]([0-9]{4})$)
- high: required(string - pattern: ^(([1-9][0-9]*)|[0])[.]([0-9]{4})$)
- five_minute: required(object)
- low: required(string - pattern: ^(([1-9][0-9]*)|[0])[.]([0-9]{4})$)
- high: required(string - pattern: ^(([1-9][0-9]*)|[0])[.]([0-9]{4})$)
- fifteen_minute: required(object)
- low: required(string - pattern: ^(([1-9][0-9]*)|[0])[.]([0-9]{4})$)
- high: required(string - pattern: ^(([1-9][0-9]*)|[0])[.]([0-9]{4})$)
- emit_at_startup: required(boolean)
- on_change_only: required(boolean)
- one_minute: required(object)
- mem: (object)
- percent: required(string - pattern: ^(([1-9][0-9]*)|[0])[.]([0-9]{4})$)
- on_change_only: required(boolean)
- network: (object)
- coalesce: required(string)
- interfaces: required(array of object)
Items: items
- interface: required(string)
Reference to a physif ID
- attributes: required(array of string)
A list of attributes to monitor
- interface: required(string)
- ping: (object)
- interface: required(string)
Reference to a physif ID
- destination: required(string)
- on_change_only: required(boolean)
- interface: required(string)
- serial_login: (object)
- check_login: required(boolean - default: true)
- check_logout: required(boolean - default: true)
- ports: required(array of string)
- serial_signal: (object)
- ports: required(array of string)
- signals: required(array of string)
- serial_pattern: (object)
- pattern: required(string)
- disconnect: required(boolean - default: false)
- trigger_rx: required(boolean - default: true)
- trigger_tx: required(boolean - default: true)
- ports: required(array of string)
- wtmp: (object)
- login: required(boolean)
- logout: required(boolean)
- actions: required(array of object)
The list of references to actions along with the resolution values to use for that action
Items: items
- action: required(string)
- resolution_values: required(array of string)
- dependant_keys_any: required(array of any)
A list of keys that are or'd to determine the Auto-Response Beacon state
- dependant_keys_all: required(array of any)
A list of keys that are and'd to determine the Auto-Response Beacon state
- id: required(string)
Example:
{
"auto_response_beacon": {
"id": "0",
"name": "wtmp-beacon",
"description": "The description for this wtmp beacon",
"module": "wtmp",
"interval": 60,
"enable": true,
"wtmp": {
"login": true,
"logout": true
},
"actions": [],
"dependant_keys_any": [],
"dependant_keys_all": []
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /auto_response/beacons/{id}
Update settings for an Auto-Response beacon on the Operations Manager appliance.
Operations Manager base authentication scheme
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- auto_response_beacon: required(object)
- name: required(string)
Each Auto-Response Beacon must have a unique symbolic name. Use this to distinguish between multiple beacons on the device.
- description: (string)
Each Auto-Response Beacon may have an optional description.
- module: required(one of btmp, cell_connection, cell_signal_strength, curl, custom_cmd, load, mem, network, ping, serial_login, serial_pattern, serial_signal, cell_message, wtmp)
The corresponding 'salt' Auto-Response module this Beacon will use.
- interval: (number)
Interval in seconds between running the Auto-Response Beacon
- enable: (boolean - default: false)
Turn on this Auto-Response Beacon
- cell_signal_strength: (object)
- threshold: required(number - minimum: 1 - maximum: 99)
- on_change_only: (boolean - default: true)
- emit_at_startup: (boolean - default: true)
- cell_message: (object)
- message_pattern: required(string)
- phone_numbers: required(array of any)
- curl: (object)
- urls: required(array of any)
- request: (string - default: GET)
- on_change_only: (boolean - default: true)
- data: (string)
- max_time: (number)
- custom_cmd: (object)
- shell_command: required(string)
- timeout: (number - default: 10 - minimum: 1)
- load: (object)
- one_minute: required(object)
- low: required(string - pattern: ^(([1-9][0-9]*)|[0])[.]([0-9]{4})$)
- high: required(string - pattern: ^(([1-9][0-9]*)|[0])[.]([0-9]{4})$)
- five_minute: required(object)
- low: required(string - pattern: ^(([1-9][0-9]*)|[0])[.]([0-9]{4})$)
- high: required(string - pattern: ^(([1-9][0-9]*)|[0])[.]([0-9]{4})$)
- fifteen_minute: required(object)
- low: required(string - pattern: ^(([1-9][0-9]*)|[0])[.]([0-9]{4})$)
- high: required(string - pattern: ^(([1-9][0-9]*)|[0])[.]([0-9]{4})$)
- emit_at_startup: (boolean - default: true)
- on_change_only: (boolean - default: false)
- one_minute: required(object)
- mem: (object)
- percent: required(string - pattern: ^(([1-9][0-9]*)|[0])[.]([0-9]{4})$)
- on_change_only: (boolean - default: false)
- network: (object)
- interfaces: required(array of object)
Items: items
- interface: required(string)
Reference to a physif ID
- attributes: required(array of string)
A list of attributes to monitor
- interface: required(string)
- coalesce: required(boolean)
- interfaces: required(array of object)
- ping: (object)
- interface: required(string)
Reference to a physif ID
- destination: required(string)
- on_change_only: (boolean - default: true)
- interface: required(string)
- serial_login: (object)
- check_login: (boolean - default: true)
- check_logout: (boolean - default: true)
- ports: required(array of string)
- serial_signal: (object)
- ports: required(array of string)
- signals: required(array of string)
- serial_pattern: (object)
- pattern: required(string)
- disconnect: (boolean - default: false)
- trigger_rx: (boolean - default: true)
- trigger_tx: (boolean - default: true)
- ports: required(array of string)
- wtmp: (object)
- login: required(boolean - default: true)
- logout: required(boolean - default: true)
- actions: required(array of object)
The list of references to actions along with the resolution values to use for that action
Items: items
- action: required(string)
- resolution_values: required(array of string)
- dependant_keys_any: required(array of any)
A list of keys that are or'd to determine the Auto-Response Beacon state
- dependant_keys_all: required(array of any)
A list of keys that are and'd to determine the Auto-Response Beacon state
- name: required(string)
Example:
{
"auto_response_beacon": {
"name": "wtmp-beacon",
"description": "The description for this wtmp beacon",
"module": "wtmp",
"interval": 60,
"enable": true,
"wtmp": {
"login": true,
"logout": true
},
"actions": [],
"dependant_keys_any": [],
"dependant_keys_all": []
}
}HTTP status code 200
The beacon settings were updated.
Body
Media type: application/json
Type: object
Properties- auto_response_beacon: required(object)
An Auto-Response Beacon
- id: required(string)
Database ID for this Auto-Response Beacon.
- name: required(string)
Each Auto-Response Beacon must have a unique symbolic name. Use this to distinguish between multiple beacons on the device.
- description: (string)
Each Auto-Response Beacon may have an optional description.
- module: required(one of btmp, cell_connection, cell_signal_strength, curl, custom_cmd, load, mem, network, ping, serial_login, serial_pattern, serial_signal, cell_message, wtmp)
The corresponding 'salt' Auto-Response module this Beacon will use.
- interval: (number)
Interval in seconds between running the Auto-Response Beacon
- enable: required(boolean)
Turn on this Auto-Response Beacon
- cell_signal_strength: (object)
- threshold: required(number - minimum: 0 - maximum: 99)
- on_change_only: required(boolean)
- emit_at_startup: required(boolean)
- cell_message: (object)
- message_pattern: required(string)
- phone_numbers: required(array of any)
- curl: (object)
- urls: required(array of any)
- request: required(string)
- on_change_only: required(boolean - default: true)
- data: (string)
- max_time: (number)
- custom_cmd: (object)
- shell_command: required(string)
- timeout: required(number)
- load: (object)
- one_minute: required(object)
- low: required(string - pattern: ^(([1-9][0-9]*)|[0])[.]([0-9]{4})$)
- high: required(string - pattern: ^(([1-9][0-9]*)|[0])[.]([0-9]{4})$)
- five_minute: required(object)
- low: required(string - pattern: ^(([1-9][0-9]*)|[0])[.]([0-9]{4})$)
- high: required(string - pattern: ^(([1-9][0-9]*)|[0])[.]([0-9]{4})$)
- fifteen_minute: required(object)
- low: required(string - pattern: ^(([1-9][0-9]*)|[0])[.]([0-9]{4})$)
- high: required(string - pattern: ^(([1-9][0-9]*)|[0])[.]([0-9]{4})$)
- emit_at_startup: required(boolean)
- on_change_only: required(boolean)
- one_minute: required(object)
- mem: (object)
- percent: required(string - pattern: ^(([1-9][0-9]*)|[0])[.]([0-9]{4})$)
- on_change_only: required(boolean)
- network: (object)
- coalesce: required(string)
- interfaces: required(array of object)
Items: items
- interface: required(string)
Reference to a physif ID
- attributes: required(array of string)
A list of attributes to monitor
- interface: required(string)
- ping: (object)
- interface: required(string)
Reference to a physif ID
- destination: required(string)
- on_change_only: required(boolean)
- interface: required(string)
- serial_login: (object)
- check_login: required(boolean - default: true)
- check_logout: required(boolean - default: true)
- ports: required(array of string)
- serial_signal: (object)
- ports: required(array of string)
- signals: required(array of string)
- serial_pattern: (object)
- pattern: required(string)
- disconnect: required(boolean - default: false)
- trigger_rx: required(boolean - default: true)
- trigger_tx: required(boolean - default: true)
- ports: required(array of string)
- wtmp: (object)
- login: required(boolean)
- logout: required(boolean)
- actions: required(array of object)
The list of references to actions along with the resolution values to use for that action
Items: items
- action: required(string)
- resolution_values: required(array of string)
- dependant_keys_any: required(array of any)
A list of keys that are or'd to determine the Auto-Response Beacon state
- dependant_keys_all: required(array of any)
A list of keys that are and'd to determine the Auto-Response Beacon state
- id: required(string)
Example:
{
"auto_response_beacon": {
"id": "0",
"name": "wtmp-beacon",
"description": "The description for this wtmp beacon",
"module": "wtmp",
"interval": 60,
"enable": true,
"wtmp": {
"login": true,
"logout": true
},
"actions": [],
"dependant_keys_any": [],
"dependant_keys_all": []
}
}HTTP status code 400
Invalid request: body is not json or does not conform to required json schema. Incomplete data: beacon id parameter missing.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}HTTP status code 404
beacon {id} does not exist. Attempted to change read only fields. Attempted to change unknown fields.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
delete /auto_response/beacons/{id}
Delete an Auto-Response beacon on the Operations Manager appliance
Operations Manager base authentication scheme
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Beacon deleted
HTTP status code 400
Incomplete data
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}HTTP status code 404
Beacon did not exist
Body
Media type: application/json
Type: object
Example:
{
"error": [
{
"type": 5,
"code": 29,
"text": "Could not find auto_response/beacon with name or id 'services_autoresponse_beacon-1'",
"args": {
"uuid": "services_autoresponse_beacon-1"
},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Read and manipulate the Auto-Response reactions on the Operations Manager appliance.
Get a list of the Auto-Response Reactions.
Add a new Auto-Response reaction to the Operations Manager appliance.
Bulk delete a list of reactions defined for the appliance.
get /auto_response/reactions
Get a list of the Auto-Response Reactions.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- reactions: required(array of object)
Items: items
- id: required(string)
Database ID for this Auto-Response Reaction.
- name: required(string)
Each Auto-Response Reaction has a non-unique name to help distinguish it.
- sub_type: required(one of cell_message_react, custom_command, serial_text, slack, snmp)
The type of Auto-Response Reaction.
- custom_command: (object)
- shell_command: required(string)
- timeout: required(number)
- cell_message_react: (object)
- phone_numbers: required(array of any)
- message: required(string)
- serial_text: (object)
- port: required(string)
Reference to a port ID
- command: required(string)
- response: required(string)
- timeout: required(number - minimum: 0)
- port: required(string)
- slack: (object)
- channels: required(array of any)
- message: required(string)
- from_name: required(string)
- api_key: required(string)
- snmp: (object)
- oid: required(string)
- timeout: required(number)
- var_binds: required(array of object)
Items: items
- mib_oid: required(string)
- mib_type: required(string)
- mib_value: required(string)
- id: required(string)
- meta: required(object)
- searchId: (string)
- total_pages: (string)
Example:
{
"reactions": [
{
"id": "0",
"name": "slack-reaction",
"sub_type": "slack",
"slack": {
"channels": [
"#here",
"#there"
],
"message": "Example test message",
"from_name": "me@here.com",
"api_key": "key123"
}
},
{
"id": "1",
"name": "cell_message-reaction",
"sub_type": "cell_message_react",
"cell_message_react": {
"phone_numbers": [
"15551234",
"15554321"
],
"message": "Example SMS text"
}
}
],
"meta": {
"total_pages": "1"
}
}HTTP status code 400
Invalid request, missing or incorrect page/per_page
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 4,
"code": 39,
"level": 1,
"text": "Invalid request body",
"args": {}
}
]
}HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
post /auto_response/reactions
Add a new Auto-Response reaction to the Operations Manager appliance.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- auto_response_reaction: required(object)
- name: required(string)
Each Auto-Response Reaction must have a unique symbolic name. Use this to distinguish between multiple Auto-Response Reaction's on the device.
- sub_type: required(one of cell_message_react, custom_command, serial_text, slack, snmp)
The type of Auto-Response Reaction.
- custom_command: (object)
- shell_command: required(string)
- timeout: (number - default: 10 - minimum: 1)
- cell_message_react: (object)
- phone_numbers: required(array of any)
- message: required(string)
- serial_text: (object)
- port: required(string)
Reference to a port ID
- command: required(string)
- response: required(string)
- timeout: required(number - minimum: 0)
- port: required(string)
- slack: (object)
- channels: required(array of any)
- message: required(string)
- from_name: required(string)
- api_key: required(string)
- snmp: (object)
- oid: required(string)
- timeout: required(number)
- var_binds: required(array of object)
Items: items
- mib_oid: required(string)
- mib_type: required(string)
- mib_value: required(string)
- name: required(string)
Example:
{
"auto_response_reaction": {
"name": "slack-reaction",
"sub_type": "slack",
"slack": {
"channels": [
"#here",
"#there"
],
"message": "Example test message",
"from_name": "me@here.com",
"api_key": "key123"
}
}
}HTTP status code 200
The reaction was added.
Body
Media type: application/json
Type: object
Properties- auto_response_reaction: required(object)
An Auto-Response Reaction
- id: required(string)
Database ID for this Auto-Response Reaction.
- name: required(string)
Each Auto-Response Reaction has a non-unique name to help distinguish it.
- sub_type: required(one of cell_message_react, custom_command, serial_text, slack, snmp)
The type of Auto-Response Reaction.
- custom_command: (object)
- shell_command: required(string)
- timeout: required(number)
- cell_message_react: (object)
- phone_numbers: required(array of any)
- message: required(string)
- serial_text: (object)
- port: required(string)
Reference to a port ID
- command: required(string)
- response: required(string)
- timeout: required(number - minimum: 0)
- port: required(string)
- slack: (object)
- channels: required(array of any)
- message: required(string)
- from_name: required(string)
- api_key: required(string)
- snmp: (object)
- oid: required(string)
- timeout: required(number)
- var_binds: required(array of object)
Items: items
- mib_oid: required(string)
- mib_type: required(string)
- mib_value: required(string)
- id: required(string)
Example:
{
"auto_response_reaction": {
"id": "0",
"name": "slack-reaction",
"sub_type": "slack",
"slack": {
"channels": [
"#here",
"#there"
],
"message": "Example test message",
"from_name": "me@here.com",
"api_key": "key123"
}
}
}HTTP status code 400
Invalid request: body is not json or does not conform to required json schema. Incomplete data: reaction id parameter missing.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}HTTP status code 404
Reaction {id} does not exist. Attempted to change read only fields. Attempted to change unknown fields.
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
delete /auto_response/reactions
Bulk delete a list of reactions defined for the appliance.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- auto_response_reaction: required(array of string)
Example:
{
"auto_response_reaction": [
"auto_response_reaction-1",
"auto_response_reaction-5"
]
}HTTP status code 204
All reactions were deleted successfully.
HTTP status code 400
Invalid request
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 4,
"code": 39,
"level": 1,
"text": "Invalid request body",
"args": {}
}
]
}HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}HTTP status code 404
Reaction(s) do not exist.
Body
Media type: application/json
Type: object
Example:
{
"error": [
{
"type": 5,
"code": 29,
"text": "Could not find auto_response/reaction with name or id 'auto_response_reaction-5'",
"args": {
"uuid": "auto_response_reaction-5"
},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Get the configuration of an Auto-Response reaction on the Operations Manager appliance
Update settings for an Auto-Response reaction on the Operations Manager appliance.
Delete an Auto-Response reaction on the Operations Manager appliance
get /auto_response/reactions/{id}
Get the configuration of an Auto-Response reaction on the Operations Manager appliance
Operations Manager base authentication scheme
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- auto_response_reaction: required(object)
An Auto-Response Reaction
- id: required(string)
Database ID for this Auto-Response Reaction.
- name: required(string)
Each Auto-Response Reaction has a non-unique name to help distinguish it.
- sub_type: required(one of cell_message_react, custom_command, serial_text, slack, snmp)
The type of Auto-Response Reaction.
- custom_command: (object)
- shell_command: required(string)
- timeout: required(number)
- cell_message_react: (object)
- phone_numbers: required(array of any)
- message: required(string)
- serial_text: (object)
- port: required(string)
Reference to a port ID
- command: required(string)
- response: required(string)
- timeout: required(number - minimum: 0)
- port: required(string)
- slack: (object)
- channels: required(array of any)
- message: required(string)
- from_name: required(string)
- api_key: required(string)
- snmp: (object)
- oid: required(string)
- timeout: required(number)
- var_binds: required(array of object)
Items: items
- mib_oid: required(string)
- mib_type: required(string)
- mib_value: required(string)
- id: required(string)
Example:
{
"auto_response_reaction": {
"id": "0",
"name": "slack-reaction",
"sub_type": "slack",
"slack": {
"channels": [
"#here",
"#there"
],
"message": "Example test message",
"from_name": "me@here.com",
"api_key": "key123"
}
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /auto_response/reactions/{id}
Update settings for an Auto-Response reaction on the Operations Manager appliance.
Operations Manager base authentication scheme
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- auto_response_reaction: required(object)
- name: required(string)
Each Auto-Response Reaction must have a unique symbolic name. Use this to distinguish between multiple Auto-Response Reaction's on the device.
- sub_type: required(one of cell_message_react, custom_command, serial_text, slack, snmp)
The type of Auto-Response Reaction.
- custom_command: (object)
- shell_command: required(string)
- timeout: (number - default: 10 - minimum: 1)
- cell_message_react: (object)
- phone_numbers: required(array of any)
- message: required(string)
- serial_text: (object)
- port: required(string)
Reference to a port ID
- command: required(string)
- response: required(string)
- timeout: required(number - minimum: 0)
- port: required(string)
- slack: (object)
- channels: required(array of any)
- message: required(string)
- from_name: required(string)
- api_key: required(string)
- snmp: (object)
- oid: required(string)
- timeout: required(number)
- var_binds: required(array of object)
Items: items
- mib_oid: required(string)
- mib_type: required(string)
- mib_value: required(string)
- name: required(string)
Example:
{
"auto_response_reaction": {
"name": "slack-reaction",
"sub_type": "slack",
"slack": {
"channels": [
"#here",
"#there"
],
"message": "Example test message",
"from_name": "me@here.com",
"api_key": "key123"
}
}
}HTTP status code 200
The reaction settings were updated.
Body
Media type: application/json
Type: object
Properties- auto_response_reaction: required(object)
An Auto-Response Reaction
- id: required(string)
Database ID for this Auto-Response Reaction.
- name: required(string)
Each Auto-Response Reaction has a non-unique name to help distinguish it.
- sub_type: required(one of cell_message_react, custom_command, serial_text, slack, snmp)
The type of Auto-Response Reaction.
- custom_command: (object)
- shell_command: required(string)
- timeout: required(number)
- cell_message_react: (object)
- phone_numbers: required(array of any)
- message: required(string)
- serial_text: (object)
- port: required(string)
Reference to a port ID
- command: required(string)
- response: required(string)
- timeout: required(number - minimum: 0)
- port: required(string)
- slack: (object)
- channels: required(array of any)
- message: required(string)
- from_name: required(string)
- api_key: required(string)
- snmp: (object)
- oid: required(string)
- timeout: required(number)
- var_binds: required(array of object)
Items: items
- mib_oid: required(string)
- mib_type: required(string)
- mib_value: required(string)
- id: required(string)
Example:
{
"auto_response_reaction": {
"id": "0",
"name": "slack-reaction",
"sub_type": "slack",
"slack": {
"channels": [
"#here",
"#there"
],
"message": "Example test message",
"from_name": "me@here.com",
"api_key": "key123"
}
}
}HTTP status code 400
Invalid request: body is not json or does not conform to required json schema. Incomplete data: reaction id parameter missing.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}HTTP status code 404
reaction {id} does not exist. Attempted to change read only fields. Attempted to change unknown fields.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
delete /auto_response/reactions/{id}
Delete an Auto-Response reaction on the Operations Manager appliance
Operations Manager base authentication scheme
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Reaction deleted
HTTP status code 400
Incomplete data
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}HTTP status code 404
Reaction did not exist
Body
Media type: application/json
Type: object
Example:
{
"error": [
{
"type": 5,
"code": 29,
"text": "Could not find auto_response/reaction with name or id 'services_autoresponse_reaction-1'",
"args": {
"uuid": "services_autoresponse_reaction-1"
},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Read the AutoResponse Status on the Operations Manager appliance.
Get the status of the Auto-Response Beacons.
get /auto_response/status
Get the status of the Auto-Response Beacons.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Query Parameters
- eventLines: (integer - default: 50)
The number of event lines to fetch - min 0.
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- auto_response_status: required(object)
- beacons: required(array of object)
Status for all Beacons
Items: items
- id: required(string)
Database ID for this Auto-Response Beacon.
- name: required(string)
Each Auto-Response Beacon must have a unique symbolic name. Use this to distinguish between multiple beacons on the device.
- module: required(one of btmp, cell_connection, cell_signal_strength, curl, custom_cmd, load, mem, network, ping, serial_login, serial_pattern, serial_signal, cell_message, wtmp)
The corresponding 'salt' Auto-Response module this Beacon is using.
- trigger_count: required(integer)
The number of Auto-Response Beacon events that were triggered, includes resolved events
- last_triggered: required(string)
The date and timestamp when the last Auto-Response Beacon event occurred
- beacon_data: required(object)
The data the Auto-Response Beacon was triggered with
- events: required(array of any)
The Auto-Response Beacon events since last boot
- id: required(string)
- beacons: required(array of object)
Example:
{
"auto_response_status": {
"beacons": [
{
"id": "0",
"name": "wtmp-beacon",
"module": "wtmp",
"trigger_count": 0,
"last_triggered": "",
"beacon_data": {},
"events": []
},
{
"id": "1",
"name": "curl-beacon",
"module": "curl",
"trigger_count": 1,
"last_triggered": "2020-01-16T20:22:14.477327",
"beacon_data": {
"cmd": [
"/usr/bin/curl",
"--max-time",
"3",
"--request",
"GET",
"http://www.google.com"
],
"exit_status": 0,
"timeout": 5,
"_stamp": "2020-01-16T20:22:14.477327",
"id": "22161907057534",
"result": "success"
},
"events": [
{
"beacon_data": {
"cmd": [
"/usr/bin/curl",
"--max-time",
"3",
"--request",
"GET",
"http://www.google.com"
],
"exit_status": 0,
"timeout": 5,
"_stamp": "2020-01-16T20:22:14.477327",
"id": "22161907057534",
"result": "success"
},
"beacon_id": "auto_response_beacons-1",
"timestamp": "2020-01-16T20:22:14.477327",
"beacon_name": "curl-beacon"
},
{
"timestamp": "2020-01-16T20:22:14",
"beacon_id": "auto_response_beacons-1",
"reactor_id": "auto_response_reactions-1",
"reactor_type": "custom_command",
"reactor_name": "custom cmd reaction test",
"beacon_tag": "salt/beacon/22481809000004/curl-beacon/",
"beacon_name": "curl-beacon",
"reactor_filename": "reactor_0_0.py"
}
]
}
]
}
}HTTP status code 400
Number of eventLines is not a positive number.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Get the status of the Auto-Response Beacon
get /auto_response/status/beacons/{id}
Get the status of the Auto-Response Beacon
Operations Manager base authentication scheme
URI Parameters
- id: required(string)
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Query Parameters
- eventLines: (integer - default: 50)
The number of event lines to fetch - min 0.
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- auto_response_status: required(object)
The Auto-Response Status of a Beacon
- id: required(string)
Database ID for this Auto-Response Beacon.
- name: required(string)
Each Auto-Response Beacon must have a unique symbolic name. Use this to distinguish between multiple beacons on the device.
- module: required(one of btmp, cell_connection, cell_signal_strength, curl, custom_cmd, load, mem, network, ping, serial_login, serial_pattern, serial_signal, cell_message, wtmp)
The corresponding 'salt' Auto-Response module this Beacon is using.
- trigger_count: required(integer)
The number of Auto-Response Beacon events that were triggered, includes resolved events
- last_triggered: required(string)
The date and timestamp when the last Auto-Response Beacon event occurred
- beacon_data: required(object)
The data the Auto-Response Beacon was triggered with
- events: required(array of any)
The Auto-Response Beacon events since last boot
- id: required(string)
Example:
{
"auto_response_status": {
"id": "1",
"name": "curl-beacon",
"module": "curl",
"trigger_count": 1,
"last_triggered": "2020-01-16T20:22:14.477327",
"beacon_data": {
"cmd": [
"/usr/bin/curl",
"--max-time",
"3",
"--request",
"GET",
"http://www.google.com"
],
"exit_status": 0,
"timeout": 5,
"_stamp": "2020-01-16T20:22:14.477327",
"id": "22161907057534",
"result": "success"
},
"events": [
{
"beacon_data": {
"cmd": [
"/usr/bin/curl",
"--max-time",
"3",
"--request",
"GET",
"http://www.google.com"
],
"exit_status": 0,
"timeout": 5,
"_stamp": "2020-01-16T20:22:14.477327",
"id": "22161907057534",
"result": "success"
},
"beacon_id": "auto_response_beacons-1",
"timestamp": "2020-01-16T20:22:14.477327",
"beacon_name": "curl-beacon"
},
{
"timestamp": "2020-01-16T20:22:14",
"beacon_id": "auto_response_beacons-1",
"reactor_id": "auto_response_reactions-1",
"reactor_type": "custom_command",
"reactor_name": "custom cmd reaction test",
"beacon_tag": "salt/beacon/22481809000004/curl-beacon/",
"beacon_name": "curl-beacon",
"reactor_filename": "reactor_0_0.py"
}
]
}
}HTTP status code 400
Number of eventLines is not a positive number.
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}HTTP status code 404
beacon {id} does not exist.
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
Read the AutoResponse Status of Beacon Modules on the Operations Manager appliance.
Get all the Beacon Modules and their resolution values that can be used to filter beacon events.
get /auto_response/status/beacon-modules
Get all the Beacon Modules and their resolution values that can be used to filter beacon events.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- beacon-modules: required(array of object)
Status for all Beacon Modules
Items: items
- module: required(one of btmp, cell_connection, cell_signal_strength, curl, custom_cmd, load, mem, network, ping, serial_login, serial_pattern, serial_signal, cell_message, wtmp)
The corresponding 'salt' Auto-Response beacon module.
- resolution_values: required(array of string)
The list of resolution values to filter on for a reaction for this beacon module.
- module: required(one of btmp, cell_connection, cell_signal_strength, curl, custom_cmd, load, mem, network, ping, serial_login, serial_pattern, serial_signal, cell_message, wtmp)
Example:
{
"beacon-modules": [
{
"module": "ping",
"resolution_values": [
"trigger",
"resolve"
]
},
{
"module": "cell_message",
"resolution_values": []
},
{
"module": "network",
"resolution_values": []
},
{
"module": "serial_signal",
"resolution_values": []
},
{
"module": "mem",
"resolution_values": []
},
{
"module": "cell_signal_strength",
"resolution_values": [
"trigger",
"resolve"
]
},
{
"module": "custom_cmd",
"resolution_values": [
"trigger",
"resolve"
]
},
{
"module": "serial_pattern",
"resolution_values": []
},
{
"module": "curl",
"resolution_values": [
"trigger",
"resolve"
]
},
{
"module": "cell_connection",
"resolution_values": []
},
{
"module": "serial_login",
"resolution_values": []
},
{
"module": "btmp",
"resolution_values": []
},
{
"module": "load",
"resolution_values": []
},
{
"module": "wtmp",
"resolution_values": []
}
]
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
/ip_passthrough
IP Passthrough endpoints are for retrieving / changing IP Passthrough settings.
Retrieve the current IP Passthrough settings.
Update the IP Passthrough settings.
get /ip_passthrough
Retrieve the current IP Passthrough settings.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
Returns the current IP Passthrough settings.
Body
Media type: application/json
Type: object
Properties- ip_passthrough: required(object)
- enabled: required(boolean)
- passthrough_physif: required(string)
[Optional when IP Passthrough is disabled]
The network interface port used for ethernet connection to the downstream device. - mac_address: (string)
The downstream device's MAC address that is connected to the Operations Manager. If mac_address is not specified, the Operations Manager will connect to the first downstream device requesting a DHCP assigned IP address. If this field is empty when IP Passthrough is to be disabled, the stored MAC address will be removed.
- service_intercepts: required(object)
Service intercepts allow specific protocols to be accessed on the Operations Manager in addition to those found on the downstream device.
- https: (object)
Choose an unused port number, so that the HTTPS server on the Operations Manager can be accessed. This will not impede traffic bound for the downstream device's configured HTTPS port.
If https is an empty field, omitted entirely, or set to 0, incoming HTTPS connections are passed through to the downstream device by default, and the Operations Manager's HTTPS server will be inaccessible via incoming connections through the cellular interface.- port: (string)
- ssh: (object)
Choose an unused port number, so that the SSH server on the Operations Manager can be accessed. This will not impede traffic bound for the downstream device's configured SSH port.
If ssh is an empty field, omitted entirely, or set to 0, incoming SSH connections are passed through to the downstream device by default, and the Operations Manager's SSH server will be inaccessible via incoming connections through the cellular interface.- port: (string)
- https: (object)
Examples:
example1:
{
"ip_passthrough": {
"enabled": false,
"passthrough_physif": "net1",
"mac_address": "None",
"service_intercepts": {
"https": {
"port": "None"
},
"ssh": {
"port": "None"
}
}
}
}example2:
{
"ip_passthrough": {
"enabled": true,
"passthrough_physif": "net2",
"mac_address": "00:e0:4c:12:93:8d",
"service_intercepts": {
"https": {
"port": "5551"
},
"ssh": {
"port": "None"
}
}
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
put /ip_passthrough
Update the IP Passthrough settings.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
Body
Media type: application/json
Type: object
Properties- ip_passthrough: required(object)
- enabled: required(boolean)
- passthrough_physif: required(string)
[Optional when IP Passthrough is disabled]
The network interface port used for ethernet connection to the downstream device. - mac_address: (string)
The downstream device's MAC address that is connected to the Operations Manager. If mac_address is not specified, the Operations Manager will connect to the first downstream device requesting a DHCP assigned IP address. If this field is empty when IP Passthrough is to be disabled, the stored MAC address will be removed.
- service_intercepts: required(object)
Service intercepts allow specific protocols to be accessed on the Operations Manager in addition to those found on the downstream device.
- https: (object)
Choose an unused port number, so that the HTTPS server on the Operations Manager can be accessed. This will not impede traffic bound for the downstream device's configured HTTPS port.
If https is an empty field, omitted entirely, or set to 0, incoming HTTPS connections are passed through to the downstream device by default, and the Operations Manager's HTTPS server will be inaccessible via incoming connections through the cellular interface.- port: (string)
- ssh: (object)
Choose an unused port number, so that the SSH server on the Operations Manager can be accessed. This will not impede traffic bound for the downstream device's configured SSH port.
If ssh is an empty field, omitted entirely, or set to 0, incoming SSH connections are passed through to the downstream device by default, and the Operations Manager's SSH server will be inaccessible via incoming connections through the cellular interface.- port: (string)
- https: (object)
Examples:
example1:
{
"ip_passthrough": {
"enabled": true,
"passthrough_physif": "net1",
"mac_address": "00:e0:4c:12:93:8d",
"service_intercepts": {
"https": {
"port": "8443"
},
"ssh": {
"port": "8222"
}
}
}
}example2:
{
"ip_passthrough": {
"enabled": false,
"passthrough_physif": "net2",
"service_intercepts": {}
}
}HTTP status code 200
Returns the current IP Passthrough settings.
Body
Media type: application/json
Type: object
Properties- ip_passthrough: required(object)
- enabled: required(boolean)
- passthrough_physif: required(string)
[Optional when IP Passthrough is disabled]
The network interface port used for ethernet connection to the downstream device. - mac_address: (string)
The downstream device's MAC address that is connected to the Operations Manager. If mac_address is not specified, the Operations Manager will connect to the first downstream device requesting a DHCP assigned IP address. If this field is empty when IP Passthrough is to be disabled, the stored MAC address will be removed.
- service_intercepts: required(object)
Service intercepts allow specific protocols to be accessed on the Operations Manager in addition to those found on the downstream device.
- https: (object)
Choose an unused port number, so that the HTTPS server on the Operations Manager can be accessed. This will not impede traffic bound for the downstream device's configured HTTPS port.
If https is an empty field, omitted entirely, or set to 0, incoming HTTPS connections are passed through to the downstream device by default, and the Operations Manager's HTTPS server will be inaccessible via incoming connections through the cellular interface.- port: (string)
- ssh: (object)
Choose an unused port number, so that the SSH server on the Operations Manager can be accessed. This will not impede traffic bound for the downstream device's configured SSH port.
If ssh is an empty field, omitted entirely, or set to 0, incoming SSH connections are passed through to the downstream device by default, and the Operations Manager's SSH server will be inaccessible via incoming connections through the cellular interface.- port: (string)
- https: (object)
Examples:
example1:
{
"ip_passthrough": {
"enabled": true,
"passthrough_physif": "net1",
"mac_address": "00:e0:4c:12:93:8d",
"service_intercepts": {
"https": {
"port": "8443"
},
"ssh": {
"port": "8222"
}
}
}
}example2:
{
"ip_passthrough": {
"enabled": false,
"passthrough_physif": "net2",
"mac_address": "None",
"service_intercepts": {
"https": {
"port": "None"
},
"ssh": {
"port": "None"
}
}
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Example:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}HTTP status code 404
Not found
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 500
Internal error
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c
The IP Passthrough status endpoint provides information about what part of the IP Passthrough connection process the device is currently at and information about the connected downstream device.
Retrieve the current IP Passthrough status.
get /ip_passthrough/status
Retrieve the current IP Passthrough status.
Operations Manager base authentication scheme
Headers
- Authorization: required(string)
Example:
Token {{sessionUid}}
HTTP status code 200
This response object provides information about the current status of the IP Passthrough connection and the connected downstream device.
Body
Media type: application/json
Type: object
Properties- ip_passthrough_status: required(object)
- status: required(one of disabled, cell_not_active, connecting, active)
A status value indicating the current state of the IP Passthrough connection with a downstream device.
- downstream_ip: required(string)
The IP address taken from the device's cellular modem and assigned to the downstream device.
- downstream_mac: required(string)
The MAC address of the downstream device that has been assigned the cellular IP address.
- status: required(one of disabled, cell_not_active, connecting, active)
Examples:
example1:
{
"ip_passthrough_status": {
"status": "active",
"downstream_ip": "100.120.10.1",
"downstream_mac": "01:02:03:04:05:06"
}
}example2:
{
"ip_passthrough_status": {
"status": "connecting",
"downstream_ip": "",
"downstream_mac": ""
}
}example3:
{
"ip_passthrough_status": {
"status": "cell_not_active",
"downstream_ip": "",
"downstream_mac": ""
}
}example4:
{
"ip_passthrough_status": {
"status": "disabled",
"downstream_ip": "",
"downstream_mac": ""
}
}HTTP status code 400
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
HTTP status code 401
Authentication failure
Body
Media type: application/json
Type: object
Properties- error: required(array of object)
A list of errors
Items: items
- type: required(integer)
- code: required(integer)
- level: required(integer)
- text: required(string)
- args: required(object)
Examples:
example1:
{
"error": [
{
"type": 7,
"code": 42,
"level": 1,
"text": "Invalid session ID",
"args": {}
}
]
}example2:
{
"error": [
{
"type": 7,
"code": 46,
"text": "Permission denied",
"args": {},
"level": 1
}
]
}Secured by token
Headers
- Authorization: required(string)
authorization session token
Example:
Token 521a00e57d4a461b3e4bb0c55166f97c