Important

   

Starting from version 8.9.03, BMC Network Automation is renamed to TrueSight Network Automation. This space contains information about TrueSight Network Automation 8.9.03 and the later service packs for 8.9. For earlier releases, see BMC Network Automation 8.9.

Event Receivers API

TrueSight Network Automation REST API – EventReceiverService
The base URL for the API is:

https://serverName:portNumber/bca-networks/api


GET /v3.0/event_receivers
 Retrieves event receivers, matching any filter criteria


Parameters

Name

Located in

Description

Default

Schema

filter.enabled

query

Filter for enabled or disabled event receivers, when true, returns only enabled event receivers; when false, returns only disabled event receivers; when this filter is absent, no filtering is done


boolean

orderBy

query

Sort by the specified attribute (address, enabledFlag, or a listable event receiver dynamic field name) in the specified order (prefix with a '+' for ascending or a '-' for descending)

"+address"

string
Enum: [
  "+enabledFlag",
  "-enabledFlag",
  "+address",
  "-address"
]

offset

query

Return the specified page number

1

integer

limit

query

Define the number of rows in a page or the maximum number of event receivers to return

25

integer

Authorization

header

Authorization token formatted as 'Bearer [token]'


string*

Responses

Code

Description

Schema

200

successful operation

[
   #EventReceiverDTO
]

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in


403

Forbidden: Not allowed to access event receivers


500

Internal server error: Unexpected exception occurred


POST /v3.0/event_receivers
 Adds a new event receiver


Parameters

Name

Located in

Description

Default

Schema

body

body

Complete attributes of the new event receiver


#EventReceiverDTO

Authorization

header

Authorization token formatted as 'Bearer [token]'


string*

Responses

Code

Description

Schema

201

Created: New event receiver successfully added


400

Bad request: Input event receiver DTO is missing or new event receiver is invalid


401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in


403

Forbidden: Not allowed to add a new event receiver


500

Internal server error: Unexpected exception occurred


GET /v3.0/event_receivers/{addressOrKey}
 Retrieves one event receiver either by address or by database key


Parameters

Name

Located in

Description

Default

Schema

addressOrKey

path

Address or database key of the event receiver of interest


string*

Authorization

header

Authorization token formatted as 'Bearer [token]'


string*

Responses

Code

Description

Schema

200

successful operation

#EventReceiverDTO

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in


403

Forbidden: Not allowed to access event receivers


404

Not found: No single matching event receiver found


500

Internal server error: Unexpected exception occurred


PUT /v3.0/event_receivers/{addressOrKey}
 Modifies all attributes of an existing event receiver


Parameters

Name

Located in

Description

Default

Schema

addressOrKey

path

Address or database key of the event receiver to be modified


string*

body

body

Complete new attribute values for the event receiver; anything left out will be considered to be null and will be nulled out in the event receiver


#EventReceiverDTO

Authorization

header

Authorization token formatted as 'Bearer [token]'


string*

Responses

Code

Description

Schema

200

successful operation

#EventReceiverDTO

400

Bad request: Input event receiver DTO is missing or modified event receiver is invalid


401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in


403

Forbidden: Not allowed to modify the event receiver


404

Not found: No single matching event receiver found


500

Internal server error: Unexpected exception occurred


DELETE /v3.0/event_receivers/{addressOrKey}
 Deletes an event receiver


Parameters

Name

Located in

Description

Default

Schema

addressOrKey

path

Address or database key of the event receiver to be deleted


string*

Authorization

header

Authorization token formatted as 'Bearer [token]'


string*

Responses

Code

Description

Schema

200

successful operation

string

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in


403

Forbidden: Not allowed to delete the event receiver


404

Not found: No single matching event receiver found


500

Internal server error: Unexpected exception occurred


PATCH /v3.0/event_receivers/{addressOrKey}
 Modifies only the specified attributes of an existing event receiver, where the changes are specified in JSON Patch format (per RFC 6902)


Parameters

Name

Located in

Description

Default

Schema

addressOrKey

path

Address or database key of the event receiver to be modified


string*

body

body

New attribute values for the event receiver, in JSON Patch format


#JsonPatch

Authorization

header

Authorization token formatted as 'Bearer [token]'


string*

Responses

