Trap Configurations

Gets a list of trap configurations

get

This endpoint is used to fetch all the trap configurations in the current organization

Authorizations

Query parameters

items_per_pageintegerRequired

Items Per Page

pageintegerRequired

Page Number

reversebooleanOptional

Sorting Order

sortstringOptional

Sorting Key

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

GET /ux/common/trap/configuration/?items_per_page=1&page=1 HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

[
  {
    "id": "text",
    "rca_raise_msg": "text",
    "rca_raise_varbind": "text",
    "rca_varmap_status": "text",
    "rca_raise_varbind_msgmap": "text",
    "rca_varbindconv": "text",
    "rca_conversion": "text",
    "trap_id": "text",
    "name": "text",
    "description": "text",
    "type": "text",
    "trap_oid": "text",
    "trap_clear_oid": "text",
    "clear_event_on_clear_oid": true,
    "resource": "text",
    "resource_var_bind": "text",
    "action": "text",
    "stat_map": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "status": 1,
    "severity": 1,
    "set_criteria": [],
    "reset_criteria": [],
    "alarm_msg": "text",
    "clear_msg": "text",
    "rca": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "config_download": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "organization": "text",
    "creation_time": "2025-06-07T16:44:29.914Z",
    "last_update_time": "2025-06-07T16:44:29.914Z",
    "isdeleted": true,
    "thresid_map": "text"
  }
]

Creates a new trap configuration

post

This endpoint is used to save a new trap configuration for the current organization

Authorizations

Body

Other propertiesanyOptional

Responses

201

No response body

post

HTTPcURLJavaScriptPython

POST /ux/common/trap/configuration/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 663

{
  "name": "Link Down Trap",
  "trap_id": "123456789012345",
  "description": "Used to configure the link down trap",
  "type": "Link Down",
  "trap_oid": "1.3.6.1.6.3.1.1.5.3",
  "stat_name": "ge-0/0/1",
  "stat_dn": "l_util",
  "stat_unit": "%",
  "status": 1,
  "severity": "Critical",
  "set_criteria": {
    "varbind": [
      {
        "key": 6,
        "condition": "in",
        "value": "Critical"
      },
      {
        "key": 7,
        "condition": "equal to",
        "value": "Down"
      }
    ],
    "condition": "and"
  },
  "reset_criteria": {
    "varbind": [
      {
        "key": 6,
        "condition": "in",
        "value": "Info"
      },
      {
        "key": 7,
        "condition": "equal to",
        "value": "Up"
      }
    ],
    "condition": "or"
  },
  "alarm_msg": "Link Down",
  "clear_msg": "Link UP",
  "applicable": "All",
  "applies_to": {},
  "applicable_filter": {},
  "organization": "123456789012345"
}

201

No response body

No content

Gets a trap configuration with the given id

get

This endpoint is used to fetch a trap configuration details in the current organization

Authorizations

Path parameters

idstringRequired

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

GET /ux/common/trap/configuration/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "rca_raise_msg": "text",
  "rca_raise_varbind": "text",
  "rca_varmap_status": "text",
  "rca_raise_varbind_msgmap": "text",
  "rca_varbindconv": "text",
  "rca_conversion": "text",
  "trap_id": "text",
  "name": "text",
  "description": "text",
  "type": "text",
  "trap_oid": "text",
  "trap_clear_oid": "text",
  "clear_event_on_clear_oid": true,
  "resource": "text",
  "resource_var_bind": "text",
  "action": "text",
  "stat_map": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "status": 1,
  "severity": 1,
  "set_criteria": [],
  "reset_criteria": [],
  "alarm_msg": "text",
  "clear_msg": "text",
  "rca": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "config_download": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "organization": "text",
  "creation_time": "2025-06-07T16:44:29.914Z",
  "last_update_time": "2025-06-07T16:44:29.914Z",
  "isdeleted": true,
  "thresid_map": "text"
}

Edits the trap configuration with given id

put

This endpoint is used to edit an existing trap configuration for the current organization

Authorizations

Path parameters

idstringRequired

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

idstringRead-onlyRequired

rca_raise_msgstringRead-onlyRequired

rca_raise_varbindstringRead-onlyRequired

rca_varmap_statusstringRead-onlyRequired

rca_raise_varbind_msgmapstringRead-onlyRequired

rca_varbindconvstringRead-onlyRequired

rca_conversionstringRead-onlyRequired

trap_idstring · max: 225Required

namestringOptional

