[{"label":"Latest (6.4.0)","version":"latest"}]
vrealize-network-insight-api

Update Subscriber

Description

Update subscription to receive data related to a ‘message group’ from ‘Databus’. Receiver url of the subscription can be updated. Message group cannot be updated after creation of the subscription. If there is a requirement to change the message group, a new subscription can be created after deleting the subscription.

Request

Request

URL

URL


put
https://vrni.example.com/api/ni/settings/databus/subscribers/{subscriptionId}
Copy

Path Parameters

Path Parameters

string
subscriptionId Required

ID of the subscription as returned in GET / POST subscription API response


Request Body

Request Body

DatabusSubscriber of type(s) application/json Required

Databus Subscriber Request

{
	"id": "9c488c91-692e-4992-a83f-ee33a0f9a6c6",
	"message_group": "problems",
	"url": "https://data-pipeline.vmware.com/vrni/events"
}
string
id Optional

unique id assigned for the receiver by vRNI. This is not required while creating the subscription


string
message_group Optional

Message-group name for receiving the data from. Message group of a subscription cannot be changed after creation.


string
url Optional

URL where the data will be posted to. All the messages from the message group will be posted to this url. If multiple receivers are present behind a load balancer, this can be the url of the load balancer. The url of the subscription can be changed after the creation of the subscription.

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK returns DatabusSubscriber of type(s) application/json
{
	"id": "9c488c91-692e-4992-a83f-ee33a0f9a6c6",
	"message_group": "problems",
	"url": "https://data-pipeline.vmware.com/vrni/events"
}
string
id Optional

unique id assigned for the receiver by vRNI. This is not required while creating the subscription


string
message_group Optional

Message-group name for receiving the data from. Message group of a subscription cannot be changed after creation.


string
url Optional

URL where the data will be posted to. All the messages from the message group will be posted to this url. If multiple receivers are present behind a load balancer, this can be the url of the load balancer. The url of the subscription can be changed after the creation of the subscription.

Errors

Errors

400

Bad Request


401

Unauthorized


403

Forbidden


500

Internal Error

Code Samples

Code Samples

cURL Command

curl -X PUT -H "Content-Type: application/json" -d '{"id":"9c488c91-692e-4992-a83f-ee33a0f9a6c6","message_group":"problems","url":"https://data-pipeline.vmware.com/vrni/events"}' https://vrni.example.com/api/ni/settings/databus/subscribers/{subscriptionId}


[{"label":"Latest (6.4.0)","version":"latest"}]
vrealize-network-insight-api
Settings Operations
Feedback

Was this page helpful?