---
title: "List previews and creation choices for one app"
method: GET
path: "/api/v1/hosting/apps/{app_id}/previews/administration_index"
tags: ["hosting"]
---

# List previews and creation choices for one app

`GET /api/v1/hosting/apps/{app_id}/previews/administration_index`

## Request

- Base URL: `https://composal.com` (the document declares no server; this is the origin it was published from)
- URL: `https://composal.com/api/v1/hosting/apps/{app_id}/previews/administration_index`
- Auth: HTTP bearer

## Path parameters

- `app_id` string, required

## Response `200`

Preview administration index

- object
  - `app` HostedApp, required
    - `id` string, required
    - `organization_id` string, required
    - `repository_id` string, required
    - `repository_kind` string, nullable, required
    - `slug` string, required
    - `name` string, required
    - `description` string, nullable, required
    - `root_path` string, required
    - `root_path_display` string, required
    - `framework` string, nullable, required
    - `status` 'draft' | 'active' | 'archived', required
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required
    - `created_at_label` string, nullable, required
    - `updated_at_label` string, nullable, required
  - `previews` PreviewEnvironmentRecord[], required
    - `id` string, required
    - `hosted_app_id` string, required
    - `app_environment_id` string, required
    - `app_preview_profile_id` string, required
    - `vcs_change_id` string, nullable
    - `created_by_user_id` union
      - string
      - integer
    - `source_revision` string, required
    - `snapshot_version` integer, required
    - `generation` integer, required
    - `access` 'org_members' | 'public', required
    - `retained` boolean, required
    - `expires_at` string, required
    - `created_at` string
    - `updated_at` string
    - `status` string, required
    - `name` string, required
    - `slug` string, required
    - `profile_name` string, required
    - `resource_overrides` PreviewResourceOverrides: Service public IDs mapped to resource overrides. Omitted fields inherit; an empty map removes all local overrides. Null reservations select platform defaults.
    - `urls` object[], required
      - `hostname` string, required
      - `dns_status` string, required
      - `tls_status` string, required
  - `profiles` PreviewDefaultsRecord[], required
    - `id` string, required
    - `hosted_app_id` string, required
    - `source_environment_id` string, required
    - `name` string, required
    - `slug` string, required
    - `automatic` boolean, required
    - `ttl_days` integer, required
    - `created_at` string
    - `updated_at` string
    - `configuration` PreviewDefaultsConfiguration, required
      - `variables` object
      - `build_variables` object
      - `required_keys` string[]
      - `service_resources` PreviewResourceOverrides: Service public IDs mapped to resource overrides. Omitted fields inherit; an empty map removes all local overrides. Null reservations select platform defaults.
    - `bindings` PreviewSecretBinding[], required
      - `id` string, required
      - `hosted_app_id` string
      - `app_environment_id` string, nullable
      - `app_preview_profile_id` string, nullable
      - `secret_id` string, nullable
      - `secret_version_id` string, nullable
      - `env_key` string, required
      - `mode` 'linked' | 'masked', required
      - `source_slug` string, nullable
      - `version_number` integer, nullable
      - `pinned` boolean, required
      - `available` boolean, required
      - `created_at` string
      - `updated_at` string
  - `source_environments` AppEnvironment[], required
    - `id` string, required
    - `hosted_app_id` string, required
    - `location_id` string, required
    - `slug` string, required
    - `name` string, required
    - `kind` 'production' | 'staging' | 'development' | 'preview' | 'ephemeral' | 'custom', required
    - `status` 'active' | 'paused' | 'archived', required
    - `location` HostingLocation, required
      - `id` string, required
      - `code` string, required
      - `name` string, required
      - `nomad_datacenter` string, required
      - `created_at` string, date-time, required
      - `updated_at` string, date-time, required
    - `branch_pattern` string, nullable, required
    - `base_domain` string, nullable, required
    - `auto_deploy` boolean, required
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required
    - `created_at_label` string, nullable, required
    - `updated_at_label` string, nullable, required
  - `resource_services` object[], required
    - `id` string, required
    - `name` string, required
    - `resources` PreviewResourceSettings, required
      - `cpu_mhz` integer, nullable
      - `cpu_hard_limit` boolean
      - `memory_mb` integer, nullable
      - `memory_max_mb` integer, nullable
      - `disk_mb` integer, nullable
  - `can_manage` boolean, required
  - `binding_sources` PreviewBindingSource[], required
    - `id` string, required
    - `name` string, required
    - `slug` string, required
    - `scope_kind` string, required
    - `source_app_name` string, nullable, required
    - `source_environment_name` string, nullable, required
    - `available` boolean, required
    - `latest_version_number` integer, nullable, required
    - `versions` object[], required
      - `id` string, required
      - `version_number` integer, required

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not found
- `422`: Unprocessable entity
- `502`: Bad gateway

---

[API](https://skmtc.dev/composal/apis/vex-api.md) - [All operations](https://skmtc.dev/composal/apis/vex-api/llms.txt) - [OpenAPI document](https://skmtc.dev/composal/apis/vex-api/revisions/74298a24e040?raw)