Skip to content

Evaluate API Group.

POST
/api/ml/data/namespaces/{namespace}/app_api_groups/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/app_api_groups/stats \
--header 'Authorization: <Authorization>' \
--header 'Content-Type: application/json' \
--data '{ "namespace": "example" }'

Check if there are any changes happened to the API Groups, and return number of API Endpoints updated for each API Group.

Examples of this operation.

namespace
required
string

Namespace Namespace of the API Group for the current request.

Media typeapplication/json
API Groups Stats Request

Request shape for API Groups Stats.

object
namespace
Namespace

Namespace of the API Group for the current request.

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

A successful response.

Media typeapplication/json
API Groups Stats Response

Response for the API Groups Stats request.

object
items
items

A list of API Groups stats, where each item contains an API Group ID and stats.

Array<object>
API Groups Stats Item

API Groups Stats Item.

object
id
object
name
Name

Name of the API Group.

string
>= 6 characters <= 1024 characters
namespace
Namespace

Namespace of the API Group.

string
>= 6 characters <= 1024 characters
stats
object
outdated_api_endpoints_count
outdated_api_endpoints_count

Number of outdated API Endpoints is the difference in the stored API Group contents and the contents if it be evaluated against current state.

integer format: int64
Examplegenerated
{
"items": [
{
"id": {
"name": "example",
"namespace": "example"
},
"stats": {
"outdated_api_endpoints_count": 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