Runpod API

https://docs.runpod.io/api-reference/
Admin
Runpod API is a REST-based cloud compute platform that enables programmatic management of GPU...
Tokens:130,852
Snippets:603
Trust Score:10
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Query parameter example for product

Source: https://docs.runpod.io/api-reference-v2/catalog/get-a-cpu-type

Example value for the product query parameter, which is required with include=AVAILABILITY.

```json
["POD", "SERVERLESS"]
```

--------------------------------

### Successful response for get data center

Source: https://docs.runpod.io/api-reference-v2/catalog/get-a-data-center

Example 200 response containing data center details such as id, name, region, network volume types, compliance, and GPU/CPU availability.

```json
{
  "id": "US-KS-2",
  "name": "US Kansas 2",
  "region": "NORTH_AMERICA",
  "globalNetwork": true,
  "networkVolumeTypes": [
    "STANDARD",
    "HIGH_PERFORMANCE"
  ],
  "compliance": [
    "SOC_2_TYPE_2",
    "ISO_IEC_27001"
  ],
  "gpuAvailability": [
    {
      "id": "NVIDIA GeForce RTX 4090",
      "name": "RTX 4090",
      "availability": "HIGH"
    }
  ],
  "cpuAvailability": [
    {
      "id": "cpu3c-2-4",
      "name": "Compute-Optimized",
      "availability": "MEDIUM"
    }
  ]
}
```

--------------------------------

### Successful response for getting a serverless endpoint build

Source: https://docs.runpod.io/api-reference-v2/serverless/get-a-serverless-endpoint-build

Example 200 response containing build details such as id, status, commit information, and image name.

```json
{
  "id": "build_abc123",
  "status": "COMPLETED",
  "commitHash": "abc1234",
  "commitMessage": "bump model",
  "branch": "main",
  "commitDate": "2026-06-01T12:00:00Z",
  "imageName": "registry.runpod.net/repo:abc1234",
  "startedAt": "2026-06-01T12:00:05Z",
  "completedAt": "2026-06-01T12:04:31Z",
  "error": null
}
```

--------------------------------

### Query parameter include example

Source: https://docs.runpod.io/api-reference-v2/catalog/get-a-data-center

Example value for the 'include' query parameter, which can be used to expand GPU_AVAILABILITY or CPU_AVAILABILITY.

```json
["GPU_AVAILABILITY"]
```

--------------------------------

### Successful response for get a CPU type

Source: https://docs.runpod.io/api-reference-v2/catalog/get-a-cpu-type

Example 200 response containing CPU type details including id, name, group, vcpu, ramGbPerVcpu, price, availability, and dataCenters.

```json
{
  "id": "cpu3c-2-4",
  "name": "Compute-Optimized",
  "group": "Gen 3",
  "vcpu": {
    "min": 2,
    "max": 32
  },
  "ramGbPerVcpu": 2.5,
  "price": {
    "securePerVcpu": 0.04,
    "serverlessPerVcpu": 0.03
  },
  "availability": "MEDIUM",
  "dataCenters": [
    {
      "id": "US-KS-2",
      "name": "US Kansas 2",
      "availability": "MEDIUM"
    }
  ]
}
```

--------------------------------

### List serverless endpoint builds - request examples

Source: https://docs.runpod.io/api-reference-v2/serverless/list-serverless-endpoint-builds

Example requests for the List serverless endpoint builds endpoint. All examples send a GET request to https://api.runpod.io/v2/serverless/{id}/builds with an Authorization header containing a Bearer token. The endpoint returns a list of builds for the specified serverless endpoint ID.

```cURL
curl --request GET \
  --url https://api.runpod.io/v2/serverless/{id}/builds \
  --header 'Authorization: Bearer <token>'
```

```Python
import requests

url = "https://api.runpod.io/v2/serverless/{id}/builds"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
```

```JavaScript
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.runpod.io/v2/serverless/{id}/builds', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
```

```PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.runpod.io/v2/serverless/{id}/builds",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
```

