Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions api-reference-v2/account/create-a-secret.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
openapi: post /v2/account/secrets
description: Create an encrypted Runpod account secret that Pods, Serverless endpoints, and templates can reference from environment variables at boot.
---
4 changes: 4 additions & 0 deletions api-reference-v2/account/delete-a-secret.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
openapi: delete /v2/account/secrets/{id}
description: Delete a Runpod account secret so Pods, Serverless endpoints, and templates can no longer resolve it from environment variables.
---
4 changes: 4 additions & 0 deletions api-reference-v2/account/get-a-secret.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
openapi: get /v2/account/secrets/{id}
description: Retrieve a Runpod account secret's metadata by ID. The secret value is write-only and is never returned.
---
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---
openapi: get /v2/account/ssh-keys
description: "List the SSH public keys registered to your Runpod account and used to authenticate secure connections to newly created Pods."
description: List the SSH public keys registered to your Runpod account and used to authenticate secure connections to newly created Pods.
---
4 changes: 4 additions & 0 deletions api-reference-v2/account/list-secrets.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
openapi: get /v2/account/secrets
description: List the encrypted secrets on your Runpod account that Pods, Serverless endpoints, and templates reference from environment variables. Values are never returned.
---
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---
openapi: put /v2/account/ssh-keys
description: "Replace all SSH public keys registered to your Runpod account, remove omitted keys, and apply the new set to subsequently created Pods."
description: Replace all SSH public keys registered to your Runpod account, remove omitted keys, and apply the new set to subsequently created Pods.
---
4 changes: 4 additions & 0 deletions api-reference-v2/account/update-a-secret.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
openapi: patch /v2/account/secrets/{id}
description: Update a Runpod account secret's description or rotate its value. The new value takes effect the next time a referencing Pod or worker boots.
---
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---
openapi: get /v2/billing
description: "Retrieve time-bucketed total Runpod spend across Pods, Serverless, storage, Public Endpoints, and Clusters for the authenticated account."
description: Retrieve time-bucketed total Runpod spend across Pods, Serverless, storage, Public Endpoints, and Clusters for the authenticated account.
---
2 changes: 1 addition & 1 deletion api-reference-v2/billing/get-cluster-billing-history.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---
openapi: get /v2/billing/clusters
description: "Retrieve time-bucketed Runpod Cluster billing history, including GPU compute, disk, inter-node networking, and total costs."
description: Retrieve time-bucketed Runpod Cluster billing history, including GPU compute, disk, inter-node networking, and total costs.
---
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---
openapi: get /v2/billing/network-volumes
description: "Retrieve time-bucketed billing history for one or all Runpod network volumes, including storage tiers, totals, and query metadata."
description: Retrieve time-bucketed billing history for one or all Runpod network volumes, including storage tiers, totals, and query metadata.
---
2 changes: 1 addition & 1 deletion api-reference-v2/billing/get-pod-billing-history.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---
openapi: get /v2/billing/pods
description: "Retrieve time-bucketed billing details for one or all Runpod Pods, including GPU, CPU, disk, total costs, and query metadata."
description: Retrieve time-bucketed billing details for one or all Runpod Pods, including GPU, CPU, disk, total costs, and query metadata.
---
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---
openapi: get /v2/billing/endpoints
description: "Retrieve time-bucketed billing history for Runpod Public Endpoints, including endpoint totals and resolved query metadata."
description: Retrieve time-bucketed billing history for Runpod Public Endpoints, including endpoint totals and resolved query metadata.
---
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---
openapi: get /v2/billing/serverless
description: "Retrieve time-bucketed billing history for one or all Runpod Serverless endpoints, including compute, disk, platform, and total costs."
description: Retrieve time-bucketed billing history for one or all Runpod Serverless endpoints, including compute, disk, platform, and total costs.
---
2 changes: 1 addition & 1 deletion api-reference-v2/catalog/get-a-cpu-type.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---
openapi: get /v2/catalog/cpus/{id}
description: "Retrieve one Runpod CPU type with pricing and optional availability details for a specified product and deployment context."
description: Retrieve one Runpod CPU type with pricing and optional availability details for a specified product and deployment context.
---
1 change: 1 addition & 0 deletions api-reference-v2/catalog/get-a-data-center.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
openapi: get /v2/catalog/datacenters/{id}
description: Retrieve a single Runpod data center by ID, optionally including current GPU or CPU availability for Pod deployment.
---
2 changes: 1 addition & 1 deletion api-reference-v2/catalog/get-a-gpu-type.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---
openapi: get /v2/catalog/gpus/{id}
description: "Retrieve one Runpod GPU type with pricing and optional availability details for a specified product and deployment context."
description: Retrieve one Runpod GPU type with pricing and optional availability details for a specified product and deployment context.
---
2 changes: 1 addition & 1 deletion api-reference-v2/catalog/list-cpu-types.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---
openapi: get /v2/catalog/cpus
description: "List available Runpod CPU types with pricing and optional availability details for a specified product and deployment context."
description: List available Runpod CPU types with pricing and optional availability details for a specified product and deployment context.
---
2 changes: 1 addition & 1 deletion api-reference-v2/catalog/list-data-centers.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---
openapi: get /v2/catalog/datacenters
description: "List Runpod data centers with region, compliance, storage, networking, and optional GPU or CPU availability details."
description: List Runpod data centers with region, compliance, storage, networking, and optional GPU or CPU availability details.
---
2 changes: 1 addition & 1 deletion api-reference-v2/catalog/list-gpu-types.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---
openapi: get /v2/catalog/gpus
description: "List available Runpod GPU types with pricing and optional availability filters by product, country, and deployment context."
description: List available Runpod GPU types with pricing and optional availability filters by product, country, and deployment context.
---
2 changes: 1 addition & 1 deletion api-reference-v2/catalog/list-public-templates.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---
openapi: get /v2/catalog/templates
description: "List Runpod public templates by official, verified, or community source and inspect reusable Pod and Serverless configurations."
description: List Runpod public templates by official, verified, or community source and inspect reusable Pod and Serverless configurations.
---
2 changes: 1 addition & 1 deletion api-reference-v2/clusters/create-a-cluster.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---
openapi: post /v2/clusters
description: "Create a multi-node Runpod Cluster with a consistent compute shape and container configuration across every member Pod."
description: Create a multi-node Runpod Cluster with a consistent compute shape and container configuration across every member Pod.
---
2 changes: 1 addition & 1 deletion api-reference-v2/clusters/delete-a-cluster.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---
openapi: delete /v2/clusters/{id}
description: "Permanently delete a Runpod Cluster and terminate all of its member Pods, with the response confirming the deleted Cluster."
description: Permanently delete a Runpod Cluster and terminate all of its member Pods, with the response confirming the deleted Cluster.
---
1 change: 1 addition & 0 deletions api-reference-v2/clusters/get-a-cluster.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
openapi: get /v2/clusters/{id}
description: Retrieve a Runpod Cluster by ID with its configuration, status, and an aggregate summary of member Pods by status.
---
2 changes: 1 addition & 1 deletion api-reference-v2/clusters/list-a-clusters-pods.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---
openapi: get /v2/clusters/{id}/pods
description: "List every Pod in a Runpod Cluster with each member's complete configuration and status, beyond the aggregate counts in the Cluster summary."
description: List every Pod in a Runpod Cluster with each member's complete configuration and status, beyond the aggregate counts in the Cluster summary.
---
2 changes: 1 addition & 1 deletion api-reference-v2/clusters/list-clusters.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---
openapi: get /v2/clusters
description: "List all Runpod Clusters owned by the authenticated user, including each Cluster's configuration, status, and aggregate Pod counts."
description: List all Runpod Clusters owned by the authenticated user, including each Cluster's configuration, status, and aggregate Pod counts.
---
1 change: 1 addition & 0 deletions api-reference-v2/clusters/rename-a-cluster.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
openapi: patch /v2/clusters/{id}
description: Rename a Runpod Cluster. Compute shape, type, and container configuration are fixed at creation and cannot be changed.
---
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---
openapi: post /v2/network-volumes
description: "Create a persistent Runpod network volume with a name, size, data center, and storage tier for use by Pods and Serverless workers."
description: Create a persistent Runpod network volume with a name, size, data center, and storage tier for use by Pods and Serverless workers.
---
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---
openapi: delete /v2/network-volumes/{id}
description: "Permanently delete a Runpod network volume, release its persistent storage, and confirm the removed volume in the response."
description: Permanently delete a Runpod network volume, release its persistent storage, and confirm the removed volume in the response.
---
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---
openapi: get /v2/network-volumes/{id}
description: "Retrieve a Runpod network volume by ID with its name, size, data center, storage tier, and current resource details."
description: Retrieve a Runpod network volume by ID with its name, size, data center, storage tier, and current resource details.
---
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---
openapi: get /v2/network-volumes
description: "List all network volumes owned by the authenticated Runpod user, including each volume's size, data center, and storage tier."
description: List all network volumes owned by the authenticated Runpod user, including each volume's size, data center, and storage tier.
---
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
openapi: patch /v2/network-volumes/{id}
description: Update a Runpod network volume's mutable fields, such as its name or size. Size can only be increased, never reduced.
---
Loading
Loading