Skip to content

Update Status of Receiver.

POST
/api/data-intelligence/namespaces/{namespace}/receivers/{id}/status
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/status \
--header 'Authorization: <Authorization>' \
--header 'Content-Type: application/json' \
--data '{ "id": "example", "namespace": "example", "type": "DISABLE" }'

Update receiver object status from enable to disable and vice versa.

Examples of this operation.

namespace
required
string

Namespace Namespace in which the suggestions are scoped.

id
required
string

ID Receiver Name.

Media typeapplication/json
UpdateReceiverStatusRequest

Request to update.

object
id
id

Receiver Name.

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

Namespace in which the suggestions are scoped.

string
>= 6 characters <= 1024 characters
type
string
default: DISABLE
Allowed values: DISABLE ENABLE

A successful response.

Media typeapplication/json
UpdateReceiverStatusResponse

Payload about status of receiver status result.

object
id
id

ID of the receiver.

string
>= 1 <= 4094 <= 1024 characters
receiver_name
receiver_name

Name of the receiver configured by the customer.

string
<= 1024 characters
status
status

Values: not_modified , success Status about receiver status modification.

string
>= 17 characters <= 1024 characters
Examplegenerated
{
"id": "example",
"receiver_name": "example",
"status": "example"
}

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