```Go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.runpod.io/v2/serverless/{id}/builds"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

```Java
HttpResponse<String> response = Unirest.get("https://api.runpod.io/v2/serverless/{id}/builds")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```Ruby
require 'uri'
require 'net/http'

url = URI("https://api.runpod.io/v2/serverless/{id}/builds")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

--------------------------------

### 404 response for getting a container registry credential

Source: https://docs.runpod.io/api-reference-v2/registries/get-a-container-registry-credential

Example error response when the resource is not found.

```json
{
  "title": "Not Found",
  "status": 404,
  "detail": "resource not found"
}

```

--------------------------------

### 200 OK response for serverless endpoint

Source: https://docs.runpod.io/api-reference-v2/serverless/get-a-serverless-endpoint

Example 200 OK response for a successful GET request. Shows the full serverless endpoint configuration including id, name, type, requestUrls, image, gpu, workers, scaling, and other fields.

```json
{
  "id": "4m7x2k9q",
  "name": "image-generator",
  "type": "LOAD_BALANCER",
  "requestUrls": {
    "base": "https://4m7x2k9q.api.runpod.ai",
    "health": "https://4m7x2k9q.api.runpod.ai/ping"
  },
  "image": "runpod/pytorch:1.0.2-cu1281-torch280-ubuntu2404",
  "args": "",
  "disk": 20,
  "ports": [
    "8000/http"
  ],
  "env": {
    "MODEL_NAME": "sdxl"
  },
  "registry": null,
  "gpu": {
    "pools": [
      "ADA_24"
    ],
    "count": 1,
    "allowedCudaVersions": [],
    "minCudaVersion": null
  },
  "workers": {
    "min": 0,
    "max": 5,
    "idleTimeout": 5
  },
  "scaling": {
    "type": "REQUEST_COUNT",
    "requestCount": 4
  },
  "dataCenterIds": [
    "US-KS-2"
  ],
  "networkVolumes": [
    "2q9m7x4c"
  ],
  "timeout": 300000,
  "flashboot": "OFF",
  "createdAt": "2026-06-01T12:00:00Z"
}
```

--------------------------------

### 200 response for getting a container registry credential

Source: https://docs.runpod.io/api-reference-v2/registries/get-a-container-registry-credential

Example success response containing the registry credential details.

```json
{
  "id": "6n2k8v4d",
  "name": "dockerhub-private"
}

```

--------------------------------

### entrypoint field example

Source: https://docs.runpod.io/api-reference-v2/serverless/create-a-serverless-endpoint

Example of the `entrypoint` field in exec form, overriding the image's own ENTRYPOINT.

```json
["/bin/bash", "-c"]
```

--------------------------------

### cmd field example

Source: https://docs.runpod.io/api-reference-v2/serverless/create-a-serverless-endpoint

Example of the `cmd` field in exec form, showing a list of arguments passed to the container's ENTRYPOINT.

```json
[  
  "--model",  
  "meta-llama/Llama-3-8B",  
  "--max-model-len",  
  "8192"  
]
```

--------------------------------

### ports field example

Source: https://docs.runpod.io/api-reference-v2/serverless/create-a-serverless-endpoint

Example of the `ports` field, listing exposed ports formatted as port/protocol.

```json
["8888/http", "22/tcp"]
```

--------------------------------

### GET /v2/registries/delegations

Source: https://docs.runpod.io/api-reference-v2/registries/list-all-ecr-delegations

This snippet documents the GET /v2/registries/delegations endpoint, which lists all ECR delegations. It includes the endpoint URL, required authorization header, and the response structure with example JSON.

```APIDOC
## GET /v2/registries/delegations

### Description
Lists all ECR delegations associated with the authenticated user.

### Method
GET

### Endpoint
https://api.runpod.io/v2/registries/delegations

### Parameters
#### Headers
- **Authorization** (string) - Required - Bearer token for authentication.

### Request Example
No request body is required.

### Response
#### Success Response (200)
- **delegations** (object[]) - Required - List of delegation objects.

#### Response Example
```json
{
  "delegations": [
    {
      "id": "deleg_abc123",
      "delegatorUserId": "user_xyz",
      "awsUser": "123456789",
      "repository": "runpod/deployment",
      "tag": "latest",
      "awsRegion": "us-east-2",
      "createdAt": "2026-03-13T20:00:00Z",
      "name": "my-delegation",
      "dockerRegistryUri": "123456789.dkr.ecr.us-east-2.amazonaws.com"
    }
  ]
}
```

