Skip to content

List reports.

POST
/api/infraprotect/namespaces/{namespace}/infraprotect/reports
curl --request POST \
--url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/infraprotect/namespaces/example/infraprotect/reports \
--header 'Authorization: <Authorization>' \
--header 'Content-Type: application/json' \
--data '{ "end_time": "2026-04-15T12:00:00Z", "namespace": "example", "start_time": "2026-04-15T12:00:00Z" }'

Returns a list of available reports to be downloaded. Reports summarise an event or a mitigation in a single PDF document.

Examples of this operation.

namespace
required
string

Namespace This request is supported only in system namespace.

Media typeapplication/json
Reports request

Request to GET a list of available reports.

object
end_time
End time

End time of metric collection from which data will be considered to build graph. Format: RFC3339 string

Optional: If not specified, then the end_time will be evaluated to

string format: date-time
<= 1024 characters
namespace
Namespace

This request is supported only in system namespace.

string
>= 6 characters <= 1024 characters
start_time
Start time

Start time of metric collection from which data will be considered to build graph. Format: RFC3339 string

Optional: If not specified, then the start_time will be evaluated to -3d.

string format: date-time
<= 1024 characters
Examplegenerated
{
"end_time": "2026-04-15T12:00:00Z",
"namespace": "example",
"start_time": "2026-04-15T12:00:00Z"
}

A successful response.

Media typeapplication/json
Reports response

List of available reports.

object
reports
Reports

List of reports available to the tenant.

Array<object>
Report record

A single DDoS report record.

object
created_at
Created date

RFC3339 string of the creation date.

string format: date-time
<= 1024 characters
gos_name
Storage name

Name of the report.

string
<= 1024 characters
id
Report ID

ID of the report.

string
>= 1 <= 4094 <= 1024 characters
name
Report name

Name of the report.

string
>= 6 characters <= 1024 characters
scheduled
Scheduled flag

True if the report is scheduled.

boolean format: boolean
scheduled_name
Scheduled name

Full name, including the date part. Optional, only present if scheduled is set to true.

string
<= 1024 characters
type
Report type

Type of the report.

string
<= 1024 characters
version
Storage version

Document version assigned by generic object store.

string
>= 1 characters <= 1024 characters
Examplegenerated
{
"reports": [
{
"created_at": "2026-04-15T12:00:00Z",
"gos_name": "example",
"id": "example",
"name": "example",
"scheduled": true,
"scheduled_name": "example",
"type": "example",
"version": "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