GET Report.

GET

/api/report/namespaces/{namespace}/reports/{name}

const url = 'https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/report/namespaces/example/reports/example?response_format=GET_RSP_FORMAT_DEFAULT';
const options = {method: 'GET', headers: {Authorization: '<Authorization>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/report/namespaces/example/reports/example?response_format=GET_RSP_FORMAT_DEFAULT' \
  --header 'Authorization: <Authorization>'

GET Report will read the report metadata.

Examples of this operation.

Authorizations

ApiToken

Parameters

Path Parameters

namespace

required

string

Namespace The namespace in which the configuration object is present.

name

required

string

Name The name of the configuration object to be fetched.

Query Parameters

response_format

string

default: GET_RSP_FORMAT_DEFAULT

Allowed values: GET_RSP_FORMAT_DEFAULT GET_RSP_FORMAT_READ GET_RSP_FORMAT_REFERRING_OBJECTS GET_RSP_FORMAT_BROKEN_REFERENCES

The format in which the configuration object is to be fetched. This could be for example

in GetSpec form for the contents of object
in CreateRequest form to create a new similar object
to ReplaceRequest form to replace changeable values

Default format of returned resource Response should be in format of GetSpecType Response should have other objects referring to this object Response should have deleted and disabled objects referrred by this object.

Responses

200

A successful response.

application/json

GetResponse is the shape of a read report

This is the output message of the ‘GET’ RPC.

object

deleted_referred_objects

deleted_referred_objects

The set of deleted objects that are referred by this object.

Array<object>

ObjectRefType

This type establishes a ‘direct reference’ from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name for public API and Uid for private API This type of reference is called direct because the relation is explicit and concrete (as opposed to selector reference which builds a group based on labels of selectee objects)

object

kind

kind

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. “route”)

string

>= 12 characters <= 1024 characters

name

name

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.

string

>= 6 characters <= 1024 characters

namespace

namespace

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.

string

>= 6 characters <= 1024 characters

tenant

tenant

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.

string

>= 6 characters <= 1024 characters

uid

uid

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid.

string format: uuid

>= 36 characters <= 1024 characters

disabled_referred_objects

disabled_referred_objects

The set of deleted objects that are referred by this object.

Array<object>

ObjectRefType

object

kind

kind

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. “route”)

string

>= 12 characters <= 1024 characters

name

name

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.

string

>= 6 characters <= 1024 characters

namespace

namespace

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.

string

>= 6 characters <= 1024 characters

tenant

tenant

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.

string

>= 6 characters <= 1024 characters

uid

uid

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid.

string format: uuid

>= 36 characters <= 1024 characters

metadata

object

annotations

annotations

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.

object

description

description

Human readable description for the object.

string

>= 21 characters <= 1200 characters

disable

disable

A value of true will administratively disable the object.

boolean format: boolean

labels

labels

Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user. Values specified here will be used by selector expression.

object

name

name

This is the name of configuration object. It has to be unique within the namespace. It can only be specified during create API and cannot be changed during replace API. The value of name has to follow DNS-1035 format. Required: YES.

string

>= 6 characters <= 1024 characters

namespace

namespace

This defines the workspace within which each the configuration object is to be created. Must be a DNS_LABEL format. For a namespace object itself, namespace value will be ""

string

>= 6 characters <= 1024 characters

referring_objects

referring_objects

The set of objects that are referring to this object in their spec.

Array<object>

ObjectRefType

object

kind

kind

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. “route”)

string

>= 12 characters <= 1024 characters

name

name

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.

string

>= 6 characters <= 1024 characters

namespace

namespace

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.

string

>= 6 characters <= 1024 characters

tenant

tenant

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.

string

>= 6 characters <= 1024 characters

uid

uid

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid.

string format: uuid

>= 36 characters <= 1024 characters

spec

object

atb

object

json_data

JSON data containing details like the number of malicious bots detected in the given timerange

Json_data Required: YES.

string

<= 1024 characters

report_config

object

name

name

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.

string

>= 1 characters <= 128 characters

namespace

namespace

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.

string

>= 6 characters <= 64 characters

tenant

tenant

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.

string

