---
title: "list vhosts"
method: GET
path: "/apps/{app_id}/vhosts"
tags: ["Vhosts"]
---

# list vhosts

`GET /apps/{app_id}/vhosts`

## Request

- Base URL: `https://api.aptible.com`
- URL: `https://api.aptible.com/apps/{app_id}/vhosts`
- Auth: API key in header `Authorization`

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

## Path parameters

- `app_id` integer, required

## Query parameters

- `page` integer
- `per_page` integer
- `no_embed` boolean

## Headers

- `Prefer` 'no_sensitive_extras=true'

## Response `200`

successful

- ListVhostsForAccount200Response
  - `_embedded` ListVhostsForAccount200ResponseEmbedded, required
    - `vhosts` Vhost[]
      - `id` integer, required
      - `_type` string, required
      - `virtual_domain` string, required
      - `type` 'http' | 'http_proxy_protocol' | 'tcp' | 'tls' | 'grpc', required
      - `elastic_load_balancer_name` string, required
      - `application_load_balancer_arn` string, required
      - `network_load_balancer_arn` string, required
      - `security_group_id` string, required
      - `external_host` string, required
      - `external_http_port` integer, required
      - `external_https_port` integer, required
      - `internal_host` string, required
      - `internal_http_port` integer, required
      - `internal_https_port` integer, required
      - `internal_health_port` integer, required
      - `docker_name` string, required
      - `created_at` string, dateTime, required
      - `updated_at` string, dateTime, required
      - `status` string, required
      - `platform` 'alb' | 'elb' | 'nlb', required
      - `default` boolean, required
      - `internal` boolean, required
      - `container_exposed_ports` integer[], required
      - `host_mapped_ports` integer[], required
      - `ip_whitelist` string[], required
      - `user_domain` string, required
      - `acme` boolean, required
      - `acme_status` string, required
      - `acme_dns_challenge_host` string, required
      - `container_port` integer, required
      - `container_ports` integer[], required
      - `acme_configuration` VhostAcmeConfiguration, required
        - `names` string[]
        - `challenges` VhostAcmeConfigurationChallengesInner[]
          - `method` 'http01' | 'dns01'
          - `from` VhostAcmeConfigurationChallengesInnerFrom
            - `name` string
          - `to` VhostAcmeConfigurationChallengesInnerToInner[]
            - `name` string
            - `legacy` boolean
      - `shared` boolean, required
      - `shared_fingerprint` string, required
      - `load_balancing_algorithm_type` string, required
      - `_links` VhostLinks
        - `service` ListAccountsForStack200ResponseLinksStack
          - `href` string, uri
        - `certificate` ListAccountsForStack200ResponseLinksStack
          - `href` string, uri
        - `operations` ListAccountsForStack200ResponseLinksStack
          - `href` string, uri
        - `settings` ListAccountsForStack200ResponseLinksStack
          - `href` string, uri
        - `current_setting` ListAccountsForStack200ResponseLinksStack
          - `href` string, uri
        - `self` ListAccountsForStack200ResponseLinksStack
          - `href` string, uri
  - `total_count` integer, required
  - `per_page` integer, required
  - `current_page` integer, required
  - `_links` ListVhostsForAccount200ResponseLinks, required
    - `app` ListAccountsForStack200ResponseLinksStack
      - `href` string, uri
    - `service` ListAccountsForStack200ResponseLinksStack
      - `href` string, uri
    - `next` ListAccountsForStack200ResponseLinksStack
      - `href` string, uri
    - `prev` ListAccountsForStack200ResponseLinksStack
      - `href` string, uri
    - `self` ListAccountsForStack200ResponseLinksStack
      - `href` string, uri

## Other responses

- `default`: Error response. Often a 4xx or 5xx status code

## Changes

- **2026-07-24** `1dc1e5b8c6eb`: 3 info
  - added the new optional `header` request parameter `Prefer`
  - added the new optional `query` request parameter `no_embed`
  - added the new optional `query` request parameter `per_page`
- **2026-07-15** `5c71f4c63067`: 8 warning, 1 info
  - added the new `alb` enum value to the `_embedded/vhosts/items/platform` response property for the response status `200`
  - added the new `elb` enum value to the `_embedded/vhosts/items/platform` response property for the response status `200`
  - added the new `grpc` enum value to the `_embedded/vhosts/items/type` response property for the response status `200`
  - added the new `http` enum value to the `_embedded/vhosts/items/type` response property for the response status `200`
  - …5 more
- **2025-11-14** `a0af32b45330`: 2 info
  - added the optional property `_embedded/vhosts/items/_links/current_setting` to the response with the `200` status
  - added the optional property `_embedded/vhosts/items/_links/settings` to the response with the `200` status
- **2025-07-15** `e8d113b83937`: 1 info
  - added the required property `_embedded/vhosts/items/load_balancing_algorithm_type` to the response with the `200` status
- **2025-05-28** `5762db6dcf07`: 2 info
  - added the required property `_embedded/vhosts/items/shared` to the response with the `200` status
  - added the required property `_embedded/vhosts/items/shared_fingerprint` to the response with the `200` status

[Operation history](https://skmtc.dev/aptible/apis/aptible-api-v1/changes/apps/:app_id/vhosts/get.md)

---

[API](https://skmtc.dev/aptible/apis/aptible-api-v1.md) - [All operations](https://skmtc.dev/aptible/apis/aptible-api-v1/llms.txt) - [OpenAPI document](https://skmtc.dev/aptible/apis/aptible-api-v1/revisions/a21f6b1bc6fe?raw)