#### Error Responses
- **401 Unauthorized** - Missing or invalid bearer token.
- **403 Forbidden** - Access denied.
- **429 Too Many Requests** - Rate limit exceeded.
- **404 Not Found** - Resource not found.

#### Error Response Example (401)
```json
{
  "title": "Unauthorized",
  "status": 401,
  "detail": "missing bearer token"
}
```
```

--------------------------------

### List cluster pods with Go

Source: https://docs.runpod.io/api-reference-v2/clusters/list-a-clusters-pods

Go example using net/http to list pods in a cluster. Replace {id} and <token> with your cluster ID and API token.

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.runpod.io/v2/clusters/{id}/pods"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

--------------------------------

### 403 response for getting a container registry credential

Source: https://docs.runpod.io/api-reference-v2/registries/get-a-container-registry-credential

Example error response when access is denied.

```json
{
  "title": "Forbidden",
  "status": 403,
  "detail": "access denied"
}

```

--------------------------------

### 401 response for getting a container registry credential

Source: https://docs.runpod.io/api-reference-v2/registries/get-a-container-registry-credential

Example error response when the request is unauthorized.

```json
{
  "title": "Unauthorized",
  "status": 401,
  "detail": "missing bearer token"
}

```

--------------------------------

### Go example to replace SSH keys

Source: https://docs.runpod.io/api-reference-v2/account/replace-registered-ssh-public-keys

Uses net/http to send a PUT request with the keys in the body. Prints the response body.

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.runpod.io/v2/account/ssh-keys"

	payload := strings.NewReader("{\n  \"keys\": [\n    \"ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAILXGDN/SclOozk1xsDztpmhGiKkkrfQB9SKoO8dSIQQZ me@example.com\"\n  ]\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

--------------------------------

### Successful response for getting a secret

Source: https://docs.runpod.io/api-reference-v2/account/get-a-secret

Example of a 200 response containing the secret details.

```json
{
  "id": "2q9m7x4cavgd",
  "name": "hf-token",
  "description": "Hugging Face read token",
  "createdAt": "2026-08-01T12:00:00Z",
  "valueLastUpdatedAt": "2026-09-01T08:30:00Z"
}
```

--------------------------------

### Create registry credential with Go

Source: https://docs.runpod.io/api-reference-v2/registries/create-a-container-registry-credential

Uses the net/http package to POST a new registry credential. Prints the response body.

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.runpod.io/v2/registries"

	payload := strings.NewReader("{\n  \"name\": \"dockerhub-private\",\n  \"username\": \"runpod-user\",\n  \"password\": \"correct-horse-battery-staple\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

--------------------------------

### 201 response with endpoint details

Source: https://docs.runpod.io/api-reference-v2/serverless/create-a-serverless-endpoint

Example response returned when the endpoint is created successfully. Contains the endpoint ID, request URLs, and configuration details such as GPU, workers, scaling, and timeout.

```json
{
  "id": "4m7x2k9q",
  "name": "image-generator",
  "type": "QUEUE",
  "requestUrls": {
    "run": "https://api.runpod.ai/v2/4m7x2k9q/run",
    "runSync": "https://api.runpod.ai/v2/4m7x2k9q/runsync",
    "status": "https://api.runpod.ai/v2/4m7x2k9q/status/{job_id}",
    "stream": "https://api.runpod.ai/v2/4m7x2k9q/stream/{job_id}",
    "cancel": "https://api.runpod.ai/v2/4m7x2k9q/cancel/{job_id}",
    "retry": "https://api.runpod.ai/v2/4m7x2k9q/retry/{job_id}",
    "purgeQueue": "https://api.runpod.ai/v2/4m7x2k9q/purge-queue",
    "health": "https://api.runpod.ai/v2/4m7x2k9q/health"
  },
  "image": "runpod/pytorch:1.0.2-cu1281-torch280-ubuntu2404",
  "args": "",
  "disk": 20,
  "ports": [
    "8000/http"
  ],
  "env": {
    "MODEL_NAME": "sdxl"
  },
  "registry": null,
  "gpu": {
    "pools": [
      "ADA_24"
    ],
    "count": 1,
    "allowedCudaVersions": [],
    "minCudaVersion": null
  },
  "workers": {
    "min": 0,
    "max": 5,
    "idleTimeout": 5
  },
  "scaling": {
    "type": "QUEUE_DELAY",
    "queueDelay": 4
  },
  "dataCenterIds": [
    "US-KS-2"
  ],
  "networkVolumes": [
    "2q9m7x4c"
  ],
  "timeout": 300000,
  "flashboot": "OFF",
  "createdAt": "2026-06-01T12:00:00Z"
}
```

--------------------------------

### 429 response for getting a container registry credential

Source: https://docs.runpod.io/api-reference-v2/registries/get-a-container-registry-credential

Example error response when the rate limit is exceeded.

```json
{
  "title": "Too Many Requests",
  "status": 429,
  "detail": "rate limit exceeded for the minute window"
}