>= 6 characters <= 64 characters

report_creator_method

string

default: REPORT_CREATE_METHOD_NONE

Allowed values: REPORT_CREATE_METHOD_NONE REPORT_CREATE_METHOD_PERIODIC REPORT_CREATE_METHOD_USER_TRIGGERED

report_delivery_status

object

delivered_time

report delivered time

Delivery time.

string format: date-time

<= 1024 characters

eta

estimated time at which the report delivery would be complete

Estimated time.

string format: date-time

<= 1024 characters

report_delivery_state

string

default: REPORT_DELIVERY_STATE_NONE

Allowed values: REPORT_DELIVERY_STATE_NONE REPORT_DELIVERY_STATE_SUCCESS REPORT_DELIVERY_STATE_ERROR REPORT_DELIVERY_STATE_PARTIAL REPORT_DELIVERY_STATE_PENDING REPORT_DELIVERY_STATE_DOWNLOAD

report_frequency

Report frequency Required: YES.

string

<= 1024 characters

report_generation_status

object

eta

estimated time at which the report generation would be complete

Estimated time.

string format: date-time

<= 1024 characters

report_status

string

default: NONE

Allowed values: NONE SUCCESS ERROR PENDING PAUSED PARTIAL

scheduled_time

report scheduled time

Scheduled time.

string format: date-time

<= 1024 characters

generated_time

report generated time

Generated time.

string format: date-time

<= 1024 characters

report_id

Unique identifier for this resource

string format: uint64

<= 1024 characters

report_status

string

default: NONE

Allowed values: NONE SUCCESS ERROR PENDING PAUSED PARTIAL

sent_time

Sent time Required: YES.

string format: date-time

<= 1024 characters

waap

object

attack_impact

object

data

attack impact data

Attack impact data Required: YES.

Array<object>

AttackImpactData

Key value pair of attack impact data.

object

key

string

default: ATTACK_IMPACT_KEY_NONE

Allowed values: ATTACK_IMPACT_KEY_NONE ATTACK_IMPACT_KEY_TOP_3_ATTACKED_PATHS ATTACK_IMPACT_KEY_TOP_3_ATTACKED_DOMAINS

value

object

data

field data list

Waap report data field list Required: YES.

Array<object>

Waap Report Field Data

Waap report field data.

object

current_value

field current value

Field current value Required: YES.

number format: double

current_value_header

field value header

Field value header.

string

<= 1024 characters

current_value_sub_values

field value sub values

Field sub values.

object

current_value_type

string

default: TYPE_NONE

Allowed values: TYPE_NONE TYPE_RATE TYPE_PERCENT TYPE_THROUGHPUT TYPE_NUMBER

prev_value

field previous value

Field previous value, type will be same as current_value_type.

number format: double

prev_value_header

field previous value header

Field previous value header.

string

<= 1024 characters

trend_value

object

description

Description

Description of the method used to calculate trend.

string

>= 21 characters <= 1024 characters

previous_value

Previous Value

Configuration parameter for previous value

string

<= 1024 characters

sentiment

string

default: TREND_SENTIMENT_NONE

Allowed values: TREND_SENTIMENT_NONE TREND_SENTIMENT_POSITIVE TREND_SENTIMENT_NEGATIVE

value

Value

Configuration parameter for value

string

>= 3 characters <= 1024 characters

header

header

Header Required: YES.

string

<= 1024 characters

attack_sources

object

data

Attack Sources data

Attack Sources data Required: YES.

Array<object>

AttackSourcesData

Key value pair of attack sources data.

object

key

string

default: ATTACK_SOURCES_KEY_NONE

Allowed values: ATTACK_SOURCES_KEY_NONE ATTACK_SOURCES_KEY_TOP_3_ASNS ATTACK_SOURCES_KEY_TOP_3_COUNTRIES

value

object

data

field data list

Waap report data field list Required: YES.

Array<object>

Waap Report Field Data

Waap report field data.

object

current_value

field current value

Field current value Required: YES.

number format: double

current_value_header

field value header

Field value header.

string

<= 1024 characters

current_value_sub_values

field value sub values

Field sub values.

object

current_value_type

string