Code

Description

Schema

200

successful operation

#EventReceiverDTO

400

Bad request: Input JSON patch information is missing or modified event receiver is invalid


401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in


403

Forbidden: Not allowed to modify the event receiver


404

Not found: No single matching event receiver found


500

Internal server error: Unexpected exception occurred



Object Definitions

Object

Schema

DynamicFieldValueDTO


 A dynamic field value


{
    id: string
    The database key of the dynamic field whose value this is (read-only)
 
    name: string
    The name of the dynamic field (read-only)
 
    values: [
      The value(s) for the dynamic field; for a single-value field, only the first entry is relevant; read-only for Auto Derived and Configuration Profiled types
 
      string
    ]
 
    dynamicFieldDetailsLink: string
    Link to get more detailed information about the dynamic field (read-only)
}

EventReceiverDTO


 Information about an event receiver


{
    id: string
    The event receiver's unique database key (read-only)
 
    address: string*
    Host name or IP address of the event receiver
 
    annotation: string
    Notes, comments, description, explanation
 
    enabledFlag: boolean
    Whether or not this event receiver is enabled; when true (enabled), new events are forwarded to the receiver; when false (disabled), no events are sent to the receiver
 
    eventCategoryIds: [
      Selects which events are forwarded to the event receiver, by category
 
      integer
    ]*
 
    eventSeverityIds: [
      Selects which events are forwarded to the event receiver, by severity
 
      integer
    ]*
 
    port: integer*
    TCP/UDP port number where the event receiver is listening for input events
 
    protocolId: integer*
    The protocol used to transmit events to the event receiver; allowed values are 1 for UDP and 2 for TLS
 
    protocolName: string
    The meaning of the numeric protocolId (read-only)
 
    syslogHeaderHostname: string
    When sending events to the event receiver as syslog messages, specifies the local host name to be included in the header; when null, the system looks up the local host name defined by the host operating system
 
    syslogMessageFormatId: integer*
    How events are formatted into syslog messages; allowed values are 1 for RFC 5424 and 2 for ArcSight Common Event Format (CEF)
 
    syslogMessageFormatName: string
    The meaning of the numeric syslogMessageFormatId (read-only)
 
    timeoutMinutes: integer
    When sending an event to the event receiver via TLS, how long to wait (in minutes) for a response before declaring a send failure; required when the protocol is TLS
 
    dynamicFields: [
      The dynamic fields
 
       #DynamicFieldValueDTO
    ]
}

JsonPatch


 A list of JSON Patch operations


[
    A list of JSON Patch operations
 
     #JsonPatch.OneOperation
  ]

JsonPatch.OneOperation

JsonPatch.Pointer


 Pointer or path to an element or property


string
  Pointer or path to an element or property

JsonPatch.Add


 Add a value to an object or inserts it into an array. In the case of an array, the value is inserted before the given index. The - character can be used instead of an index to insert at the end of an array. The value can be any JSON value.


{
    op: string*
    Enum: [
      "add"
    ]
    value: any*
    path: #JsonPatch.Pointer *
}

JsonPatch.Remove


 Remove a value from an object or array.


{
    op: string*
    Enum: [
      "remove"
    ]
    path: #JsonPatch.Pointer *
}

JsonPatch.Replace


 Replace an existing value. THe value can be any JSON value.


{
    op: string*
    Enum: [
      "replace"
    ]
    value: any*
    path: #JsonPatch.Pointer *
}

JsonPatch.Move


 Move a value from one location to the other. "path" is the destination.


{
    op: string*
    Enum: [
      "move"
    ]
    path: #JsonPatch.Pointer *
    from: #JsonPatch.Pointer *
}

JsonPatch.Copy


 Copy a value from one location to another. "path" is the destination.


{
    op: string*
    Enum: [
      "copy"
    ]
    path: #JsonPatch.Pointer *
    from: #JsonPatch.Pointer *
}

JsonPatch.Test


 Test that the specified value is set in the document at the specified path. If the test fails, then the patch as a whole is not applied. The Value can be any JSON value.


{
    op: string*
    Enum: [
      "test"
    ]
    value: any*
    path: #JsonPatch.Pointer *
}

Was this page helpful? Yes No Submitting... Thank you

Comments