```

--------------------------------

### Successful response for listing serverless endpoint releases

Source: https://docs.runpod.io/api-reference-v2/serverless/list-serverless-endpoint-releases

Example 200 response containing endpoint version, rollout status, release list, and pagination information.

```json
{
  "endpointVersion": 4,
  "rollout": {
    "inProgress": true,
    "workersOnLatest": 1,
    "workersTotal": 2,
    "percentOnLatest": 50
  },
  "releases": [
    {
      "id": "5r9x2m7q",
      "version": 4,
      "source": "MANUAL",
      "buildId": null,
      "createdByUserId": null,
      "workerCount": 2,
      "createdAt": "2026-06-01T12:10:00Z",
      "diff": [
        {
          "field": "workers.max",
          "old": 5,
          "new": 10
        }
      ]
    }
  ],
  "pagination": {
    "nextCursor": null,
    "hasNextPage": false
  }
}
```

--------------------------------

### List cluster pods with JavaScript fetch

Source: https://docs.runpod.io/api-reference-v2/clusters/list-a-clusters-pods

JavaScript example using fetch to list pods in a cluster. Replace {id} and <token> with your cluster ID and API token.

```javascript
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.runpod.io/v2/clusters/{id}/pods', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
```

--------------------------------

### GET /v2/catalog/cpus/{id}

Source: https://docs.runpod.io/api-reference-v2/catalog/get-a-cpu-type

Complete API documentation for retrieving a CPU type by ID, including request, response, and error examples.

```APIDOC
## GET /v2/catalog/cpus/{id}

### Description
Retrieves details for a specific CPU type by its identifier.

### Method
GET

### Endpoint
https://api.runpod.io/v2/catalog/cpus/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - CPU flavor identifier (use in cpu.id for pod creation).

### Request Example
No request body required.

### Response
#### Success Response (200)
- **id** (string) - CPU flavor identifier (use in cpu.id for pod creation).
- **name** (string) - Human-readable flavor name.
- **group** (string) - CPU generation group.
- **vcpu** (object) - Contains min and max vCPU counts.
- **ramGbPerVcpu** (number<float>) - GB of RAM allocated per vCPU.
- **price** (object) - Contains pricing per vCPU for secure and serverless.
- **availability** (enum<string>) - Overall CPU availability (NONE, LOW, MEDIUM, HIGH). Present only when requested with include=AVAILABILITY.
- **dataCenters** (object[]) - Per-datacenter CPU availability. Present only when requested with include=AVAILABILITY.

#### Response Example
{
  "id": "cpu3c-2-4",
  "name": "Compute-Optimized",
  "group": "Gen 3",
  "vcpu": {
    "min": 2,
    "max": 32
  },
  "ramGbPerVcpu": 2.5,
  "price": {
    "securePerVcpu": 0.04,
    "serverlessPerVcpu": 0.03
  },
  "availability": "MEDIUM",
  "dataCenters": [
    {
      "id": "US-KS-2",
      "name": "US Kansas 2",
      "availability": "MEDIUM"
    }
  ]
}

### Error Responses
#### 401 Unauthorized
{
  "title": "Unauthorized",
  "status": 401,
  "detail": "missing bearer token"
}

#### 403 Forbidden
{
  "title": "Forbidden",
  "status": 403,
  "detail": "access denied"
}

