List countries.

GET

/api/web/custom/countries/{prefix}

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

• F5 Distributed Cloud Console

Returns a list of supported countries along with with additional information such as address validation rules.

Examples of this operation.

Authorizations

• ApiToken

Parameters

Path Parameters

prefix

required

string

Prefix first two or more characters of the country you look for (can be upper or lower case)

Responses

200

A successful response.

Media typeapplication/json

Country list response

ListCountriesResponse contains a list of countries supported by the platform.

object

countries

available countries

List of all countries supported by the platform.

Array<object>

Country item

CountryItem contains a single element of country list response.

object

additional_info

additional information

Any additional information related to the country.

object

country_code

country code

X-displayName : “Country code” 2 characters country code as described in https://en.wikipedia.org/wiki/ISO_3166-1, column alpha-2

string

<= 1024 characters

country_name

country name

Name of the country in the human readable form (can be used as a description)

string

<= 1024 characters

Example^generated

{
  "countries": [
    {
      "additional_info": {},
      "country_code": "example",
      "country_name": "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