Skip to content

GET API Endpoints Stats for Namespace.

POST
/api/ml/data/namespaces/{namespace}/api_endpoints/stats
curl --request POST \
--url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/ml/data/namespaces/example/api_endpoints/stats \
--header 'Authorization: <Authorization>' \
--header 'Content-Type: application/json' \
--data '{ "namespace": "example", "vhosts_filter": [ "example" ], "vhosts_types_filter": [ "VIRTUAL_SERVICE" ] }'

GET API endpoints stats for the given Namespace.

Examples of this operation.

namespace
required
string

Namespace Namespace of the App type for current request.

Media typeapplication/json
Api Endpoints stats request

Request shape for GET API Endpoints Stats.

object
namespace
Namespace

Namespace of the App type for current request.

string
>= 6 characters <= 1024 characters
vhosts_filter
List Of Virtual Hosts Name

List of Virtual Hosts for current request If the list is empty or not provided, it will return stats for all virtual hosts under the requested namespace.

Array<string>
vhosts_types_filter
Virtual Hosts Types Filter

List of Virtual Hosts types for current request If the list is empty or not provided, it will return stats for all virtual hosts under the requested namespace.

Array<string>
Allowed values: VIRTUAL_SERVICE HTTP_LOAD_BALANCER API_GATEWAY TCP_LOAD_BALANCER PROXY CDN_LOAD_BALANCER NGINX_SERVER UDP_LOAD_BALANCER

A successful response.

Media typeapplication/json
Api Endpoints stats Response

Response shape for GET API endpoints Stats.

object
discovered
number of discovered endpoints

Number of endpoints that categorized as discover.

integer format: int32
inventory
number of inventory endpoints

Number of endpoints that categorized as inventory.

integer format: int32
pii_detected
number of pii endpoints

Number of endpoints that detected with pii.

integer format: int32
shadow
number of shadow endpoints

Number of endpoints that categorized as shadow.

integer format: int32
total_endpoints
number of endpoints

Total endpoints.

integer format: int32
Examplegenerated
{
"discovered": 1,
"inventory": 1,
"pii_detected": 1,
"shadow": 1,
"total_endpoints": 1
}

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