omegazero API documentation


Returns information for a given service ID (see: /v2/servicebroker/rootdomain).

URL Parameters

Name Type Description Required Default value
id string The service ID. yes -

Response Body

JSON Object:

Name Type Description
exists boolean Whether a service with the given ID exists. If this is false, all other properties are unset.
external boolean Whether the service is external.
ipaddrs array(string) An array of all public IPv4/6 addresses of the service. May be empty.
rdns array(string) An array of the reverse DNS names of the IP addresses in ipaddrs. Always the same length as ipaddrs.
hostsrv string The domain name of the host system the service (virtual machine) is running on.