---
title: "GET /api/v1/execution/runtime_instances"
method: GET
path: "/api/v1/execution/runtime_instances"
tags: ["execution"]
---

# GET /api/v1/execution/runtime_instances

`GET /api/v1/execution/runtime_instances`

## 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/execution/runtime_instances`
- Auth: HTTP bearer

## Query parameters

- `hosted_app_id` string
- `app_environment_id` string
- `app_service_id` string
- `page` integer
- `limit` integer

## Response `200`

Recent and live runtime instances

- object
  - `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
  - `pagination` object, required
    - `page` integer, required
    - `limit` integer, required
    - `count` integer, required
    - `last` integer, required
    - `previous` integer, nullable
    - `next` integer, nullable

## 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)