APaptible
Vhosts

show vhost

Changed on

Returns the details of a specific vhost by ID.

get/vhosts/{id}

Request

  • Base URL
    https://api.aptible.com
  • Auth
    API key in header Authorization

Path parameters

idinteger required

id

Query parameters

no_embedboolean

When true, omits embedded resources from the response. Also triggered when the Prefer: no_sensitive_extras=true header is present.

Headers

Prefer'no_sensitive_extras=true'

When set to no_sensitive_extras=true, omits sensitive fields and embedded resources from the response.

Response

successful

idinteger required
_typestring required
virtual_domainstring required
type'http' | 'http_proxy_protocol' | 'tcp' | 'tls' | 'grpc' required
elastic_load_balancer_namestring required
application_load_balancer_arnstring required
network_load_balancer_arnstring required
security_group_idstring required
external_hoststring required
external_http_portinteger required
external_https_portinteger required
internal_hoststring required
internal_http_portinteger required
internal_https_portinteger required
internal_health_portinteger required
docker_namestring required
created_atstring dateTime required
updated_atstring dateTime required
statusstring required
platform'alb' | 'elb' | 'nlb' required
defaultboolean required
internalboolean required
container_exposed_portsinteger[] required
host_mapped_portsinteger[] required
ip_whiteliststring[] required
user_domainstring required
acmeboolean required
acme_statusstring required
acme_dns_challenge_hoststring required
container_portinteger required
container_portsinteger[] required
sharedboolean required
shared_fingerprintstring required
load_balancing_algorithm_typestring required

Changes

  • 1dc1e5b8c6ebRevision changes
    • info

      added the new optional header request parameter Prefer

    • info

      added the new optional query request parameter no_embed

  • 5c71f4c63067Revision changes
    • warning

      added the new alb enum value to the response property for the response status

    • warning

      added the new elb enum value to the response property for the response status

    • warning

      added the new grpc enum value to the response property for the response status

    • warning

      added the new http enum value to the response property for the response status

    • warning

      added the new http_proxy_protocol enum value to the response property for the response status

    • warning

      added the new nlb enum value to the response property for the response status

    • warning

      added the new tcp enum value to the response property for the response status

    • warning

      added the new tls enum value to the response property for the response status

    • info

      added the required property to the response with the status