---
title: "Retrieve App Instances"
method: GET
path: "/v2/apps/{app_id}/instances"
tags: ["DigitalOcean-public.v2-new_Apps"]
---

# Retrieve App Instances

`GET /v2/apps/{app_id}/instances`

Retrieve the list of running instances for a given application, including instance names and component types. Please note that these instances are ephemeral and may change over time. It is recommended not to make persistent changes or develop scripts that rely on their persistence.

## Path parameters

- `app_id` string, required

## Response `200`

A JSON with key `instances`

- AppInstances
  - `instances` AppInstance[]
    - `component_name` string — Name of the component, from the app spec.
    - `component_type` 'SERVICE' | 'WORKER' | 'JOB' — Supported compute component by DigitalOcean App Platform.
    - `instance_name` string — Name of the instance, which is a unique identifier for the instance.
    - `instance_alias` string — Readable identifier, an alias of the instance name, reference for mapping insights to instance names.

## Other responses

- `401` — Authentication failed due to invalid credentials.
- `404` — The resource was not found.
- `429` — The API rate limit has been exceeded.
- `500` — There was a server error.
- `default` — There was an unexpected error.

---

[API](https://skmtc.net/digitalocean/apis/digitalocean-api.md) · [All operations](https://skmtc.net/digitalocean/apis/digitalocean-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/digitalocean/digitalocean-api/versions/cb3bf9b21459/schema)