Get Subscriber

Retrieve a Databus subscription by specifying the ID of the subscription

Request

URI

GET

https://{api_host}/api/ni/settings/databus/subscribers/{subscriptionId}

COPY

Path Parameters

string

subscriptionId

Required

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

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",
    "filter_tags": [
        {
            "filterKey": "appName",
            "filterValue": [
                "app1",
                "app2"
            ]
        }
    ]
}

string

Optional

unique id assigned for the receiver by Operations for Networks. 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. Supported message groups - application, flows, problems, metrics, vms, hosts, nics, switchports, vms-metrics, hosts-metrics, flows-metrics, nics-metrics, switchports-metrics

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.

array of object

filter_tags

Optional

Filter tag is optional and used only for flows filtering. Please reach out to VMware support to enable filtering functionality in Databus.

400

Bad Request

Returns ApiError of type(s) application/json

"ApiError Object"

integer As int32 As int32

code

Optional

code

string

message

Optional

message

array of object

details

Optional

details

401

Unauthorized

Returns ApiError of type(s) application/json

"ApiError Object"

integer As int32 As int32

code

Optional

code

string

message

Optional

message

array of object

details

Optional

details

404

Not Found

Returns ApiError of type(s) application/json

"ApiError Object"

integer As int32 As int32

code

Optional

code

string

message

Optional

message

array of object

details

Optional

details

500

Internal Error

Operation doesn't return any data structure

Code Samples

COPY

                    curl -H 'Authorization: <value>' https://{api_host}/api/ni/settings/databus/subscribers/{subscriptionId}

On This Page

Description

Request

Path Parameters

Authentication

Response

200 Response Body

Errors

Settings Operations