---
title: "Inspect a preview administration page"
method: GET
path: "/api/v1/hosting/apps/{app_id}/previews/{id}/administration"
tags: ["hosting"]
---

# Inspect a preview administration page

`GET /api/v1/hosting/apps/{app_id}/previews/{id}/administration`

## 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/{id}/administration`
- Auth: HTTP bearer

Combined preview policy, configuration, binding, lifecycle and isolated deployment state. Members receive read-only actions. Unavailable configuration is reported by section without hiding the page or returning credentials.

## Path parameters

- `app_id` string, required
- `id` string, required

## Response `200`

Preview administration page

- PreviewAdministrationPage
  - `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
  - `preview` 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
  - `profile` PreviewProfileRecord, 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.
  - `deployment` DeploymentDetailsPage, required
    - `filters` DeploymentFilters, required: The option lists the deployments page's app, service and stage pickers narrow by. `services` and `environments` are empty until an app is selected.
      - `apps` 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
      - `services` object[], required
        - `id` string, required
        - `name` string, required
      - `environments` object[], required
        - `id` string, required
        - `slug` string, required
        - `name` string, required
    - `deploy_targets` DeploymentTarget[], required
      - `service_id` string, required
      - `service_name` string, required
      - `environment_id` string, required
      - `environment_name` string, required
      - `placement_id` string, required
      - `region_count` integer, required
      - `replicas_per_region` integer, required
      - `rollout_strategy` 'health_gated' | 'burst', required
      - `source_ref` string, nullable, required
      - `auto_deploy` boolean, required
      - `redeploy` boolean, required
    - `app_id` string, nullable, required
    - `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
    - `health` DeploymentScopeHealth, required: The rolled-up state of the selected scope. `control_state` is the one word the dashboard leads with, and which signal wins is a deployment rule rather than something to re-derive from the counts beside it.
      - `control_state` 'degraded' | 'deploying' | 'healthy' | 'idle', required
      - `running_instances` integer, required
      - `total_instances` integer, required
      - `unhealthy_instances` integer, required
      - `active_rollouts` integer, required
      - `active_deployments` integer, required
      - `failed_deployments` integer, required
    - `nomad` DeploymentScopeNomad, required: The Nomad footprint of the selected scope, deduplicated.
      - `allocation_count` integer, required
      - `job_count` integer, required
      - `deployment_count` integer, required
      - `datacenters` string[], required
      - `task_names` string[], required
    - `capacity` DeploymentCapacity, required
      - `cpu_mhz` integer, required
      - `memory_mb` integer, required
      - `disk_mb` integer, required
      - `cpu_label` string, required
      - `memory_label` string, required
      - `disk_label` string, required
      - `running_instances` integer, required
      - `desired_instances` integer, required
      - `public_endpoints` integer, required
    - `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
    - `placements` AppServicePlacement[], required
      - `id` string, required
      - `organization_id` string, required
      - `hosted_app_id` string, required
      - `app_service_id` string, required
      - `app_environment_id` string, required
      - `mode` 'single_region' | 'multi_region', required
      - `rollout_strategy` 'health_gated' | 'burst', required
      - `deployment_channel` 'stable' | 'blue_green', nullable, required: Preview-only override; null inherits the captured source channel.
      - `replicas_per_region` integer, required
      - `region_count` integer, required
      - `total_replicas` integer, required
      - `targets` object[], required
        - `id` string, required
        - `location_id` string, 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
        - `position` integer, required
        - `enabled` boolean, required
      - `created_at` string, date-time, required
      - `updated_at` string, date-time, required
    - `desired_states` AppDesiredState[], required
      - `id` string, required
      - `organization_id` string, required
      - `hosted_app_id` string, required
      - `app_environment_id` string, required
      - `app_service_id` string, required
      - `network_segment_id` string, nullable, required
      - `slug` string, required
      - `status` 'active' | 'paused' | 'archived', required
      - `desired_instances` integer, required
      - `desired_version` string, nullable, required
      - `image_locator` string, nullable, required
      - `command` string, nullable, required
      - `env_fingerprint` string, nullable, required
      - `config_fingerprint` string, nullable, 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
    - `service_views` DetailsServiceView[], required
      - `service` AppService, required
        - `id` string, required
        - `hosted_app_id` string, required
        - `slug` string, required
        - `name` string, required
        - `kind` 'web' | 'worker' | 'cron' | 'static' | 'private', required
        - `runtime` 'docker' | 'node' | 'ruby' | 'python' | 'go' | 'rust' | 'static' | 'generic', required
        - `runtime_adapter_kind` 'nomad' | 'database', required
        - `runtime_adapter_settings_json` string, nullable, required
        - `nomad_namespace` string, nullable, required
        - `nomad_region` string, nullable, required
        - `cpu_mhz` integer, nullable, required
        - `memory_mb` integer, nullable, required
        - `memory_max_mb` integer, nullable, required: Hard memory limit in MB the task may burst to (Nomad MemoryMaxMB). memory_mb stays the reservation the scheduler places against, so raising this does not make a rollout harder to place. Must be >= memory_mb. Memory above the reservation is oversubscribed and best effort: under node pressure the kernel reclaims it and can OOM-kill the task. Null/absent renders no limit beyond the reservation.
        - `disk_mb` integer, nullable, required
        - `nomad_constraints_json` string, nullable, required
        - `nomad_update_strategy_json` string, nullable, required
        - `nomad_ulimits_json` string, nullable, required: Docker task ulimits as a JSON object of rlimit name to "soft:hard" (e.g. {"nofile":"65536:65536"}). Null/absent leaves the container on the daemon default.
        - `nomad_kill_timeout_seconds` integer, nullable, required: Seconds the task gets after SIGTERM before SIGKILL. Null/absent leaves Nomad's 5s default. Capped at 30 because a Nomad client silently clamps kill_timeout to its own max_kill_timeout (default 30s).
        - `nomad_shutdown_delay_seconds` integer, nullable, required: Seconds Nomad waits between deregistering the group's services and sending SIGTERM, so the edge stops routing new requests to the allocation before it is signalled. Null/absent leaves Nomad's 0s default.
        - `source_path` string, required
        - `repo_source_path` string, required
        - `build_command` string, nullable, required
        - `release_command` string, nullable, required
        - `prestart_command` string, nullable, required
        - `start_command` string, nullable, required
        - `healthcheck_path` string, nullable, required
        - `schedule` string, nullable, required
        - `internal_port` integer, nullable, required
        - `desired_instances` integer, required
        - `publicly_accessible` boolean, required
        - `auto_deploy` boolean, required
        - `deploy_paths` string[], required: Explicit repo-root-relative path prefixes/globs a push must touch to auto-deploy. Empty means default to the app root_path.
        - `effective_deploy_paths` string[], required: Tracked paths actually applied by the auto-deploy trigger (explicit deploy_paths, else [root_path]).
        - `bindings` AppServiceBinding[], required
          - `id` string, required
          - `hosted_app_id` string, required
          - `app_service_id` string, required
          - `bindable_type` string, required
          - `bindable_id` string, required
          - `binding_type` string, required
          - `name` string, required
          - `mount_path` string, nullable, required
          - `read_only` boolean, required
          - `required` boolean, required
          - `created_at` string, date-time, required
          - `updated_at` string, date-time, 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
        - `cpu_label` string, nullable, required
        - `memory_label` string, nullable, required
        - `memory_max_label` string, nullable, required
        - `disk_label` string, nullable, required
      - `status` string, required
      - `runtime_summary` EnvironmentRuntimeSummary, required
        - `desired_instances` integer, required
        - `desired_version` string, nullable, required
        - `total_instances` integer, required
        - `running_instances` integer, required
        - `degraded_instances` integer, required
        - `failed_instances` integer, required
      - `capacity` ServiceCapacity, required
        - `reservation_instances` integer, required
        - `deployment_channel` string, required
        - `rollout_extra_instances` integer, required
        - `rollout_peak` RolloutPeakCapacity, required
          - `instances` integer, required
          - `cpu_mhz` integer, required
          - `memory_mb` integer, required
          - `disk_mb` integer, required
          - `cpu_label` string, required
          - `memory_label` string, required
          - `disk_label` string, required
        - `resources` object, required
          - `cpu` ServiceCapacityResource, required
            - `value` integer, required
            - `value_label` string, required
            - `defaulted` boolean, required
            - `total` integer, required
            - `total_label` string, required
          - `memory` ServiceCapacityResource, required
            - `value` integer, required
            - `value_label` string, required
            - `defaulted` boolean, required
            - `total` integer, required
            - `total_label` string, required
          - `disk` ServiceCapacityResource, required
            - `value` integer, required
            - `value_label` string, required
            - `defaulted` boolean, required
            - `total` integer, required
            - `total_label` string, required
      - `network` ServiceNetworkSummary, required: How a service is reachable, counted rather than listed. Only live instances are counted: a terminated one answers on nothing.
        - `endpoints` integer, required
        - `private_addresses` integer, required
        - `network_peers` integer, required
      - `latest_release` ServiceReleaseCaption, required: The two fields a lane or card prints for its newest release, not the release resource: that one answers a release page's questions and costs several reads per row to build.
        - `version` string, required
        - `status` string, required
      - `latest_deployment` object, nullable, required
        - `status` string, required
        - `source_ref` string, nullable, required
        - `commit_sha` string, nullable, required
      - `signal` object, required
        - `value` string, required
        - `detail` string, nullable, required
      - `endpoints` string[], required
      - `environment_views` DetailsEnvironmentView[], required
        - `environment` 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
        - `status` string, required
        - `desired_version` string, nullable, required
        - `instance_count` integer, required
        - `updated_label` string, nullable, required
        - `instances` DetailsInstanceRef[], required
          - `id` string, required
          - `label` string, required
          - `status` string, required
    - `operations` DeploymentOperation[], required
      - `rollout_predecessor_id` string, nullable, required
      - `id` string, required
      - `number` integer, required
      - `status` 'queued' | 'building' | 'deploying' | 'active' | 'failed' | 'rolled_back' | 'canceled', required
      - `app` object, required
        - `id` string, required
        - `slug` string, required
        - `name` string, required
      - `service` object, required
        - `id` string, required
        - `slug` string, required
        - `name` string, required
      - `environment` object, required
        - `id` string, required
        - `slug` string, required
        - `name` string, required
        - `kind` string, required
      - `placement` object, nullable, required
        - `id` string, required
        - `mode` 'single_region' | 'multi_region', required
        - `rollout_strategy` 'health_gated' | 'burst', required
        - `replicas_per_region` integer, required
        - `total_replicas` integer, required
      - `rollout_strategy` 'health_gated' | 'burst', required
      - `replicas_per_region` integer, required
      - `total_replicas` integer, required
      - `trigger_kind` 'manual' | 'push' | 'schedule' | 'api' | 'rollback', required
      - `is_rollback` boolean, required
      - `rollback_source_release_id` string, nullable, required
      - `rollback_target_release_id` string, nullable, required
      - `rollback_reason` string, nullable, required
      - `source_ref` string, nullable, required
      - `commit_sha` string, nullable, required
      - `artifact_locator` string, nullable, required
      - `deployed_url` string, uri, nullable, required
      - `build_duration_seconds` integer, nullable, required
      - `duration_seconds` integer, nullable, required
      - `creator` object, nullable, required
        - `id` string, required
        - `name` string, nullable, required
        - `picture_url` string, nullable, required
      - `build_status` 'queued' | 'building' | 'succeeded' | 'failed' | 'canceled' | 'skipped', required
      - `rollout_status` 'not_started' | 'queued' | 'running' | 'succeeded' | 'failed' | 'canceled' | 'mixed', required
      - `history_kind` 'current' | 'superseded' | 'stale' | 'historical', required
      - `history_reason` string, nullable, required
      - `ci_pipeline_id` string, nullable, required
      - `ci_pipeline_run_id` string, nullable, required
      - `build_source` object, nullable, required
        - `phase` 'waiting' | 'reused', required
        - `deployment_id` string, required
        - `canonical_deployment_id` string, required
        - `number` integer, required
      - `region_count` integer, required
      - `live_region_count` integer, required
      - `is_live` boolean, required
      - `children` DeploymentOperationChild[], required
        - `deployment_id` string, required
        - `target_id` string, nullable, required
        - `number` integer, required
        - `environment` object, required
          - `id` string, required
          - `slug` string, required
          - `name` string, required
          - `kind` string, required
        - `location` object, nullable, required
          - `id` string, required
          - `code` string, required
          - `name` string, required
        - `build_role` 'leader' | 'follower' | 'standalone', required
        - `build_status` 'queued' | 'building' | 'succeeded' | 'failed' | 'canceled' | 'skipped', required
        - `rollout_status` 'not_started' | 'queued' | 'running' | 'succeeded' | 'failed' | 'canceled', required
        - `history_kind` 'current' | 'superseded' | 'stale' | 'historical', required
        - `history_reason` string, nullable, required
        - `recorded_status` 'queued' | 'building' | 'deploying' | 'active' | 'failed' | 'rolled_back' | 'canceled', required
        - `desired_replicas` integer, required
        - `live_replicas` integer, required
        - `is_live` boolean, required
        - `release_id` string, nullable, required
        - `rollout_id` string, nullable, required
        - `failure_message` string, nullable, required
        - `superseded_by_deployment_id` string, nullable, required
        - `ci_pipeline_id` string, nullable, required
        - `ci_pipeline_run_id` string, nullable, required
        - `started_at` string, date-time, nullable, required
        - `finished_at` string, date-time, nullable, required
        - `created_at` string, date-time, required
        - `updated_at` string, date-time, required
      - `created_at` string, date-time, required
      - `updated_at` string, date-time, required
    - `deployments` DetailsDeploymentRow[], required
      - `id` string, required
      - `app_service_id` string, required
      - `app_environment_id` string, required
      - `status` string, required
      - `is_rollback` boolean, required
      - `source_ref` string, nullable, required
      - `commit_sha` string, nullable, required
      - `updated_label` string, nullable, required
    - `releases` DetailsReleaseRow[], required
      - `id` string, required
      - `app_service_id` string, required
      - `app_environment_id` string, required
      - `version` string, required
      - `status` string, required
      - `rollout` object, nullable, required
        - `strategy` string, required
        - `target_percentage` integer, required
        - `status` string, required
      - `nomad_job_id` string, nullable, required
      - `nomad_deployment_id` string, nullable, required
      - `nomad_eval_id` string, nullable, required
      - `rendered_job_spec_digest` string, nullable, required
      - `updated_label` string, nullable, required
    - `runtime_instances` RuntimeInstance[], required
      - `id` string, required
      - `organization_id` string, required
      - `hosted_app_id` string, required
      - `app_environment_id` string, required
      - `app_service_id` string, required
      - `app_release_id` string, nullable, required
      - `location_id` string, required
      - `network_peer_id` string, nullable, required
      - `slug` string, required
      - `instance_key` string, required
      - `service_name` string, required: Name of the Vex service this instance runs, in the same vocabulary as `vex deploy list`. `nomad_task_name` is the scheduler's own name for the same workload.
      - `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
      - `status` 'starting' | 'running' | 'degraded' | 'stopped' | 'terminated' | 'failed', required
      - `adapter_kind` 'database' | 'nomad', required
      - `provider_instance_id` string, nullable, required
      - `nomad_allocation_id` string, nullable, required
      - `nomad_task_name` string, nullable, required
      - `private_ipv4` string, nullable, required
      - `private_ipv6` string, nullable, required
      - `public_endpoint` string, nullable, required
      - `booted_at` string, date-time, nullable, required
      - `terminated_at` string, date-time, nullable, required
      - `last_seen_at` string, date-time, nullable, required
      - `last_reconciled_at` string, date-time, nullable, required
      - `created_at` string, date-time, required
      - `updated_at` string, date-time, required
      - `booted_at_label` string, nullable, required
      - `terminated_at_label` string, nullable, required
      - `last_seen_at_label` string, nullable, required
      - `last_reconciled_at_label` string, nullable, required
      - `created_at_label` string, nullable, required
      - `updated_at_label` string, nullable, required
    - `reconciler_ticks` ReconcilerTick[], required
      - `id` string, required
      - `organization_id` string, required
      - `hosted_app_id` string, nullable, required
      - `app_environment_id` string, nullable, required
      - `app_service_id` string, nullable, required
      - `kind` 'generic' | 'release' | 'runtime' | 'network' | 'health' | 'cdn', required
      - `status` 'queued' | 'running' | 'succeeded' | 'failed', required
      - `observed_version` string, nullable, required
      - `summary` string, nullable, required
      - `started_at` string, date-time, nullable, required
      - `finished_at` string, date-time, nullable, required
      - `created_at` string, date-time, required
      - `updated_at` string, date-time, required
      - `started_at_label` string, nullable, required
      - `finished_at_label` string, nullable, required
      - `created_at_label` string, nullable, required
      - `updated_at_label` string, nullable, required
    - `audit_events` AuditEvent[], required
      - `id` string, required
      - `observability_space_id` string, nullable, required
      - `organization_id` string, required
      - `actor_user_id` string, nullable, required
      - `actor_kind` 'user' | 'service' | 'system' | 'agent', required
      - `action` string, required
      - `subject_kind` string, required
      - `subject_id` string, required
      - `subject_name` string, nullable, required
      - `request_id` string, nullable, required
      - `severity` 'info' | 'notice' | 'warn' | 'error', required
      - `payload` unknown, 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
    - `service_bindings` AppServiceBinding[], required
      - `id` string, required
      - `hosted_app_id` string, required
      - `app_service_id` string, required
      - `bindable_type` string, required
      - `bindable_id` string, required
      - `binding_type` string, required
      - `name` string, required
      - `mount_path` string, nullable, required
      - `read_only` boolean, required
      - `required` boolean, required
      - `created_at` string, date-time, required
      - `updated_at` string, date-time, required
    - `data_resources` AppDataResource[], required
      - `id` string, required
      - `hosted_app_id` string, required
      - `app_environment_id` string, nullable, required
      - `slug` string, required
      - `name` string, required
      - `kind` 'database' | 'cache' | 'queue' | 'search' | 'vector', required
      - `engine` 'postgres' | 'mysql' | 'valkey', required
      - `version` string, nullable, required
      - `plan` string, nullable, required
      - `region` string, nullable, required
      - `status` 'provisioning' | 'available' | 'updating' | 'failed' | 'archived', required
      - `storage_gb` integer, nullable, required
      - `storage_label` string, nullable, required
      - `high_availability` boolean, required
      - `provider_metadata` object, required
      - `failure_message` string, nullable, required
      - `created_at` string, date-time, required
      - `updated_at` string, date-time, required
    - `storage_resources` AppStorageResource[], required
      - `id` string, required
      - `hosted_app_id` string, required
      - `app_environment_id` string, nullable, required
      - `location_id` string, nullable, required: Volume datacenter pin (volume kind only)
      - `location_code` string, nullable, required
      - `slug` string, required
      - `name` string, required
      - `kind` 'bucket' | 'volume', required
      - `provider` 's3' | 'tigris' | 'nomad_csi' | 'local_nvme' | 'local_nvme_authority', required: Storage backend. `local_nvme` is a directory on the node's own NVMe, created as a Nomad dynamic host volume — fast, node-local and EPHEMERAL: the platform may delete it at any time and it does not survive the loss of its node. Use it as a cache, never as a system of record. `local_nvme_authority` is a single-node, single-writer authority volume that refuses destructive repair. Node loss requires restoration from remote replication into a new volume.
      - `region` string, nullable, required
      - `access_mode` 'private' | 'public' | 'internal', required: Object-store semantics only; ignored for volume resources
      - `mount_path` string, nullable, required
      - `capacity_gb` integer, nullable, required
      - `capacity_label` string, nullable, required
      - `status` 'provisioning' | 'available' | 'updating' | 'failed' | 'archived', required
      - `external_volume_id` string, nullable, required: Nomad/CSI volume id assigned at provisioning
      - `attachment` object, nullable, required: Attachment readback: CSI publish state for nomad_csi, or the nodes carrying the directory for local_nvme. Nil until provisioned
        - `state` 'attached' | 'detached'
        - `node_ids` string[]
        - `alloc_ids` string[]
      - `ephemeral` boolean, required: True when the contents may be deleted at any time and do not survive the loss of the underlying node. Ephemeral storage is a cache and must never hold a system of record.
      - `provider_error` string, nullable, required: Last provisioning/teardown error from the storage provider
      - `created_at` string, date-time, required
      - `updated_at` string, date-time, required
    - `activity` DeploymentActivityItem[], required
      - `id` string, required
      - `source` 'deployment' | 'release' | 'rollout' | 'reconciler' | 'event', required
      - `title` string, required
      - `subtitle` string, required
      - `timestamp` string, date-time, required
      - `timestamp_label` string, required
      - `service_id` string, nullable, required
      - `environment_id` string, nullable, required
      - `status` string, required
      - `tone` 'neutral' | 'success' | 'warning' | 'danger' | 'info', required
      - `detail` string, nullable, required
  - `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
  - `profile_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
  - `operations` PreviewLifecycleOperation[], required
    - `id` string, required
    - `app_preview_id` string
    - `created_by_user_id` union
      - string
      - integer
    - `action` 'pause' | 'archive' | 'delete' | 'expire' | 'close', required
    - `status` 'queued' | 'running' | 'succeeded' | 'failed' | 'canceled', required
    - `generation` integer, required
    - `failure_message` string, nullable
    - `started_at` string, nullable
    - `finished_at` string, nullable
    - `created_at` string
    - `updated_at` string
  - `placement_locations` HostingLocation[]
    - `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
  - `storage_bindings` PreviewStorageBindingChoice[], required
    - `binding_id` string, required
    - `name` string, required
    - `mount_path` string, nullable, required
    - `read_only` boolean, required
    - `source_resource_name` string, required
    - `selected_resource_id` string, nullable, required
    - `resources` object[], required
      - `id` string, required
      - `name` string, required
      - `provider` string, required
      - `capacity_gb` integer, nullable, required
      - `location_id` string, nullable, required
      - `shared` boolean, required
  - `can_manage` boolean, required
  - `actions` object, required
    - `deploy` boolean, required
    - `pause` boolean, required
    - `resume` boolean, required
    - `configure` boolean, required
    - `rotate_secrets` boolean, required
    - `review_source` boolean, required
    - `policy` boolean, required
    - `delete` boolean, required
  - `comparison` object, nullable, required
    - `runtime_consumers` PreviewRuntimeSecretConsumer[]
      - `runtime_instance_id` string, required
      - `app_service_id` string, required
      - `app_release_id` string, nullable
      - `status` 'unknown' | 'current' | 'stale' | 'unavailable', required
      - `keys` object[], required
        - `env_key` string, required
        - `secret_id` string, nullable
        - `loaded_version_id` string, nullable
        - `selected_version_id` string, nullable
        - `available` boolean, required
        - `stale` boolean, required
    - `configuration` PreviewServiceConfigurationComparison[]
      - `app_service_id` string, required
      - `setting_differences` string[], required
      - `backing_resources` object
        - `captured` PreviewBackingResource[], required
          - `binding_id` string, required
          - `name` string, required
          - `binding_type` string, required
          - `resource_type` string, required
          - `resource_id` string, required
          - `resource_environment_id` string, nullable
          - `network_peer_id` string, nullable
          - `network_space_id` string, nullable
          - `network_dns_suffix` string, nullable
          - `network_available` boolean, nullable
          - `resource_name` string, required
          - `resource_status` string, required
          - `resource_provider` string
          - `resource_kind` string
          - `resource_location_id` string, nullable
          - `resource_capacity_gb` integer, nullable
          - `resource_external_volume_id` string, nullable
          - `resource_authority_identity` object
          - `provider_private_endpoint` boolean: Captured managed data resource advertises a provider-private endpoint; no endpoint or credential material is included.
          - `required` boolean, required
          - `read_only` boolean, required
          - `mount_path` string, nullable, required
          - `environment_variable_name` string, nullable, required
          - `dependency_endpoint_id` string, nullable
          - `dependency_url` string
        - `source` PreviewBackingResource[], required
          - `binding_id` string, required
          - `name` string, required
          - `binding_type` string, required
          - `resource_type` string, required
          - `resource_id` string, required
          - `resource_environment_id` string, nullable
          - `network_peer_id` string, nullable
          - `network_space_id` string, nullable
          - `network_dns_suffix` string, nullable
          - `network_available` boolean, nullable
          - `resource_name` string, required
          - `resource_status` string, required
          - `resource_provider` string
          - `resource_kind` string
          - `resource_location_id` string, nullable
          - `resource_capacity_gb` integer, nullable
          - `resource_external_volume_id` string, nullable
          - `resource_authority_identity` object
          - `provider_private_endpoint` boolean: Captured managed data resource advertises a provider-private endpoint; no endpoint or credential material is included.
          - `required` boolean, required
          - `read_only` boolean, required
          - `mount_path` string, nullable, required
          - `environment_variable_name` string, nullable, required
          - `dependency_endpoint_id` string, nullable
          - `dependency_url` string
        - `preview` PreviewBackingResource[], required
          - `binding_id` string, required
          - `name` string, required
          - `binding_type` string, required
          - `resource_type` string, required
          - `resource_id` string, required
          - `resource_environment_id` string, nullable
          - `network_peer_id` string, nullable
          - `network_space_id` string, nullable
          - `network_dns_suffix` string, nullable
          - `network_available` boolean, nullable
          - `resource_name` string, required
          - `resource_status` string, required
          - `resource_provider` string
          - `resource_kind` string
          - `resource_location_id` string, nullable
          - `resource_capacity_gb` integer, nullable
          - `resource_external_volume_id` string, nullable
          - `resource_authority_identity` object
          - `provider_private_endpoint` boolean: Captured managed data resource advertises a provider-private endpoint; no endpoint or credential material is included.
          - `required` boolean, required
          - `read_only` boolean, required
          - `mount_path` string, nullable, required
          - `environment_variable_name` string, nullable, required
          - `dependency_endpoint_id` string, nullable
          - `dependency_url` string
        - `requires_refresh` boolean, required
      - `resources` object
      - `capacity` object, required
        - `source` PreviewCapacityEntry[], required
          - `location_id` string, required
          - `location_name` string, required
          - `replicas` integer, required
        - `preview` PreviewCapacityEntry[], required
          - `location_id` string, required
          - `location_name` string, required
          - `replicas` integer, required
      - `keys` object[], required
        - `key` string, required
        - `source` PreviewConfigurationReference, required
          - `key` string, required
          - `kind` string, required
          - `layer` string, required
          - `secret_id` string
          - `secret_version_id` string
          - `version_number` integer
          - `config_variable_id` string
          - `value_kind` string
          - `binding_id` string
          - `pinned` boolean
        - `preview` PreviewConfigurationReference, required
          - `key` string, required
          - `kind` string, required
          - `layer` string, required
          - `secret_id` string
          - `secret_version_id` string
          - `version_number` integer
          - `config_variable_id` string
          - `value_kind` string
          - `binding_id` string
          - `pinned` boolean
        - `shadowed` PreviewConfigurationReference[], required
          - `key` string, required
          - `kind` string, required
          - `layer` string, required
          - `secret_id` string
          - `secret_version_id` string
          - `version_number` integer
          - `config_variable_id` string
          - `value_kind` string
          - `binding_id` string
          - `pinned` boolean
        - `approval_required` boolean, required
        - `required` boolean, required
        - `missing_reference` boolean, required
        - `matches_source` boolean, required
  - `sharing_approvals` PreviewSharingApprovals, required
    - `snapshot_version` integer, required
    - `source_keys` string[], required
    - `services` object[], required
      - `service_id` string, required
      - `source_keys` string[], required
      - `build_keys` string[], required
    - `default_configuration` object[], required
      - `id` string, required
      - `key` string, required
      - `value_kind` string, required
    - `default_secrets` object[], required
      - `id` string, required
      - `key` string, nullable, required
    - `build_secrets` object[], required
      - `id` string, required
      - `key` string, required
      - `version_id` string, required
      - `binding_id` string, nullable, required
    - `approved_build_secrets` string[], required
    - `approved_build_keys` string[], required
    - `approved_source_keys` string[], required
    - `approved_default_secrets` string[], required
    - `approved_default_configuration` string[], 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
  - `owned_secrets` PreviewOwnedSecret[], required
    - `id` string, required
    - `env_key` string, required
    - `name` string, required
    - `status` string, required
    - `latest_version_number` integer, nullable, required
    - `available` boolean, required
  - `configuration_errors` object, 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)