default: TYPE_NONE

Allowed values: TYPE_NONE TYPE_RATE TYPE_PERCENT TYPE_THROUGHPUT TYPE_NUMBER

prev_value

field previous value

Field previous value, type will be same as current_value_type.

number format: double

prev_value_header

field previous value header

Field previous value header.

string

<= 1024 characters

trend_value

object

description

Description

Description of the method used to calculate trend.

string

>= 21 characters <= 1024 characters

previous_value

Previous Value

Configuration parameter for previous value

string

<= 1024 characters

sentiment

string

default: TREND_SENTIMENT_NONE

Allowed values: TREND_SENTIMENT_NONE TREND_SENTIMENT_POSITIVE TREND_SENTIMENT_NEGATIVE

value

Value

Configuration parameter for value

string

>= 3 characters <= 1024 characters

header

header

Header Required: YES.

string

<= 1024 characters

lb_count

object

protected_lb_count

LB count protectd by waap

LB protected by waap Required: YES.

string format: uint64

<= 1024 characters

total_lb_count

total LB count

Total LB count Required: YES.

string format: uint64

<= 1024 characters

report_footer

object

report_header

object

end_time

report end time

End time of the report data Required: YES.

string

<= 1024 characters

generation_time

report generation time

Report generation time Required: YES.

string

<= 1024 characters

namespace

namespace

Namespace of the report data Required: YES.

string

>= 6 characters <= 1024 characters

report_frequency

string

default: REPORT_FREQUENCY_NONE

Allowed values: REPORT_FREQUENCY_NONE REPORT_FREQUENCY_DAILY REPORT_FREQUENCY_WEEKLY REPORT_FREQUENCY_MONTHLY

report_sub_title

sub title of the report

Report sub title Required: YES.

string

<= 1024 characters

report_title

title of the report

Report title Required: YES.

string

<= 1024 characters

start_time

report start time

Start time of the report data Required: YES.

string

<= 1024 characters

tenant_fqdn

tenant fqdn

X-displayName “Tenant” Tenant to which this object belongs. Required: YES.

string

<= 1024 characters

security_events

object

data

Security events data

Security events breakdown data Required: YES.

Array<object>

SecurityEventsData

Security events breakdown data.

object

key

string

default: SECURITY_EVENTS_KEY_NONE

Allowed values: SECURITY_EVENTS_KEY_NONE SECURITY_EVENTS_KEY_TOTAL_SECURITY_EVENTS SECURITY_EVENTS_KEY_WAF_SECURITY_EVENTS SECURITY_EVENTS_KEY_BOT_DEFENSE_SECURITY_EVENTS SECURITY_EVENTS_KEY_API_SECURITY_EVENTS SECURITY_EVENTS_KEY_SERVICE_POLICY_SECURITY_EVENTS SECURITY_EVENTS_KEY_WAF_SECURITY_EVENTS_ALLOWED SECURITY_EVENTS_KEY_WAF_SECURITY_EVENTS_BLOCKED SECURITY_EVENTS_KEY_BOT_DEFENSE_SECURITY_EVENTS_ALLOWED SECURITY_EVENTS_KEY_BOT_DEFENSE_SECURITY_EVENTS_BLOCKED SECURITY_EVENTS_KEY_API_SECURITY_EVENTS_ALLOWED SECURITY_EVENTS_KEY_API_SECURITY_EVENTS_BLOCKED SECURITY_EVENTS_KEY_SERVICE_POLICY_SECURITY_EVENTS_ALLOWED SECURITY_EVENTS_KEY_SERVICE_POLICY_SECURITY_EVENTS_BLOCKED

value

object

current_value

field current value

Field current value Required: YES.

number format: double

current_value_header

field value header

Field value header.

string

<= 1024 characters

current_value_sub_values

field value sub values

Field sub values.

object

current_value_type

string

default: TYPE_NONE

Allowed values: TYPE_NONE TYPE_RATE TYPE_PERCENT TYPE_THROUGHPUT TYPE_NUMBER

prev_value

field previous value

Field previous value, type will be same as current_value_type.

number format: double

prev_value_header

field previous value header

Field previous value header.

string

