Skip to content

Generate Report Now.

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

Generate report now.

Examples of this operation.

namespace
required
string

Namespace

x-required Namespace for this request.

name
required
string

Name

x-required Name of the report config for which report has to be generated.

Media typeapplication/json
Generate Report Request

Generate report request.

object
name
Name

Name of the report config for which report has to be generated. Required: YES.

string
>= 6 characters <= 1024 characters
namespace
Namespace

Namespace for this request. Required: YES.

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

A successful response.

Media typeapplication/json
Generate Report Response

Generate report response.

object
Examplegenerated
{}

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