REST API for Oracle SD-WAN Edge Release 9.1.1

Get alarm information

get

http://<SDWAN_TENANT_IP>/v1/admin/event_management/alarms

Request

Query Parameters

type(required): string
sets the event type
Example:
```
event_type
```

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Result OK

Root Schema : schema

Type: object

401 Response

Not Logged into the SDWAN-Edge device

Root Schema : 401NotLoggedin

Type: object

Show Source

message: string

Example: Not logged in.
status: string

Example: fail

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "example":"fail"
        },
        "message":{
            "type":"string",
            "example":"Not logged in."
        }
    }
}

403 Response

Insufficient Userlevel

Root Schema : 403InsufficientUserLevel

Type: object

Show Source

message: string

Example: User Level for user <user_name> is not sufficient for this <URL value> operation.
required_user_level: string

Example: ADMIN
status: string

Example: fail
user_level: string

Example: GUEST
user_name: string

Example: username

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "example":"fail"
        },
        "user_name":{
            "type":"string",
            "example":"username"
        },
        "user_level":{
            "type":"string",
            "example":"GUEST"
        },
        "required_user_level":{
            "type":"string",
            "example":"ADMIN"
        },
        "message":{
            "type":"string",
            "example":"User Level for user <user_name> is not sufficient for this <URL value> operation."
        }
    }
}

405 Response

Invalid request method

Root Schema : 405ExpectedGet

Type: object

Show Source

message: string

Example: Operation must use a GET
status: string

Example: fail

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "example":"fail"
        },
        "message":{
            "type":"string",
            "example":"Operation must use a GET"
        }
    }
}

Examples

Example of Accessing the API with cURL

The following example shows how to get alarm information by submitting a GET request on the REST resource using cURL. If the request requires a timestamp, use the timestamp from the response of the /login API. For more information about cURL, see Use cURL.

curl -X GET \
    -b cookies.txt \
    --header "Content-Type: application/json" \
    "https://$IPADDR/v1/admin/event_management/alarms"

The following shows other examples of accessing this API resource.

curl -X GET -b cookies.txt -H "Content-Type: application/json" "https://$IPADDR/v1/admin/event_management/alarms?type=alarm_configuration"
curl -X GET -b cookies.txt -H "Content-Type: application/json" "https://$IPADDR/v1/admin/event_management/alarms?type=event_types"
curl -X GET -b cookies.txt -H "Content-Type: application/json" "https://$IPADDR/v1/admin/event_management/alarms?type=trigger_state"
curl -X GET -b cookies.txt -H "Content-Type: application/json" "https://$IPADDR/v1/admin/event_management/alarms?type=clear_state"
curl -X GET -b cookies.txt -H "Content-Type: application/json" "https://$IPADDR/v1/admin/event_management/alarms?type=severity"

Example of the Response Body

The following example shows the contents of the response body in JSON format.

{
  "data": {
    "Clear States": [
      {
        "eventType id": 4,
        "id": 4,
        "index": 0,
        "name": "GOOD"
      },
      {
        "eventType id": 4,
        "id": 1,
        "index": 0,
        "name": "DISABLED"
      },
      {
        "eventType id": 4,
        "id": 3,
        "index": 0,
        "name": "BAD"
      },
      {
        "eventType id": 4,
        "id": 2,
        "index": 0,
        "name": "DEAD"
      }
    ]
  },
  "status": "success"
}