#### 404 Not Found
{
  "title": "Not Found",
  "status": 404,
  "detail": "resource not found"
}

#### 429 Too Many Requests
{
  "title": "Too Many Requests",
  "status": 429,
  "detail": "rate limit exceeded for the minute window"
}

#### default Error
{
  "title": "Not Found",
  "status": 404,
  "detail": "pod not found",
  "errors": [
    "$: additional properties 'bogus' not allowed"
  ]
}
```

--------------------------------

### List cluster pods with Python requests

Source: https://docs.runpod.io/api-reference-v2/clusters/list-a-clusters-pods

Python example using the requests library to list pods in a cluster. Replace {id} and <token> with your cluster ID and API token.

```python
import requests

url = "https://api.runpod.io/v2/clusters/{id}/pods"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
```

--------------------------------

### default response for getting a container registry credential

Source: https://docs.runpod.io/api-reference-v2/registries/get-a-container-registry-credential

Example error response for a default error case, showing additional validation errors.

```json
{
  "title": "Not Found",
  "status": 404,
  "detail": "pod not found",
  "errors": [
    "$: additional properties 'bogus' not allowed"
  ]
}

```

--------------------------------

### 200 Response for Get a GPU type

Source: https://docs.runpod.io/api-reference-v2/catalog/get-a-gpu-type

Example of a successful 200 response for the Get a GPU type endpoint. It shows the GPU details including ID, name, pool, manufacturer, memory, secure/community flags, pricing, max counts, availability, and data centers.

```json
{
  "id": "NVIDIA GeForce RTX 4090",
  "name": "RTX 4090",
  "pool": "ADA_24",
  "manufacturer": "NVIDIA",
  "memory": 24,
  "secure": true,
  "community": true,
  "price": {
    "secure": 0.44,
    "community": 0.31,
    "serverless": 1.1
  },
  "maxCount": {
    "secure": 8,
    "community": 4
  },
  "availability": "HIGH",
  "dataCenters": [
    {
      "id": "US-KS-2",
      "name": "US Kansas 2",
      "availability": "HIGH"
    }
  ]
}
```

--------------------------------

### List cluster pods with Ruby Net::HTTP

Source: https://docs.runpod.io/api-reference-v2/clusters/list-a-clusters-pods

Ruby example using Net::HTTP to list pods in a cluster. Replace {id} and <token> with your cluster ID and API token.

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.runpod.io/v2/clusters/{id}/pods")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

--------------------------------

### List secrets with cURL, Python, JavaScript, PHP, Go, Java, and Ruby

Source: https://docs.runpod.io/api-reference-v2/account/list-secrets

These examples show how to call the Runpod API v2 endpoint GET /v2/account/secrets to list secrets. Each example uses the same URL and Authorization header with a bearer token. The response is a JSON object containing an array of secrets.

```cURL
curl --request GET \
  --url https://api.runpod.io/v2/account/secrets \
  --header 'Authorization: Bearer <token>'
```

```Python
import requests

url = "https://api.runpod.io/v2/account/secrets"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
```

```JavaScript
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.runpod.io/v2/account/secrets', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
```

```PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.runpod.io/v2/account/secrets",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
```

```Go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.runpod.io/v2/account/secrets"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

```Java
HttpResponse<String> response = Unirest.get("https://api.runpod.io/v2/account/secrets")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```Ruby
require 'uri'
require 'net/http'

url = URI("https://api.runpod.io/v2/account/secrets")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

--------------------------------

### List serverless endpoint workers - API request examples

Source: https://docs.runpod.io/api-reference-v2/serverless/list-serverless-endpoint-workers

These examples show how to call the List serverless endpoint workers endpoint using different languages. All use the GET method with the Authorization header set to 'Bearer <token>'. The endpoint returns a list of workers for the specified serverless endpoint ID.

```cURL
curl --request GET \
  --url https://api.runpod.io/v2/serverless/{id}/workers \
  --header 'Authorization: Bearer <token>'
```

```Python
import requests

url = "https://api.runpod.io/v2/serverless/{id}/workers"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
```

```JavaScript
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.runpod.io/v2/serverless/{id}/workers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
```

```PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.runpod.io/v2/serverless/{id}/workers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
```

