APaptible
Vhosts

list vhosts

Changed on

Returns a paginated list of vhosts belonging to the specified service.

get/services/{service_id}/vhosts

Request

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

Path parameters

service_idinteger required

service_id

Query parameters

pageinteger

Current page of paginated results

per_pageinteger

Number of results to return per page

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

total_countinteger required
per_pageinteger required
current_pageinteger required

Changes

  • 1dc1e5b8c6ebRevision changes
    • info

      added the new optional header request parameter Prefer

    • info

      added the new optional query request parameter no_embed

    • info

      added the new optional query request parameter per_page

  • 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