> ## Documentation Index > Fetch the complete documentation index at: https://docs.runpod.io/llms.txt > Use this file to discover all available pages before exploring further. # List endpoints > Returns a list of endpoints. ## OpenAPI ````yaml GET /endpoints openapi: 3.0.3 info: title: Runpod API description: Public Rest API for managing Runpod programmatically. version: 0.1.0 contact: name: help url: https://contact.runpod.io/hc/requests/new email: help@runpod.io servers: - url: https://rest.runpod.io/v1 security: - ApiKey: [] tags: - name: docs description: This documentation page. - name: pods description: Manage Pods. - name: endpoints description: Manage Serverless endpoints. - name: network volumes description: Manage Runpod network volumes. - name: templates description: Manage Pod and Serverless templates. - name: container registry auths description: >- Manage authentication for container registries such as dockerhub to use private images. - name: billing description: Retrieve billing history for your Runpod account. externalDocs: description: Find out more about Runpod. url: https://runpod.io paths: /endpoints: get: tags: - endpoints summary: List endpoints description: Returns a list of endpoints. operationId: ListEndpoints parameters: - name: includeTemplate in: query schema: type: boolean default: false example: true description: >- Include information about the template used to create the endpoint. - name: includeWorkers in: query schema: type: boolean default: false example: true description: Include information about the workers running on the endpoint. responses: '200': description: Successful operation. content: application/json: schema: $ref: '#/components/schemas/Endpoints' '400': description: Invalid ID supplied. '404': description: Endpoint not found. components: schemas: Endpoints: type: array items: $ref: '#/components/schemas/Endpoint' Endpoint: type: object properties: allowedCudaVersions: type: array items: type: string enum: - '13.0' - '12.9' - '12.8' - '12.7' - '12.6' - '12.5' - '12.4' - '12.3' - '12.2' - '12.1' - '12.0' - '11.8' description: >- A list of acceptable CUDA versions for the workers on a Serverless endpoint. If not set, any CUDA version is acceptable. computeType: type: string enum: - CPU - GPU example: GPU description: The type of compute used by workers on a Serverless endpoint. createdAt: type: string example: '2024-07-12T19:14:40.144Z' description: The UTC timestamp when a Serverless endpoint was created. dataCenterIds: type: array example: EU-NL-1,EU-RO-1,EU-SE-1 default: - EU-RO-1 - CA-MTL-1 - EU-SE-1 - US-IL-1 - EUR-IS-1 - EU-CZ-1 - US-TX-3 - EUR-IS-2 - US-KS-2 - US-GA-2 - US-WA-1 - US-TX-1 - CA-MTL-3 - EU-NL-1 - US-TX-4 - US-CA-2 - US-NC-1 - OC-AU-1 - US-DE-1 - EUR-IS-3 - CA-MTL-2 - AP-JP-1 - EUR-NO-1 - EU-FR-1 - US-KS-3 - US-GA-1 items: type: string enum: - EU-RO-1 - CA-MTL-1 - EU-SE-1 - US-IL-1 - EUR-IS-1 - EU-CZ-1 - US-TX-3 - EUR-IS-2 - US-KS-2 - US-GA-2 - US-WA-1 - US-TX-1 - CA-MTL-3 - EU-NL-1 - US-TX-4 - US-CA-2 - US-NC-1 - OC-AU-1 - US-DE-1 - EUR-IS-3 - CA-MTL-2 - AP-JP-1 - EUR-NO-1 - EU-FR-1 - US-KS-3 - US-GA-1 description: >- A list of Runpod data center IDs where workers on a Serverless endpoint can be located. env: type: object items: type: string example: ENV_VAR: value default: {} executionTimeoutMs: type: integer example: 600000 description: >- The maximum number of milliseconds an individual request can run on a Serverless endpoint before the worker is stopped and the request is marked as failed. gpuCount: type: integer example: 1 description: The number of GPUs attached to each worker on a Serverless endpoint. gpuTypeIds: type: array items: type: string enum: - NVIDIA GeForce RTX 4090 - NVIDIA A40 - NVIDIA RTX A5000 - NVIDIA GeForce RTX 5090 - NVIDIA H100 80GB HBM3 - NVIDIA GeForce RTX 3090 - NVIDIA RTX A4500 - NVIDIA L40S - NVIDIA H200 - NVIDIA L4 - NVIDIA RTX 6000 Ada Generation - NVIDIA A100-SXM4-80GB - NVIDIA RTX 4000 Ada Generation - NVIDIA RTX A6000 - NVIDIA A100 80GB PCIe - NVIDIA RTX 2000 Ada Generation - NVIDIA RTX A4000 - NVIDIA RTX PRO 6000 Blackwell Server Edition - NVIDIA H100 PCIe - NVIDIA H100 NVL - NVIDIA L40 - NVIDIA B200 - NVIDIA GeForce RTX 3080 Ti - NVIDIA RTX PRO 6000 Blackwell Workstation Edition - NVIDIA GeForce RTX 3080 - NVIDIA GeForce RTX 3070 - AMD Instinct MI300X OAM - NVIDIA GeForce RTX 4080 SUPER - Tesla V100-PCIE-16GB - Tesla V100-SXM2-32GB - NVIDIA RTX 5000 Ada Generation - NVIDIA GeForce RTX 4070 Ti - NVIDIA RTX 4000 SFF Ada Generation - NVIDIA GeForce RTX 3090 Ti - NVIDIA RTX A2000 - NVIDIA GeForce RTX 4080 - NVIDIA A30 - NVIDIA GeForce RTX 5080 - Tesla V100-FHHL-16GB - NVIDIA H200 NVL - Tesla V100-SXM2-16GB - NVIDIA RTX PRO 6000 Blackwell Max-Q Workstation Edition - NVIDIA A5000 Ada - Tesla V100-PCIE-32GB - NVIDIA RTX A4500 - NVIDIA A30 - NVIDIA GeForce RTX 3080TI - Tesla T4 - NVIDIA RTX A30 description: >- A list of Runpod GPU types which can be attached to a Serverless endpoint. id: type: string example: jpnw0v75y3qoql description: A unique string identifying a Serverless endpoint. idleTimeout: type: integer example: 5 description: >- The number of seconds a worker on a Serverless endpoint can be running without taking a job before the worker is scaled down. instanceIds: type: array items: type: string example: - cpu3c-8-16 description: >- For CPU Serverless endpoints, a list of instance IDs that can be attached to a Serverless endpoint. minCudaVersion: type: string enum: - '13.0' - '12.9' - '12.8' - '12.7' - '12.6' - '12.5' - '12.4' - '12.3' - '12.2' - '12.1' - '12.0' - '11.8' description: >- The minimum acceptable CUDA version for the workers on a Serverless endpoint. name: type: string example: my endpoint description: >- A user-defined name for a Serverless endpoint. The name does not need to be unique. networkVolumeId: type: string example: agv6w2qcg7 description: >- The unique string identifying the network volume to attach to the Serverless endpoint. networkVolumeIds: type: array items: type: string example: - agv6w2qcg7 - bxh7w3rch8 description: >- A list of network volume IDs attached to the Serverless endpoint. Allows multiple network volumes to be used with multi-region endpoints. scalerType: type: string example: QUEUE_DELAY enum: - QUEUE_DELAY - REQUEST_COUNT description: >- The method used to scale up workers on a Serverless endpoint. If QUEUE_DELAY, workers are scaled based on a periodic check to see if any requests have been in queue for too long. If REQUEST_COUNT, the desired number of workers is periodically calculated based on the number of requests in the endpoint's queue. Use QUEUE_DELAY if you need to ensure requests take no longer than a maximum latency, and use REQUEST_COUNT if you need to scale based on the number of requests. scalerValue: type: integer example: 4 description: >- If the endpoint scalerType is QUEUE_DELAY, the number of seconds a request can remain in queue before a new worker is scaled up. If the endpoint scalerType is REQUEST_COUNT, the number of workers is increased as needed to meet the number of requests in the endpoint's queue divided by scalerValue. template: $ref: '#/components/schemas/Template' templateId: type: string example: 30zmvf89kd description: >- The unique string identifying the template used to create a Serverless endpoint. userId: type: string example: user_2PyTJrLzeuwfZilRZ7JhCQDuSqo description: >- A unique string identifying the Runpod user who created a Serverless endpoint. version: type: integer example: 0 description: >- The latest version of a Serverless endpoint, which is updated whenever the template or environment variables of the endpoint are changed. workers: type: array items: $ref: '#/components/schemas/Pod' description: Information about current workers on a Serverless endpoint. workersMax: type: integer example: 3 description: >- The maximum number of workers that can be running at the same time on a Serverless endpoint. workersMin: type: integer example: 0 description: >- The minimum number of workers that will run at the same time on a Serverless endpoint. This number of workers will always stay running for the endpoint, and will be charged even if no requests are being processed, but they are charged at a lower rate than running autoscaling workers. Template: type: object properties: category: type: string example: NVIDIA description: >- The category of the template. The category can be used to filter templates in the Runpod UI. Current categories are NVIDIA, AMD, and CPU. containerDiskInGb: type: integer example: 50 description: >- The amount of disk space, in gigabytes (GB), to allocate on the container disk for a Pod or worker. The data on the container disk is wiped when the Pod or worker restarts. To persist data across restarts, set volumeInGb to configure the local network volume. containerRegistryAuthId: type: string dockerEntrypoint: type: array items: type: string example: [] description: >- If specified, overrides the ENTRYPOINT for the Docker image run on a Pod or worker. If [], uses the ENTRYPOINT defined in the image. dockerStartCmd: type: array items: type: string example: [] description: >- If specified, overrides the start CMD for the Docker image run on a Pod or worker. If [], uses the start CMD defined in the image. earned: type: number example: 100 description: >- The amount of Runpod credits earned by the creator of a template by all Pods or workers created from the template. env: type: object items: type: string example: ENV_VAR: value default: {} id: type: string example: 30zmvf89kd description: A unique string identifying a template. imageName: type: string example: runpod/pytorch:2.1.0-py3.10-cuda11.8.0-devel-ubuntu22.04 description: >- The image tag for the container run on Pods or workers created from a template. isPublic: type: boolean example: false description: >- Set to true if a template is public and can be used by any Runpod user. Set to false if a template is private and can only be used by the creator. isRunpod: type: boolean example: true description: If true, a template is an official template managed by Runpod. isServerless: type: boolean example: true description: >- If true, instances created from a template are Serverless workers. If false, instances created from a template are Pods. name: type: string example: my template description: A user-defined name for a template. The name needs to be unique. ports: type: array items: type: string example: - 8888/http - 22/tcp description: >- A list of ports exposed on a Pod or worker. Each port is formatted as [port number]/[protocol]. Protocol can be either http or tcp. readme: type: string description: >- A string of markdown-formatted text that describes a template. The readme is displayed in the Runpod UI when a user selects the template. runtimeInMin: type: integer volumeInGb: type: integer example: 20 description: >- The amount of disk space, in gigabytes (GB), to allocate on the local network volume for a Pod or worker. The data on the local network volume is persisted across restarts. To persist data so that future Pods and workers can access it, create a network volume and set networkVolumeId to attach it to the Pod or worker. volumeMountPath: type: string example: /workspace description: >- If a local network volume or network volume is attached to a Pod or worker, the absolute path where the network volume is mounted in the filesystem. Pod: type: object properties: adjustedCostPerHr: type: number example: 0.69 description: >- The effective cost in Runpod credits per hour of running a Pod, adjusted by active Savings Plans. aiApiId: type: string example: null description: Synonym for endpointId (legacy name). consumerUserId: type: string example: user_2PyTJrLzeuwfZilRZ7JhCQDuSqo description: A unique string identifying the Runpod user who rents a Pod. containerDiskInGb: type: integer example: 50 description: >- The amount of disk space, in gigabytes (GB), to allocate on the container disk for a Pod. The data on the container disk is wiped when the Pod restarts. To persist data across Pod restarts, set volumeInGb to configure the Pod network volume. containerRegistryAuthId: type: string example: clzdaifot0001l90809257ynb description: >- If a Pod is created with a container registry auth, the unique string identifying that container registry auth. costPerHr: type: number example: '0.74' format: currency description: >- The cost in Runpod credits per hour of running a Pod. Note that the actual cost may be lower if Savings Plans are applied. cpuFlavorId: type: string example: cpu3c description: >- If the Pod is a CPU Pod, the unique string identifying the CPU flavor the Pod is running on. desiredStatus: type: string enum: - RUNNING - EXITED - TERMINATED description: The current expected status of a Pod. dockerEntrypoint: type: array items: type: string description: >- If specified, overrides the ENTRYPOINT for the Docker image run on the created Pod. If [], uses the ENTRYPOINT defined in the image. dockerStartCmd: type: array items: type: string description: >- If specified, overrides the start CMD for the Docker image run on the created Pod. If [], uses the start CMD defined in the image. endpointId: type: string example: null description: >- If the Pod is a Serverless worker, a unique string identifying the associated endpoint. env: type: object items: type: string example: ENV_VAR: value default: {} gpu: type: object properties: id: type: string count: type: integer example: 1 description: The number of GPUs attached to a Pod. displayName: type: string securePrice: type: number communityPrice: type: number oneMonthPrice: type: number threeMonthPrice: type: number sixMonthPrice: type: number oneWeekPrice: type: number communitySpotPrice: type: number secureSpotPrice: type: number id: type: string example: xedezhzb9la3ye description: A unique string identifying a [Pod](#/components/schema/Pod). image: type: string example: runpod/pytorch:2.1.0-py3.10-cuda11.8.0-devel-ubuntu22.04 description: The image tag for the container run on a Pod. interruptible: type: boolean example: false description: >- Describes how a Pod is rented. An interruptible Pod can be rented at a lower cost but can be stopped at any time to free up resources for another Pod. A reserved Pod is rented at a higher cost but runs until it exits or is manually stopped. lastStartedAt: type: string example: '2024-07-12T19:14:40.144Z' description: The UTC timestamp when a Pod was last started. lastStatusChange: type: string example: >- Rented by User: Fri Jul 12 2024 15:14:40 GMT-0400 (Eastern Daylight Time) description: A string describing the last lifecycle event on a Pod. locked: type: boolean example: false description: >- Set to true to lock a Pod. Locking a Pod disables stopping or resetting the Pod. machine: type: object properties: minPodGpuCount: type: integer gpuTypeId: type: string gpuType: type: object properties: id: type: string count: type: integer example: 1 description: The number of GPUs attached to a Pod. displayName: type: string securePrice: type: number communityPrice: type: number oneMonthPrice: type: number threeMonthPrice: type: number sixMonthPrice: type: number oneWeekPrice: type: number communitySpotPrice: type: number secureSpotPrice: type: number cpuCount: type: integer cpuTypeId: type: string cpuType: type: object properties: id: type: string displayName: type: string cores: type: number threadsPerCore: type: number groupId: type: string location: type: string dataCenterId: type: string diskThroughputMBps: type: integer maxDownloadSpeedMbps: type: integer maxUploadSpeedMbps: type: integer supportPublicIp: type: boolean secureCloud: type: boolean maintenanceStart: type: string maintenanceEnd: type: string maintenanceNote: type: string note: type: string costPerHr: type: number currentPricePerGpu: type: number gpuAvailable: type: integer gpuDisplayName: type: string description: >- Information about the machine a Pod is running on (see [Machine](#/components/schemas/Machine)). machineId: type: string example: s194cr8pls2z description: A unique string identifying the host machine a Pod is running on. memoryInGb: type: number example: 62 description: The amount of RAM, in gigabytes (GB), attached to a Pod. name: type: string maxLength: 191 description: >- A user-defined name for the created Pod. The name does not need to be unique. networkVolume: type: object properties: id: type: string example: agv6w2qcg7 description: A unique string identifying a network volume. name: type: string example: my network volume description: >- A user-defined name for a network volume. The name does not need to be unique. size: type: integer example: 50 description: >- The amount of disk space, in gigabytes (GB), allocated to a network volume. dataCenterId: type: string example: EU-RO-1 description: The Runpod data center ID where a network volume is located. description: >- If a network volume is attached to a Pod, information about the network volume (see [network volume schema](#/components/schemas/NetworkVolume)). portMappings: type: object nullable: true items: type: integer example: '22': 10341 description: >- A mapping of internal ports to public ports on a Pod. For example, { "22": 10341 } means that port 22 on the Pod is mapped to port 10341 and is publicly accessible at [public ip]:10341. If the Pod is still initializing, this mapping is not yet determined and will be empty. ports: type: array items: type: string example: - 8888/http - 22/tcp description: >- A list of ports exposed on a Pod. Each port is formatted as [port number]/[protocol]. Protocol can be either http or tcp. publicIp: type: string example: 100.65.0.119 format: ipv4 nullable: true description: >- The public IP address of a Pod. If the Pod is still initializing, this IP is not yet determined and will be empty. savingsPlans: type: array items: $ref: '#/components/schemas/SavingsPlan' description: >- The list of active Savings Plans applied to a Pod (see [Savings Plans](#/components/schemas/SavingsPlan)). If none are applied, the list is empty. slsVersion: type: integer example: 0 description: >- If the Pod is a Serverless worker, the version of the associated endpoint (see [Endpoint Version](#/components/schemas/Endpoint/version)). templateId: type: string example: null description: >- If a Pod is created with a template, the unique string identifying that template. vcpuCount: type: number example: 24 description: The number of virtual CPUs attached to a Pod. volumeEncrypted: type: boolean example: false description: >- Set to true if the local network volume of a Pod is encrypted. Can only be set when creating a Pod. volumeInGb: type: integer example: 20 description: >- The amount of disk space, in gigabytes (GB), to allocate on the Pod volume for a Pod. The data on the Pod volume is persisted across Pod restarts. To persist data so that future Pods can access it, create a network volume and set networkVolumeId to attach it to the Pod. volumeMountPath: type: string example: /workspace description: >- If either a Pod volume or a network volume is attached to a Pod, the absolute path where the network volume is mounted in the filesystem. SavingsPlan: type: object properties: costPerHr: type: number example: 0.21 endTime: type: string example: '2024-07-12T19:14:40.144Z' gpuTypeId: type: string example: NVIDIA GeForce RTX 4090 id: type: string example: clkrb4qci0000mb09c7sualzo podId: type: string example: xedezhzb9la3ye startTime: type: string example: '2024-05-12T19:14:40.144Z' securitySchemes: ApiKey: type: http scheme: bearer bearerFormat: Bearer ````