```Go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.runpod.io/v2/serverless/{id}/workers"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

```Java
HttpResponse<String> response = Unirest.get("https://api.runpod.io/v2/serverless/{id}/workers")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```Ruby
require 'uri'
require 'net/http'

url = URI("https://api.runpod.io/v2/serverless/{id}/workers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

--------------------------------

### Create cluster with Net::HTTP (Ruby)

Source: https://docs.runpod.io/api-reference-v2/clusters/create-a-cluster

Ruby example using Net::HTTP to POST to the RunPod v2 clusters endpoint. Requires a valid bearer token and a JSON body with cluster configuration. Prints the response body.

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.runpod.io/v2/clusters")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"compute\": {\n    \"gpuTypeId\": \"NVIDIA H100 80GB HBM3\",\n    \"gpuCountPerPod\": 8,\n    \"podCount\": 4\n  },\n  \"name\": \"my-training-cluster\",\n  \"type\": \"TRAINING\",\n  \"args\": \"--model meta-llama/Llama-3-8B --max-model-len 8192\",\n  \"cmd\": [\n    \"--model\",\n    \"meta-llama/Llama-3-8B\",\n    \"--max-model-len\",\n    \"8192\"\n  ],\n  \"entrypoint\": [\n    \"/bin/bash\",\n    \"-c\"\n  ],\n  \"disk\": 50,\n  \"env\": {\n    \"JUPYTER_PASSWORD\": \"hunter2\"\n  },\n  \"image\": \"runpod/pytorch:1.0.2-cu1281-torch280-ubuntu2404\",\n  \"ports\": [\n    \"8888/http\",\n    \"22/tcp\"\n  ],\n  \"templateId\": \"30zmvf89kd\",\n  \"dataCenterIds\": [\n    \"US-TX-3\"\n  ],\n  \"mounts\": {\n    \"network\": [\n      {\n        \"volumeId\": \"vol_xyz\",\n        \"path\": \"/runpod-volume\"\n      }\n    ]\n  },\n  \"startJupyter\": false,\n  \"startSsh\": false\n}"

response = http.request(request)
puts response.read_body
```

--------------------------------

### Successful response for list GPU types

Source: https://docs.runpod.io/api-reference-v2/catalog/list-gpu-types

Example 200 response containing a list of GPU objects with fields like id, name, memory, price, and availability.

```json
{
  "gpus": [
    {
      "id": "NVIDIA GeForce RTX 4090",
      "name": "RTX 4090",
      "pool": "ADA_24",
      "manufacturer": "NVIDIA",
      "memory": 24,
      "secure": true,
      "community": true,
      "price": {
        "secure": 0.44,
        "community": 0.31,
        "serverless": 1.1
      },
      "maxCount": {
        "secure": 8,
        "community": 4
      },
      "availability": "HIGH",
      "dataCenters": [
        {
          "id": "US-KS-2",
          "name": "US Kansas 2",
          "availability": "HIGH"
        }
      ]
    }
  ]
}
```

--------------------------------

### List cluster pods with Java Unirest

Source: https://docs.runpod.io/api-reference-v2/clusters/list-a-clusters-pods

Java example using Unirest to list pods in a cluster. Replace {id} and <token> with your cluster ID and API token.

```java
HttpResponse<String> response = Unirest.get("https://api.runpod.io/v2/clusters/{id}/pods")
  .header("Authorization", "Bearer <token>")
  .asString();
```

--------------------------------

### Fetch OpenAPI schema with cURL or Python

Source: https://docs.runpod.io/api-reference/overview

Retrieve the OpenAPI specification for Runpod REST API v1. The cURL command uses the --request GET flag and the Python example uses the requests library. Both target the same endpoint and are presented as interchangeable alternatives.

```bash
curl --request GET \
  --url https://rest.runpod.io/v1/openapi.json \  
```

```python
import requests

url = "https://rest.runpod.io/v1/openapi.json"
response = requests.get(url)
print(response.json())

```

--------------------------------

### Go request to list GPU types

Source: https://docs.runpod.io/api-reference-v2/catalog/list-gpu-types

Uses the net/http package to send a GET request with an Authorization header. Reads and prints the response body.

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.runpod.io/v2/catalog/gpus?count=1"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

