---
title: "GET /v1/endpoints"
method: GET
path: "/v1/endpoints"
tags: ["endpoint"]
---

# GET /v1/endpoints

`GET /v1/endpoints`

## Request

- Base URL: `https://api.octoai.cloud`
- URL: `https://api.octoai.cloud/v1/endpoints`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/octoml/apis/octoai-api/docs/v1/endpoints/get.ts> (a function with typed inputs; its response is checked against the schema)

Return list of endpoints

## Response `200`

A set of endpoints

- EndpointResponse[]
  - `name` string, required: Name of the endpoint
  - `display_name` string: User-friendly name of the endpoint (e.g. Stable Diffusion 2.1)
  - `description` string: Description of the endpoint
  - `image_url` string, required: URL of the docker image
  - `port` integer, required: Port number of the endpoint
  - `health_check_path` string: URL path of a health check endpoint
  - `auto_volume_experimental` boolean: EXPERIMENTAL: autogenerate a volume for the endpoint
  - `volumes_experimental` VolumeExperimental[]: EXPERIMENTAL: volumes to be used by this container
    - `name` string, required
    - `path` string, required
    - `mount` string, required
  - `min_replicas` integer: Minimum number of replicas
  - `max_replicas` integer: Maximum number of replicas
  - `scale_to_zero` integer: Time to scale to zero (in seconds)
  - `registry_credential` string: The key of a registry credential used to authenticate to a private registry
  - `visibility` 'private' | 'public': Visibility of the endpoint
  - `endpoint_state` 'active' | 'disabled': State of a endpoint
  - `env_overrides` object: JSON object with environment variable overrides
  - `instance_type` string: Endpoint to query against
  - `container_secrets` string[]: A list of container secrets to inject as environment variables
  - `concurrency_per_replica` integer: The maximum concurrency per replica
  - `endpoint` string: Endpoint to query against
  - `replicas` Replica[], required: Active replicas for the endpoint
    - `account_key` string, required: account key for this replica
    - `endpoint_name` string, required: endpoint name
    - `replica_id` string, required: unique ID of the replica
    - `status` 'pending' | 'running' | 'succeeded' | 'failed' | 'unknown', required: status of the replica
    - `restarts` integer, required
    - `age` integer, required: number of seconds this replica has been ready. set to -1 if replica is not ready

---

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