REST API for Oracle SD-WAN Edge Release 9.1.1

Adds an event type

post

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

Request

There are no request parameters for this operation.

Supported Media Types

application/json

A JSON object containing event type

Root Schema : schema

Type: object

Show Source

type: string

Example: { "type":"add_event", "objID":9999999, "objName":"User-initiated test event", "objType":8, "eventType":0, "severity":0, "description":"User-initiated test event", "timestamp":"<timestamp>" }

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "example":{
                "type":"add_event",
                "objID":9999999,
                "objName":"User-initiated test event",
                "objType":8,
                "eventType":0,
                "severity":0,
                "description":"User-initiated test event",
                "timestamp":"<timestamp>"
            }
        }
    }
}

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 : 405ExpectedPost

Type: object

Show Source

message: string

Example: Operation must use a POST
status: string

Example: fail

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

Examples

Example of Accessing the API with cURL

The following example shows how to set event data by submitting a POST 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 POST \
    -b cookies.txt \
    -d@request.json \
    --header "Content-Type: application/json" \
    "https://$IPADDR/v1/admin/event_management/events"

The following shows an example of the contents of the request.json file sent as the request body.

{
  "type":"add_event",
  "objID":9999999,
  "objName":"User-initiated test event",
  "objType":8,
  "eventType":0,
  "severity":0,
  "description":"User-initiated test event",
  "timestamp":<timestamp>
}

Example of the Response Body

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

{
  "data": {
    "Emails": 0,
    "SNMP Traps": 0,
    "Syslog Messages": 0
  },
  "status": "success"
}