NSX-T Data Center REST API

Returns notification watcher by watcher id.

Request:

Method:

GET

URI Path(s):

/api/v1/notification-watchers/<watcher-id>

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

n/a

Example Request:

GET /api/v1/notification-watchers/daabc688-3a90-4545-9af8-23e1b045e6f3

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

NotificationWatcher+

NotificationWatcher (schema)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
authentication_scheme	Scheme to authenticate requests sent to the server A NotificationAuthenticationScheme that describes how notification requests should authenticate to the server.	NotificationAuthenticationScheme	Required
certificate_sha256_thumbprint	SHA256 thumbprint of the HTTPS certificate Contains the hex-encoded SHA256 thumbprint of the HTTPS certificate. It must be specified if use_https is set to true.	string
description	Description associated with this notification watcher Optional description that can be associated with this NotificationWatcher.	string
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Identifier to identify a notification watcher uniquely System generated identifier to identify a notification watcher uniquely.	string	Readonly
max_send_uri_count	Optional maximum number of notification URIs batched in a single notification request If the number of notification URIs accumulated in specified send_interval exceeds max_send_uri_count, then multiple notification requests (each with max_send_uri_count or less number of notification URIs) will be sent to this NotificationWatcher. The default value is 5000.	integer	Minimum: 1 Maximum: 5000 Default: "5000"
method	Type of method notification requests should be made on the server Type of method notification requests should be made on the specified server. The value must be set to POST.	string	Required Enum: POST
port	Integer port value to specify a non-standard HTTP or HTTPS port Optional integer port value to specify a non-standard HTTP or HTTPS port.	integer	Minimum: 0 Maximum: 65535
resource_type	Must be set to the value NotificationWatcher	string
send_interval	Optional time interval for which notification URIs will be accumulated Optional time interval (in seconds) for which notification URIs will be accumulated. At the end of the time interval the accumulated notification URIs will be sent to this NotificationWatcher in the form of zero (nothing accumulated) or more notification requests as soon as possible. If it is not specified, the NotificationWatcher should expected to receive notifications at any time.	integer	Minimum: 30
send_timeout	Optional time period within which response for a notification request should be received from this NotificationWatcher Optional time duration (in seconds) to specify request timeout to notification watcher. If the send reaches the timeout, will try to send refresh_needed as true in the next time interval. The default value is 30 seconds.	integer	Minimum: 1 Default: "30"
server	IP address or fully qualified domain name of watcher IP address or fully qualified domain name of the partner/customer watcher.	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
uri	URI notification requests should be made on the server URI notification requests should be made on the specified server.	string	Required
use_https	Flag to indicate if REST API server should use HTTPS Optional field, when set to true indicates REST API server should use HTTPS.	boolean	Default: "False"

Example Response:

{ "id": "daabc688-3a90-4545-9af8-23e1b045e6f3", "server": "10.0.0.1", "use_https": false, "method": "POST", "uri": "/nsx-notifications", "authentication_scheme": { "scheme_name": "BASIC_AUTH", "username": "nsx_notification_user" } }

NSX-T Data Center REST API

Returns notification watcher by watcher id.

Request:

Example Request:

Successful Response:

NotificationWatcher (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: