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

# GET /v1/public-endpoints

`GET /v1/public-endpoints`

Return list of public, OctoAI-deployed endpoints

## Response `200`

A list of OctoAI-deployed endpoints

- HostedEndpoint[]
  - `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, required — Endpoint to query against
  - `is_live` boolean — If this endpoint should be considered live or not

---

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