Summary

GET

/api/config/tenants/{tenant}/summary

curl --request GET \
  --url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/config/tenants/example/summary \
  --header 'Authorization: <Authorization>'

• F5 Distributed Cloud Console

This API returns tenant summary.

Examples of this operation.

Authorizations

• ApiToken

Parameters

Path Parameters

tenant

required

string

Tenant ID

Tenant ID.

Responses

200

A successful response.

Media typeapplication/json

SummaryResponse

Tenant Summary Response.

object

type

Type

Default VIP Type (dedicated/shared)

string

<= 1024 characters

vip

VIP

Default VIP.

string

<= 1024 characters

Example^generated

{
  "type": "example",
  "vip": "example"
}

401

Returned when operation is not authorized.

Media typeapplication/json

string format: string

Example^generated

example

403

Returned when there is no permission to access resource.

Media typeapplication/json

string format: string

Example^generated

example

404

Returned when resource is not found.

Media typeapplication/json

string format: string

Example^generated

example

409

Returned when operation on resource is conflicting with current value.

Media typeapplication/json

string format: string

Example^generated

example

429

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

Media typeapplication/json

string format: string

Example^generated

example

500

Returned when server encountered an error in processing API.

Media typeapplication/json

string format: string

Example^generated

example

503

Returned when service is unavailable temporarily.

Media typeapplication/json

string format: string

Example^generated

example

504

Returned when server timed out processing request.

Media typeapplication/json

string format: string

Example^generated

example