Events REST API

• Description – returns information on all events running in the fabric, or on a specific event using its ID

• Request URL – GET /ufmRest/app/events

• Main operationsGet all eventsGet an event using its IDTrigger external eventTrigger external events

Get All Events

• Description – Returns information on all events running in the fabric

• Request URL – GET /ufmRest/app/events

• Request Content Type – Application/json

• Response 

  [
     {
        "id":97213,
        "name":"MCast Group Deleted",
        "type":"Site",
        "event_type":"67",
        "severity":"Info",
        "timestamp":"2024-05-28 08:03:05",
        "counter":"N/A",
        "category":"Fabric Notification",
        "object_name":"default",
        "object_path":"default(2)",
        "write_to_syslog":false,
        "description":"Mcast group is deleted: ff12601bffff0000, 1fffc6ec2"
     },
     {
        "id":97214,
        "name":"New MCast Group Created",
        "type":"Site",
        "event_type":"66",
        "severity":"Info",
        "timestamp":"2024-05-28 08:03:07",
        "counter":"N/A",
        "category":"Fabric Notification",
        "object_name":"default",
        "object_path":"default(2)",
        "write_to_syslog":false,
        "description":"New MCast group is created: ff12601bffff0000, 1fffc6ec2"
     }
  ]
  
  
  

  
  

• Possible Filters

  • object_name – filters by object name

  • type – filters by type

  • category – filters by category

  • severity – filters by severity

  • group – filters events by the group that has caused the event

• Status Codes200 – OK

Get Event Using ID

• Description – returns information on a specific event by its ID

• Request URL – GET /ufmRest/app/events/<id>

• Request Content Type – Application/json

• Response 

  {
     "id":97227,
     "name":"New MCast Group Created",
     "type":"Site",
     "event_type":"66",
     "severity":"Info",
     "timestamp":"2024-05-28 08:09:05",
     "counter":"N/A",
     "category":"Fabric Notification",
     "object_name":"default",
     "object_path":"default(2)",
     "write_to_syslog":false,
     "description":"New MCast group is created: ff12601bffff0000, 1ffd9acbf"
  }
  

  
  

• Note – if the <id> parameter is not provided, all events will be listed

• Status Codes200 – OK404 – NOT FOUND—event was not found (by ID)

Trigger External Event

• Description – Trigger external event in UFM

• Request URL – POST /ufmRest/app/events/external_event

• Request Content Type – Application/json

• Response - Success

• Request Body

  {
     "event_id":554,
     "external_event_name":"External event new name",
     "external_event_type":"External event type",
     "external_event_source":"External event source",
     "description":"Awsome external event!"
  }
  

  
  

• Status Codes200 – OK404 – NOT FOUND—event was not found (by ID)

Trigger External Events

• Description – Trigger external events in UFM

• Request URL – POST /ufmRest/app/events/external_events

• Request Content Type – Application/json

• Response - Success

• Request Body

  [
     {
        "event_id":554,
        "external_event_name":"External event new name",
        "external_event_type":"External event type",
        "external_event_source":"External event source",
        "description":"Awsome external event!"
     }
  ]
  

  
  

• Status Codes200 – OK404 – NOT FOUND—event was not found (by ID)

Last updated: May 28, 2024