<= 1024 characters

trend_value

object

description

Description

Description of the method used to calculate trend.

string

>= 21 characters <= 1024 characters

previous_value

Previous Value

Configuration parameter for previous value

string

<= 1024 characters

sentiment

string

default: TREND_SENTIMENT_NONE

Allowed values: TREND_SENTIMENT_NONE TREND_SENTIMENT_POSITIVE TREND_SENTIMENT_NEGATIVE

value

Value

Configuration parameter for value

string

>= 3 characters <= 1024 characters

header

header

Security events header Required: YES.

string

<= 1024 characters

threat_details

object

data

Threat details data

Threat details data. Required: YES.

Array<object>

ThreatDetailsData

Key value pair threat details data.

object

key

string

default: THREAT_DETAILS_KEY_NONE

Allowed values: THREAT_DETAILS_KEY_NONE THREAT_DETAILS_KEY_ALL_TRAFFIC_IS_FROM_BOTS THREAT_DETAILS_KEY_ALL_TRAFFIC_FROM_MALICIOUS_BOTS THREAT_DETAILS_KEY_THREAT_CAMPAIGNS THREAT_DETAILS_KEY_IP_REPUTATION_ATTACK_MITIGATED THREAT_DETAILS_KEY_LB_DDOS_ATTACK_ACTIVITY THREAT_DETAILS_KEY_MALICIOUS_USERS_DETECTED THREAT_DETAILS_KEY_API_ENDPOINTS THREAT_DETAILS_KEY_API_ENDPOINTS_PII_DETECTED THREAT_DETAILS_KEY_API_ENDPOINTS_PII_NOT_DETECTED THREAT_DETAILS_KEY_THREAT_CAMPAIGNS_ALLOWED THREAT_DETAILS_KEY_THREAT_CAMPAIGNS_BLOCKED THREAT_DETAILS_KEY_IP_REPUTATION_ALLOWED THREAT_DETAILS_KEY_IP_REPUTATION_BLOCKED

value

object

current_value

field current value

Field current value Required: YES.

number format: double

current_value_header

field value header

Field value header.

string

<= 1024 characters

current_value_sub_values

field value sub values

Field sub values.

object

current_value_type

string

default: TYPE_NONE

Allowed values: TYPE_NONE TYPE_RATE TYPE_PERCENT TYPE_THROUGHPUT TYPE_NUMBER

prev_value

field previous value

Field previous value, type will be same as current_value_type.

number format: double

prev_value_header

field previous value header

Field previous value header.

string

<= 1024 characters

trend_value

object

description

Description

Description of the method used to calculate trend.

string

>= 21 characters <= 1024 characters

previous_value

Previous Value

Configuration parameter for previous value

string

<= 1024 characters

sentiment

string

default: TREND_SENTIMENT_NONE

Allowed values: TREND_SENTIMENT_NONE TREND_SENTIMENT_POSITIVE TREND_SENTIMENT_NEGATIVE

value

Value

Configuration parameter for value

string

>= 3 characters <= 1024 characters

header

header

Header Required: YES.

string

<= 1024 characters

system_metadata

object

creation_timestamp

creation_timestamp

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

string format: date-time

<= 1024 characters

creator_class

creator_class

A value identifying the class of the user or service which created this configuration object.

string

<= 1024 characters

creator_id

creator_id

A value identifying the exact user or service that created this configuration object.

string

<= 1024 characters

deletion_timestamp

deletion_timestamp

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

Populated by the system when a graceful deletion is requested. Read-only.

string format: date-time

<= 1024 characters

finalizers

finalizers

Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed.

Array<string>

initializers

object

pending

pending

Pending is a list of initializers that must execute in order before this object is initialized. When the last pending initializer is removed, and no failing result is set, the initializers struct will be set to nil and the object is considered as initialized and visible to all clients.

Array<object>

InitializerType

Initializer is information about an initializer that has not yet completed.

object

name

name

Name of the service that is responsible for initializing this object.

string

>= 6 characters <= 1024 characters

result

object

code

code

Suggested HTTP return code for this status, 0 if not set.

integer format: int32

reason

reason