--------------------------------

### List clusters with cURL, Python, JavaScript, PHP, Go, Java, and Ruby

Source: https://docs.runpod.io/api-reference-v2/clusters/list-clusters

Send a GET request to the Runpod API endpoint to list clusters. All examples use the same endpoint and require an Authorization header with a bearer token. The response is a JSON object containing an array of clusters.

```bash
curl --request GET \
  --url https://api.runpod.io/v2/clusters \
  --header 'Authorization: Bearer <token>'
```

```python
import requests

url = "https://api.runpod.io/v2/clusters"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
```

```javascript
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.runpod.io/v2/clusters', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
```

```php
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.runpod.io/v2/clusters",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.runpod.io/v2/clusters"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

```java
HttpResponse<String> response = Unirest.get("https://api.runpod.io/v2/clusters")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.runpod.io/v2/clusters")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

--------------------------------

### List all ECR delegations - cURL, Python, JavaScript, PHP, Go, Java, Ruby

Source: https://docs.runpod.io/api-reference-v2/registries/list-all-ecr-delegations

Send a GET request to the /v2/registries/delegations endpoint to list all ECR delegations. Each example uses the same URL and requires an Authorization header with a Bearer token. The response is a JSON object containing a delegations array.

```bash
curl --request GET \
  --url https://api.runpod.io/v2/registries/delegations \
  --header 'Authorization: Bearer <token>'
```

```python
import requests

url = "https://api.runpod.io/v2/registries/delegations"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
```

```javascript
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.runpod.io/v2/registries/delegations', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
```

```php
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.runpod.io/v2/registries/delegations",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.runpod.io/v2/registries/delegations"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

```java
HttpResponse<String> response = Unirest.get("https://api.runpod.io/v2/registries/delegations")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.runpod.io/v2/registries/delegations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

--------------------------------

### List GPU types - cURL, Python, JavaScript, PHP, Go, Java, Ruby

Source: https://docs.runpod.io/api-reference-v2/catalog/list-gpu-types

Example requests to the List GPU types endpoint. Each request uses the GET method with the Authorization header set to a bearer token. The response is a JSON object containing a list of GPU types.

```bash
curl --request GET \
  --url 'https://api.runpod.io/v2/catalog/gpus?count=1' \
  --header 'Authorization: Bearer <token>'
```

```python
import requests

url = "https://api.runpod.io/v2/catalog/gpus?count=1"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
```

```javascript
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.runpod.io/v2/catalog/gpus?count=1', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
```

```php
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.runpod.io/v2/catalog/gpus?count=1",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.runpod.io/v2/catalog/gpus?count=1"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

```java
HttpResponse<String> response = Unirest.get("https://api.runpod.io/v2/catalog/gpus?count=1")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.runpod.io/v2/catalog/gpus?count=1")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

--------------------------------

### Response 200: List clusters

Source: https://docs.runpod.io/api-reference-v2/clusters/list-clusters

Example successful response containing a list of clusters with details such as id, name, type, compute, pods, network, and primary.

```json
{
  "clusters": [
    {
      "id": "cluster_abc123",
      "name": "my-training-cluster",
      "type": "TRAINING",
      "compute": {
        "gpuTypeId": "NVIDIA H100 80GB HBM3",
        "gpuCountPerPod": 8,
        "podCount": 4
      },
      "pods": {
        "total": 4,
        "byStatus": {
          "RUNNING": 3,
          "PROVISIONING": 1
        }
      },
      "createdAt": "2026-06-29T20:00:00Z",
      "template": "tpl_abc",
      "dataCenterId": "US-TX-3",
      "network": {
        "cidr": "10.65.0.0/16",
        "vxlanId": 42,
        "vxlanPort": 4789
      },
      "primary": {
        "podId": "pod_node0",
        "status": "PROVISIONING",
        "sshEndpoint": "1.2.3.4:22001"
      }
    }
  ]
}
```

--------------------------------

### List public templates with Go

Source: https://docs.runpod.io/api-reference-v2/catalog/list-public-templates

Uses Go's net/http package to send a GET request to the Runpod API and prints the response body.

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.runpod.io/v2/catalog/templates?source=official"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```
Tokens:
Raw