descriptionstringOptional

typestringOptional

trap_oidstringOptional

trap_clear_oidstringOptional

clear_event_on_clear_oidbooleanOptional

resourcestringOptional

resource_var_bindstringOptional

actionstringOptional

statusintegerOptional

severityintegerOptional

alarm_msgstringOptional

clear_msgstringOptional

organizationstring · max: 225Required

creation_timestring · date-timeOptional

last_update_timestring · date-timeOptional

isdeletedbooleanOptional

thresid_mapstringOptional

Responses

200Success

application/json

put

HTTPcURLJavaScriptPython

PUT /ux/common/trap/configuration/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 603

{
  "trap_id": "text",
  "name": "text",
  "description": "text",
  "type": "text",
  "trap_oid": "text",
  "trap_clear_oid": "text",
  "clear_event_on_clear_oid": true,
  "resource": "text",
  "resource_var_bind": "text",
  "action": "text",
  "stat_map": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "status": 1,
  "severity": 1,
  "set_criteria": [],
  "reset_criteria": [],
  "alarm_msg": "text",
  "clear_msg": "text",
  "rca": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "config_download": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "organization": "text",
  "creation_time": "2025-06-07T16:44:29.914Z",
  "last_update_time": "2025-06-07T16:44:29.914Z",
  "isdeleted": true,
  "thresid_map": "text"
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

200Success

{
  "id": "text",
  "rca_raise_msg": "text",
  "rca_raise_varbind": "text",
  "rca_varmap_status": "text",
  "rca_raise_varbind_msgmap": "text",
  "rca_varbindconv": "text",
  "rca_conversion": "text",
  "trap_id": "text",
  "name": "text",
  "description": "text",
  "type": "text",
  "trap_oid": "text",
  "trap_clear_oid": "text",
  "clear_event_on_clear_oid": true,
  "resource": "text",
  "resource_var_bind": "text",
  "action": "text",
  "stat_map": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "status": 1,
  "severity": 1,
  "set_criteria": [],
  "reset_criteria": [],
  "alarm_msg": "text",
  "clear_msg": "text",
  "rca": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "config_download": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "organization": "text",
  "creation_time": "2025-06-07T16:44:29.914Z",
  "last_update_time": "2025-06-07T16:44:29.914Z",
  "isdeleted": true,
  "thresid_map": "text"
}

Deletes the trap configuration with given id

delete

This endpoint is used to delete an existing trap configuration for the current organization

Authorizations

Path parameters

idstringRequired

Responses

204

No response body

delete

HTTPcURLJavaScriptPython

DELETE /ux/common/trap/configuration/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

204

No response body

No content

get

API endpoint that allows users to be viewed or edited.

Authorizations

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

GET /ux/common/trap/configuration/msg_options/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "rca_raise_msg": "text",
  "rca_raise_varbind": "text",
  "rca_varmap_status": "text",
  "rca_raise_varbind_msgmap": "text",
  "rca_varbindconv": "text",
  "rca_conversion": "text",
  "trap_id": "text",
  "name": "text",
  "description": "text",
  "type": "text",
  "trap_oid": "text",
  "trap_clear_oid": "text",
  "clear_event_on_clear_oid": true,
  "resource": "text",
  "resource_var_bind": "text",
  "action": "text",
  "stat_map": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "status": 1,
  "severity": 1,
  "set_criteria": [],
  "reset_criteria": [],
  "alarm_msg": "text",
  "clear_msg": "text",
  "rca": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "config_download": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "organization": "text",
  "creation_time": "2025-06-07T16:44:29.914Z",
  "last_update_time": "2025-06-07T16:44:29.914Z",
  "isdeleted": true,
  "thresid_map": "text"
}

post

API endpoint that allows users to be viewed or edited.

Authorizations

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

idstringRead-onlyRequired

rca_raise_msgstringRead-onlyRequired

rca_raise_varbindstringRead-onlyRequired

rca_varmap_statusstringRead-onlyRequired

rca_raise_varbind_msgmapstringRead-onlyRequired

rca_varbindconvstringRead-onlyRequired

rca_conversionstringRead-onlyRequired

trap_idstring · max: 225Required

namestringOptional

descriptionstringOptional

typestringOptional

trap_oidstringOptional

trap_clear_oidstringOptional

clear_event_on_clear_oidbooleanOptional

resourcestringOptional

resource_var_bindstringOptional

actionstringOptional

statusintegerOptional

severityintegerOptional