A human-readable description of why this operation is in the “Failure” status. If this value is empty there is no information available.

string

>= 27 characters <= 1024 characters

status

status

Status of the operation. One of: “Success” or “Failure”.

string

>= 17 characters <= 1024 characters

labels

labels

Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the operator or software. Values here can be interpreted by software(backend or frontend) to enable certain behavior e.g. Things marked as soft-deleted(restorable).

object

modification_timestamp

modification_timestamp

ModificationTimestamp is a timestamp representing the server time when this object was last modified.

string format: date-time

<= 1024 characters

object_index

object_index

Unique index for the object. Some objects need a unique integer index to be allocated for each object type. This field will be populated for all objects that need it and will be zero otherwise.

integer format: int64

owner_view

object

kind

kind

Kind of the view object.

string

>= 12 characters <= 1024 characters

name

name

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.

string

>= 6 characters <= 1024 characters

namespace

namespace

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.

string

>= 6 characters <= 1024 characters

uid

uid

UID of the view object.

string format: uuid

>= 36 characters <= 1024 characters

tenant

tenant

Tenant to which this configuration object belongs to. The value for this is found from presented credentials.

string

>= 6 characters <= 1024 characters

uid

uid

Uid is the unique in time and space value for this object. It is generated by the server on successful creation of an object and is not allowed to change on Replace API. The value of is taken from uid field of ObjectMetaType, if provided.

string format: uuid

>= 36 characters <= 1024 characters

Example

{
  "spec": {
    "report_creator_method": "REPORT_CREATE_METHOD_NONE",
    "report_delivery_status": {
      "report_delivery_state": "REPORT_DELIVERY_STATE_NONE"
    },
    "report_generation_status": {
      "report_status": "NONE"
    },
    "report_status": "NONE",
    "waap": {
      "attack_impact": {
        "data": [
          {
            "key": "ATTACK_IMPACT_KEY_NONE",
            "value": {
              "data": [
                {
                  "current_value_type": "TYPE_NONE",
                  "trend_value": {
                    "sentiment": "TREND_SENTIMENT_NONE"
                  }
                }
              ]
            }
          }
        ]
      },
      "attack_sources": {
        "data": [
          {
            "key": "ATTACK_SOURCES_KEY_NONE",
            "value": {
              "data": [
                {
                  "current_value_type": "TYPE_NONE",
                  "trend_value": {
                    "sentiment": "TREND_SENTIMENT_NONE"
                  }
                }
              ]
            }
          }
        ]
      },
      "report_header": {
        "report_frequency": "REPORT_FREQUENCY_NONE"
      },
      "security_events": {
        "data": [
          {
            "key": "SECURITY_EVENTS_KEY_NONE",
            "value": {
              "current_value_type": "TYPE_NONE",
              "trend_value": {
                "sentiment": "TREND_SENTIMENT_NONE"
              }
            }
          }
        ]
      },
      "threat_details": {
        "data": [
          {
            "key": "THREAT_DETAILS_KEY_NONE",
            "value": {
              "current_value_type": "TYPE_NONE",
              "trend_value": {
                "sentiment": "TREND_SENTIMENT_NONE"
              }
            }
          }
        ]
      }
    }
  }
}

401

Returned when operation is not authorized.

application/json

string format: string

Example^generated

example

403

Returned when there is no permission to access resource.

application/json

string format: string

Example^generated

example

404

Returned when resource is not found.

application/json

string format: string

Example^generated

example

409

Returned when operation on resource is conflicting with current value.

application/json

string format: string

Example^generated

example

429

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

application/json

string format: string

Example^generated

example

500

Returned when server encountered an error in processing API.

application/json

string format: string

Example^generated

example

503

Returned when service is unavailable temporarily.

application/json

string format: string

Example^generated

example

504

Returned when server timed out processing request.

application/json

string format: string

Example^generated

example

GET Report.

Authorizations

Parameters

Path Parameters

Query Parameters

Responses

200

Example

401

Examplegenerated

403

Examplegenerated

404

Examplegenerated

409

Examplegenerated

429

Examplegenerated

500

Examplegenerated

503

Examplegenerated

504

Examplegenerated

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated