v2

latestOpenAPI 3.0.3Apache 2.0raw.githubusercontent.com2026-07-21130282381.6 KB

APIs

Verify TCP and Kafka API hosts

Verify hosts before creating or updating a TCP or Kafka API.<br> This will check it is not already used by other APIs in the environment.<br> The result will indicate if the hosts are OK, and give the reason of the failure if they are not.

post/environments/{envId}/apis/_verify/hosts

Path parameters

envIdstring required

Id or Hrid (Human readable Id) of an environment.

Request body

apiIdstring

listenerType'HTTP' | 'SUBSCRIPTION' | 'TCP' | 'KAFKA'

Listener type.

hostsstring[] required

Example request

{
  "listenerType": "HTTP",
  "hosts": [
    "foo.example.com"
  ]
}

Response

Result of the API hosts verification

okboolean

Indicates whether the hosts are valid.

reasonstring

An optional reason giving details about the result.