alarm_msgstringOptional

clear_msgstringOptional

organizationstring · max: 225Required

creation_timestring · date-timeOptional

last_update_timestring · date-timeOptional

isdeletedbooleanOptional

thresid_mapstringOptional

Responses

200Success

application/json

post

HTTPcURLJavaScriptPython

POST /ux/common/trap/configuration/multidelete/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 603

{
  "trap_id": "text",
  "name": "text",
  "description": "text",
  "type": "text",
  "trap_oid": "text",
  "trap_clear_oid": "text",
  "clear_event_on_clear_oid": true,
  "resource": "text",
  "resource_var_bind": "text",
  "action": "text",
  "stat_map": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "status": 1,
  "severity": 1,
  "set_criteria": [],
  "reset_criteria": [],
  "alarm_msg": "text",
  "clear_msg": "text",
  "rca": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "config_download": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "organization": "text",
  "creation_time": "2025-06-07T16:44:29.914Z",
  "last_update_time": "2025-06-07T16:44:29.914Z",
  "isdeleted": true,
  "thresid_map": "text"
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

200Success

{
  "id": "text",
  "rca_raise_msg": "text",
  "rca_raise_varbind": "text",
  "rca_varmap_status": "text",
  "rca_raise_varbind_msgmap": "text",
  "rca_varbindconv": "text",
  "rca_conversion": "text",
  "trap_id": "text",
  "name": "text",
  "description": "text",
  "type": "text",
  "trap_oid": "text",
  "trap_clear_oid": "text",
  "clear_event_on_clear_oid": true,
  "resource": "text",
  "resource_var_bind": "text",
  "action": "text",
  "stat_map": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "status": 1,
  "severity": 1,
  "set_criteria": [],
  "reset_criteria": [],
  "alarm_msg": "text",
  "clear_msg": "text",
  "rca": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "config_download": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "organization": "text",
  "creation_time": "2025-06-07T16:44:29.914Z",
  "last_update_time": "2025-06-07T16:44:29.914Z",
  "isdeleted": true,
  "thresid_map": "text"
}

get

API endpoint that allows users to be viewed or edited.

Authorizations

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

GET /ux/common/trap/configuration/options/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "rca_raise_msg": "text",
  "rca_raise_varbind": "text",
  "rca_varmap_status": "text",
  "rca_raise_varbind_msgmap": "text",
  "rca_varbindconv": "text",
  "rca_conversion": "text",
  "trap_id": "text",
  "name": "text",
  "description": "text",
  "type": "text",
  "trap_oid": "text",
  "trap_clear_oid": "text",
  "clear_event_on_clear_oid": true,
  "resource": "text",
  "resource_var_bind": "text",
  "action": "text",
  "stat_map": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "status": 1,
  "severity": 1,
  "set_criteria": [],
  "reset_criteria": [],
  "alarm_msg": "text",
  "clear_msg": "text",
  "rca": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "config_download": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "organization": "text",
  "creation_time": "2025-06-07T16:44:29.914Z",
  "last_update_time": "2025-06-07T16:44:29.914Z",
  "isdeleted": true,
  "thresid_map": "text"
}

Gets a list of trap messages

get

This endpoint is used to fetch all the traps received on the agents for current organization

Authorizations

Query parameters

items_per_pageintegerRequired

Items Per Page

pageintegerRequired

Page Number

reversebooleanOptional

Sorting Order

sortstringOptional

Sorting Key

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

GET /ux/common/trap/configuration/trap_msgs/?items_per_page=1&page=1 HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "rca_raise_msg": "text",
  "rca_raise_varbind": "text",
  "rca_varmap_status": "text",
  "rca_raise_varbind_msgmap": "text",
  "rca_varbindconv": "text",
  "rca_conversion": "text",
  "trap_id": "text",
  "name": "text",
  "description": "text",
  "type": "text",
  "trap_oid": "text",
  "trap_clear_oid": "text",
  "clear_event_on_clear_oid": true,
  "resource": "text",
  "resource_var_bind": "text",
  "action": "text",
  "stat_map": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "status": 1,
  "severity": 1,
  "set_criteria": [],
  "reset_criteria": [],
  "alarm_msg": "text",
  "clear_msg": "text",
  "rca": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "config_download": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "organization": "text",
  "creation_time": "2025-06-07T16:44:29.914Z",
  "last_update_time": "2025-06-07T16:44:29.914Z",
  "isdeleted": true,
  "thresid_map": "text"
}