Skip to content

Lookup cname.

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

Checks if a cname is available.

Examples of this operation.

cname
string

Cname to look-uo.

namespace
string

Namespace to query.

A successful response.

Media typeapplication/json

LookupCnameResponse sets the response format based on the availability of cname.

It can return any of these three types of errors. EEXISTS => cname exists. EOK => valid request. However, cname does not exist. EUNKNOWN => internal error in fetching tenants info.

object
Examplegenerated
{}

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