Update Subscriber

Update Subscriber

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

URI

PUT

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

COPY

Path Parameters

string

subscriptionId

Required

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

Request Body

DatabusSubscriber of type(s) application/json

Optional

{
    "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

This operation uses the following authentication methods.

ApiKeyAuth

Responses

200

Success

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.

400

Bad Request

Returns ApiError of type(s) application/json

{
    "code": 0,
    "message": "string",
    "details": [
        {
            "code": 0,
            "message": "string",
            "target": [
                "string"
            ]
        }
    ]
}

integer As int32 As int32

code

Optional

code

string

message

Optional

message

array of ErrorDetail

details

Optional

details

401

Unauthorized

Returns ApiError of type(s) application/json

{
    "code": 0,
    "message": "string",
    "details": [
        {
            "code": 0,
            "message": "string",
            "target": [
                "string"
            ]
        }
    ]
}

integer As int32 As int32

code

Optional

code

string

message

Optional

message

array of ErrorDetail

details

Optional

details

403

Forbidden

Returns ApiError of type(s) application/json

{
    "code": 0,
    "message": "string",
    "details": [
        {
            "code": 0,
            "message": "string",
            "target": [
                "string"
            ]
        }
    ]
}

integer As int32 As int32

code

Optional

code

string

message

Optional

message

array of ErrorDetail

details

Optional

details

500

Internal Error

Returns ApiError of type(s) application/json

{
    "code": 0,
    "message": "string",
    "details": [
        {
            "code": 0,
            "message": "string",
            "target": [
                "string"
            ]
        }
    ]
}

integer As int32 As int32

code

Optional

code

string

message

Optional

message

array of ErrorDetail

details

Optional

details

On This Page

Request

Path Parameters

200 Response Body

Errors

Settings Operations

Activate Serial Number

Add new SNMP Trap destination profile

Add Backup Config

Add Restore Config

Add Search Based Alert Config

Add Vidm User Group

Create Subnet Mapping

Create Subscriber

Create User Defined Event

Deactivate Serial Number

Delete An existing SNMP Trap destination profile

Delete Backup Config

Delete Restore Config

Delete Search Based Alert Config

Delete Subnet Mapping

Delete Subscriber

Delete User Defined Event

Delete User Group

Delete Vidm Configuration

Delete Web Proxy

Disable Search Based Alert Config

Disable User Defined Event

Enable Search Based Alert Config

Enable User Defined Event

Get details Of An existing SNMP destination profile

Get All Search Based Alert Configs

Get All Subscriber

Get All User Defined Events

Get Backup Config

Get Backup Status Report

Get Certificate

Get Connected Clients To Web Proxy

Get Infra Nodes Web Proxy

Get Restore Config

Get Restore Status Report

Get Search Based Alert Config

Get Subnet Mappings

Get User Defined Event

Get User Groups

Get Vidm Configuration

Get Web Proxies

List the configured SNMP Trap destination profiles

Migrate event subscriptions To other SNMP Trap destination profiles

Save Vidm Configuration

Send Test trap To SNMP destination profile

Update An existing SNMP destination profile

Update user password

Update Backup Config

Update Search Based Alert Config

Update Subnet Mapping

Update Subscriber

Update User Defined Event

Update Vidm Configuration

Update Vidm User Group Role

Update Vidm User Role

Update Web Proxy

Validate Connections Via Web Proxy

Validate Serial Number

Validate Web Proxy Migration