Skip to content

Test Receiver.

POST
/api/data-intelligence/namespaces/{namespace}/receivers/{id}/test
curl --request POST \
--url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/data-intelligence/namespaces/example/receivers/example/test \
--header 'Authorization: <Authorization>' \
--header 'Content-Type: application/json' \
--data '{ "id": "example", "namespace": "example" }'

API to test receiver destination sink connection.

Examples of this operation.

namespace
required
string

Namespace

x-required Namespace in which the receiver is configured.

id
required
string

ID Receiver Name.

Media typeapplication/json
Test Receiver Request

Request to test receiver & destination sink.

object
id
id

Receiver Name.

string
>= 1 <= 4094 <= 1024 characters
namespace
Namespace

Namespace in which the receiver is configured Required: YES.

string
>= 6 characters <= 1024 characters
Examplegenerated
{
"id": "example",
"namespace": "example"
}

A successful response.

Media typeapplication/json
Test Receiver Response

Response for the Receiver test request; empty because the only returned information is error message.

object
message
message

The error string if the status is failed.

string
<= 1024 characters
status
string
default: SUCCESS
Allowed values: SUCCESS FAILED
Example
{
"status": "SUCCESS"
}

Returned when operation is not authorized.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when there is no permission to access resource.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when resource is not found.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when operation on resource is conflicting with current value.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when operation has been rejected as it is happening too frequently.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when server encountered an error in processing API.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when service is unavailable temporarily.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when server timed out processing request.

Media typeapplication/json
string format: string
Examplegenerated
example