Runpod GraphQL API Spec
Runpod API spec includes most common GraphQL types, queries, and mutations to manage your pods. If you need additional support, contact us.
API Endpoints
https://api.runpod.io/graphqlHeaders
Authorization: Bearer <RUNPOD_API_KEY>Version
1.1.0
Queries
cpuTypes
Response
Returns [CpuType]
Example
Query
query cpuTypes {
cpuTypes {
id
displayName
manufacturer
cores
threadsPerCore
groupId
}
}
Response
{
"data": {
"cpuTypes": [
{
"id": "xyz789",
"displayName": "xyz789",
"manufacturer": "xyz789",
"cores": 123,
"threadsPerCore": 123,
"groupId": "xyz789"
}
]
}
}
gpuTypes
Response
Returns [GpuType]
Arguments
| Name | Description |
|---|---|
input - GpuTypeFilter
|
Example
Query
query gpuTypes($input: GpuTypeFilter) {
gpuTypes(input: $input) {
lowestPrice {
...LowestPriceFragment
}
maxGpuCount
maxGpuCountCommunityCloud
maxGpuCountSecureCloud
minPodGpuCount
nodeGroupGpuSizes
nodeGroupDatacenters {
...DataCenterFragment
}
id
displayName
manufacturer
gpuGeneration
memoryInGb
cudaCores
secureCloud
communityCloud
securePrice
clusterPrice
communityPrice
oneMonthPrice
threeMonthPrice
sixMonthPrice
oneYearPrice
oneWeekPrice
communitySpotPrice
secureSpotPrice
throughput
defaultQuotaAbsolute
}
}
Variables
{"input": GpuTypeFilter}
Response
{
"data": {
"gpuTypes": [
{
"lowestPrice": LowestPrice,
"maxGpuCount": 123,
"maxGpuCountCommunityCloud": 987,
"maxGpuCountSecureCloud": 987,
"minPodGpuCount": 987,
"nodeGroupGpuSizes": [987],
"nodeGroupDatacenters": [DataCenter],
"id": "xyz789",
"displayName": "abc123",
"manufacturer": "xyz789",
"gpuGeneration": "PASCAL",
"memoryInGb": 123,
"cudaCores": 123,
"secureCloud": true,
"communityCloud": false,
"securePrice": 123.45,
"clusterPrice": 987.65,
"communityPrice": 987.65,
"oneMonthPrice": 987.65,
"threeMonthPrice": 123.45,
"sixMonthPrice": 123.45,
"oneYearPrice": 123.45,
"oneWeekPrice": 123.45,
"communitySpotPrice": 987.65,
"secureSpotPrice": 123.45,
"throughput": 987,
"defaultQuotaAbsolute": 987
}
]
}
}
myself
Response
Returns a User
Example
Query
query myself {
myself {
pods {
...PodFragment
}
backgroundPods {
...PodFragment
}
podsConnection {
...PodsConnectionFragment
}
machines {
...MachineFragment
}
hiddenMachines {
...MachineFragment
}
machinesSummary {
...MachineSummaryFragment
}
id
createdAt
updatedAt
authId
email
containerRegistryCreds {
...ContainerRegistryAuthFragment
}
currentSpendPerHr
machineQuota
referralEarned
signedTermsOfService
spendLimit
stripeSavedPaymentId
stripeSavedPaymentLast4
templateEarned
multiFactorEnabled
machineEarnings {
...MachineEarningFragment
}
machineEarningsCustomRange {
...MachineEarningFragment
}
networkStorageEarnings {
...NetworkStorageEarningFragment
}
underBalance
billingMode
minBalance
stripeAutoReloadAmount
stripeAutoPaymentThreshold
spendDetails {
...SpendDetailsFragment
}
maxServerlessConcurrency
clientLifetimeSpend
referralId
datacenters {
...DataCenterFragment
}
githubAccountInfo {
...GithubAccountInfoFragment
}
discordAccountInfo {
...DiscordAccountInfoFragment
}
isAutoPayEnabled
enableBackupPayments
onboardingInfo {
...OnboardingInfoFragment
}
affiliateKey
hasActivated
hasLoadedCredits
referralUsageId
referralEmailUsageCount
activeMigrations {
...PodMigrationFragment
}
poolMemberships
notifyCcList
orgCapabilities
userPreferences {
...UserPreferenceFragment
}
clientBalance
hostBalance
hostStripeLinked
stripeAccountId
stripeReloadHistory {
...StripeReloadTransactionFragment
}
payoutHistory {
...PayoutHistoryFragment
}
dailyCharges {
...ClientCreditChargeFragment
}
referral {
...UserReferralFragment
}
pubKey
sshPublicKeys {
...SshPublicKeyFragment
}
information {
...UserInformationFragment
}
notifyPodsStale
notifyPodsGeneral
notifyLowBalance
creditAlertThreshold
notifyOther
podTemplates {
...PodTemplateFragment
}
creditCodes {
...CreditCodeFragment
}
endpoint {
...EndpointFragment
}
endpoints {
...EndpointFragment
}
networkVolumes {
...NetworkVolumeFragment
}
networkVolumePricing {
...NetworkVolumePricingFragment
}
teams {
...TeamFragment
}
ownedTeams {
...TeamFragment
}
team {
...TeamFragment
}
teamMembership {
...TeamMembershipFragment
}
teamScopes {
...TeamScopesFragment
}
isTeam
savingsPlans {
...SavingsPlanFragment
}
savingsPlan {
...SavingsPlanFragment
}
serverlessDiscount {
...DiscountFragment
}
serverlessDiscounts {
...DiscountFragment
}
billing {
...UserBillingFragment
}
costCenterBilling {
...CostCenterBillingRecordFragment
}
costCenterBillingSummary {
...CostCenterBillingSummaryFragment
}
costCenterBillingCreditCodes {
...CreditTransferFragment
}
secrets {
...SecretFragment
}
globalStoreBuckets {
...GlobalStoreBucketFragment
}
byoObjectStores {
...ByoObjectStoreFragment
}
impersonations {
...ImpersonationFragment
}
activeImpersonation {
...ImpersonationFragment
}
nodeGroups {
...NodeGroupFragment
}
cluster {
...ClusterFragment
}
clusters {
...ClusterFragment
}
clusterExpansionAvailability {
...ClusterExpansionAvailabilityFragment
}
sandbox {
...SandboxFragment
}
sandboxes {
...SandboxFragment
}
apiKeys {
...ApiKeyFragment
}
sharedApiKeys {
...SharedApiKeyFragment
}
paymentMethods {
...PaymentMethodFragment
}
paymentMethodsByPriority {
...PaymentMethodFragment
}
defaultPaymentMethod {
...PaymentMethodFragment
}
reservations {
...ReservationFragment
}
flashApps {
...FlashAppFragment
}
tags {
...TagFragment
}
costCenters {
...CostCenterFragment
}
subscription {
...AccountSubscriptionFragment
}
entitlements {
...EntitlementsFragment
}
entitlementsForTier {
...EntitlementsFragment
}
storageEvictionAt
}
}
Response
{
"data": {
"myself": {
"pods": [Pod],
"backgroundPods": [Pod],
"podsConnection": PodsConnection,
"machines": [Machine],
"hiddenMachines": [Machine],
"machinesSummary": [MachineSummary],
"id": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"authId": "abc123",
"email": "abc123",
"containerRegistryCreds": [ContainerRegistryAuth],
"currentSpendPerHr": 123.45,
"machineQuota": 987,
"referralEarned": 987.65,
"signedTermsOfService": false,
"spendLimit": 123,
"stripeSavedPaymentId": "abc123",
"stripeSavedPaymentLast4": "xyz789",
"templateEarned": 987.65,
"multiFactorEnabled": true,
"machineEarnings": [MachineEarning],
"machineEarningsCustomRange": [MachineEarning],
"networkStorageEarnings": [NetworkStorageEarning],
"underBalance": false,
"billingMode": "PREPAID",
"minBalance": 123.45,
"stripeAutoReloadAmount": 123,
"stripeAutoPaymentThreshold": 123,
"spendDetails": SpendDetails,
"maxServerlessConcurrency": 123,
"clientLifetimeSpend": 987.65,
"referralId": "xyz789",
"datacenters": [DataCenter],
"githubAccountInfo": GithubAccountInfo,
"discordAccountInfo": DiscordAccountInfo,
"isAutoPayEnabled": true,
"enableBackupPayments": true,
"onboardingInfo": OnboardingInfo,
"affiliateKey": "xyz789",
"hasActivated": true,
"hasLoadedCredits": false,
"referralUsageId": "xyz789",
"referralEmailUsageCount": 123,
"activeMigrations": [PodMigration],
"poolMemberships": ["abc123"],
"notifyCcList": "abc123",
"orgCapabilities": ["xyz789"],
"userPreferences": [UserPreference],
"clientBalance": 123.45,
"hostBalance": 987.65,
"hostStripeLinked": true,
"stripeAccountId": "xyz789",
"stripeReloadHistory": [StripeReloadTransaction],
"payoutHistory": [PayoutHistory],
"dailyCharges": [ClientCreditCharge],
"referral": UserReferral,
"pubKey": "xyz789",
"sshPublicKeys": [SshPublicKey],
"information": UserInformation,
"notifyPodsStale": true,
"notifyPodsGeneral": false,
"notifyLowBalance": false,
"creditAlertThreshold": 987.65,
"notifyOther": true,
"podTemplates": [PodTemplate],
"creditCodes": [CreditCode],
"endpoint": Endpoint,
"endpoints": [Endpoint],
"networkVolumes": [NetworkVolume],
"networkVolumePricing": NetworkVolumePricing,
"teams": [Team],
"ownedTeams": [Team],
"team": Team,
"teamMembership": TeamMembership,
"teamScopes": TeamScopes,
"isTeam": true,
"savingsPlans": [SavingsPlan],
"savingsPlan": SavingsPlan,
"serverlessDiscount": Discount,
"serverlessDiscounts": [Discount],
"billing": UserBilling,
"costCenterBilling": [CostCenterBillingRecord],
"costCenterBillingSummary": CostCenterBillingSummary,
"costCenterBillingCreditCodes": [CreditTransfer],
"secrets": [Secret],
"globalStoreBuckets": [GlobalStoreBucket],
"byoObjectStores": [ByoObjectStore],
"impersonations": [Impersonation],
"activeImpersonation": Impersonation,
"nodeGroups": [NodeGroup],
"cluster": Cluster,
"clusters": [Cluster],
"clusterExpansionAvailability": ClusterExpansionAvailability,
"sandbox": Sandbox,
"sandboxes": [Sandbox],
"apiKeys": [ApiKey],
"sharedApiKeys": [SharedApiKey],
"paymentMethods": [PaymentMethod],
"paymentMethodsByPriority": [PaymentMethod],
"defaultPaymentMethod": PaymentMethod,
"reservations": [Reservation],
"flashApps": [FlashApp],
"tags": [Tag],
"costCenters": [CostCenter],
"subscription": AccountSubscription,
"entitlements": Entitlements,
"entitlementsForTier": Entitlements,
"storageEvictionAt": "2007-12-03T10:15:30Z"
}
}
}
pod
Example
Query
query pod($input: PodFilter) {
pod(input: $input) {
lowestBidPriceToResume
aiApiId
apiKey
clusterIp
clusterIdx
clusterRole
consumerUserId
createdByUserId
createdByUser {
...ResourceUserFragment
}
containerDiskInGb
containerRegistryAuthId
costMultiplier
costPerHr
createdAt
adjustedCostPerHr
desiredStatus
dockerArgs
dockerId
env
envKeyValue {
...EnvironmentVariableFragment
}
gpuCount
gpuPowerLimitPercent
gpus {
...GpuFragment
}
id
imageName
lastStatusChange
locked
machineId
memoryInGb
name
podType
port
ports
sandboxId
sandbox {
...PodSandboxFragment
}
registry {
...PodRegistryFragment
}
templateId
hasTerminalAccess
uptimeSeconds
vcpuCount
version
volumeEncrypted
volumeInGb
volumeKey
volumeMountPath
sshAuthorizedKeys
sshKeysHash
lastStartedAt
cpuFlavorId
machineType
slsVersion
networkVolumeId
testPod
ideAiApiId
hubReleaseId
hubRelease {
...HubReleaseFragment
}
modelVersions {
...ModelVersionPodAssignmentFragment
}
objectStores {
...PodObjectStoreFragment
}
volumeMounts {
...PodVolumeMountFragment
}
cpuFlavor {
...CpuFlavorFragment
}
runtime {
...PodRuntimeFragment
}
machine {
...PodMachineInfoFragment
}
latestTelemetry {
...PodTelemetryFragment
}
endpoint {
...EndpointFragment
}
slsWorkerType
networkVolume {
...NetworkVolumeFragment
}
savingsPlans {
...SavingsPlanFragment
}
clusterId
ipAddress {
...IPAddressFragment
}
models
flashEnvironmentId
tags {
...TagFragment
}
}
}
Variables
{"input": PodFilter}
Response
{
"data": {
"pod": {
"lowestBidPriceToResume": 123.45,
"aiApiId": "xyz789",
"apiKey": "xyz789",
"clusterIp": "xyz789",
"clusterIdx": 987,
"clusterRole": "SLURM_CONTROLLER",
"consumerUserId": "xyz789",
"createdByUserId": "abc123",
"createdByUser": ResourceUser,
"containerDiskInGb": 123,
"containerRegistryAuthId": "abc123",
"costMultiplier": 123.45,
"costPerHr": 987.65,
"createdAt": "2007-12-03T10:15:30Z",
"adjustedCostPerHr": 123.45,
"desiredStatus": "CREATED",
"dockerArgs": "xyz789",
"dockerId": "abc123",
"env": ["abc123"],
"envKeyValue": [EnvironmentVariable],
"gpuCount": 123,
"gpuPowerLimitPercent": 123,
"gpus": [Gpu],
"id": "abc123",
"imageName": "xyz789",
"lastStatusChange": "abc123",
"locked": true,
"machineId": "abc123",
"memoryInGb": 987.65,
"name": "xyz789",
"podType": "INTERRUPTABLE",
"port": 19758,
"ports": "abc123",
"sandboxId": "xyz789",
"sandbox": PodSandbox,
"registry": PodRegistry,
"templateId": "xyz789",
"hasTerminalAccess": true,
"uptimeSeconds": 123,
"vcpuCount": 123.45,
"version": 123,
"volumeEncrypted": false,
"volumeInGb": 123.45,
"volumeKey": "abc123",
"volumeMountPath": "abc123",
"sshAuthorizedKeys": ["xyz789"],
"sshKeysHash": "xyz789",
"lastStartedAt": "2007-12-03T10:15:30Z",
"cpuFlavorId": "abc123",
"machineType": "xyz789",
"slsVersion": 123,
"networkVolumeId": "xyz789",
"testPod": false,
"ideAiApiId": "abc123",
"hubReleaseId": "xyz789",
"hubRelease": HubRelease,
"modelVersions": [ModelVersionPodAssignment],
"objectStores": [PodObjectStore],
"volumeMounts": [PodVolumeMount],
"cpuFlavor": CpuFlavor,
"runtime": PodRuntime,
"machine": PodMachineInfo,
"latestTelemetry": PodTelemetry,
"endpoint": Endpoint,
"slsWorkerType": "BATCH",
"networkVolume": NetworkVolume,
"savingsPlans": [SavingsPlan],
"clusterId": "abc123",
"ipAddress": IPAddress,
"models": ["abc123"],
"flashEnvironmentId": "xyz789",
"tags": [Tag]
}
}
}
Mutations
createCluster
Response
Returns a Cluster!
Arguments
| Name | Description |
|---|---|
input - CreateClusterInput!
|
Example
Query
mutation createCluster($input: CreateClusterInput!) {
createCluster(input: $input) {
id
name
userId
gpuTypeId
gpuDisplayName
podCount
gpuCountPerPod
type
templateId
createdAt
createdByUserId
createdByUser {
...ResourceUserFragment
}
pods {
...PodFragment
}
endpoints {
...EndpointFragment
}
metadata
tags {
...TagFragment
}
}
}
Variables
{"input": CreateClusterInput}
Response
{
"data": {
"createCluster": {
"id": "abc123",
"name": "abc123",
"userId": "xyz789",
"gpuTypeId": "abc123",
"gpuDisplayName": "abc123",
"podCount": 123,
"gpuCountPerPod": 987,
"type": "APPLICATION",
"templateId": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"createdByUserId": "xyz789",
"createdByUser": ResourceUser,
"pods": [Pod],
"endpoints": [Endpoint],
"metadata": {},
"tags": [Tag]
}
}
}
deleteCluster
Response
Returns a Void
Arguments
| Name | Description |
|---|---|
input - DeleteClusterInput!
|
Example
Query
mutation deleteCluster($input: DeleteClusterInput!) {
deleteCluster(input: $input)
}
Variables
{"input": DeleteClusterInput}
Response
{"data": {"deleteCluster": null}}
podBidResume
Spot pods are no longer offered
Response
Returns a Pod
Arguments
| Name | Description |
|---|---|
input - PodBidResumeInput!
|
Example
Query
mutation podBidResume($input: PodBidResumeInput!) {
podBidResume(input: $input) {
lowestBidPriceToResume
aiApiId
apiKey
clusterIp
clusterIdx
clusterRole
consumerUserId
createdByUserId
createdByUser {
...ResourceUserFragment
}
containerDiskInGb
containerRegistryAuthId
costMultiplier
costPerHr
createdAt
adjustedCostPerHr
desiredStatus
dockerArgs
dockerId
env
envKeyValue {
...EnvironmentVariableFragment
}
gpuCount
gpuPowerLimitPercent
gpus {
...GpuFragment
}
id
imageName
lastStatusChange
locked
machineId
memoryInGb
name
podType
port
ports
sandboxId
sandbox {
...PodSandboxFragment
}
registry {
...PodRegistryFragment
}
templateId
hasTerminalAccess
uptimeSeconds
vcpuCount
version
volumeEncrypted
volumeInGb
volumeKey
volumeMountPath
sshAuthorizedKeys
sshKeysHash
lastStartedAt
cpuFlavorId
machineType
slsVersion
networkVolumeId
testPod
ideAiApiId
hubReleaseId
hubRelease {
...HubReleaseFragment
}
modelVersions {
...ModelVersionPodAssignmentFragment
}
objectStores {
...PodObjectStoreFragment
}
volumeMounts {
...PodVolumeMountFragment
}
cpuFlavor {
...CpuFlavorFragment
}
runtime {
...PodRuntimeFragment
}
machine {
...PodMachineInfoFragment
}
latestTelemetry {
...PodTelemetryFragment
}
endpoint {
...EndpointFragment
}
slsWorkerType
networkVolume {
...NetworkVolumeFragment
}
savingsPlans {
...SavingsPlanFragment
}
clusterId
ipAddress {
...IPAddressFragment
}
models
flashEnvironmentId
tags {
...TagFragment
}
}
}
Variables
{"input": PodBidResumeInput}
Response
{
"data": {
"podBidResume": {
"lowestBidPriceToResume": 987.65,
"aiApiId": "xyz789",
"apiKey": "xyz789",
"clusterIp": "abc123",
"clusterIdx": 123,
"clusterRole": "SLURM_CONTROLLER",
"consumerUserId": "xyz789",
"createdByUserId": "xyz789",
"createdByUser": ResourceUser,
"containerDiskInGb": 123,
"containerRegistryAuthId": "xyz789",
"costMultiplier": 123.45,
"costPerHr": 123.45,
"createdAt": "2007-12-03T10:15:30Z",
"adjustedCostPerHr": 987.65,
"desiredStatus": "CREATED",
"dockerArgs": "xyz789",
"dockerId": "xyz789",
"env": ["abc123"],
"envKeyValue": [EnvironmentVariable],
"gpuCount": 987,
"gpuPowerLimitPercent": 987,
"gpus": [Gpu],
"id": "xyz789",
"imageName": "abc123",
"lastStatusChange": "abc123",
"locked": true,
"machineId": "abc123",
"memoryInGb": 123.45,
"name": "xyz789",
"podType": "INTERRUPTABLE",
"port": 19758,
"ports": "abc123",
"sandboxId": "abc123",
"sandbox": PodSandbox,
"registry": PodRegistry,
"templateId": "xyz789",
"hasTerminalAccess": true,
"uptimeSeconds": 123,
"vcpuCount": 987.65,
"version": 987,
"volumeEncrypted": true,
"volumeInGb": 123.45,
"volumeKey": "abc123",
"volumeMountPath": "xyz789",
"sshAuthorizedKeys": ["abc123"],
"sshKeysHash": "xyz789",
"lastStartedAt": "2007-12-03T10:15:30Z",
"cpuFlavorId": "xyz789",
"machineType": "abc123",
"slsVersion": 987,
"networkVolumeId": "xyz789",
"testPod": false,
"ideAiApiId": "abc123",
"hubReleaseId": "abc123",
"hubRelease": HubRelease,
"modelVersions": [ModelVersionPodAssignment],
"objectStores": [PodObjectStore],
"volumeMounts": [PodVolumeMount],
"cpuFlavor": CpuFlavor,
"runtime": PodRuntime,
"machine": PodMachineInfo,
"latestTelemetry": PodTelemetry,
"endpoint": Endpoint,
"slsWorkerType": "BATCH",
"networkVolume": NetworkVolume,
"savingsPlans": [SavingsPlan],
"clusterId": "abc123",
"ipAddress": IPAddress,
"models": ["abc123"],
"flashEnvironmentId": "abc123",
"tags": [Tag]
}
}
}
podEditJob
Response
Returns a Pod
Arguments
| Name | Description |
|---|---|
input - PodEditJobInput!
|
Example
Query
mutation podEditJob($input: PodEditJobInput!) {
podEditJob(input: $input) {
lowestBidPriceToResume
aiApiId
apiKey
clusterIp
clusterIdx
clusterRole
consumerUserId
createdByUserId
createdByUser {
...ResourceUserFragment
}
containerDiskInGb
containerRegistryAuthId
costMultiplier
costPerHr
createdAt
adjustedCostPerHr
desiredStatus
dockerArgs
dockerId
env
envKeyValue {
...EnvironmentVariableFragment
}
gpuCount
gpuPowerLimitPercent
gpus {
...GpuFragment
}
id
imageName
lastStatusChange
locked
machineId
memoryInGb
name
podType
port
ports
sandboxId
sandbox {
...PodSandboxFragment
}
registry {
...PodRegistryFragment
}
templateId
hasTerminalAccess
uptimeSeconds
vcpuCount
version
volumeEncrypted
volumeInGb
volumeKey
volumeMountPath
sshAuthorizedKeys
sshKeysHash
lastStartedAt
cpuFlavorId
machineType
slsVersion
networkVolumeId
testPod
ideAiApiId
hubReleaseId
hubRelease {
...HubReleaseFragment
}
modelVersions {
...ModelVersionPodAssignmentFragment
}
objectStores {
...PodObjectStoreFragment
}
volumeMounts {
...PodVolumeMountFragment
}
cpuFlavor {
...CpuFlavorFragment
}
runtime {
...PodRuntimeFragment
}
machine {
...PodMachineInfoFragment
}
latestTelemetry {
...PodTelemetryFragment
}
endpoint {
...EndpointFragment
}
slsWorkerType
networkVolume {
...NetworkVolumeFragment
}
savingsPlans {
...SavingsPlanFragment
}
clusterId
ipAddress {
...IPAddressFragment
}
models
flashEnvironmentId
tags {
...TagFragment
}
}
}
Variables
{"input": PodEditJobInput}
Response
{
"data": {
"podEditJob": {
"lowestBidPriceToResume": 987.65,
"aiApiId": "abc123",
"apiKey": "xyz789",
"clusterIp": "abc123",
"clusterIdx": 987,
"clusterRole": "SLURM_CONTROLLER",
"consumerUserId": "xyz789",
"createdByUserId": "xyz789",
"createdByUser": ResourceUser,
"containerDiskInGb": 987,
"containerRegistryAuthId": "abc123",
"costMultiplier": 123.45,
"costPerHr": 987.65,
"createdAt": "2007-12-03T10:15:30Z",
"adjustedCostPerHr": 123.45,
"desiredStatus": "CREATED",
"dockerArgs": "abc123",
"dockerId": "abc123",
"env": ["abc123"],
"envKeyValue": [EnvironmentVariable],
"gpuCount": 123,
"gpuPowerLimitPercent": 123,
"gpus": [Gpu],
"id": "abc123",
"imageName": "abc123",
"lastStatusChange": "xyz789",
"locked": false,
"machineId": "abc123",
"memoryInGb": 123.45,
"name": "abc123",
"podType": "INTERRUPTABLE",
"port": 19758,
"ports": "abc123",
"sandboxId": "abc123",
"sandbox": PodSandbox,
"registry": PodRegistry,
"templateId": "abc123",
"hasTerminalAccess": true,
"uptimeSeconds": 987,
"vcpuCount": 987.65,
"version": 987,
"volumeEncrypted": true,
"volumeInGb": 987.65,
"volumeKey": "xyz789",
"volumeMountPath": "xyz789",
"sshAuthorizedKeys": ["xyz789"],
"sshKeysHash": "xyz789",
"lastStartedAt": "2007-12-03T10:15:30Z",
"cpuFlavorId": "abc123",
"machineType": "xyz789",
"slsVersion": 987,
"networkVolumeId": "abc123",
"testPod": true,
"ideAiApiId": "xyz789",
"hubReleaseId": "abc123",
"hubRelease": HubRelease,
"modelVersions": [ModelVersionPodAssignment],
"objectStores": [PodObjectStore],
"volumeMounts": [PodVolumeMount],
"cpuFlavor": CpuFlavor,
"runtime": PodRuntime,
"machine": PodMachineInfo,
"latestTelemetry": PodTelemetry,
"endpoint": Endpoint,
"slsWorkerType": "BATCH",
"networkVolume": NetworkVolume,
"savingsPlans": [SavingsPlan],
"clusterId": "abc123",
"ipAddress": IPAddress,
"models": ["abc123"],
"flashEnvironmentId": "abc123",
"tags": [Tag]
}
}
}
podFindAndDeployOnDemand
Response
Returns a Pod
Arguments
| Name | Description |
|---|---|
input - PodFindAndDeployOnDemandInput
|
Example
Query
mutation podFindAndDeployOnDemand($input: PodFindAndDeployOnDemandInput) {
podFindAndDeployOnDemand(input: $input) {
lowestBidPriceToResume
aiApiId
apiKey
clusterIp
clusterIdx
clusterRole
consumerUserId
createdByUserId
createdByUser {
...ResourceUserFragment
}
containerDiskInGb
containerRegistryAuthId
costMultiplier
costPerHr
createdAt
adjustedCostPerHr
desiredStatus
dockerArgs
dockerId
env
envKeyValue {
...EnvironmentVariableFragment
}
gpuCount
gpuPowerLimitPercent
gpus {
...GpuFragment
}
id
imageName
lastStatusChange
locked
machineId
memoryInGb
name
podType
port
ports
sandboxId
sandbox {
...PodSandboxFragment
}
registry {
...PodRegistryFragment
}
templateId
hasTerminalAccess
uptimeSeconds
vcpuCount
version
volumeEncrypted
volumeInGb
volumeKey
volumeMountPath
sshAuthorizedKeys
sshKeysHash
lastStartedAt
cpuFlavorId
machineType
slsVersion
networkVolumeId
testPod
ideAiApiId
hubReleaseId
hubRelease {
...HubReleaseFragment
}
modelVersions {
...ModelVersionPodAssignmentFragment
}
objectStores {
...PodObjectStoreFragment
}
volumeMounts {
...PodVolumeMountFragment
}
cpuFlavor {
...CpuFlavorFragment
}
runtime {
...PodRuntimeFragment
}
machine {
...PodMachineInfoFragment
}
latestTelemetry {
...PodTelemetryFragment
}
endpoint {
...EndpointFragment
}
slsWorkerType
networkVolume {
...NetworkVolumeFragment
}
savingsPlans {
...SavingsPlanFragment
}
clusterId
ipAddress {
...IPAddressFragment
}
models
flashEnvironmentId
tags {
...TagFragment
}
}
}
Variables
{"input": PodFindAndDeployOnDemandInput}
Response
{
"data": {
"podFindAndDeployOnDemand": {
"lowestBidPriceToResume": 987.65,
"aiApiId": "xyz789",
"apiKey": "abc123",
"clusterIp": "abc123",
"clusterIdx": 987,
"clusterRole": "SLURM_CONTROLLER",
"consumerUserId": "xyz789",
"createdByUserId": "abc123",
"createdByUser": ResourceUser,
"containerDiskInGb": 123,
"containerRegistryAuthId": "abc123",
"costMultiplier": 987.65,
"costPerHr": 123.45,
"createdAt": "2007-12-03T10:15:30Z",
"adjustedCostPerHr": 123.45,
"desiredStatus": "CREATED",
"dockerArgs": "xyz789",
"dockerId": "xyz789",
"env": ["xyz789"],
"envKeyValue": [EnvironmentVariable],
"gpuCount": 987,
"gpuPowerLimitPercent": 987,
"gpus": [Gpu],
"id": "abc123",
"imageName": "abc123",
"lastStatusChange": "abc123",
"locked": false,
"machineId": "abc123",
"memoryInGb": 123.45,
"name": "xyz789",
"podType": "INTERRUPTABLE",
"port": 19758,
"ports": "abc123",
"sandboxId": "xyz789",
"sandbox": PodSandbox,
"registry": PodRegistry,
"templateId": "xyz789",
"hasTerminalAccess": true,
"uptimeSeconds": 123,
"vcpuCount": 123.45,
"version": 123,
"volumeEncrypted": false,
"volumeInGb": 987.65,
"volumeKey": "abc123",
"volumeMountPath": "abc123",
"sshAuthorizedKeys": ["abc123"],
"sshKeysHash": "abc123",
"lastStartedAt": "2007-12-03T10:15:30Z",
"cpuFlavorId": "abc123",
"machineType": "xyz789",
"slsVersion": 123,
"networkVolumeId": "xyz789",
"testPod": true,
"ideAiApiId": "xyz789",
"hubReleaseId": "abc123",
"hubRelease": HubRelease,
"modelVersions": [ModelVersionPodAssignment],
"objectStores": [PodObjectStore],
"volumeMounts": [PodVolumeMount],
"cpuFlavor": CpuFlavor,
"runtime": PodRuntime,
"machine": PodMachineInfo,
"latestTelemetry": PodTelemetry,
"endpoint": Endpoint,
"slsWorkerType": "BATCH",
"networkVolume": NetworkVolume,
"savingsPlans": [SavingsPlan],
"clusterId": "abc123",
"ipAddress": IPAddress,
"models": ["abc123"],
"flashEnvironmentId": "xyz789",
"tags": [Tag]
}
}
}
podRentInterruptable
Spot pods are no longer offered
Response
Returns a Pod
Arguments
| Name | Description |
|---|---|
input - PodRentInterruptableInput!
|
Example
Query
mutation podRentInterruptable($input: PodRentInterruptableInput!) {
podRentInterruptable(input: $input) {
lowestBidPriceToResume
aiApiId
apiKey
clusterIp
clusterIdx
clusterRole
consumerUserId
createdByUserId
createdByUser {
...ResourceUserFragment
}
containerDiskInGb
containerRegistryAuthId
costMultiplier
costPerHr
createdAt
adjustedCostPerHr
desiredStatus
dockerArgs
dockerId
env
envKeyValue {
...EnvironmentVariableFragment
}
gpuCount
gpuPowerLimitPercent
gpus {
...GpuFragment
}
id
imageName
lastStatusChange
locked
machineId
memoryInGb
name
podType
port
ports
sandboxId
sandbox {
...PodSandboxFragment
}
registry {
...PodRegistryFragment
}
templateId
hasTerminalAccess
uptimeSeconds
vcpuCount
version
volumeEncrypted
volumeInGb
volumeKey
volumeMountPath
sshAuthorizedKeys
sshKeysHash
lastStartedAt
cpuFlavorId
machineType
slsVersion
networkVolumeId
testPod
ideAiApiId
hubReleaseId
hubRelease {
...HubReleaseFragment
}
modelVersions {
...ModelVersionPodAssignmentFragment
}
objectStores {
...PodObjectStoreFragment
}
volumeMounts {
...PodVolumeMountFragment
}
cpuFlavor {
...CpuFlavorFragment
}
runtime {
...PodRuntimeFragment
}
machine {
...PodMachineInfoFragment
}
latestTelemetry {
...PodTelemetryFragment
}
endpoint {
...EndpointFragment
}
slsWorkerType
networkVolume {
...NetworkVolumeFragment
}
savingsPlans {
...SavingsPlanFragment
}
clusterId
ipAddress {
...IPAddressFragment
}
models
flashEnvironmentId
tags {
...TagFragment
}
}
}
Variables
{"input": PodRentInterruptableInput}
Response
{
"data": {
"podRentInterruptable": {
"lowestBidPriceToResume": 123.45,
"aiApiId": "abc123",
"apiKey": "abc123",
"clusterIp": "abc123",
"clusterIdx": 123,
"clusterRole": "SLURM_CONTROLLER",
"consumerUserId": "abc123",
"createdByUserId": "abc123",
"createdByUser": ResourceUser,
"containerDiskInGb": 123,
"containerRegistryAuthId": "abc123",
"costMultiplier": 123.45,
"costPerHr": 123.45,
"createdAt": "2007-12-03T10:15:30Z",
"adjustedCostPerHr": 987.65,
"desiredStatus": "CREATED",
"dockerArgs": "xyz789",
"dockerId": "abc123",
"env": ["abc123"],
"envKeyValue": [EnvironmentVariable],
"gpuCount": 123,
"gpuPowerLimitPercent": 123,
"gpus": [Gpu],
"id": "xyz789",
"imageName": "abc123",
"lastStatusChange": "xyz789",
"locked": true,
"machineId": "xyz789",
"memoryInGb": 123.45,
"name": "xyz789",
"podType": "INTERRUPTABLE",
"port": 19758,
"ports": "abc123",
"sandboxId": "xyz789",
"sandbox": PodSandbox,
"registry": PodRegistry,
"templateId": "abc123",
"hasTerminalAccess": true,
"uptimeSeconds": 987,
"vcpuCount": 123.45,
"version": 987,
"volumeEncrypted": true,
"volumeInGb": 123.45,
"volumeKey": "abc123",
"volumeMountPath": "xyz789",
"sshAuthorizedKeys": ["abc123"],
"sshKeysHash": "abc123",
"lastStartedAt": "2007-12-03T10:15:30Z",
"cpuFlavorId": "xyz789",
"machineType": "xyz789",
"slsVersion": 987,
"networkVolumeId": "abc123",
"testPod": false,
"ideAiApiId": "abc123",
"hubReleaseId": "abc123",
"hubRelease": HubRelease,
"modelVersions": [ModelVersionPodAssignment],
"objectStores": [PodObjectStore],
"volumeMounts": [PodVolumeMount],
"cpuFlavor": CpuFlavor,
"runtime": PodRuntime,
"machine": PodMachineInfo,
"latestTelemetry": PodTelemetry,
"endpoint": Endpoint,
"slsWorkerType": "BATCH",
"networkVolume": NetworkVolume,
"savingsPlans": [SavingsPlan],
"clusterId": "abc123",
"ipAddress": IPAddress,
"models": ["xyz789"],
"flashEnvironmentId": "xyz789",
"tags": [Tag]
}
}
}
podResume
Response
Returns a Pod
Arguments
| Name | Description |
|---|---|
input - PodResumeInput!
|
Example
Query
mutation podResume($input: PodResumeInput!) {
podResume(input: $input) {
lowestBidPriceToResume
aiApiId
apiKey
clusterIp
clusterIdx
clusterRole
consumerUserId
createdByUserId
createdByUser {
...ResourceUserFragment
}
containerDiskInGb
containerRegistryAuthId
costMultiplier
costPerHr
createdAt
adjustedCostPerHr
desiredStatus
dockerArgs
dockerId
env
envKeyValue {
...EnvironmentVariableFragment
}
gpuCount
gpuPowerLimitPercent
gpus {
...GpuFragment
}
id
imageName
lastStatusChange
locked
machineId
memoryInGb
name
podType
port
ports
sandboxId
sandbox {
...PodSandboxFragment
}
registry {
...PodRegistryFragment
}
templateId
hasTerminalAccess
uptimeSeconds
vcpuCount
version
volumeEncrypted
volumeInGb
volumeKey
volumeMountPath
sshAuthorizedKeys
sshKeysHash
lastStartedAt
cpuFlavorId
machineType
slsVersion
networkVolumeId
testPod
ideAiApiId
hubReleaseId
hubRelease {
...HubReleaseFragment
}
modelVersions {
...ModelVersionPodAssignmentFragment
}
objectStores {
...PodObjectStoreFragment
}
volumeMounts {
...PodVolumeMountFragment
}
cpuFlavor {
...CpuFlavorFragment
}
runtime {
...PodRuntimeFragment
}
machine {
...PodMachineInfoFragment
}
latestTelemetry {
...PodTelemetryFragment
}
endpoint {
...EndpointFragment
}
slsWorkerType
networkVolume {
...NetworkVolumeFragment
}
savingsPlans {
...SavingsPlanFragment
}
clusterId
ipAddress {
...IPAddressFragment
}
models
flashEnvironmentId
tags {
...TagFragment
}
}
}
Variables
{"input": PodResumeInput}
Response
{
"data": {
"podResume": {
"lowestBidPriceToResume": 123.45,
"aiApiId": "xyz789",
"apiKey": "xyz789",
"clusterIp": "xyz789",
"clusterIdx": 987,
"clusterRole": "SLURM_CONTROLLER",
"consumerUserId": "xyz789",
"createdByUserId": "xyz789",
"createdByUser": ResourceUser,
"containerDiskInGb": 123,
"containerRegistryAuthId": "xyz789",
"costMultiplier": 123.45,
"costPerHr": 987.65,
"createdAt": "2007-12-03T10:15:30Z",
"adjustedCostPerHr": 123.45,
"desiredStatus": "CREATED",
"dockerArgs": "abc123",
"dockerId": "abc123",
"env": ["abc123"],
"envKeyValue": [EnvironmentVariable],
"gpuCount": 987,
"gpuPowerLimitPercent": 123,
"gpus": [Gpu],
"id": "abc123",
"imageName": "xyz789",
"lastStatusChange": "xyz789",
"locked": false,
"machineId": "abc123",
"memoryInGb": 987.65,
"name": "xyz789",
"podType": "INTERRUPTABLE",
"port": 19758,
"ports": "xyz789",
"sandboxId": "abc123",
"sandbox": PodSandbox,
"registry": PodRegistry,
"templateId": "abc123",
"hasTerminalAccess": true,
"uptimeSeconds": 987,
"vcpuCount": 123.45,
"version": 123,
"volumeEncrypted": true,
"volumeInGb": 123.45,
"volumeKey": "xyz789",
"volumeMountPath": "abc123",
"sshAuthorizedKeys": ["xyz789"],
"sshKeysHash": "abc123",
"lastStartedAt": "2007-12-03T10:15:30Z",
"cpuFlavorId": "abc123",
"machineType": "abc123",
"slsVersion": 987,
"networkVolumeId": "xyz789",
"testPod": true,
"ideAiApiId": "xyz789",
"hubReleaseId": "xyz789",
"hubRelease": HubRelease,
"modelVersions": [ModelVersionPodAssignment],
"objectStores": [PodObjectStore],
"volumeMounts": [PodVolumeMount],
"cpuFlavor": CpuFlavor,
"runtime": PodRuntime,
"machine": PodMachineInfo,
"latestTelemetry": PodTelemetry,
"endpoint": Endpoint,
"slsWorkerType": "BATCH",
"networkVolume": NetworkVolume,
"savingsPlans": [SavingsPlan],
"clusterId": "abc123",
"ipAddress": IPAddress,
"models": ["xyz789"],
"flashEnvironmentId": "abc123",
"tags": [Tag]
}
}
}
podStop
Response
Returns a Pod
Arguments
| Name | Description |
|---|---|
input - PodStopInput!
|
Example
Query
mutation podStop($input: PodStopInput!) {
podStop(input: $input) {
lowestBidPriceToResume
aiApiId
apiKey
clusterIp
clusterIdx
clusterRole
consumerUserId
createdByUserId
createdByUser {
...ResourceUserFragment
}
containerDiskInGb
containerRegistryAuthId
costMultiplier
costPerHr
createdAt
adjustedCostPerHr
desiredStatus
dockerArgs
dockerId
env
envKeyValue {
...EnvironmentVariableFragment
}
gpuCount
gpuPowerLimitPercent
gpus {
...GpuFragment
}
id
imageName
lastStatusChange
locked
machineId
memoryInGb
name
podType
port
ports
sandboxId
sandbox {
...PodSandboxFragment
}
registry {
...PodRegistryFragment
}
templateId
hasTerminalAccess
uptimeSeconds
vcpuCount
version
volumeEncrypted
volumeInGb
volumeKey
volumeMountPath
sshAuthorizedKeys
sshKeysHash
lastStartedAt
cpuFlavorId
machineType
slsVersion
networkVolumeId
testPod
ideAiApiId
hubReleaseId
hubRelease {
...HubReleaseFragment
}
modelVersions {
...ModelVersionPodAssignmentFragment
}
objectStores {
...PodObjectStoreFragment
}
volumeMounts {
...PodVolumeMountFragment
}
cpuFlavor {
...CpuFlavorFragment
}
runtime {
...PodRuntimeFragment
}
machine {
...PodMachineInfoFragment
}
latestTelemetry {
...PodTelemetryFragment
}
endpoint {
...EndpointFragment
}
slsWorkerType
networkVolume {
...NetworkVolumeFragment
}
savingsPlans {
...SavingsPlanFragment
}
clusterId
ipAddress {
...IPAddressFragment
}
models
flashEnvironmentId
tags {
...TagFragment
}
}
}
Variables
{"input": PodStopInput}
Response
{
"data": {
"podStop": {
"lowestBidPriceToResume": 987.65,
"aiApiId": "abc123",
"apiKey": "xyz789",
"clusterIp": "xyz789",
"clusterIdx": 987,
"clusterRole": "SLURM_CONTROLLER",
"consumerUserId": "xyz789",
"createdByUserId": "xyz789",
"createdByUser": ResourceUser,
"containerDiskInGb": 987,
"containerRegistryAuthId": "xyz789",
"costMultiplier": 987.65,
"costPerHr": 123.45,
"createdAt": "2007-12-03T10:15:30Z",
"adjustedCostPerHr": 987.65,
"desiredStatus": "CREATED",
"dockerArgs": "abc123",
"dockerId": "abc123",
"env": ["xyz789"],
"envKeyValue": [EnvironmentVariable],
"gpuCount": 123,
"gpuPowerLimitPercent": 987,
"gpus": [Gpu],
"id": "abc123",
"imageName": "xyz789",
"lastStatusChange": "xyz789",
"locked": false,
"machineId": "xyz789",
"memoryInGb": 123.45,
"name": "xyz789",
"podType": "INTERRUPTABLE",
"port": 19758,
"ports": "xyz789",
"sandboxId": "xyz789",
"sandbox": PodSandbox,
"registry": PodRegistry,
"templateId": "xyz789",
"hasTerminalAccess": false,
"uptimeSeconds": 123,
"vcpuCount": 123.45,
"version": 987,
"volumeEncrypted": true,
"volumeInGb": 123.45,
"volumeKey": "xyz789",
"volumeMountPath": "xyz789",
"sshAuthorizedKeys": ["abc123"],
"sshKeysHash": "abc123",
"lastStartedAt": "2007-12-03T10:15:30Z",
"cpuFlavorId": "abc123",
"machineType": "abc123",
"slsVersion": 987,
"networkVolumeId": "xyz789",
"testPod": true,
"ideAiApiId": "abc123",
"hubReleaseId": "abc123",
"hubRelease": HubRelease,
"modelVersions": [ModelVersionPodAssignment],
"objectStores": [PodObjectStore],
"volumeMounts": [PodVolumeMount],
"cpuFlavor": CpuFlavor,
"runtime": PodRuntime,
"machine": PodMachineInfo,
"latestTelemetry": PodTelemetry,
"endpoint": Endpoint,
"slsWorkerType": "BATCH",
"networkVolume": NetworkVolume,
"savingsPlans": [SavingsPlan],
"clusterId": "abc123",
"ipAddress": IPAddress,
"models": ["abc123"],
"flashEnvironmentId": "abc123",
"tags": [Tag]
}
}
}
podTerminate
Response
Returns a Void
Arguments
| Name | Description |
|---|---|
input - PodTerminateInput!
|
Example
Query
mutation podTerminate($input: PodTerminateInput!) {
podTerminate(input: $input)
}
Variables
{"input": PodTerminateInput}
Response
{"data": {"podTerminate": null}}
saveRegistryAuth
Response
Returns a ContainerRegistryAuth
Arguments
| Name | Description |
|---|---|
input - SaveRegistryAuthInput
|
Example
Query
mutation saveRegistryAuth($input: SaveRegistryAuthInput) {
saveRegistryAuth(input: $input) {
id
name
userId
registryAuth
}
}
Variables
{"input": SaveRegistryAuthInput}
Response
{
"data": {
"saveRegistryAuth": {
"id": "abc123",
"name": "xyz789",
"userId": "abc123",
"registryAuth": "xyz789"
}
}
}
Types
AccountSubscription
Description
An account's subscription lifecycle record — one per billable account (solo user or team owner). Named AccountSubscription because Subscription is GraphQL's reserved root-operation-type name.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
tier - SubscriptionTier!
|
|
planId - String!
|
Immutable plan version the account is on (family + version, e.g. PRO_V1). |
status - SubscriptionStatus!
|
|
cancelAtPeriodEnd - Boolean!
|
|
currentPeriodStart - DateTime
|
|
currentPeriodEnd - DateTime
|
|
grandfatherFittedPlanId - String
|
The plan version whose capabilities a GRANDFATHERED account keeps (tier stays FREE, so nothing bills). Keeps granting through the soft-cap ramp that follows expiry, until softCapUntil; the soft-cap flip clears it once the ramp has passed, as does the first paid invoice of a paid subscription. Null for accounts never grandfathered. |
grandfatherExpiresAt - DateTime
|
|
softCapUntil - DateTime
|
End of the soft-cap ramp the grandfather-expiry sweep wrote when it flipped the account off its window: expiry plus 30 days, or at least 7 days after the flip when the sweep ran late. Until this instant grandfatherFittedPlanId keeps granting; from it the account resolves the plan it is stamped with, and the soft-cap flip then clears both fields. Null for an account that never expired out of a grandfather window, or whose ramp has closed. |
storageGraceUntil - DateTime
|
End of the storage grace window a downgrade opened when it lowered the free Global Storage allowance: everything stored stays free until this instant, then the overage bills. The window billing honors, not the raw stamp: between the end of a soft-cap ramp and the flip that stamps it, this is the window the flip will stamp. Null when no downgrade ever opened one; a lapsed window stays set, so compare to now. |
pendingPlanId - String
|
The plan version a scheduled downgrade moves the account to when the paid period ends. The current plan, its entitlements and its granted credit stay in force until then, and nothing is refunded. Null while no downgrade is pending. changeSubscription with the current tier drops a pending downgrade to another tier; a pending cheaper version of the current tier is dropped only by an upgrade or a cancellation. |
pendingTier - SubscriptionTier
|
Tier family of pendingPlanId; null while no downgrade is pending. |
pendingPlanAt - DateTime
|
When the pending downgrade takes effect: the end of the paid period at the time it was scheduled. |
createdAt - DateTime!
|
|
updatedAt - DateTime!
|
|
entitlements - Entitlements!
|
Effective levers: fitted-tier capabilities while grandfathered; PAST_DUE and CANCELED keep their paid-tier levers until the state machine moves them off the tier. |
creditBalance - CreditBalance!
|
Per-product credit buckets. Buckets an account was never granted are synthesized empty. |
plan - SubscriptionPlan
|
The plan version this row is on, priced as it was sold — pinned to planId, so a later repricing (a new version) does not move it; its sellsNow says whether that version still sells. Null when the plan table serves no row for the planId: entitlements still resolve through the family fallback, but there is no price to show. |
Example
{
"id": 4,
"tier": "FREE",
"planId": "xyz789",
"status": "INCOMPLETE",
"cancelAtPeriodEnd": false,
"currentPeriodStart": "2007-12-03T10:15:30Z",
"currentPeriodEnd": "2007-12-03T10:15:30Z",
"grandfatherFittedPlanId": "xyz789",
"grandfatherExpiresAt": "2007-12-03T10:15:30Z",
"softCapUntil": "2007-12-03T10:15:30Z",
"storageGraceUntil": "2007-12-03T10:15:30Z",
"pendingPlanId": "abc123",
"pendingTier": "FREE",
"pendingPlanAt": "2007-12-03T10:15:30Z",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"entitlements": Entitlements,
"creditBalance": CreditBalance,
"plan": SubscriptionPlan
}
ApiKey
Fields
| Field Name | Description |
|---|---|
id - String!
|
|
permissions - String!
|
|
createdAt - DateTime!
|
|
lastUsed - DateTime
|
|
name - String
|
|
policies - JSON
|
|
isActive - Boolean
|
|
isActiveHumanReadableString - String
|
|
isLegacy - Boolean
|
|
scopes - [String!]
|
Scopes granted to this key, sorted. Null for keys created without scopes, which are unrestricted. |
Example
{
"id": "abc123",
"permissions": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"lastUsed": "2007-12-03T10:15:30Z",
"name": "abc123",
"policies": {},
"isActive": false,
"isActiveHumanReadableString": "abc123",
"isLegacy": false,
"scopes": ["xyz789"]
}
AuditLog
Example
{
"actorId": "abc123",
"email": "abc123",
"ownerId": "abc123",
"organizationId": "abc123",
"resourceType": "xyz789",
"resourceId": "xyz789",
"action": "xyz789",
"value": "xyz789",
"timestamp": "2007-12-03T10:15:30Z"
}
AuditLogConnection
Fields
| Field Name | Description |
|---|---|
edges - [AuditLog]
|
|
pageInfo - AuditLogsPageInfo
|
Example
{
"edges": [AuditLog],
"pageInfo": AuditLogsPageInfo
}
AuditLogsPageInfo
AutoMachineVerifyStatus
Availability
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"AVAILABLE"
BenchmarkPod
BillingGranularity
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"MINUTELY"
BillingMode
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"PREPAID"
Boolean
Description
The Boolean scalar type represents true or false.
Example
true
ByoObjectStore
Description
A customer-owned bucket registered with Runpod, with the non-secret half of its credential.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
name - String!
|
|
protocol - ByoObjectStoreProtocol!
|
|
s3 - ByoS3Config
|
Set when protocol is S3. |
createdAt - DateTime!
|
|
createdByUser - ResourceUser
|
Example
{
"id": "4",
"name": "abc123",
"protocol": "S3",
"s3": ByoS3Config,
"createdAt": "2007-12-03T10:15:30Z",
"createdByUser": ResourceUser
}
ByoObjectStoreProtocol
Values
| Enum Value | Description |
|---|---|
|
|
Example
"S3"
ByoS3Config
Example
{
"endpointUrl": "abc123",
"bucket": "abc123",
"prefix": "xyz789",
"region": "xyz789",
"accessKeyId": "xyz789"
}
CapacityPriority
Description
Deploy priority class. Higher classes are placed first when capacity frees up.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"STANDARD"
Card
ChecklistPath
ClientCreditCharge
Example
{
"amount": 987.65,
"updatedAt": "2007-12-03T10:15:30Z",
"diskCharges": 123.45,
"podCharges": 123.45,
"apiCharges": 123.45,
"serverlessCharges": 987.65,
"type": "CHARGE_SERVERLESS"
}
ClientCreditChargeType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CHARGE_SERVERLESS"
CloudTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"SECURE"
Cluster
Fields
| Field Name | Description |
|---|---|
id - String
|
|
name - String
|
|
userId - String
|
|
gpuTypeId - String
|
|
gpuDisplayName - String
|
|
podCount - Int
|
|
gpuCountPerPod - Int
|
|
type - ClusterType
|
|
templateId - String
|
|
createdAt - DateTime
|
|
createdByUserId - String
|
|
createdByUser - ResourceUser
|
|
pods - [Pod]
|
|
endpoints - [Endpoint!]
|
|
metadata - JSON
|
Per-service cluster state, as stored. Each service owns one key. |
tags - [Tag!]
|
Example
{
"id": "xyz789",
"name": "abc123",
"userId": "xyz789",
"gpuTypeId": "abc123",
"gpuDisplayName": "abc123",
"podCount": 123,
"gpuCountPerPod": 987,
"type": "APPLICATION",
"templateId": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"createdByUserId": "xyz789",
"createdByUser": ResourceUser,
"pods": [Pod],
"endpoints": [Endpoint],
"metadata": {},
"tags": [Tag]
}
ClusterExpansionAvailability
Fields
| Field Name | Description |
|---|---|
currentPodCount - Int!
|
|
maxAdditionalPods - Int!
|
Pods that can be added right now: bounded by the eligible machines, the per-cluster limit and, while the plan cap is enforced, the account's maxInstantClusterNodes. Zero once the cluster meets its plan ceiling. |
costPerPodPerHr - Float!
|
Example
{"currentPodCount": 123, "maxAdditionalPods": 987, "costPerPodPerHr": 123.45}
ClusterFilterInput
Fields
| Input Field | Description |
|---|---|
createdByUserIds - [String!]
|
|
tags - [ResourceTagMatch!]
|
Example
{
"createdByUserIds": ["abc123"],
"tags": [ResourceTagMatch]
}
ClusterInput
Fields
| Input Field | Description |
|---|---|
id - String!
|
Example
{"id": "xyz789"}
ClusterRole
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"SLURM_CONTROLLER"
ClusterServing
Fields
| Field Name | Description |
|---|---|
clusterId - String!
|
|
deploymentName - String
|
|
inferenceToken - String
|
|
targets - [ClusterServingTarget!]!
|
Example
{
"clusterId": "xyz789",
"deploymentName": "xyz789",
"inferenceToken": "xyz789",
"targets": [ClusterServingTarget]
}
ClusterServingPod
Fields
| Field Name | Description |
|---|---|
id - String!
|
|
desiredStatus - String!
|
|
runtime - PodRuntime
|
Example
{
"id": "xyz789",
"desiredStatus": "xyz789",
"runtime": PodRuntime
}
ClusterServingTarget
Fields
| Field Name | Description |
|---|---|
id - String!
|
|
servingPod - ClusterServingPod!
|
|
port - Int!
|
Example
{
"id": "abc123",
"servingPod": ClusterServingPod,
"port": 123
}
ClusterType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"APPLICATION"
Compliance
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"GDPR"
ComputeType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"CPU"
ContainerRegistryAuth
CostCenter
Example
{
"id": "4",
"userId": "abc123",
"value": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"deletedAt": "2007-12-03T10:15:30Z",
"resourceTags": [ResourceTag]
}
CostCenterBillingCreditCodesInput
CostCenterBillingInput
Fields
| Input Field | Description |
|---|---|
startDate - DateTime!
|
|
endDate - DateTime!
|
|
includeSubscriptionLines - Boolean
|
Opt-in for the synthetic SUBSCRIPTION_CHARGE / SUBSCRIPTION_CREDIT lines (see CostCenterBillingRecord.resourceType). Defaults to false so a client that predates the synthetic lines never receives rows it would misrender. |
includeGlobalVolumeLines - Boolean
|
Opt-in for the OBJECT_STORE line (see CostCenterBillingRecord.resourceType). Defaults to false so a client without a label for it never receives a row it would misrender. |
Example
{
"startDate": "2007-12-03T10:15:30Z",
"endDate": "2007-12-03T10:15:30Z",
"includeSubscriptionLines": true,
"includeGlobalVolumeLines": true
}
CostCenterBillingRecord
Fields
| Field Name | Description |
|---|---|
billingMonth - DateTime!
|
|
costCenterTagValue - String!
|
|
resourceType - String!
|
A TagResourceType (POD, CLUSTER, NETWORK_VOLUME, AI_API), or one of two synthetic monthly subscription lines, returned only when input.includeSubscriptionLines is true: SUBSCRIPTION_CHARGE (the month's subscription fees net of refund reversals, bucketed by payment date — a refund-only month is a negative line) and SUBSCRIPTION_CREDIT (credit applied to the month's charges, normally negative totalCharge — a correction-heavy month can net positive so detail and summary keep reconciling; in org scope only credit funded by the org's own plan, never a member's personal plan). Synthetic lines carry costCenterTagValue "subscription", empty resourceId, and null resource — unattributed to any cost center. Identify synthetic lines by this field, never by costCenterTagValue: "subscription" is not reserved, so a customer's real cost-center tag can collide with it. OBJECT_STORE, returned only when input.includeGlobalVolumeLines is true, is the month's Global Store usage for a single user's view (personal scope, or a CSR narrowed to one org member; never a whole-org aggregate), also unattributed: empty costCenterTagValue and resourceId, null resource. Its subscription-credit share is folded into that month's SUBSCRIPTION_CREDIT line when both opt-ins are set. |
resourceId - String!
|
|
totalCharge - Float!
|
|
resource - CostCenterBillingResource
|
Example
{
"billingMonth": "2007-12-03T10:15:30Z",
"costCenterTagValue": "abc123",
"resourceType": "abc123",
"resourceId": "xyz789",
"totalCharge": 987.65,
"resource": CostCenterBillingResource
}
CostCenterBillingResource
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
name - String
|
|
dataCenter - CostCenterBillingResourceDataCenter
|
|
createdByUser - ResourceUser
|
|
gpuDisplayName - String
|
|
createdAt - DateTime
|
|
deletedAt - DateTime
|
Example
{
"id": 4,
"name": "abc123",
"dataCenter": CostCenterBillingResourceDataCenter,
"createdByUser": ResourceUser,
"gpuDisplayName": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"deletedAt": "2007-12-03T10:15:30Z"
}
CostCenterBillingResourceDataCenter
CostCenterBillingSummary
Fields
| Field Name | Description |
|---|---|
totalCharge - Float!
|
|
totalHoursBilled - Float!
|
|
startingBalance - Float
|
|
endingBalance - Float
|
|
totalCredits - Float!
|
|
subscriptionCreditApplied - Float!
|
Distinct from totalCredits, the wallet ledger (reloads + credit codes). Personal scope: the credit applied to the window's charges, equal to the detail records' SUBSCRIPTION_CREDIT line. Org scope: credit funded by the org's OWN plan only — a member's personal plan funding org usage is excluded, like the fee ledger. |
subscriptionFeeTotal - Float!
|
The window's subscription fees net of full-refund reversals; 0 in org context (no org fee ledger). totalCharge is usage + debits only — add this and subtract subscriptionCreditApplied to reconcile against detail records that include the synthetic subscription lines. |
Example
{
"totalCharge": 123.45,
"totalHoursBilled": 123.45,
"startingBalance": 987.65,
"endingBalance": 987.65,
"totalCredits": 123.45,
"subscriptionCreditApplied": 123.45,
"subscriptionFeeTotal": 987.65
}
CostCenterBillingSummaryInput
Fields
| Input Field | Description |
|---|---|
startDate - DateTime!
|
|
endDate - DateTime!
|
|
includeGlobalVolumeLines - Boolean
|
Adds the window's Global Store charges to totalCharge and their subscription-credit share to subscriptionCreditApplied. Pair with CostCenterBillingInput.includeGlobalVolumeLines so summary and detail keep reconciling. |
Example
{
"startDate": "2007-12-03T10:15:30Z",
"endDate": "2007-12-03T10:15:30Z",
"includeGlobalVolumeLines": true
}
CpuAvailability
CpuAvailabilityInput
CpuFlavor
Fields
| Field Name | Description |
|---|---|
id - String
|
|
groupId - String
|
|
groupName - String
|
|
displayName - String
|
|
minVcpu - Float
|
|
maxVcpu - Int
|
|
vcpuBurstable - Boolean
|
|
ramMultiplier - Float
|
|
diskLimitPerVcpu - Int
|
|
securePricePerVcpu - Float
|
|
slsPricePerVcpu - Float
|
|
specifics - Specifics
|
|
Arguments
|
|
lowestPrice - CpuLowestPrice
|
|
Arguments
|
|
Example
{
"id": "xyz789",
"groupId": "abc123",
"groupName": "xyz789",
"displayName": "abc123",
"minVcpu": 987.65,
"maxVcpu": 123,
"vcpuBurstable": false,
"ramMultiplier": 123.45,
"diskLimitPerVcpu": 123,
"securePricePerVcpu": 987.65,
"slsPricePerVcpu": 123.45,
"specifics": Specifics,
"lowestPrice": CpuLowestPrice
}
CpuFlavorDataCenterAvailability
Fields
| Field Name | Description |
|---|---|
dataCenterId - String
|
|
supportNetworkVolumes - Boolean
|
|
availability - Availability
|
Example
{
"dataCenterId": "xyz789",
"supportNetworkVolumes": false,
"availability": "AVAILABLE"
}
CpuInstanceAvailability
CpuLowestPrice
Fields
| Field Name | Description |
|---|---|
cpuFlavorId - String
|
|
securePrice - Float
|
Price and stock of the flavor's smallest vCPU/RAM tier. |
slsPrice - Float
|
|
stockStatus - String
|
|
instances - [CpuInstanceAvailability]
|
|
cpuFlavorDatacenters - [CpuFlavorDataCenterAvailability]
|
Example
{
"cpuFlavorId": "xyz789",
"securePrice": 123.45,
"slsPrice": 123.45,
"stockStatus": "xyz789",
"instances": [CpuInstanceAvailability],
"cpuFlavorDatacenters": [
CpuFlavorDataCenterAvailability
]
}
CpuLowestPriceInput
CpuType
CreateClusterInput
Fields
| Input Field | Description |
|---|---|
clusterName - String
|
|
gpuTypeId - String!
|
|
podCount - Int!
|
|
gpuCountPerPod - Int!
|
|
type - ClusterType!
|
|
templateId - String
|
|
deployCost - Float
|
|
networkVolumeId - String
|
|
volumeInGb - Int
|
|
throughput - Int
|
|
allowedCudaVersions - [String]
|
|
minCudaVersion - String
|
|
volumeKey - String
|
|
dataCenterIds - [String!]
|
|
startJupyter - Boolean
|
|
startSsh - Boolean
|
|
containerDiskInGb - Int
|
|
imageName - String
|
|
containerRegistryAuthId - String
|
|
dockerArgs - String
|
|
env - [EnvironmentVariableInput]
|
|
volumeMountPath - String
|
|
ports - String
|
|
compliance - [Compliance]
|
|
tags - [TagKeyValueInput!]
|
|
specJson - String
|
|
k8sOptions - JSON
|
K8S clusters only: stored as-is under metadata.k8s.options. |
Example
{
"clusterName": "xyz789",
"gpuTypeId": "abc123",
"podCount": 123,
"gpuCountPerPod": 123,
"type": "APPLICATION",
"templateId": "abc123",
"deployCost": 123.45,
"networkVolumeId": "abc123",
"volumeInGb": 123,
"throughput": 123,
"allowedCudaVersions": ["xyz789"],
"minCudaVersion": "abc123",
"volumeKey": "abc123",
"dataCenterIds": ["abc123"],
"startJupyter": true,
"startSsh": true,
"containerDiskInGb": 123,
"imageName": "abc123",
"containerRegistryAuthId": "xyz789",
"dockerArgs": "abc123",
"env": [EnvironmentVariableInput],
"volumeMountPath": "xyz789",
"ports": "xyz789",
"compliance": ["GDPR"],
"tags": [TagKeyValueInput],
"specJson": "abc123",
"k8sOptions": {}
}
CreditBalance
Description
An account's credit buckets, one per credit-eligible product. Bucket rows are created lazily on first grant — a product with no CreditBalance row is a zero bucket on the subscription's current grant window (the same expiry as its granted siblings), never null.
Fields
| Field Name | Description |
|---|---|
serverless - CreditBucket!
|
|
sandbox - CreditBucket!
|
|
general - CreditBucket!
|
The subscription's general credit — drained before product buckets, before cash. |
Example
{
"serverless": CreditBucket,
"sandbox": CreditBucket,
"general": CreditBucket
}
CreditBucket
Description
One per-(account, product) credit bucket. Invariant while the period is live: balanceUsd = currentPeriodGrantedUsd - currentPeriodRedeemedUsd, never negative.
Fields
| Field Name | Description |
|---|---|
product - CreditProduct!
|
|
balanceUsd - Float!
|
Display-precision value. Storage is Decimal(20,10); Float round-trips realistic credit magnitudes exactly but is not for arithmetic — reconciliation reads the ledger. |
currentPeriod - String!
|
Period key of the current grant: YYYY-MM (calendar cadence — free tier and grandfathered) or YYYY-MM-DD, the billing-window start (anniversary cadence — paid tiers). Treat as an opaque key; currentPeriodEndsAt carries the expiry instant. |
currentPeriodGrantedUsd - Float!
|
|
currentPeriodRedeemedUsd - Float!
|
|
currentPeriodEndsAt - DateTime!
|
When the unused balance expires — credits do not roll over. |
Example
{
"product": "SERVERLESS",
"balanceUsd": 987.65,
"currentPeriod": "xyz789",
"currentPeriodGrantedUsd": 123.45,
"currentPeriodRedeemedUsd": 123.45,
"currentPeriodEndsAt": "2007-12-03T10:15:30Z"
}
CreditCode
CreditProduct
Description
Credit bucket kinds. Product buckets fund only their product; GENERAL is the subscription-supplied credit, cash-equivalent on usage billing and drained first in the general → product bucket → cash chain.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"SERVERLESS"
CreditTransfer
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
type - CreditTransferType!
|
|
user - ResourceUser!
|
|
counterparty - ResourceUser
|
|
amount - Int!
|
|
occurredAt - DateTime!
|
Example
{
"id": "4",
"type": "DEBIT",
"user": ResourceUser,
"counterparty": ResourceUser,
"amount": 123,
"occurredAt": "2007-12-03T10:15:30Z"
}
CreditTransferType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"DEBIT"
DataCenter
Fields
| Field Name | Description |
|---|---|
id - String
|
|
name - String
|
|
location - String
|
|
storage - DataCenterStorage
|
|
s3apiEnabled - Boolean
|
|
globalNetwork - Boolean
|
|
storageClusters - [StorageClusterInfo]
|
|
storageSupport - Boolean
|
|
listed - Boolean
|
|
gpuAvailability - [GpuAvailability]
|
|
Arguments
|
|
compliance - [Compliance]
|
|
region - DataCenterRegion
|
|
cpuAvailability - [CpuAvailability]
|
|
Arguments
|
|
pools - [Pool!]!
|
|
Example
{
"id": "abc123",
"name": "abc123",
"location": "abc123",
"storage": DataCenterStorage,
"s3apiEnabled": true,
"globalNetwork": false,
"storageClusters": [StorageClusterInfo],
"storageSupport": true,
"listed": false,
"gpuAvailability": [GpuAvailability],
"compliance": ["GDPR"],
"region": "NORTH_AMERICA",
"cpuAvailability": [CpuAvailability],
"pools": [Pool]
}
DataCenterRegion
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NORTH_AMERICA"
DataCenterStorage
DataCenterStorageList
Date
Description
A date string, such as 2007-12-03, compliant with the full-date format outlined in section 5.6 of the RFC 3339 profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar.
Example
"2007-12-03"
DateTime
Description
A date-time string at UTC, such as 2007-12-03T10:15:30Z, compliant with the date-time format outlined in section 5.6 of the RFC 3339 profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar.
Example
"2007-12-03T10:15:30Z"
DeleteClusterInput
Fields
| Input Field | Description |
|---|---|
id - String!
|
Example
{"id": "xyz789"}
DeployerStats
DiscordAccountInfo
Discount
Example
{
"userId": "xyz789",
"type": "SERVERLESS",
"discountFactor": 123.45,
"expirationDate": "2007-12-03T10:15:30Z",
"activeDiscountFactor": 123.45,
"activeWorkers": 987
}
DiscountType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Use tier-specific types instead |
|
|
Use tier-specific types instead |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"SERVERLESS"
EarningsCustomRangeInput
Endpoint
Fields
| Field Name | Description |
|---|---|
aiKey - String
|
|
gpuIds - String
|
|
id - String
|
|
idleTimeout - Int
|
|
name - String
|
|
networkVolumeId - String
|
|
networkVolumeIds - [NetworkVolumeIds]
|
|
volumes - [EndpointVolume!]!
|
|
locations - String
|
Use dataCenterIds instead |
dataCenterIds - [String!]
|
|
pods - [Pod]
|
|
scalerType - String
|
|
scalerValue - Float
|
|
template - PodTemplate
|
|
templateId - String
|
|
type - String
|
|
userId - String
|
|
organizationId - String
|
|
createdByUserId - String
|
|
clusterId - String
|
|
clusterServing - ClusterServing
|
|
createdByUser - ResourceUser
|
|
userEmail - String
|
|
version - Int
|
|
workersMax - Int
|
|
workersMin - Int
|
|
workersStandby - Int
|
|
workersPFBTarget - Int
|
|
gpuCount - Int
|
|
env - [EnvironmentVariable]
|
|
createdAt - DateTime
|
|
allowedCudaVersions - String
|
|
minCudaVersion - String
|
|
executionTimeoutMs - Int
|
|
instanceIds - [String]
|
|
computeType - ComputeType
|
|
builds - [GitBuild]
|
DEPRECATED: use buildsConnection instead, which pages the full history. Returns only the 30 most recent builds. Retained for wire compatibility; not marked with the @deprecated directive because deprecated members are hidden from introspection by default. |
buildsConnection - GitBuildConnection!
|
This endpoint's build history, newest first. Page size defaults to 30; a limit outside 1..100 is rejected with INVALID_INPUT. |
Arguments
|
|
build - GitBuild!
|
One of this endpoint's builds by id, regardless of age — unlike buildsConnection, which is a page of recent history. Throws BUILD_NOT_FOUND for every case where the build is unavailable: the endpoint is not yours or does not exist, the build is not linked to it, or the build does not exist. These are deliberately indistinguishable, so build ids cannot be probed for existence. |
Arguments
|
|
activeBuildid - String
|
|
repo - Repo
|
|
hubRelease - HubRelease
|
|
idePodId - String
|
|
modelStatus - ModelStatusInfo
|
|
modelReferences - [String]
|
|
activeUserReservations - [UserReservation]
|
|
flashBootType - FlashBootType
|
|
compliance - [Compliance]
|
Compliance requirements for this endpoint, stored as csv string null or [] = clear, undefined = no-op |
requestTTL - Int
|
|
supplyScope - SupplyScope
|
|
overdrive - EndpointOverdrive
|
Tuned (Overdrive) vLLM config this endpoint runs. Null until a save applies one, and again once an env edit changes a value it seeded. |
workerState - [WorkerState]
|
|
Arguments
|
|
webhookRequests - [WebhookRequestStatus]
|
|
Arguments
|
|
workerLifecyclePhases - [WorkerLifecyclePhaseCount!]!
|
|
requestMetrics - EndpointRequestMetricConnection
|
Request series (request_ts_v2), oldest first, empty buckets omitted. Page size 1..1000, default 1000. |
Arguments
|
|
coldStartMetrics - EndpointColdStartMetricConnection
|
Cold start series (cold_start_ts_v2), oldest first, empty buckets omitted. Page size 1..1000, default 1000. |
Arguments
|
|
workerMetrics - EndpointWorkerMetricConnection
|
Worker count series (endpoint_worker_states_v2), oldest first, empty buckets omitted. Page size 1..1000, default 1000. |
Arguments
|
|
networkVolume - NetworkVolume
|
|
flashEnvironmentId - String
|
Flash environment linkage; omit to keep current, set null to clear. |
tags - [Tag!]
|
|
Example
{
"aiKey": "xyz789",
"gpuIds": "abc123",
"id": "abc123",
"idleTimeout": 123,
"name": "abc123",
"networkVolumeId": "abc123",
"networkVolumeIds": [NetworkVolumeIds],
"volumes": [EndpointVolume],
"locations": "xyz789",
"dataCenterIds": ["xyz789"],
"pods": [Pod],
"scalerType": "abc123",
"scalerValue": 987.65,
"template": PodTemplate,
"templateId": "xyz789",
"type": "xyz789",
"userId": "abc123",
"organizationId": "abc123",
"createdByUserId": "abc123",
"clusterId": "abc123",
"clusterServing": ClusterServing,
"createdByUser": ResourceUser,
"userEmail": "abc123",
"version": 987,
"workersMax": 987,
"workersMin": 123,
"workersStandby": 123,
"workersPFBTarget": 123,
"gpuCount": 123,
"env": [EnvironmentVariable],
"createdAt": "2007-12-03T10:15:30Z",
"allowedCudaVersions": "abc123",
"minCudaVersion": "abc123",
"executionTimeoutMs": 123,
"instanceIds": ["xyz789"],
"computeType": "CPU",
"builds": [GitBuild],
"buildsConnection": GitBuildConnection,
"build": GitBuild,
"activeBuildid": "abc123",
"repo": Repo,
"hubRelease": HubRelease,
"idePodId": "abc123",
"modelStatus": ModelStatusInfo,
"modelReferences": ["abc123"],
"activeUserReservations": [UserReservation],
"flashBootType": "OFF",
"compliance": ["GDPR"],
"requestTTL": 123,
"supplyScope": "ORG_ONLY",
"overdrive": EndpointOverdrive,
"workerState": [WorkerState],
"webhookRequests": [WebhookRequestStatus],
"workerLifecyclePhases": [WorkerLifecyclePhaseCount],
"requestMetrics": EndpointRequestMetricConnection,
"coldStartMetrics": EndpointColdStartMetricConnection,
"workerMetrics": EndpointWorkerMetricConnection,
"networkVolume": NetworkVolume,
"flashEnvironmentId": "abc123",
"tags": [Tag]
}
EndpointColdStartMetric
Fields
| Field Name | Description |
|---|---|
time - DateTime!
|
|
count - Int!
|
|
duration - EndpointDurationStats!
|
Example
{
"time": "2007-12-03T10:15:30Z",
"count": 123,
"duration": EndpointDurationStats
}
EndpointColdStartMetricConnection
Description
A page of cold start metric buckets, oldest first. See PaginationInput / PaginationResponse.
Fields
| Field Name | Description |
|---|---|
edges - [EndpointColdStartMetric!]!
|
|
pagination - PaginationResponse!
|
Example
{
"edges": [EndpointColdStartMetric],
"pagination": PaginationResponse
}
EndpointDurationStats
EndpointFilterInput
Fields
| Input Field | Description |
|---|---|
createdByUserIds - [String!]
|
|
tags - [ResourceTagMatch!]
|
Example
{
"createdByUserIds": ["abc123"],
"tags": [ResourceTagMatch]
}
EndpointMetricsInput
Fields
| Input Field | Description |
|---|---|
startTime - DateTime!
|
Start of the window, inclusive. Must be within the last 90 days. |
endTime - DateTime!
|
End of the window, exclusive. |
interval - EndpointMetricsInterval!
|
Example
{
"startTime": "2007-12-03T10:15:30Z",
"endTime": "2007-12-03T10:15:30Z",
"interval": "ONE_MINUTE"
}
EndpointMetricsInterval
Description
Bucket size for endpoint metrics.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ONE_MINUTE"
EndpointOverdrive
EndpointRequestMetric
Fields
| Field Name | Description |
|---|---|
time - DateTime!
|
|
requests - Int!
|
|
completed - Int!
|
|
failed - Int!
|
|
retries - Int!
|
|
executionTime - EndpointDurationStats!
|
|
delayTime - EndpointDurationStats!
|
Example
{
"time": "2007-12-03T10:15:30Z",
"requests": 987,
"completed": 987,
"failed": 987,
"retries": 123,
"executionTime": EndpointDurationStats,
"delayTime": EndpointDurationStats
}
EndpointRequestMetricConnection
Description
A page of request metric buckets, oldest first. See PaginationInput / PaginationResponse.
Fields
| Field Name | Description |
|---|---|
edges - [EndpointRequestMetric!]!
|
|
pagination - PaginationResponse!
|
Example
{
"edges": [EndpointRequestMetric],
"pagination": PaginationResponse
}
EndpointStatisticGranularity
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"LIVE"
EndpointVolume
Description
One volume attached to an endpoint, mounted on every worker. Same shape as Pod.volumeMounts.
Fields
| Field Name | Description |
|---|---|
volumeId - ID!
|
NetworkVolume.id or ObjectStore.id, per volumeType. |
volumeType - PodVolumeType!
|
|
mountPath - String!
|
|
dataCenterId - String
|
Set for network volumes, which are pinned to a data center. Null for global volumes. |
volume - PodVolume
|
The mounted volume, as on Pod.volumeMounts. Null when the volume no longer exists. PodObjectStore.secretAccessKey is always null here. |
Example
{
"volumeId": "4",
"volumeType": "NETWORK_VOLUME",
"mountPath": "abc123",
"dataCenterId": "abc123",
"volume": NetworkVolume
}
EndpointWorkerMetric
Description
Worker counts from the last snapshot in each bucket.
Example
{
"time": "2007-12-03T10:15:30Z",
"running": 987,
"idle": 987,
"initializing": 987,
"throttled": 123,
"unhealthy": 987
}
EndpointWorkerMetricConnection
Description
A page of worker metric buckets, oldest first. See PaginationInput / PaginationResponse.
Fields
| Field Name | Description |
|---|---|
edges - [EndpointWorkerMetric!]!
|
|
pagination - PaginationResponse!
|
Example
{
"edges": [EndpointWorkerMetric],
"pagination": PaginationResponse
}
Entitlements
Description
Effective entitlement levers for a subscription, resolved from the tier table (all values PLACEHOLDERS pending the V2 tier lock) with value overrides applied. Numeric caps are absolute limits; null = unlimited.
Fields
| Field Name | Description |
|---|---|
maxGpuConcurrency - Int
|
Global cap on concurrently RUNNING GPUs counted across Pods, Instant Clusters, and live Serverless workers combined — not a Pods-only limit; null = unlimited. |
maxHighPerformanceGpuConcurrency - Int
|
Cap on concurrently RUNNING GPUs of the high-performance class (B300, B200, H200) counted across Pods and Serverless workers combined; a sub-cap of maxGpuConcurrency, never on top of it. 0 = none, null = unlimited. Enforced on GPU pod admission (Pods, Instant Clusters and Serverless worker spin-ups) behind its own brake. |
maxCpuConcurrency - Int
|
Global cap on vCPUs summed across concurrently RUNNING CPU Pods, CPU Serverless workers, and Sandboxes combined; a GPU pod's attached vCPUs never count. null = unlimited. |
maxServerlessWorkers - Int
|
|
maxInstantClusterNodes - Int
|
Per-cluster Instant Cluster node ceiling; 0 = no Instant Clusters, null = unlimited. Enforced on cluster create and expand behind its own brake. |
overdrive - Boolean!
|
Whether the account may run Overdrive (tuned vLLM configs) on Serverless endpoints. Serverless-team-owned enforcement. |
maxFlashbootEndpoints - Int
|
Cap on endpoints with FlashBoot on in any mode; 0 = none, null = unlimited. Enforced on enable only, so existing FlashBoot endpoints survive a downgrade. |
maxPriorityFlashbootEndpoints - Int
|
Cap on endpoints with a Priority FlashBoot worker target above 0; 0 = none, null = unlimited. A Priority endpoint also counts toward maxFlashbootEndpoints. |
maxPriorityFlashbootWorkers - Int
|
Ceiling on Priority FlashBoot worker targets summed across the account's endpoints; 0 = none, null = unlimited. One endpoint's target is bounded by its workersMax. |
maxHumanSeats - Int
|
Hard cap on humans (members + pending invites); null = unlimited. No per-seat billing. |
maxCostCenters - Int
|
Hard cap on cost centers an account may hold; 0 = none, null = unlimited. Enforced on create only, so existing cost centers survive a downgrade. |
auditLogRetentionDays - Int
|
Days of audit-log history an account may read; 0 = no audit log, null = unbounded. Enforced on read: the log is written for every tier, so an upgrade widens the window over rows that already exist. |
networkStorageGb - Int
|
Always null. Nothing reads or enforces it; the field stays until the console stops selecting it. Removed from the lever set; always null. |
freeGlobalStorageGb - Int
|
Global Storage (object storage) GB free before overage billing — subtracted from the account's total before billable size is computed; null = all free. |
freeStorageEvictionDays - Int
|
Days without a cash debit on the account after which its free-tier Global Storage is evicted (buckets deleted after a notice period); null = never. Only a cash debit inside the window resets the clock: logins, top-ups, an unspent balance and credit-funded usage do not. |
maxNetworkVolumeGb - Int
|
Per-volume network volume size ceiling in GB; null = only the product bound applies. |
monthlyServerlessCreditUsd - Float!
|
Monthly credit granted at the persisted tier — for grandfathered accounts this is the amount actually granted, not the fitted tier's. |
monthlySandboxCreditUsd - Float!
|
|
monthlyGeneralCreditUsd - Float!
|
Monthly general credit (cash-equivalent on usage billing): drained first in the general → product bucket → cash chain. |
supportLevel - SupportLevel!
|
|
deployWhenAvailable - Boolean!
|
Whether the account may queue deploy-when-available entries. capacityPriority orders the queue; this admits to it. Enforced at enrollment behind its own brake; entries queued before a downgrade survive. |
capacityPriority - CapacityPriority!
|
|
byoObjectStore - Boolean!
|
Whether the account may register a customer-owned (BYO) object store. Enforced at registration behind its own brake; stores registered before a downgrade keep working. |
Example
{
"maxGpuConcurrency": 123,
"maxHighPerformanceGpuConcurrency": 987,
"maxCpuConcurrency": 987,
"maxServerlessWorkers": 123,
"maxInstantClusterNodes": 123,
"overdrive": true,
"maxFlashbootEndpoints": 123,
"maxPriorityFlashbootEndpoints": 123,
"maxPriorityFlashbootWorkers": 123,
"maxHumanSeats": 123,
"maxCostCenters": 123,
"auditLogRetentionDays": 987,
"networkStorageGb": 987,
"freeGlobalStorageGb": 123,
"freeStorageEvictionDays": 123,
"maxNetworkVolumeGb": 123,
"monthlyServerlessCreditUsd": 123.45,
"monthlySandboxCreditUsd": 987.65,
"monthlyGeneralCreditUsd": 987.65,
"supportLevel": "COMMUNITY",
"deployWhenAvailable": false,
"capacityPriority": "STANDARD",
"byoObjectStore": false
}
EnvironmentVariable
EnvironmentVariableInput
EvictionBlob
ExpandClusterInput
FlashApp
Fields
| Field Name | Description |
|---|---|
id - String!
|
|
name - String!
|
|
flashEnvironments - [FlashEnvironment]
|
|
flashBuilds - [FlashBuild]
|
|
createdAt - DateTime!
|
Example
{
"id": "abc123",
"name": "xyz789",
"flashEnvironments": [FlashEnvironment],
"flashBuilds": [FlashBuild],
"createdAt": "2007-12-03T10:15:30Z"
}
FlashArtifactDownload
FlashBootType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"OFF"
FlashBuild
FlashEnvironment
Fields
| Field Name | Description |
|---|---|
id - String!
|
|
name - String!
|
|
activeBuildId - String
|
|
state - FlashEnvironmentState!
|
|
flashAppId - String!
|
|
networkVolumes - [NetworkVolume]!
|
|
endpoints - [Endpoint]!
|
|
activeArtifact - FlashArtifactDownload
|
|
activeCoordinatorId - String
|
|
createdAt - DateTime!
|
Example
{
"id": "abc123",
"name": "xyz789",
"activeBuildId": "abc123",
"state": "INITIALIZING",
"flashAppId": "xyz789",
"networkVolumes": [NetworkVolume],
"endpoints": [Endpoint],
"activeArtifact": FlashArtifactDownload,
"activeCoordinatorId": "xyz789",
"createdAt": "2007-12-03T10:15:30Z"
}
FlashEnvironmentState
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"INITIALIZING"
Float
Description
The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.
Example
123.45
GitBuild
Example
{
"id": "xyz789",
"commitHash": "xyz789",
"commitMessage": "abc123",
"branch": "xyz789",
"commitDate": "2007-12-03T10:15:30Z",
"state": "PENDING",
"startedAt": "2007-12-03T10:15:30Z",
"completedAt": "2007-12-03T10:15:30Z",
"error": "abc123",
"repoId": "xyz789",
"imageName": "abc123",
"imageDeletedAt": "2007-12-03T10:15:30Z",
"test": Test
}
GitBuildConnection
Description
A page of builds. See PaginationInput / PaginationResponse.
Fields
| Field Name | Description |
|---|---|
edges - [GitBuild!]!
|
|
pagination - PaginationResponse!
|
Example
{
"edges": [GitBuild],
"pagination": PaginationResponse
}
GitBuildState
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"PENDING"
GithubAccountInfo
GlobalStoreBucket
Description
A bucket in Runpod Global Store. The backing endpoint, generated bucket name and credentials are deliberately absent — only the host daemon needs those, and it reads them from Pod.objectStores.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
name - String!
|
|
size - Float
|
Estimated bytes stored, as reported by the storage provider — display only, not a billing source. Null when the provider is unreachable. Float because the provider reports int64, which overflows GraphQL's Int. |
objectCount - Float
|
Estimated object count. Display only and Float, as with size. |
createdAt - DateTime!
|
|
createdByUser - ResourceUser
|
Example
{
"id": 4,
"name": "abc123",
"size": 123.45,
"objectCount": 123.45,
"createdAt": "2007-12-03T10:15:30Z",
"createdByUser": ResourceUser
}
GlobalStoreBucketMountInput
Description
A pod-scoped mount of a whole Global Store bucket. At most one per pod: the host runs a single FUSE mount.
Example
{
"globalStoreBucketId": "4",
"mountPath": "xyz789",
"readOnly": true
}
Gpu
GpuAvailability
Example
{
"available": false,
"availableCount": 987,
"stockStatus": "abc123",
"gpuTypeId": "abc123",
"gpuType": GpuType,
"gpuTypeDisplayName": "xyz789",
"displayName": "xyz789",
"id": "abc123"
}
GpuAvailabilityInput
Fields
| Input Field | Description |
|---|---|
gpuCount - Int
|
Number of GPUs per pod (default: 1) |
minDisk - Int
|
|
minMemoryInGb - Int
|
|
minVcpuCount - Int
|
|
secureCloud - Boolean
|
defaults to Secure Cloud data centers |
allowedCudaVersions - [String]
|
|
minCudaVersion - String
|
|
includeAiApi - Boolean
|
|
machineProducts - [MachineProduct]
|
Products (pod, serverless, or instant cluster) to filter machines by. Omit entirely or pass empty array to use legacy includeAiApi behavior. |
Example
{
"gpuCount": 123,
"minDisk": 123,
"minMemoryInGb": 987,
"minVcpuCount": 123,
"secureCloud": false,
"allowedCudaVersions": ["abc123"],
"minCudaVersion": "abc123",
"includeAiApi": false,
"machineProducts": ["PODCLOUD"]
}
GpuGeneration
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"PASCAL"
GpuLowestPriceInput
Fields
| Input Field | Description |
|---|---|
countryCode - String
|
|
dataCenterIds - [String!]
|
|
gpuCount - Int!
|
|
includeAiApi - Boolean
|
|
minDisk - Int
|
|
minDownload - Int
|
|
minMemoryInGb - Int
|
|
minUpload - Int
|
|
minVcpuCount - Int
|
|
secureCloud - Boolean
|
|
supportPublicIp - Boolean
|
|
totalDisk - Int
|
|
cudaVersion - String
|
|
allowedCudaVersions - [String]
|
|
minCudaVersion - String
|
|
compliance - [Compliance]
|
|
isCluster - Boolean
|
|
podCount - Int
|
|
throughput - Int
|
|
globalNetwork - Boolean
|
|
machineProducts - [MachineProduct]
|
Products (pod, serverless, or instant cluster) to filter machines by. Omit entirely or pass empty array to use legacy includeAiApi behavior. |
supplyScope - SupplyScope
|
Example
{
"countryCode": "xyz789",
"dataCenterIds": ["xyz789"],
"gpuCount": 987,
"includeAiApi": false,
"minDisk": 987,
"minDownload": 987,
"minMemoryInGb": 123,
"minUpload": 123,
"minVcpuCount": 123,
"secureCloud": false,
"supportPublicIp": false,
"totalDisk": 123,
"cudaVersion": "xyz789",
"allowedCudaVersions": ["abc123"],
"minCudaVersion": "abc123",
"compliance": ["GDPR"],
"isCluster": false,
"podCount": 987,
"throughput": 987,
"globalNetwork": false,
"machineProducts": ["PODCLOUD"],
"supplyScope": "ORG_ONLY"
}
GpuTelemetry
GpuType
Fields
| Field Name | Description |
|---|---|
lowestPrice - LowestPrice
|
|
Arguments
|
|
maxGpuCount - Int
|
|
maxGpuCountCommunityCloud - Int
|
|
maxGpuCountSecureCloud - Int
|
|
minPodGpuCount - Int
|
|
nodeGroupGpuSizes - [Int]
|
|
nodeGroupDatacenters - [DataCenter]
|
|
id - String
|
|
displayName - String
|
|
manufacturer - String
|
|
gpuGeneration - GpuGeneration
|
|
memoryInGb - Int
|
|
cudaCores - Int
|
|
secureCloud - Boolean
|
|
communityCloud - Boolean
|
|
securePrice - Float
|
|
clusterPrice - Float
|
|
communityPrice - Float
|
|
oneMonthPrice - Float
|
|
threeMonthPrice - Float
|
|
sixMonthPrice - Float
|
|
oneYearPrice - Float
|
|
oneWeekPrice - Float
|
|
communitySpotPrice - Float
|
Spot pods are no longer offered |
secureSpotPrice - Float
|
Spot pods are no longer offered |
throughput - Int
|
|
defaultQuotaAbsolute - Int
|
|
Example
{
"lowestPrice": LowestPrice,
"maxGpuCount": 987,
"maxGpuCountCommunityCloud": 987,
"maxGpuCountSecureCloud": 123,
"minPodGpuCount": 987,
"nodeGroupGpuSizes": [123],
"nodeGroupDatacenters": [DataCenter],
"id": "xyz789",
"displayName": "abc123",
"manufacturer": "xyz789",
"gpuGeneration": "PASCAL",
"memoryInGb": 123,
"cudaCores": 987,
"secureCloud": true,
"communityCloud": true,
"securePrice": 123.45,
"clusterPrice": 987.65,
"communityPrice": 987.65,
"oneMonthPrice": 123.45,
"threeMonthPrice": 987.65,
"sixMonthPrice": 987.65,
"oneYearPrice": 123.45,
"oneWeekPrice": 123.45,
"communitySpotPrice": 123.45,
"secureSpotPrice": 987.65,
"throughput": 123,
"defaultQuotaAbsolute": 123
}
GpuTypeCudaVersionAvailability
Fields
| Field Name | Description |
|---|---|
cudaVersion - String
|
|
availability - Availability
|
Example
{
"cudaVersion": "abc123",
"availability": "AVAILABLE"
}
GpuTypeDataCenterAvailability
Fields
| Field Name | Description |
|---|---|
dataCenterId - String
|
|
supportNetworkVolumes - Boolean
|
|
availability - Availability
|
Example
{
"dataCenterId": "xyz789",
"supportNetworkVolumes": true,
"availability": "AVAILABLE"
}
GpuTypeFilter
Fields
| Input Field | Description |
|---|---|
id - String
|
|
ids - [String!]
|
|
cluster - Boolean
|
|
supplyScope - SupplyScope
|
Example
{
"id": "xyz789",
"ids": ["abc123"],
"cluster": false,
"supplyScope": "ORG_ONLY"
}
HubHealth
Description
Reliability of a Hub template or listing, recomputed periodically from deploy outcomes.
Fields
| Field Name | Description |
|---|---|
reliability - Float
|
0 to 1. Null until there is enough deploy history to score. |
reliabilityTier - ReliabilityTier!
|
UNVERIFIED while reliability is null; otherwise UNSTABLE below the cutoff for the resource type (templates and listings have separate cutoffs) and VERIFIED at or above it. A pod template is also UNSTABLE, whatever its score, once its creator has ignored a review request; listings have no review flow. |
reliabilityComputedAt - DateTime
|
Example
{
"reliability": 987.65,
"reliabilityTier": "VERIFIED",
"reliabilityComputedAt": "2007-12-03T10:15:30Z"
}
HubRelease
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
name - String!
|
|
tagName - String!
|
|
createdAt - DateTime!
|
|
releasedAt - DateTime!
|
|
updatedAt - DateTime!
|
|
authorName - String
|
|
authorId - String
|
|
authorAvatarUrl - String
|
|
iconUrl - String
|
|
body - String
|
|
readme - String
|
|
branch - String
|
|
license - String
|
|
deploys - Int!
|
|
config - String
|
|
tests - String
|
|
build - GitBuild
|
|
listing - Listing
|
Example
{
"id": "4",
"name": "xyz789",
"tagName": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"releasedAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"authorName": "xyz789",
"authorId": "xyz789",
"authorAvatarUrl": "xyz789",
"iconUrl": "xyz789",
"body": "xyz789",
"readme": "xyz789",
"branch": "xyz789",
"license": "abc123",
"deploys": 987,
"config": "xyz789",
"tests": "abc123",
"build": GitBuild,
"listing": Listing
}
ID
Description
The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.
Example
4
IPAddress
Fields
| Field Name | Description |
|---|---|
id - String
|
|
address - String
|
|
networkRangeId - String
|
|
networkRange - NetworkRange
|
|
pod - Pod
|
|
podnetNodes - [PodnetNode]
|
Example
{
"id": "abc123",
"address": "xyz789",
"networkRangeId": "abc123",
"networkRange": NetworkRange,
"pod": Pod,
"podnetNodes": [PodnetNode]
}
Impersonation
Example
{
"auditLogs": AuditLogConnection,
"id": "4",
"zendeskTicketId": 4,
"impersonateUserId": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"expiresAt": "2007-12-03T10:15:30Z",
"accepted": false,
"acceptedAt": "2007-12-03T10:15:30Z"
}
Int
Description
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Example
987
JSON
Description
The JSON scalar type represents JSON values as specified by ECMA-404.
Example
{}
LabelEqualityInput
Listing
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
listed - Boolean!
|
|
repoId - String!
|
|
title - String
|
|
description - String
|
|
repoName - String!
|
|
repoOwner - String!
|
|
repoOwnerAvatarUrl - String
|
|
createdAt - DateTime!
|
|
updatedAt - DateTime!
|
|
lastScannedAt - DateTime
|
|
views - Int!
|
|
stars - Int!
|
|
deploys - Int!
|
|
openIssues - Int!
|
|
watchers - Int!
|
|
language - String
|
|
tags - [String!]!
|
|
category - String
|
|
type - String!
|
|
rejectNote - String
|
|
releases - [HubRelease]!
|
|
listedRelease - HubRelease
|
|
health - HubHealth
|
Nullable to match PodTemplate.health; the resolver always returns one. Read null as UNVERIFIED. |
Example
{
"id": "4",
"listed": false,
"repoId": "xyz789",
"title": "abc123",
"description": "xyz789",
"repoName": "abc123",
"repoOwner": "xyz789",
"repoOwnerAvatarUrl": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"lastScannedAt": "2007-12-03T10:15:30Z",
"views": 987,
"stars": 123,
"deploys": 123,
"openIssues": 987,
"watchers": 123,
"language": "xyz789",
"tags": ["abc123"],
"category": "abc123",
"type": "xyz789",
"rejectNote": "abc123",
"releases": [HubRelease],
"listedRelease": HubRelease,
"health": HubHealth
}
LowestPrice
Fields
| Field Name | Description |
|---|---|
gpuName - String
|
|
gpuTypeId - String
|
|
minimumBidPrice - Float
|
Spot pods are no longer offered |
uninterruptablePrice - Float
|
|
clusterPrice - Float
|
|
isPrivatePool - Boolean
|
True when uninterruptablePrice (or clusterPrice for isCluster requests) is a private pool price or the caller org's own hardware, which is priced at 0, rather than the public rate. False when the caller's pool is full, since the price and the deploy fall back to public supply. |
minMemory - Int
|
|
minVcpu - Int
|
|
rentalPercentage - Float
|
|
rentedCount - Int
|
|
totalCount - Int
|
|
stockStatus - String
|
|
minDownload - Int
|
|
minDisk - Int
|
|
minUpload - Int
|
|
countryCode - String
|
|
supportPublicIp - Boolean
|
|
compliance - [Compliance]
|
|
maxGpuCount - Int
|
|
maxUnreservedGpuCount - Int
|
|
availableGpuCount - Int
|
|
availableGpuCounts - [Int]
|
|
gpuTypeDatacenters - [GpuTypeDataCenterAvailability]
|
|
gpuTypeCudaVersions - [GpuTypeCudaVersionAvailability]
|
CUDA versions present on machines matching this request's hard filters, tagged with current capacity. For isCluster requests, AVAILABLE requires podCount eligible machines on that version in one datacenter and node group. Note: scoped by the request's own cudaVersion/allowedCudaVersions/minCudaVersion inputs — to enumerate all supported versions, query without a CUDA filter. |
Example
{
"gpuName": "abc123",
"gpuTypeId": "xyz789",
"minimumBidPrice": 987.65,
"uninterruptablePrice": 987.65,
"clusterPrice": 123.45,
"isPrivatePool": true,
"minMemory": 123,
"minVcpu": 987,
"rentalPercentage": 987.65,
"rentedCount": 123,
"totalCount": 987,
"stockStatus": "xyz789",
"minDownload": 987,
"minDisk": 987,
"minUpload": 123,
"countryCode": "abc123",
"supportPublicIp": false,
"compliance": ["GDPR"],
"maxGpuCount": 123,
"maxUnreservedGpuCount": 987,
"availableGpuCount": 987,
"availableGpuCounts": [123],
"gpuTypeDatacenters": [GpuTypeDataCenterAvailability],
"gpuTypeCudaVersions": [GpuTypeCudaVersionAvailability]
}
Machine
Fields
| Field Name | Description |
|---|---|
pods - [Pod]
|
|
id - String
|
|
userId - String
|
|
name - String
|
|
registered - Boolean
|
|
readyToList - Boolean
|
|
slsEnabled - Boolean
|
|
podCloudEnabled - Boolean
|
|
clusterEnabled - Boolean
|
|
priority - Int
|
|
minPodGpuCount - Int
|
|
gpuTypeId - String
|
|
gpuType - GpuType
|
|
gpuPowerLimitPercentageRented - Int
|
|
gpuPowerLimitPercentageSelf - Int
|
|
cpuCount - Int
|
|
cpuTypeId - String
|
|
cpuType - CpuType
|
|
dataCenter - DataCenter
|
|
moboName - String
|
|
hidden - Boolean
|
|
hostPricePerGpu - Float
|
|
hostMinBidPerGpu - Float
|
|
defaultImageName - String
|
|
defaultStartScript - String
|
|
defaultArguments - String
|
|
defaultDiskInGb - Int
|
|
defaultPort - Port
|
|
defaultEnv - [String]
|
|
location - String
|
|
listed - Boolean
|
|
verified - Boolean
|
|
machineId - String
|
|
diskReserved - Int
|
|
diskTotal - Int
|
|
diskMBps - Int
|
|
downloadMbps - Int
|
|
gpuReserved - Int
|
|
totalGpuAllocated - Int
|
|
gpuTotal - Int
|
|
pcieLink - Int
|
|
pcieLinkWidth - Int
|
|
memoryReserved - Int
|
|
totalMemoryAllocated - Int
|
|
memoryTotal - Int
|
|
uploadMbps - Int
|
|
vcpuReserved - Int
|
|
totalVcpuAllocated - Int
|
|
vcpuTotal - Int
|
|
installCert - String
|
|
uptimePercentListedOneWeek - Float
|
|
uptimePercentListedFourWeek - Float
|
|
uptimePercentListedTwelveWeek - Float
|
|
uptimePercentAbsoluteTwelveWeek - Float
|
|
margin - Float
|
|
gpuCloudPrice - Float
|
|
supportPublicIp - Boolean
|
|
secureCloud - Boolean
|
|
ownedByMe - Boolean
|
|
idleJobTemplateId - String
|
|
idleJobTemplate - PodTemplate
|
|
maintenanceStart - DateTime
|
|
maintenanceEnd - DateTime
|
|
maintenanceNote - String
|
|
maintenanceMode - Boolean
|
|
note - String
|
|
machineBalance - MachineBalance
|
|
machineSystem - MachineSystem
|
|
dataCenterId - String
|
|
machineType - String
|
|
virtualizationRole - VirtualizationRole
|
|
lastBenchmark - MachineBenchmark
|
|
upcomingMaintenances - [MachineMaintenance]
|
|
nextMaintenance - MachineMaintenance
|
|
nodeGroupId - String
|
|
nodeGroup - NodeGroup
|
|
lastSyncAt - DateTime
|
|
markedForDeletion - Boolean
|
|
pinCpus - Boolean
|
|
modelRepos - [ModelRepo]
|
|
storageClusterEvictions - [StorageClusterEviction]
|
|
modelStorageClusterAssignments - [ModelStorageClusterAssignment!]
|
|
poolState - MachinePoolState
|
|
poolId - String
|
|
isSafeToReclaim - Boolean
|
|
backgroundPodTelemetry - PodTelemetry
|
|
Arguments
|
|
latestTelemetry - MachineTelemetry
|
|
uptime - MachineUptime
|
|
runpodIp - String
|
|
publicIp - String
|
|
autoMachineVerifyLastStatus - AutoMachineVerifyStatus
|
|
Example
{
"pods": [Pod],
"id": "xyz789",
"userId": "xyz789",
"name": "xyz789",
"registered": false,
"readyToList": true,
"slsEnabled": true,
"podCloudEnabled": true,
"clusterEnabled": false,
"priority": 123,
"minPodGpuCount": 987,
"gpuTypeId": "abc123",
"gpuType": GpuType,
"gpuPowerLimitPercentageRented": 123,
"gpuPowerLimitPercentageSelf": 123,
"cpuCount": 987,
"cpuTypeId": "xyz789",
"cpuType": CpuType,
"dataCenter": DataCenter,
"moboName": "xyz789",
"hidden": false,
"hostPricePerGpu": 987.65,
"hostMinBidPerGpu": 987.65,
"defaultImageName": "abc123",
"defaultStartScript": "xyz789",
"defaultArguments": "abc123",
"defaultDiskInGb": 987,
"defaultPort": 19758,
"defaultEnv": ["abc123"],
"location": "xyz789",
"listed": true,
"verified": false,
"machineId": "xyz789",
"diskReserved": 987,
"diskTotal": 987,
"diskMBps": 123,
"downloadMbps": 987,
"gpuReserved": 987,
"totalGpuAllocated": 123,
"gpuTotal": 987,
"pcieLink": 123,
"pcieLinkWidth": 987,
"memoryReserved": 987,
"totalMemoryAllocated": 123,
"memoryTotal": 123,
"uploadMbps": 987,
"vcpuReserved": 987,
"totalVcpuAllocated": 987,
"vcpuTotal": 987,
"installCert": "abc123",
"uptimePercentListedOneWeek": 123.45,
"uptimePercentListedFourWeek": 987.65,
"uptimePercentListedTwelveWeek": 987.65,
"uptimePercentAbsoluteTwelveWeek": 987.65,
"margin": 987.65,
"gpuCloudPrice": 123.45,
"supportPublicIp": true,
"secureCloud": false,
"ownedByMe": false,
"idleJobTemplateId": "abc123",
"idleJobTemplate": PodTemplate,
"maintenanceStart": "2007-12-03T10:15:30Z",
"maintenanceEnd": "2007-12-03T10:15:30Z",
"maintenanceNote": "xyz789",
"maintenanceMode": false,
"note": "abc123",
"machineBalance": MachineBalance,
"machineSystem": MachineSystem,
"dataCenterId": "xyz789",
"machineType": "abc123",
"virtualizationRole": "HOST",
"lastBenchmark": MachineBenchmark,
"upcomingMaintenances": [MachineMaintenance],
"nextMaintenance": MachineMaintenance,
"nodeGroupId": "abc123",
"nodeGroup": NodeGroup,
"lastSyncAt": "2007-12-03T10:15:30Z",
"markedForDeletion": false,
"pinCpus": false,
"modelRepos": [ModelRepo],
"storageClusterEvictions": [StorageClusterEviction],
"modelStorageClusterAssignments": [
ModelStorageClusterAssignment
],
"poolState": "GENERALLY_AVAILABLE",
"poolId": "xyz789",
"isSafeToReclaim": false,
"backgroundPodTelemetry": PodTelemetry,
"latestTelemetry": MachineTelemetry,
"uptime": MachineUptime,
"runpodIp": "xyz789",
"publicIp": "abc123",
"autoMachineVerifyLastStatus": AutoMachineVerifyStatus
}
MachineBalance
MachineBenchmark
Fields
| Field Name | Description |
|---|---|
errors - String
|
|
benchmarkedAt - DateTime
|
|
gpuCount - Int
|
|
pod - BenchmarkPod
|
Example
{
"errors": "xyz789",
"benchmarkedAt": "2007-12-03T10:15:30Z",
"gpuCount": 123,
"pod": BenchmarkPod
}
MachineEarning
Example
{
"name": "xyz789",
"date": "2007-12-03T10:15:30Z",
"machineId": "xyz789",
"hostTotalEarnings": 123.45,
"hostGpuEarnings": 987.65,
"hostDiskEarnings": 987.65
}
MachineMaintenance
Example
{
"id": "xyz789",
"machineId": "abc123",
"maintenanceStart": "2007-12-03T10:15:30Z",
"maintenanceEnd": "2007-12-03T10:15:30Z",
"maintenanceNote": "abc123"
}
MachinePoolState
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"GENERALLY_AVAILABLE"
MachineProduct
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"PODCLOUD"
MachineSummary
Fields
| Field Name | Description |
|---|---|
cpuTypeId - String
|
|
diskProfitPerHr - Float
|
|
displayName - String
|
|
gpuTotal - Int
|
|
gpuTypeId - String
|
|
id - String
|
|
listed - Int
|
|
machineType - String
|
|
virtualizationRole - VirtualizationRole
|
|
onDemandPods - Int
|
|
podProfitPerHr - Float
|
|
spotPods - Int
|
Spot pods are no longer offered |
gpuRented - Int
|
|
cpuRented - Int
|
|
vcpuTotal - Int
|
Example
{
"cpuTypeId": "xyz789",
"diskProfitPerHr": 987.65,
"displayName": "abc123",
"gpuTotal": 987,
"gpuTypeId": "xyz789",
"id": "abc123",
"listed": 987,
"machineType": "abc123",
"virtualizationRole": "HOST",
"onDemandPods": 123,
"podProfitPerHr": 123.45,
"spotPods": 987,
"gpuRented": 987,
"cpuRented": 123,
"vcpuTotal": 987
}
MachineSystem
Example
{
"os": "abc123",
"cudaVersion": "xyz789",
"diskTotal": 123,
"diskFree": 123,
"privateIp": "xyz789",
"dockerVersion": "xyz789",
"kernelVersion": "abc123",
"publicIp": "abc123"
}
MachineTelemetry
Fields
| Field Name | Description |
|---|---|
time - DateTime
|
|
cpuUtilization - Float
|
|
memoryUtilization - Float
|
|
averageGpuMetrics - GpuTelemetry
|
|
individualGpuMetrics - [GpuTelemetry]
|
Example
{
"time": "2007-12-03T10:15:30Z",
"cpuUtilization": 123.45,
"memoryUtilization": 987.65,
"averageGpuMetrics": GpuTelemetry,
"individualGpuMetrics": [GpuTelemetry]
}
MachineUptime
ModelRepo
Example
{
"versionHash": "abc123",
"versionUuid": 4,
"modelUuid": 4,
"provider": "xyz789",
"files": [ModelRepoFile],
"destPath": "abc123",
"networkPath": "xyz789",
"upload": true,
"authTokens": ["xyz789"]
}
ModelRepoFile
ModelStatusInfo
ModelStorageClusterAssignment
Example
{
"id": 4,
"modelVersionUuid": 4,
"storageClusterId": 4,
"status": "ASSIGNED",
"createdAt": "xyz789",
"updatedAt": "xyz789",
"completedAt": "abc123",
"lastAccessedAt": "xyz789"
}
ModelVersionPodAssignment
NetworkRange
Fields
| Field Name | Description |
|---|---|
id - String
|
|
cidr - String
|
|
podnetClusterId - String
|
|
podnetCluster - PodnetCluster
|
|
addresses - [IPAddress]
|
Example
{
"id": "xyz789",
"cidr": "xyz789",
"podnetClusterId": "abc123",
"podnetCluster": PodnetCluster,
"addresses": [IPAddress]
}
NetworkStorageEarning
Example
{
"date": "2007-12-03T10:15:30Z",
"dailyNetworkVolumeEarn": 123.45,
"dailyNetworkVolumeEarnHPS": 123.45,
"dataCenterId": "xyz789",
"runpodEarnings": 123.45,
"runpodEarningsHPS": 987.65
}
NetworkStorageEarningInput
Fields
| Input Field | Description |
|---|---|
granularity - String
|
Example
{"granularity": "xyz789"}
NetworkVolume
Fields
| Field Name | Description |
|---|---|
id - String
|
|
name - String
|
|
size - Int
|
|
dataCenterId - String
|
|
dataCenter - DataCenter
|
|
storageClusterId - String
|
|
storageType - StorageType
|
|
isNextGenStorage - Boolean
|
|
pricePerGbMonth - Float
|
Rate this volume is charged at, in USD per GB per month. |
createdAt - DateTime
|
|
updatedAt - DateTime
|
|
createdByUserId - String
|
|
createdByUser - ResourceUser
|
|
flashEnvironmentId - String
|
|
tags - [Tag!]
|
Example
{
"id": "abc123",
"name": "abc123",
"size": 987,
"dataCenterId": "abc123",
"dataCenter": DataCenter,
"storageClusterId": "xyz789",
"storageType": "MOOSE_FS",
"isNextGenStorage": false,
"pricePerGbMonth": 123.45,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"createdByUserId": "abc123",
"createdByUser": ResourceUser,
"flashEnvironmentId": "xyz789",
"tags": [Tag]
}
NetworkVolumeFilterInput
Fields
| Input Field | Description |
|---|---|
createdByUserIds - [String!]
|
|
tags - [ResourceTagMatch!]
|
Example
{
"createdByUserIds": ["xyz789"],
"tags": [ResourceTagMatch]
}
NetworkVolumeIds
NetworkVolumePricing
Description
Network volume rates in USD per GB per month, as charged by volume billing. An account Metronome settles is rated off its Metronome contract, so a contract override there, such as a flat standard rate, is not reflected here. Nor is a contracted rate scoped to particular volumes, such as a per-data-center override.
Fields
| Field Name | Description |
|---|---|
standardPerGbMonth - Float!
|
Standard (MooseFS) volumes. |
highPerformancePerGbMonth - Float!
|
High performance (HPS) volumes. |
discountedPerGbMonth - Float
|
Standard rate once this user's billable standard storage reaches discountThresholdGb. Null when there is no size tier. |
discountThresholdGb - Int
|
This user's billable standard storage in GB at which discountedPerGbMonth applies. Null when there is no size tier. |
Example
{
"standardPerGbMonth": 123.45,
"highPerformancePerGbMonth": 123.45,
"discountedPerGbMonth": 123.45,
"discountThresholdGb": 987
}
NodeGroup
Example
{
"id": "abc123",
"name": "abc123",
"throughput": 987,
"createdAt": "xyz789",
"listed": true,
"infiniband": true,
"rdmaType": "INFINIBAND",
"rdmaConfig": {},
"user": User,
"Machines": [Machine]
}
ObjectStoreOwnership
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"MANAGED"
OnboardingInfo
Fields
| Field Name | Description |
|---|---|
userId - String
|
|
formStarted - DateTime
|
|
formSubmitted - DateTime
|
|
accountType - String
|
|
businessSize - String
|
|
role - String
|
|
budget - String
|
|
usage - String
|
|
referrer - String
|
|
utmSource - String
|
|
utmMedium - String
|
|
utmCampaign - String
|
|
utmTerm - String
|
|
utmContent - String
|
|
referrerLink - String
|
|
internalReferrerLink - String
|
|
updatedAt - DateTime
|
|
googleSessionId - Int
|
|
googleClientId - String
|
|
subscribedToNewsletter - Boolean
|
|
subscribedToMarketing - Boolean
|
|
referralBonus - Int
|
|
referralBonusNotifiedAt - DateTime
|
|
upgradedToAffiliateNotifiedAt - DateTime
|
|
checklistType - String
|
|
checklistHidden - Boolean
|
|
completedChecklist - Boolean
|
|
checklistPathsCompleted - ChecklistPath
|
|
slsActivatedDate - DateTime
|
|
podActivatedDate - DateTime
|
Example
{
"userId": "abc123",
"formStarted": "2007-12-03T10:15:30Z",
"formSubmitted": "2007-12-03T10:15:30Z",
"accountType": "abc123",
"businessSize": "xyz789",
"role": "xyz789",
"budget": "xyz789",
"usage": "abc123",
"referrer": "abc123",
"utmSource": "xyz789",
"utmMedium": "xyz789",
"utmCampaign": "xyz789",
"utmTerm": "abc123",
"utmContent": "xyz789",
"referrerLink": "xyz789",
"internalReferrerLink": "abc123",
"updatedAt": "2007-12-03T10:15:30Z",
"googleSessionId": 123,
"googleClientId": "xyz789",
"subscribedToNewsletter": false,
"subscribedToMarketing": true,
"referralBonus": 123,
"referralBonusNotifiedAt": "2007-12-03T10:15:30Z",
"upgradedToAffiliateNotifiedAt": "2007-12-03T10:15:30Z",
"checklistType": "xyz789",
"checklistHidden": true,
"completedChecklist": true,
"checklistPathsCompleted": ChecklistPath,
"slsActivatedDate": "2007-12-03T10:15:30Z",
"podActivatedDate": "2007-12-03T10:15:30Z"
}
PaginationInput
Description
Page request for a cursor-paginated list field.
Fields
| Input Field | Description |
|---|---|
cursor - String
|
Resume strictly after this position; omit for the first page, then pass the previous response's nextCursor through verbatim. Opaque — the encoding may change, and a cursor is only valid for an identical query. Reusing one against different filters or sort order is undefined. |
limit - Int
|
Page size. Each field documents its own default and maximum; a value outside that range is rejected with INVALID_INPUT rather than clamped. Omit to take the default. |
Example
{"cursor": "xyz789", "limit": 987}
PaginationResponse
Description
Page envelope returned by every cursor-paginated list field.
Example
{
"nextCursor": "abc123",
"hasNextPage": false
}
PaymentMethod
Fields
| Field Name | Description |
|---|---|
id - String
|
|
userId - String
|
|
stripePaymentId - String
|
|
type - String
|
|
card - Card
|
|
createdAt - DateTime
|
|
updatedAt - DateTime
|
|
deletedAt - DateTime
|
|
isDefault - Boolean
|
|
failedPaymentCount - Int
|
|
declinedAt - DateTime
|
Set once a Stripe hard decline retired the card; auto-pay never charges it again. |
declineCode - String
|
|
name - String
|
|
priority - Int
|
Example
{
"id": "abc123",
"userId": "xyz789",
"stripePaymentId": "abc123",
"type": "abc123",
"card": Card,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"deletedAt": "2007-12-03T10:15:30Z",
"isDefault": true,
"failedPaymentCount": 987,
"declinedAt": "2007-12-03T10:15:30Z",
"declineCode": "xyz789",
"name": "xyz789",
"priority": 987
}
PayoutHistory
Fields
| Field Name | Description |
|---|---|
id - String
|
|
medium - TransactionMedium
|
|
transactionStartedAt - DateTime
|
|
receiptLink - String
|
|
amount - Float
|
|
type - TransactionType
|
|
status - PayoutStatus
|
|
failureReason - String
|
Example
{
"id": "xyz789",
"medium": "STRIPE",
"transactionStartedAt": "2007-12-03T10:15:30Z",
"receiptLink": "abc123",
"amount": 123.45,
"type": "RELOAD",
"status": "PENDING",
"failureReason": "xyz789"
}
PayoutStatus
Description
Stripe payout lifecycle, reconciled from transfer/payout webhooks. Null on rows that predate status tracking.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"PENDING"
PlanPriceInterval
Description
Billing cadence of a plan price. createSubscription sells MONTH today; changeSubscription keeps whatever cadence the live Stripe item has (design doc §17 Q4).
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"MONTH"
Pod
Fields
| Field Name | Description |
|---|---|
lowestBidPriceToResume - Float
|
Spot pods are no longer offered |
aiApiId - String
|
|
apiKey - String
|
|
clusterIp - String
|
|
clusterIdx - Int
|
|
clusterRole - ClusterRole
|
|
consumerUserId - String
|
|
createdByUserId - String
|
|
createdByUser - ResourceUser
|
|
containerDiskInGb - Int
|
|
containerRegistryAuthId - String
|
|
costMultiplier - Float
|
|
costPerHr - Float!
|
|
createdAt - DateTime
|
|
adjustedCostPerHr - Float!
|
|
desiredStatus - PodStatus!
|
|
dockerArgs - String
|
|
dockerId - String
|
|
env - [String]
|
|
envKeyValue - [EnvironmentVariable!]
|
|
gpuCount - Int!
|
|
gpuPowerLimitPercent - Int!
|
|
gpus - [Gpu]!
|
|
id - String!
|
|
imageName - String
|
|
lastStatusChange - String
|
|
locked - Boolean
|
|
machineId - String!
|
|
memoryInGb - Float!
|
|
name - String!
|
|
podType - PodType
|
|
port - Port
|
|
ports - String
|
|
sandboxId - String
|
|
sandbox - PodSandbox
|
The sandbox this pod runs, with the egress policy the host enforces on it; see SandboxEgressPolicy for the enforcement contract. Null on a pod with a non-null sandboxId means there is no policy to enforce, and the host must not start that pod. |
registry - PodRegistry
|
|
templateId - String
|
|
hasTerminalAccess - Boolean!
|
Whether the caller's role holds POD:TERMINAL; pod reach is enforced by the query that returned this pod. |
uptimeSeconds - Int
|
Use Pod.runtime.uptimeSeconds instead |
vcpuCount - Float!
|
|
version - Int
|
|
volumeEncrypted - Boolean!
|
|
volumeInGb - Float
|
|
volumeKey - String
|
|
volumeMountPath - String
|
|
sshAuthorizedKeys - [String!]
|
Host daemon only. The keys the host writes to the pod's /root/.ssh/authorized_keys, replacing the whole file. For a personal pod, the owner's keys. For an org pod, the keys of the members who can see the pod and whose role holds POD:TERMINAL: in an open org any such member, in a closed org the creator, their group peers and org admins. Null means "leave the file alone" (serverless worker, background job, or a pod outside the podSshKeySync rollout). An empty list means "remove every key". |
sshKeysHash - String
|
Host daemon only. Hash of sshAuthorizedKeys; changes when the keys change. Null when sshAuthorizedKeys is null. |
lastStartedAt - DateTime
|
|
cpuFlavorId - String
|
|
machineType - String
|
|
slsVersion - Int
|
|
networkVolumeId - String
|
DEPRECATED: read volumeMounts instead, which also covers Global Store buckets. The pod's network volume. Translated from volumeMounts when the pod has them and read from the column only for pods that predate the table, so retiring the column later changes nothing here. Retained for wire compatibility; not marked with the @deprecated directive because deprecated members are hidden from introspection by default and the host daemon and proxy generate their clients from it. |
testPod - Boolean
|
|
ideAiApiId - String
|
|
hubReleaseId - String
|
|
hubRelease - HubRelease
|
|
modelVersions - [ModelVersionPodAssignment!]
|
|
objectStores - [PodObjectStore!]
|
DEPRECATED: read volumeMounts instead. The pod's Global Store mounts in the flat shape the host daemon consumes, translated from volumeMounts when the pod has them. Retained for wire compatibility; not marked with the @deprecated directive, for the same introspection reason as networkVolumeId. |
volumeMounts - [PodVolumeMount!]!
|
Every persistent volume mounted into the pod. Authoritative over networkVolumeId and objectStores. |
cpuFlavor - CpuFlavor
|
|
runtime - PodRuntime
|
|
machine - PodMachineInfo
|
|
latestTelemetry - PodTelemetry
|
|
endpoint - Endpoint
|
|
slsWorkerType - SlsWorkerType
|
|
networkVolume - NetworkVolume
|
|
savingsPlans - [SavingsPlan]
|
|
clusterId - String
|
|
ipAddress - IPAddress
|
|
models - [String!]
|
|
flashEnvironmentId - String
|
|
tags - [Tag!]
|
Example
{
"lowestBidPriceToResume": 987.65,
"aiApiId": "abc123",
"apiKey": "xyz789",
"clusterIp": "abc123",
"clusterIdx": 987,
"clusterRole": "SLURM_CONTROLLER",
"consumerUserId": "xyz789",
"createdByUserId": "abc123",
"createdByUser": ResourceUser,
"containerDiskInGb": 123,
"containerRegistryAuthId": "xyz789",
"costMultiplier": 123.45,
"costPerHr": 987.65,
"createdAt": "2007-12-03T10:15:30Z",
"adjustedCostPerHr": 123.45,
"desiredStatus": "CREATED",
"dockerArgs": "xyz789",
"dockerId": "xyz789",
"env": ["abc123"],
"envKeyValue": [EnvironmentVariable],
"gpuCount": 123,
"gpuPowerLimitPercent": 123,
"gpus": [Gpu],
"id": "xyz789",
"imageName": "xyz789",
"lastStatusChange": "abc123",
"locked": false,
"machineId": "abc123",
"memoryInGb": 987.65,
"name": "xyz789",
"podType": "INTERRUPTABLE",
"port": 19758,
"ports": "xyz789",
"sandboxId": "xyz789",
"sandbox": PodSandbox,
"registry": PodRegistry,
"templateId": "xyz789",
"hasTerminalAccess": false,
"uptimeSeconds": 123,
"vcpuCount": 123.45,
"version": 987,
"volumeEncrypted": true,
"volumeInGb": 987.65,
"volumeKey": "abc123",
"volumeMountPath": "abc123",
"sshAuthorizedKeys": ["abc123"],
"sshKeysHash": "abc123",
"lastStartedAt": "2007-12-03T10:15:30Z",
"cpuFlavorId": "xyz789",
"machineType": "abc123",
"slsVersion": 123,
"networkVolumeId": "abc123",
"testPod": false,
"ideAiApiId": "abc123",
"hubReleaseId": "xyz789",
"hubRelease": HubRelease,
"modelVersions": [ModelVersionPodAssignment],
"objectStores": [PodObjectStore],
"volumeMounts": [PodVolumeMount],
"cpuFlavor": CpuFlavor,
"runtime": PodRuntime,
"machine": PodMachineInfo,
"latestTelemetry": PodTelemetry,
"endpoint": Endpoint,
"slsWorkerType": "BATCH",
"networkVolume": NetworkVolume,
"savingsPlans": [SavingsPlan],
"clusterId": "xyz789",
"ipAddress": IPAddress,
"models": ["abc123"],
"flashEnvironmentId": "xyz789",
"tags": [Tag]
}
PodBidResumeInput
PodEditJobInput
Fields
| Input Field | Description |
|---|---|
podId - String!
|
|
dockerArgs - String
|
|
imageName - String
|
|
env - [EnvironmentVariableInput]
|
|
port - Port
|
|
ports - String
|
|
containerDiskInGb - Int
|
|
volumeInGb - Int
|
|
volumeMountPath - String
|
|
containerRegistryAuthId - String
|
|
volumeMountPatches - [PodVolumeMountPatchInput!]
|
Mounts to add, change or remove; mounts not named here are left as they are. Takes precedence over volumeMountPath when both name a network volume's path. A pod with a volume disk cannot mount a volume, and its volume disk cannot be removed. |
tags - [TagKeyValueInput!]
|
Example
{
"podId": "abc123",
"dockerArgs": "abc123",
"imageName": "xyz789",
"env": [EnvironmentVariableInput],
"port": 19758,
"ports": "abc123",
"containerDiskInGb": 123,
"volumeInGb": 123,
"volumeMountPath": "xyz789",
"containerRegistryAuthId": "abc123",
"volumeMountPatches": [PodVolumeMountPatchInput],
"tags": [TagKeyValueInput]
}
PodFilter
Fields
| Input Field | Description |
|---|---|
podId - String!
|
Example
{"podId": "abc123"}
PodFindAndDeployOnDemandInput
Fields
| Input Field | Description |
|---|---|
aiApiId - String
|
|
cloudType - CloudTypeEnum
|
|
containerDiskInGb - Int
|
|
containerRegistryAuthId - String
|
|
countryCode - String
|
|
deployCost - Float
|
|
dockerArgs - String
|
|
env - [EnvironmentVariableInput]
|
|
gpuCount - Int
|
|
gpuTypeId - String
|
|
gpuTypeIdList - [String]
|
List of a comma separated GPU ids, where each list item is priority group of GPUs |
imageName - String
|
|
minDisk - Int
|
|
minDownload - Int
|
|
minMemoryInGb - Int
|
|
minUpload - Int
|
|
minVcpuCount - Int
|
|
name - String
|
|
networkVolumeId - String
|
|
port - Port
|
|
ports - String
|
|
startJupyter - Boolean
|
|
startSsh - Boolean
|
|
stopAfter - DateTime
|
|
supportPublicIp - Boolean
|
|
templateId - String
|
|
terminateAfter - DateTime
|
|
volumeInGb - Int
|
|
volumeKey - String
|
|
volumeMountPath - String
|
|
dataCenterIds - [String!]
|
|
savingsPlan - SavingsPlanInput
|
|
cudaVersion - String
|
|
allowedCudaVersions - [String]
|
|
minCudaVersion - String
|
|
instanceIds - [String]
|
|
computeType - ComputeType
|
|
globalNetwork - Boolean
|
|
ideAiApiId - String
|
|
modelReferences - [String]
|
|
compliance - [Compliance]
|
|
slsWorkerType - SlsWorkerType
|
|
supplyScope - SupplyScope
|
|
poolPlacement - PoolPlacement
|
|
globalStoreBucketMount - GlobalStoreBucketMountInput
|
|
volumeMounts - [PodVolumeMountInput!]
|
|
tags - [TagKeyValueInput!]
|
Example
{
"aiApiId": "abc123",
"cloudType": "SECURE",
"containerDiskInGb": 987,
"containerRegistryAuthId": "abc123",
"countryCode": "abc123",
"deployCost": 987.65,
"dockerArgs": "xyz789",
"env": [EnvironmentVariableInput],
"gpuCount": 987,
"gpuTypeId": "abc123",
"gpuTypeIdList": ["xyz789"],
"imageName": "abc123",
"minDisk": 123,
"minDownload": 987,
"minMemoryInGb": 987,
"minUpload": 987,
"minVcpuCount": 987,
"name": "abc123",
"networkVolumeId": "xyz789",
"port": 19758,
"ports": "xyz789",
"startJupyter": true,
"startSsh": true,
"stopAfter": "2007-12-03T10:15:30Z",
"supportPublicIp": false,
"templateId": "abc123",
"terminateAfter": "2007-12-03T10:15:30Z",
"volumeInGb": 987,
"volumeKey": "abc123",
"volumeMountPath": "abc123",
"dataCenterIds": ["xyz789"],
"savingsPlan": SavingsPlanInput,
"cudaVersion": "xyz789",
"allowedCudaVersions": ["xyz789"],
"minCudaVersion": "abc123",
"instanceIds": ["xyz789"],
"computeType": "CPU",
"globalNetwork": true,
"ideAiApiId": "xyz789",
"modelReferences": ["abc123"],
"compliance": ["GDPR"],
"slsWorkerType": "BATCH",
"supplyScope": "ORG_ONLY",
"poolPlacement": "AUTO_BURST",
"globalStoreBucketMount": GlobalStoreBucketMountInput,
"volumeMounts": [PodVolumeMountInput],
"tags": [TagKeyValueInput]
}
PodMachineInfo
Fields
| Field Name | Description |
|---|---|
id - String
|
|
poolId - String
|
|
poolState - MachinePoolState
|
|
costPerHr - Float
|
|
currentPricePerGpu - Float
|
|
diskMBps - Int
|
|
gpuAvailable - Int
|
|
gpuDisplayName - String
|
|
gpuTypeId - String
|
|
gpuType - GpuType
|
|
listed - Boolean
|
|
location - String
|
|
machineType - String
|
|
maintenanceEnd - DateTime
|
|
maintenanceNote - String
|
|
maintenanceStart - DateTime
|
|
maxDownloadSpeedMbps - Int
|
|
maxUploadSpeedMbps - Int
|
|
note - String
|
|
podHostId - String
|
|
runpodIp - String
|
|
secureCloud - Boolean
|
|
supportPublicIp - Boolean
|
|
minPodGpuCount - Int
|
|
machineSystem - MachineSystem
|
|
dataCenterId - String
|
|
cpuTypeId - String
|
|
cpuType - CpuType
|
|
cpuCount - Int
|
|
vcpuTotal - Int
|
|
vcpuReserved - Float
|
|
memoryTotal - Int
|
|
memoryReserved - Float
|
|
globalNetwork - Boolean
|
|
organizationId - String
|
Example
{
"id": "abc123",
"poolId": "xyz789",
"poolState": "GENERALLY_AVAILABLE",
"costPerHr": 123.45,
"currentPricePerGpu": 123.45,
"diskMBps": 123,
"gpuAvailable": 987,
"gpuDisplayName": "xyz789",
"gpuTypeId": "xyz789",
"gpuType": GpuType,
"listed": false,
"location": "xyz789",
"machineType": "xyz789",
"maintenanceEnd": "2007-12-03T10:15:30Z",
"maintenanceNote": "abc123",
"maintenanceStart": "2007-12-03T10:15:30Z",
"maxDownloadSpeedMbps": 987,
"maxUploadSpeedMbps": 987,
"note": "abc123",
"podHostId": "abc123",
"runpodIp": "xyz789",
"secureCloud": false,
"supportPublicIp": false,
"minPodGpuCount": 123,
"machineSystem": MachineSystem,
"dataCenterId": "xyz789",
"cpuTypeId": "abc123",
"cpuType": CpuType,
"cpuCount": 123,
"vcpuTotal": 123,
"vcpuReserved": 123.45,
"memoryTotal": 123,
"memoryReserved": 123.45,
"globalNetwork": true,
"organizationId": "abc123"
}
PodMigration
Example
{
"id": "abc123",
"sourcePodId": "abc123",
"targetPodId": "abc123",
"sourceMachineId": "xyz789",
"targetMachineId": "abc123",
"migrationType": "xyz789",
"sourceMount": "xyz789",
"status": "PENDING",
"progress": 987,
"message": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
PodMigrationStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"PENDING"
PodObjectStore
Description
One FUSE mount a pod runs: the S3 bucket and the access details the host hands to GeeseFS. Visible to the pod owner and the host daemon. secretAccessKey is decrypted for the host daemon only; null for the owner and when decryption fails.
Fields
| Field Name | Description |
|---|---|
objectStoreId - ID!
|
|
ownership - ObjectStoreOwnership!
|
|
endpointUrl - String!
|
|
bucketName - String!
|
|
accessKeyId - String!
|
|
secretAccessKey - String
|
|
prefix - String!
|
|
region - String
|
|
mountPath - String!
|
|
readOnly - Boolean!
|
|
mounts - [PodObjectStoreMount!]!
|
Always empty. Read mountPath and readOnly on this type. |
Example
{
"objectStoreId": "4",
"ownership": "MANAGED",
"endpointUrl": "abc123",
"bucketName": "abc123",
"accessKeyId": "xyz789",
"secretAccessKey": "abc123",
"prefix": "xyz789",
"region": "abc123",
"mountPath": "xyz789",
"readOnly": true,
"mounts": [PodObjectStoreMount]
}
PodObjectStoreMount
PodRegistry
PodRentInterruptableInput
Fields
| Input Field | Description |
|---|---|
bidPerGpu - Float
|
|
cloudType - CloudTypeEnum
|
|
containerDiskInGb - Int
|
|
containerRegistryAuthId - String
|
|
countryCode - String
|
|
dockerArgs - String
|
|
env - [EnvironmentVariableInput]
|
|
gpuCount - Int
|
|
gpuTypeId - String
|
|
imageName - String
|
|
minDisk - Int
|
|
minDownload - Int
|
|
minMemoryInGb - Int
|
|
minUpload - Int
|
|
minVcpuCount - Int
|
|
name - String
|
|
networkVolumeId - String
|
|
port - Port
|
|
ports - String
|
|
startJupyter - Boolean
|
|
startSsh - Boolean
|
|
stopAfter - String
|
|
supportPublicIp - Boolean
|
|
templateId - String
|
|
terminateAfter - String
|
|
volumeInGb - Int
|
|
volumeKey - String
|
|
volumeMountPath - String
|
|
dataCenterIds - [String!]
|
|
cudaVersion - String
|
|
allowedCudaVersions - [String]
|
|
minCudaVersion - String
|
|
compliance - [Compliance]
|
|
tags - [TagKeyValueInput!]
|
Example
{
"bidPerGpu": 987.65,
"cloudType": "SECURE",
"containerDiskInGb": 987,
"containerRegistryAuthId": "xyz789",
"countryCode": "xyz789",
"dockerArgs": "abc123",
"env": [EnvironmentVariableInput],
"gpuCount": 123,
"gpuTypeId": "abc123",
"imageName": "abc123",
"minDisk": 123,
"minDownload": 987,
"minMemoryInGb": 987,
"minUpload": 123,
"minVcpuCount": 987,
"name": "abc123",
"networkVolumeId": "xyz789",
"port": 19758,
"ports": "abc123",
"startJupyter": false,
"startSsh": false,
"stopAfter": "abc123",
"supportPublicIp": false,
"templateId": "xyz789",
"terminateAfter": "xyz789",
"volumeInGb": 123,
"volumeKey": "abc123",
"volumeMountPath": "xyz789",
"dataCenterIds": ["abc123"],
"cudaVersion": "abc123",
"allowedCudaVersions": ["abc123"],
"minCudaVersion": "abc123",
"compliance": ["GDPR"],
"tags": [TagKeyValueInput]
}
PodResumeInput
Fields
| Input Field | Description |
|---|---|
podId - String!
|
|
gpuCount - Int
|
|
syncMachine - Boolean
|
|
computeType - ComputeType
|
Example
{
"podId": "abc123",
"gpuCount": 987,
"syncMachine": true,
"computeType": "CPU"
}
PodRuntime
Fields
| Field Name | Description |
|---|---|
container - PodRuntimeContainer
|
|
gpus - [PodRuntimeGpus]
|
|
ports - [PodRuntimePorts]
|
|
uptimeInSeconds - Int
|
Example
{
"container": PodRuntimeContainer,
"gpus": [PodRuntimeGpus],
"ports": [PodRuntimePorts],
"uptimeInSeconds": 987
}
PodRuntimeContainer
PodRuntimeGpus
PodRuntimePorts
PodSandbox
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
egressPolicy - SandboxEgressPolicy!
|
Example
{"id": 4, "egressPolicy": SandboxEgressPolicy}
PodStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CREATED"
PodStopInput
Fields
| Input Field | Description |
|---|---|
podId - String!
|
|
incrementVersion - Boolean
|
|
stopReason - PodStopReason
|
|
stopReasonMessage - String
|
|
expectedAiApiId - String
|
Example
{
"podId": "abc123",
"incrementVersion": false,
"stopReason": "IMAGE_AUTH_ERROR",
"stopReasonMessage": "abc123",
"expectedAiApiId": "xyz789"
}
PodStopReason
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"IMAGE_AUTH_ERROR"
PodTelemetry
Fields
| Field Name | Description |
|---|---|
state - String
|
|
time - DateTime
|
|
cpuUtilization - Float
|
|
memoryUtilization - Float
|
|
averageGpuMetrics - GpuTelemetry
|
|
individualGpuMetrics - [GpuTelemetry]
|
|
lastStateTransitionTimestamp - Int
|
Example
{
"state": "xyz789",
"time": "2007-12-03T10:15:30Z",
"cpuUtilization": 123.45,
"memoryUtilization": 987.65,
"averageGpuMetrics": GpuTelemetry,
"individualGpuMetrics": [GpuTelemetry],
"lastStateTransitionTimestamp": 987
}
PodTemplate
Fields
| Field Name | Description |
|---|---|
advancedStart - Boolean
|
|
containerDiskInGb - Int
|
|
containerRegistryAuthId - String
|
|
dockerArgs - String
|
|
earned - Float
|
|
env - [EnvironmentVariable]
|
|
id - String
|
|
imageName - String
|
|
isPublic - Boolean
|
|
isRunpod - Boolean
|
|
isVerified - Boolean
|
|
isSandbox - Boolean
|
Whether the template can back a Runpod Sandbox. Set by Runpod only — saveTemplate ignores it; the admin template mutations own it. |
isServerless - Boolean
|
|
boundEndpointId - String
|
|
name - String
|
|
ports - String
|
|
portsConfig - [PortConfig]
|
|
readme - String
|
|
runtimeInMin - Int
|
|
startJupyter - Boolean
|
|
startScript - String
|
|
startSsh - Boolean
|
|
volumeInGb - Int
|
|
volumeMountPath - String
|
|
config - JSON
|
|
category - String
|
|
userId - String
|
|
createdByUser - ResourceUser
|
Who created the template; null unless the caller owns it (personally or org-wide). Templates created in a team, including ones later moved into an organization, report the team owner instead of the member who created them. |
presentationOrder - Int
|
|
deployerStats - DeployerStats
|
|
recommendedGPUIds - [String]
|
|
incompatibleGPUIds - [String]
|
|
compatibleGPUIds - [String]
|
|
minVram - Int
|
|
minRam - Int
|
|
allowedCudaVersions - [String]
|
|
networkVolumeIds - [String!]
|
|
groupId - String
|
|
templateVersionId - String
|
The release this template carries, when it is a version tag. A tagged template is reached through its versioned template, so the template lists leave it out. |
releaseType - TemplateReleaseType
|
This tag's standing within its release. Null unless the template is a version tag; several tags of one release may share a value. |
createdAt - DateTime
|
|
updatedAt - DateTime
|
|
lastEditedAt - DateTime
|
When the template's content was last edited. Unlike updatedAt, not bumped by deploy counters or stats refreshes. Falls back to createdAt for templates never edited since this field was introduced. |
health - HubHealth
|
Nullable like the rest of PodTemplate's fields, though the resolver always returns one. Read null as UNVERIFIED. |
Example
{
"advancedStart": false,
"containerDiskInGb": 987,
"containerRegistryAuthId": "xyz789",
"dockerArgs": "abc123",
"earned": 987.65,
"env": [EnvironmentVariable],
"id": "abc123",
"imageName": "xyz789",
"isPublic": false,
"isRunpod": false,
"isVerified": false,
"isSandbox": true,
"isServerless": true,
"boundEndpointId": "abc123",
"name": "abc123",
"ports": "abc123",
"portsConfig": [PortConfig],
"readme": "xyz789",
"runtimeInMin": 123,
"startJupyter": true,
"startScript": "xyz789",
"startSsh": false,
"volumeInGb": 987,
"volumeMountPath": "abc123",
"config": {},
"category": "xyz789",
"userId": "abc123",
"createdByUser": ResourceUser,
"presentationOrder": 987,
"deployerStats": DeployerStats,
"recommendedGPUIds": ["xyz789"],
"incompatibleGPUIds": ["abc123"],
"compatibleGPUIds": ["abc123"],
"minVram": 123,
"minRam": 123,
"allowedCudaVersions": ["xyz789"],
"networkVolumeIds": ["xyz789"],
"groupId": "xyz789",
"templateVersionId": "xyz789",
"releaseType": "CURRENT",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"lastEditedAt": "2007-12-03T10:15:30Z",
"health": HubHealth
}
PodTerminateInput
Fields
| Input Field | Description |
|---|---|
podId - String!
|
Example
{"podId": "xyz789"}
PodType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"INTERRUPTABLE"
PodVolume
Description
A volume a pod can mount. NetworkVolume for NETWORK_VOLUME, PodObjectStore for OBJECT_STORE_VOLUME.
Types
| Union Types |
|---|
Example
NetworkVolume
PodVolumeMount
Description
One persistent volume mounted into a pod.
A mount whose volume no longer exists is omitted from Pod.volumeMounts rather than returned with a null volume, so every entry describes storage the pod can use.
Fields
| Field Name | Description |
|---|---|
volumeId - ID!
|
NetworkVolume.id or ObjectStore.id, per volumeType. |
volumeType - PodVolumeType!
|
|
mountPath - String!
|
Absolute path the volume is mounted at inside the container. |
readOnly - Boolean!
|
|
volume - PodVolume!
|
Example
{
"volumeId": "4",
"volumeType": "NETWORK_VOLUME",
"mountPath": "xyz789",
"readOnly": true,
"volume": NetworkVolume
}
PodVolumeMountInput
Description
One volume to mount into the pod.
Supersedes networkVolumeId and globalStoreBucketMount: when this is supplied those are ignored rather than merged with it. At most 4 NETWORK_VOLUME mounts, all in one data center, and 1 OBJECT_STORE_VOLUME mount.
Fields
| Input Field | Description |
|---|---|
volumeId - ID!
|
NetworkVolume.id for NETWORK_VOLUME, ObjectStore.id for OBJECT_STORE_VOLUME. |
volumeType - PodVolumeType!
|
|
mountPath - String
|
Absolute path like /workspace/data; repeated and trailing slashes are collapsed. Optional: NETWORK_VOLUME falls back to the template's volumeMountPath, then /workspace; OBJECT_STORE_VOLUME falls back to /workspace-global. |
readOnly - Boolean
|
Defaults to false — the mount is writable unless you ask for read-only. |
Example
{
"volumeId": 4,
"volumeType": "NETWORK_VOLUME",
"mountPath": "abc123",
"readOnly": true
}
PodVolumeMountPatchInput
Description
A change to one of the pod's mounts, matched on volumeId. A volume the pod already mounts is moved, changed or removed; any other volume is mounted, and needs volumeType. The same limits as PodVolumeMountInput apply to the result.
Fields
| Input Field | Description |
|---|---|
volumeId - ID!
|
NetworkVolume.id for NETWORK_VOLUME, ObjectStore.id for OBJECT_STORE_VOLUME. |
volumeType - PodVolumeType
|
Required to mount a volume the pod does not have yet; must match an existing mount's type. |
mountPath - String
|
Absolute path to mount at. Optional when adding: NETWORK_VOLUME falls back to the pod's volumeMountPath, then /workspace; OBJECT_STORE_VOLUME to /workspace-global. |
readOnly - Boolean
|
Defaults to false when adding; omit to keep an existing mount's value. |
remove - Boolean
|
Unmount the volume. Cannot be combined with mountPath or readOnly. |
Example
{
"volumeId": "4",
"volumeType": "NETWORK_VOLUME",
"mountPath": "abc123",
"readOnly": true,
"remove": true
}
PodVolumeType
Description
Which table a PodVolumeMount's volumeId refers to.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"NETWORK_VOLUME"
PodnetCluster
Fields
| Field Name | Description |
|---|---|
id - String
|
|
name - String
|
|
description - String
|
|
PodnetNodes - [PodnetNode]
|
|
NetworkRanges - [NetworkRange]
|
Example
{
"id": "abc123",
"name": "abc123",
"description": "abc123",
"PodnetNodes": [PodnetNode],
"NetworkRanges": [NetworkRange]
}
PodnetNode
Fields
| Field Name | Description |
|---|---|
id - String
|
|
podnetClusterId - String
|
|
podnetCluster - PodnetCluster
|
|
publicIp - String
|
|
nebulaIp - String
|
Example
{
"id": "abc123",
"podnetClusterId": "abc123",
"podnetCluster": PodnetCluster,
"publicIp": "abc123",
"nebulaIp": "abc123"
}
PodsConnection
Fields
| Field Name | Description |
|---|---|
edges - [Pod]
|
List of pods that match the query. |
pageInfo - PodsPageInfo
|
Pagination information for navigating through results. |
Example
{
"edges": [Pod],
"pageInfo": PodsPageInfo
}
PodsConnectionInput
Fields
| Input Field | Description |
|---|---|
cursor - String
|
|
limit - Int
|
|
filter - PodsFilter
|
Example
{
"cursor": "abc123",
"limit": 123,
"filter": PodsFilter
}
PodsFilter
Fields
| Input Field | Description |
|---|---|
status - [PodStatus]
|
|
name - String
|
|
createdByUserIds - [String!]
|
|
tags - [ResourceTagMatch!]
|
|
inCluster - Boolean
|
Cluster membership: false keeps only standalone pods, true only cluster members (pods with a clusterId). Omit for both. Applied in the query so the page is cut after the filter, not before. |
Example
{
"status": ["CREATED"],
"name": "abc123",
"createdByUserIds": ["xyz789"],
"tags": [ResourceTagMatch],
"inCluster": false
}
PodsPageInfo
Pool
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
name - String!
|
|
reservationId - String!
|
|
dataCenterId - String
|
|
createdAt - DateTime!
|
|
updatedAt - DateTime!
|
|
machines - [Machine!]!
|
|
targetDeliveryDate - DateTime
|
When the FDE responsible for the pool has committed to delivering its machines. |
fdeUserId - String
|
|
fdeUser - ResourceUser
|
|
reservation - Reservation!
|
|
dataCenter - DataCenter
|
|
capacity - PoolCapacity!
|
|
machineMemberships - [PoolMachineMembership!]!
|
|
machineEvents - [PoolMachineEvent!]!
|
|
machineActivity - PoolMachineActivity!
|
Example
{
"id": "4",
"name": "abc123",
"reservationId": "xyz789",
"dataCenterId": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"machines": [Machine],
"targetDeliveryDate": "2007-12-03T10:15:30Z",
"fdeUserId": "xyz789",
"fdeUser": ResourceUser,
"reservation": Reservation,
"dataCenter": DataCenter,
"capacity": PoolCapacity,
"machineMemberships": [PoolMachineMembership],
"machineEvents": [PoolMachineEvent],
"machineActivity": PoolMachineActivity
}
PoolCapacity
Example
{
"totalGpus": 987,
"availableGpus": 987,
"reservedGpus": 123,
"gpuMachineCount": 987,
"totalVcpus": 123,
"availableVcpus": 987,
"reservedVcpus": 123,
"cpuMachineCount": 987
}
PoolGpuTypeHours
PoolMachineActivity
Description
What the pool owes its reservation, over its whole machine history.
Fields
| Field Name | Description |
|---|---|
firstAddedAt - DateTime
|
Earliest recorded join across every machine the pool has ever held. |
firstStartedAt - DateTime
|
Earliest recorded start across every machine the pool has ever held. |
gpuHoursMissed - Float!
|
GPU hours the pool did not deliver: every spell a machine spent paused, weighted by that machine's GPUs. A machine paused right now accrues up to the moment of the read. |
gpuHoursDelivered - [PoolGpuTypeHours!]!
|
GPU hours the pool delivered, per GPU type: every spell a machine spent started and not paused, weighted by that machine's GPUs. A machine running right now accrues up to the moment of the read. Leaves out the time before a machine's first row when the log never recorded it joining — see machinesWithUnrecordedStart. |
machinesWithUnrecordedStart - Int!
|
GPU machines whose log does not open with their join — already in the pool when the log began, or past retention — so gpuHoursDelivered undercounts them by an unknown amount. |
gpuCount - Int!
|
GPUs across the machines the pool holds now — the rate it makes missed hours back up at. |
Example
{
"firstAddedAt": "2007-12-03T10:15:30Z",
"firstStartedAt": "2007-12-03T10:15:30Z",
"gpuHoursMissed": 123.45,
"gpuHoursDelivered": [PoolGpuTypeHours],
"machinesWithUnrecordedStart": 987,
"gpuCount": 987
}
PoolMachineEvent
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
machineId - String!
|
|
machineName - String
|
Name of the machine the row belongs to, still resolved after the pool lets the machine go. Null only for a machine record that no longer exists at all. |
gpuCount - Int
|
GPUs on that machine, the weight its stopped spells are missed hours at. Null on the same terms as machineName. |
type - PoolMachineEventType!
|
|
effectiveAt - DateTime!
|
When the change took effect — the operator-supplied date when one was given, otherwise when the row was written. |
createdAt - DateTime!
|
|
startsMachine - Boolean!
|
The row the machine's time counts from: a STARTED row, or a join recorded before machines joined stopped, which was running from the moment it joined. |
notBefore - PoolMachineEventBound
|
The rows either side of this one in the order they were recorded. effectiveAt has to stay between them, so the log still reads as a sequence of changes that could have happened. |
notAfter - PoolMachineEventBound
|
Example
{
"id": 4,
"machineId": "xyz789",
"machineName": "abc123",
"gpuCount": 123,
"type": "ADDED_TO_POOL",
"effectiveAt": "2007-12-03T10:15:30Z",
"createdAt": "2007-12-03T10:15:30Z",
"startsMachine": true,
"notBefore": PoolMachineEventBound,
"notAfter": PoolMachineEventBound
}
PoolMachineEventBound
Description
A neighbouring change that pins how far a row's date can move.
Fields
| Field Name | Description |
|---|---|
at - DateTime!
|
|
type - PoolMachineEventType!
|
Example
{
"at": "2007-12-03T10:15:30Z",
"type": "ADDED_TO_POOL"
}
PoolMachineEventType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ADDED_TO_POOL"
PoolMachineMembership
Fields
| Field Name | Description |
|---|---|
machineId - String!
|
|
addedEventId - String
|
The ADDED_TO_POOL row the current membership started from. |
addedAt - DateTime
|
When the machine's current pool membership started — the operator-supplied date when one was given, otherwise when the change was recorded. |
started - Boolean!
|
False while the machine waits for its first play; its time only counts from the start. |
startedEventId - String
|
The row the current membership started counting from: its STARTED row, or for a join recorded before machines joined stopped, the ADDED_TO_POOL row itself. |
startedAt - DateTime
|
|
paused - Boolean!
|
|
lastEventAt - DateTime
|
Latest change recorded for the current membership, counting the join itself. A dated pause or resume cannot land before it without reordering the log. |
lastEventType - PoolMachineEventType
|
Example
{
"machineId": "abc123",
"addedEventId": "abc123",
"addedAt": "2007-12-03T10:15:30Z",
"started": true,
"startedEventId": "xyz789",
"startedAt": "2007-12-03T10:15:30Z",
"paused": true,
"lastEventAt": "2007-12-03T10:15:30Z",
"lastEventType": "ADDED_TO_POOL"
}
PoolPlacement
Description
Where a deploy is allowed to place a pod relative to the caller's private pool. AUTO_BURST (default) prefers the private pool then bursts to on-demand supply; POOL_ONLY restricts to the private pool and fails if it can't be satisfied.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"AUTO_BURST"
Port
Description
A field whose value is a valid TCP port within the range of 0 to 65535: https://en.wikipedia.org/wiki/Transmission_Control_Protocol#TCP_ports
Example
19758
PortConfig
RdmaType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"INFINIBAND"
ReliabilityTier
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"VERIFIED"
Repo
Example
{
"repoName": "xyz789",
"repoId": "xyz789",
"branch": "abc123",
"dockerFilePath": "xyz789",
"buildContext": "abc123",
"dockerArgs": "xyz789",
"containerRegistryAuthId": "abc123"
}
Reservation
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
name - String
|
|
contractId - String
|
|
organizationId - String
|
|
billingUserId - String
|
Payer for reservation billing (the hourly idle-capacity charge). Unset = the reservation is never billed by the reservationBilling worker. |
startDate - DateTime!
|
|
endDate - DateTime
|
|
createdAt - DateTime!
|
|
updatedAt - DateTime!
|
|
resources - [ReservationResource]
|
Resources reserved by this reservation |
pool - Pool
|
Pool where this reservation's resources are allocated |
userReservations - [UserReservation]
|
Users associated with this reservation |
isActive - Boolean
|
Whether the current date is within the reservation period |
Example
{
"id": 4,
"name": "abc123",
"contractId": "abc123",
"organizationId": "abc123",
"billingUserId": "xyz789",
"startDate": "2007-12-03T10:15:30Z",
"endDate": "2007-12-03T10:15:30Z",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"resources": [ReservationResource],
"pool": Pool,
"userReservations": [UserReservation],
"isActive": false
}
ReservationResource
Example
{
"id": 4,
"reservationId": "xyz789",
"resourceType": "GPU",
"resourceId": "xyz789",
"costPerHr": 987.65,
"quota": 987,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"gpuType": GpuType,
"cpuFlavor": CpuFlavor
}
ResourceTag
Example
{
"id": 4,
"tagId": "abc123",
"tag": Tag,
"resourceType": "POD",
"resourceId": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"deletedAt": "2007-12-03T10:15:30Z"
}
ResourceTagMatch
Description
One tag constraint for filtering a resource list: a key plus optional values. Omit or leave values empty to match any value for the key (key-exists). Callers pass a list, AND-matched across entries; values within a single entry are OR-matched.
Example
{
"key": "xyz789",
"values": ["xyz789"]
}
ResourceType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"GPU"
ResourceUser
Result
Sandbox
Fields
| Field Name | Description |
|---|---|
id - String!
|
|
userId - String
|
|
organizationId - String
|
|
name - String!
|
|
state - SandboxState!
|
|
templateId - String
|
|
cpuFlavorId - String
|
|
imageName - String
|
The image the pod runs, a template's included. |
dataCenterId - String
|
|
env - [EnvironmentVariable!]
|
As Pod.envKeyValue: secret references unresolved. Null without pod read access. |
containerRegistryAuthId - String
|
|
startedAt - DateTime
|
When the container came up, to the second. Null until it is running. |
runtime - PodRuntime
|
|
ssh - SandboxSsh
|
|
terminationReason - String
|
|
egressPolicy - SandboxEgressPolicy!
|
|
ports - [SandboxPort!]
|
Null when the backing pod could not be read; [] when the sandbox exposes no ports. |
idleTimeoutSeconds - Int!
|
Seconds without exec or log streaming (port traffic does not count) before the sandbox is terminated as IDLE_TIMEOUT. It ends at whichever of idleExpiresAt and expiresAt is first. |
maxLifetimeSeconds - Int!
|
|
lastActivityAt - DateTime!
|
|
idleExpiresAt - DateTime!
|
|
expiresAt - DateTime!
|
|
labels - JSON
|
|
createdAt - DateTime!
|
|
updatedAt - DateTime!
|
|
terminatedAt - DateTime
|
|
pod - Pod
|
Example
{
"id": "abc123",
"userId": "abc123",
"organizationId": "xyz789",
"name": "xyz789",
"state": "CREATING",
"templateId": "xyz789",
"cpuFlavorId": "abc123",
"imageName": "abc123",
"dataCenterId": "abc123",
"env": [EnvironmentVariable],
"containerRegistryAuthId": "xyz789",
"startedAt": "2007-12-03T10:15:30Z",
"runtime": PodRuntime,
"ssh": SandboxSsh,
"terminationReason": "xyz789",
"egressPolicy": SandboxEgressPolicy,
"ports": [SandboxPort],
"idleTimeoutSeconds": 987,
"maxLifetimeSeconds": 987,
"lastActivityAt": "2007-12-03T10:15:30Z",
"idleExpiresAt": "2007-12-03T10:15:30Z",
"expiresAt": "2007-12-03T10:15:30Z",
"labels": {},
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"terminatedAt": "2007-12-03T10:15:30Z",
"pod": Pod
}
SandboxEgressMode
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"DENY_ALL"
SandboxEgressPolicy
Description
A sandbox's outbound network policy. Enforcement contract for the host: entries in allow match the exact hostname only, with no implicit subdomains (github.com does not allow api.github.com). Regardless of mode or allow, the host must also block loopback, private (RFC 1918 and IPv6 ULA), link-local, and cloud metadata destinations, checked on the resolved IP addresses rather than the hostname, so an allowed name that resolves inward is still refused.
Fields
| Field Name | Description |
|---|---|
mode - SandboxEgressMode!
|
|
allow - [String!]!
|
Hostnames reachable when mode is ALLOW_LIST; empty otherwise. Each entry matches that exact hostname only, not its subdomains. |
Example
{"mode": "DENY_ALL", "allow": ["abc123"]}
SandboxPort
Fields
| Field Name | Description |
|---|---|
port - Int!
|
The container port, as requested on create. |
protocol - SandboxPortProtocol!
|
|
url - String
|
HTTP only: URL that proxies to the port. Opaque: callers must not parse it or depend on its structure, as the hostname may change. |
ip - String
|
TCP and UDP only: the public IP and port. Null until the host has mapped it. |
publicPort - Int
|
Example
{
"port": 987,
"protocol": "HTTP",
"url": "xyz789",
"ip": "xyz789",
"publicPort": 123
}
SandboxPortProtocol
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"HTTP"
SandboxSsh
Description
SSH endpoints, as REST /v2/pods reports them. The image must run sshd; see startSsh.
Fields
| Field Name | Description |
|---|---|
proxy - SandboxSshEndpoint
|
Through the SSH proxy. |
direct - SandboxSshEndpoint
|
To the public mapping of 22/tcp, when ports include it. |
Example
{
"proxy": SandboxSshEndpoint,
"direct": SandboxSshEndpoint
}
SandboxSshEndpoint
SandboxState
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"CREATING"
SandboxesFilter
Fields
| Input Field | Description |
|---|---|
state - SandboxState
|
|
labels - [LabelEqualityInput!]
|
Example
{"state": "CREATING", "labels": [LabelEqualityInput]}
SaveRegistryAuthInput
SavingsPlan
Fields
| Field Name | Description |
|---|---|
id - ID
|
|
endTime - DateTime
|
|
startTime - DateTime
|
|
gpuType - GpuType
|
|
podId - String
|
|
gpuTypeId - String
|
|
pod - Pod
|
|
savingsPlanType - String
|
|
costPerHr - Float
|
|
upfrontCost - Float
|
|
planLength - String
|
|
createdByUserId - String
|
|
source - SavingsPlanSource
|
|
createdAt - DateTime
|
|
dealId - String
|
Example
{
"id": "4",
"endTime": "2007-12-03T10:15:30Z",
"startTime": "2007-12-03T10:15:30Z",
"gpuType": GpuType,
"podId": "xyz789",
"gpuTypeId": "abc123",
"pod": Pod,
"savingsPlanType": "xyz789",
"costPerHr": 123.45,
"upfrontCost": 987.65,
"planLength": "abc123",
"createdByUserId": "xyz789",
"source": "SELF_SERVICE",
"createdAt": "2007-12-03T10:15:30Z",
"dealId": "xyz789"
}
SavingsPlanInput
SavingsPlanSource
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"SELF_SERVICE"
Scope
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"TEAM_ADMIN"
SeatUsage
Description
A team's seats against its owner's plan. Seats are a hard cap, never a charge: an over-cap team keeps every member and can add none until the plan grows. current, max and remainingCapacity describe the plan's cap whether or not it is enforced; canAddSeats and overCap describe the cap the invite gate enforces, which is lifted — canAddSeats true, overCap false — while the plan is unlimited or seat enforcement is paused. A grandfathered team is measured against its fitted plan's cap from the first day of its window.
Fields
| Field Name | Description |
|---|---|
current - Int!
|
Members plus pending (unexpired) invites — exactly what the invite gate counts. |
max - Int
|
The plan's seat cap; null is unlimited. |
remainingCapacity - Int
|
max minus current, floored at zero; null when unlimited. Zero at the cap as well as past it — read canAddSeats for the gate's answer. |
canAddSeats - Boolean!
|
Whether the invite gate would admit one more seat right now. False from the cap on: a full team cannot add, and neither can an over-cap one. |
overCap - Boolean!
|
Whether current exceeds the enforced cap — the state a downgrade, or a grandfather fit smaller than the team, leaves it in: the members stay but none can be added. False at the cap: a full team is not over it. |
Example
{
"current": 987,
"max": 123,
"remainingCapacity": 123,
"canAddSeats": false,
"overCap": false
}
Secret
Example
{
"id": "4",
"name": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"description": "abc123",
"lastRetrievedAt": "2007-12-03T10:15:30Z",
"lastUpdatedAt": "2007-12-03T10:15:30Z"
}
SlsWorkerType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"BATCH"
Specifics
SpecificsInput
SpendDetails
SshPublicKey
StorageClusterAssignmentStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ASSIGNED"
StorageClusterEviction
Fields
| Field Name | Description |
|---|---|
assignmentId - ID!
|
|
mountPath - String!
|
|
blobsToDelete - [EvictionBlob!]!
|
Example
{
"assignmentId": "4",
"mountPath": "abc123",
"blobsToDelete": [EvictionBlob]
}
StorageClusterInfo
Fields
| Field Name | Description |
|---|---|
id - String
|
|
connectionDetails - JSON
|
|
isPrimary - Boolean
|
|
type - String
|
|
mountPath - String
|
|
status - StorageClusterStatus
|
|
storageType - StorageType
|
|
isNextGenStorage - Boolean
|
Example
{
"id": "abc123",
"connectionDetails": {},
"isPrimary": true,
"type": "abc123",
"mountPath": "abc123",
"status": "PROVISIONING",
"storageType": "MOOSE_FS",
"isNextGenStorage": false
}
StorageClusterStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"PROVISIONING"
StorageType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"MOOSE_FS"
String
Description
The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
Example
"xyz789"
StripeReloadTransaction
Fields
| Field Name | Description |
|---|---|
id - String
|
|
mediumId - String
|
|
transactionCompletedAt - DateTime
|
|
receiptLink - String
|
|
amount - Float
|
|
medium - TransactionMedium
|
|
type - TransactionType
|
Example
{
"id": "xyz789",
"mediumId": "xyz789",
"transactionCompletedAt": "2007-12-03T10:15:30Z",
"receiptLink": "xyz789",
"amount": 123.45,
"medium": "STRIPE",
"type": "RELOAD"
}
SubscriptionPlan
Description
An immutable plan version with what it bills — the version an account is on, or one open for purchase. Prices are pinned to the version: repricing mints a new version and never edits a live one, so a subscriber keeps this price until they switch.
Fields
| Field Name | Description |
|---|---|
planId - String!
|
Family + version, e.g. PRO_V1 — the value AccountSubscription.planId stores. |
tier - SubscriptionTier!
|
|
sellsNow - Boolean!
|
Whether createSubscription / changeSubscription attach new subscribers to this version right now: its family's ACTIVE version, with the row self-serve. Not the row's own AdminPlanVersion.selfServe flag: false on a retired version however its row is flagged — its subscribers keep it, nobody new gets it — and on FREE and ENTERPRISE rows, which never sell. |
prices - [SubscriptionPlanPrice!]!
|
In PlanPriceInterval order (MONTH before YEAR); an interval without a PlanPrice row is absent. |
Example
{
"planId": "abc123",
"tier": "FREE",
"sellsNow": false,
"prices": [SubscriptionPlanPrice]
}
SubscriptionPlanPrice
Description
One price of a plan version — a PlanPrice row as the provisioner and the purchase paths read it.
Fields
| Field Name | Description |
|---|---|
interval - PlanPriceInterval!
|
|
unitAmount - Int!
|
Stripe unit_amount: the smallest unit of currency (cents for usd), so $50.00 is 5000. |
currency - String!
|
ISO 4217, lowercase as Stripe stores it (usd). |
purchasable - Boolean!
|
Whether createSubscription / changeSubscription would bill this price: the version sells now (SubscriptionPlan.sellsNow) and the provisioner has created its Stripe Price for the stage — the mutations refuse an unprovisioned price with SUBSCRIPTION_PLAN_UNAVAILABLE. A version no longer sold lists its prices with none purchasable, so a buyer sees exactly what the mutation would bill, or refuse. |
Example
{
"interval": "MONTH",
"unitAmount": 987,
"currency": "xyz789",
"purchasable": false
}
SubscriptionStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"INCOMPLETE"
SubscriptionTier
Description
Subscription tier families. Names are PLACEHOLDERS pending the V2 tier lock. PRO and BUSINESS are user-owned paid tiers bought through createSubscription/changeSubscription; ENTERPRISE is Organization-delivered (postpaid) and not self-serve subscribable.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"FREE"
SupplyScope
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ORG_ONLY"
SupportLevel
Description
Support tiers — PLACEHOLDER classes pending the V2 tier lock.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"COMMUNITY"
Tag
Example
{
"id": "4",
"userId": "abc123",
"key": "abc123",
"value": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"deletedAt": "2007-12-03T10:15:30Z",
"resourceTags": [ResourceTag]
}
TagKeyValueInput
TagResourceType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"POD"
Team
Fields
| Field Name | Description |
|---|---|
id - String
|
|
name - String
|
|
owner - TeamOwner!
|
|
memberships - [TeamMembership!]
|
|
membership - TeamMembership
|
|
members - [TeamMembership!]
|
|
invites - [TeamInvite]
|
|
isOwner - Boolean
|
|
availableRoles - [String]
|
|
subscription - AccountSubscription
|
The team's subscription — the owning account's row. Null when none exists, or when the caller may not read the owner's financial profile (same policy as User.subscription; passes for members in team context, denies personal-context and cross-team reads). |
seatUsage - SeatUsage
|
This team's seats against the owner's plan, resolved as the invite gate resolves them. Null under the same policy as subscription. |
Example
{
"id": "abc123",
"name": "xyz789",
"owner": TeamOwner,
"memberships": [TeamMembership],
"membership": TeamMembership,
"members": [TeamMembership],
"invites": [TeamInvite],
"isOwner": true,
"availableRoles": ["abc123"],
"subscription": AccountSubscription,
"seatUsage": SeatUsage
}
TeamInvite
TeamInviteOwner
Fields
| Field Name | Description |
|---|---|
email - String
|
Example
{"email": "xyz789"}
TeamInviteTeam
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
name - String
|
|
owner - TeamInviteOwner
|
Example
{
"id": "4",
"name": "abc123",
"owner": TeamInviteOwner
}
TeamMembership
TeamOwner
TeamRole
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"owner"
TeamScopes
Fields
| Field Name | Description |
|---|---|
role - String
|
Example
{"role": "abc123"}
TemplateReleaseType
Description
A template's release channel. At most one version of a versioned template holds each value; a version with none is untagged and coexists freely with the tagged ones.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Tags only. A version gives up its channel through deprecation rather than holding this value, because its channel column admits one holder per type. |
Example
"CURRENT"
Test
Example
{
"id": "abc123",
"status": "xyz789",
"startedAt": "2007-12-03T10:15:30Z",
"completedAt": "2007-12-03T10:15:30Z",
"githubBuildId": "abc123",
"error": "xyz789",
"results": [Result]
}
TransactionMedium
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"STRIPE"
TransactionType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Subscription fee mirror (CON-534/471) — a card charge, not a wallet movement. |
Example
"RELOAD"
User
Fields
| Field Name | Description |
|---|---|
pods - [Pod]
|
User's pods, optionally filtered to those created by specific users (e.g. an organization's "Created By" filter) and/or by tags (AND-matched — a pod must carry every listed tag; values within an entry are OR-ed). |
Arguments
|
|
backgroundPods - [Pod]
|
Background pods generated from user's machines with idle GPUs. |
podsConnection - PodsConnection
|
DEPRECATED: use Query.podsConnection instead, which returns the uniform PaginationResponse envelope. Paginated connection for user's pods with filtering and cursor-based pagination. Cursors are opaque tokens — pass pageInfo.endCursor back verbatim; a malformed cursor or an out-of-range limit (default 50, max 1000) is rejected with INVALID_INPUT. Retained for wire compatibility; not marked with the @deprecated directive because deprecated members are hidden from introspection by default. |
Arguments
|
|
machines - [Machine]
|
|
Arguments
|
|
hiddenMachines - [Machine]
|
|
machinesSummary - [MachineSummary]
|
|
id - String
|
|
createdAt - DateTime
|
|
updatedAt - DateTime
|
|
authId - String
|
|
email - String
|
|
containerRegistryCreds - [ContainerRegistryAuth]
|
|
currentSpendPerHr - Float
|
|
machineQuota - Int
|
|
referralEarned - Float
|
|
signedTermsOfService - Boolean
|
|
spendLimit - Int
|
|
stripeSavedPaymentId - String
|
|
stripeSavedPaymentLast4 - String
|
|
templateEarned - Float
|
|
multiFactorEnabled - Boolean
|
|
machineEarnings - [MachineEarning]
|
|
machineEarningsCustomRange - [MachineEarning]
|
|
Arguments
|
|
networkStorageEarnings - [NetworkStorageEarning]
|
|
Arguments
|
|
underBalance - Boolean
|
|
billingMode - BillingMode
|
|
minBalance - Float
|
|
stripeAutoReloadAmount - Int
|
|
stripeAutoPaymentThreshold - Int
|
|
spendDetails - SpendDetails
|
|
maxServerlessConcurrency - Int
|
|
clientLifetimeSpend - Float
|
|
referralId - String
|
|
datacenters - [DataCenter]
|
|
githubAccountInfo - GithubAccountInfo
|
|
discordAccountInfo - DiscordAccountInfo
|
|
isAutoPayEnabled - Boolean
|
|
enableBackupPayments - Boolean
|
|
onboardingInfo - OnboardingInfo
|
|
affiliateKey - String
|
|
hasActivated - Boolean
|
|
hasLoadedCredits - Boolean
|
|
referralUsageId - String
|
|
referralEmailUsageCount - Int
|
|
activeMigrations - [PodMigration]
|
|
poolMemberships - [String]
|
|
notifyCcList - String
|
|
orgCapabilities - [String!]
|
|
userPreferences - [UserPreference!]!
|
|
clientBalance - Float
|
|
hostBalance - Float
|
|
hostStripeLinked - Boolean
|
|
stripeAccountId - String
|
|
stripeReloadHistory - [StripeReloadTransaction]
|
|
payoutHistory - [PayoutHistory]
|
|
dailyCharges - [ClientCreditCharge]!
|
|
referral - UserReferral!
|
|
pubKey - String
|
|
sshPublicKeys - [SshPublicKey!]!
|
|
information - UserInformation
|
|
notifyPodsStale - Boolean
|
|
notifyPodsGeneral - Boolean
|
|
notifyLowBalance - Boolean
|
|
creditAlertThreshold - Float
|
|
notifyOther - Boolean
|
|
podTemplates - [PodTemplate]
|
DEPRECATED: use Query.templatesConnection instead, whose default scope pages the caller's own templates without mixing in the official set. Returns the caller's templates plus every official template, unpaged. Retained for wire compatibility; not marked with the @deprecated directive because deprecated members are hidden from introspection by default. |
creditCodes - [CreditCode]
|
|
endpoint - Endpoint
|
|
Arguments
|
|
endpoints - [Endpoint]!
|
DEPRECATED: use Query.endpointsConnection instead, which pages the full list. Returns at most the 400 oldest endpoints, oldest first. Retained for wire compatibility; not marked with the @deprecated directive because deprecated members are hidden from introspection by default. |
Arguments
|
|
networkVolumes - [NetworkVolume]
|
DEPRECATED: use Query.networkVolumesConnection instead, which pages the list. Retained for wire compatibility; not marked with the @deprecated directive because deprecated members are hidden from introspection by default. |
Arguments
|
|
networkVolumePricing - NetworkVolumePricing
|
Network volume rates this account is billed at. Readable by the user themselves whatever their organization role, since the console quotes the rate before a volume is created, and by CSR support read. Null otherwise. |
teams - [Team]
|
|
ownedTeams - [Team]
|
|
team - Team
|
|
teamMembership - TeamMembership
|
|
teamScopes - TeamScopes
|
|
isTeam - Boolean
|
|
savingsPlans - [SavingsPlan]
|
|
Arguments
|
|
savingsPlan - SavingsPlan
|
|
serverlessDiscount - Discount
|
|
serverlessDiscounts - [Discount]
|
|
billing - UserBilling
|
|
Arguments
|
|
costCenterBilling - [CostCenterBillingRecord!]!
|
|
Arguments
|
|
costCenterBillingSummary - CostCenterBillingSummary
|
|
Arguments
|
|
costCenterBillingCreditCodes - [CreditTransfer!]!
|
|
Arguments |
|
secrets - [Secret!]!
|
|
globalStoreBuckets - [GlobalStoreBucket!]!
|
|
byoObjectStores - [ByoObjectStore!]!
|
|
impersonations - [Impersonation]
|
|
activeImpersonation - Impersonation
|
|
nodeGroups - [NodeGroup]
|
|
cluster - Cluster
|
|
Arguments
|
|
clusters - [Cluster]
|
DEPRECATED: use Query.clustersConnection instead, which pages the list. Retained for wire compatibility; not marked with the @deprecated directive because deprecated members are hidden from introspection by default. |
Arguments
|
|
clusterExpansionAvailability - ClusterExpansionAvailability!
|
|
Arguments
|
|
sandbox - Sandbox
|
|
Arguments
|
|
sandboxes - [Sandbox!]!
|
|
Arguments
|
|
apiKeys - [ApiKey!]
|
|
sharedApiKeys - [SharedApiKey!]
|
|
paymentMethods - [PaymentMethod!]
|
|
paymentMethodsByPriority - [PaymentMethod!]
|
|
defaultPaymentMethod - PaymentMethod
|
|
reservations - [Reservation!]!
|
|
Arguments
|
|
flashApps - [FlashApp]
|
|
tags - [Tag!]
|
|
costCenters - [CostCenter!]
|
|
subscription - AccountSubscription
|
The account's subscription — in team context the User is the team owner, so this is the team's subscription. Null when the account has never held one, or when the caller may not read this user's financial profile (a co-member row reached via a roster edge). |
entitlements - Entitlements
|
The account's effective levers whether or not it holds a subscription row: a row resolves as AccountSubscription.entitlements does, a row-less account resolves the FREE plan with its overrides applied, and an account settling postpaid resolves ENTERPRISE over any row it still holds. Always the view keyed on the user, an org member's included: a member's org-stamped resources — every deploy they make, membership being authoritative on the request — resolve as the organization instead. Same financial-profile gate as subscription. |
entitlementsForTier - Entitlements
|
The levers this account would hold as a subscriber to the tier's current plan version, with its admin override applied — a CS exception outlives a tier change, so the plan row alone misstates the switch. A tier with no usable active row resolves the FREE fallback. Same gate as subscription. |
Arguments
|
|
storageEvictionAt - DateTime
|
When this account's free-tier Global Storage is scheduled for eviction (every RunPod-provisioned bucket deleted) after a plan-window's worth of days with no cash debit. Set when the notice period starts; cleared by a cash debit, a plan change, or the eviction itself. Null when nothing is scheduled. A date in the past means the deletion is pending its next nightly run. Same financial-profile gate as subscription. |
Example
{
"pods": [Pod],
"backgroundPods": [Pod],
"podsConnection": PodsConnection,
"machines": [Machine],
"hiddenMachines": [Machine],
"machinesSummary": [MachineSummary],
"id": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"authId": "abc123",
"email": "abc123",
"containerRegistryCreds": [ContainerRegistryAuth],
"currentSpendPerHr": 987.65,
"machineQuota": 987,
"referralEarned": 987.65,
"signedTermsOfService": true,
"spendLimit": 123,
"stripeSavedPaymentId": "abc123",
"stripeSavedPaymentLast4": "xyz789",
"templateEarned": 123.45,
"multiFactorEnabled": true,
"machineEarnings": [MachineEarning],
"machineEarningsCustomRange": [MachineEarning],
"networkStorageEarnings": [NetworkStorageEarning],
"underBalance": true,
"billingMode": "PREPAID",
"minBalance": 123.45,
"stripeAutoReloadAmount": 123,
"stripeAutoPaymentThreshold": 123,
"spendDetails": SpendDetails,
"maxServerlessConcurrency": 123,
"clientLifetimeSpend": 123.45,
"referralId": "abc123",
"datacenters": [DataCenter],
"githubAccountInfo": GithubAccountInfo,
"discordAccountInfo": DiscordAccountInfo,
"isAutoPayEnabled": false,
"enableBackupPayments": true,
"onboardingInfo": OnboardingInfo,
"affiliateKey": "abc123",
"hasActivated": true,
"hasLoadedCredits": false,
"referralUsageId": "xyz789",
"referralEmailUsageCount": 123,
"activeMigrations": [PodMigration],
"poolMemberships": ["abc123"],
"notifyCcList": "xyz789",
"orgCapabilities": ["abc123"],
"userPreferences": [UserPreference],
"clientBalance": 987.65,
"hostBalance": 987.65,
"hostStripeLinked": true,
"stripeAccountId": "abc123",
"stripeReloadHistory": [StripeReloadTransaction],
"payoutHistory": [PayoutHistory],
"dailyCharges": [ClientCreditCharge],
"referral": UserReferral,
"pubKey": "xyz789",
"sshPublicKeys": [SshPublicKey],
"information": UserInformation,
"notifyPodsStale": true,
"notifyPodsGeneral": true,
"notifyLowBalance": false,
"creditAlertThreshold": 123.45,
"notifyOther": true,
"podTemplates": [PodTemplate],
"creditCodes": [CreditCode],
"endpoint": Endpoint,
"endpoints": [Endpoint],
"networkVolumes": [NetworkVolume],
"networkVolumePricing": NetworkVolumePricing,
"teams": [Team],
"ownedTeams": [Team],
"team": Team,
"teamMembership": TeamMembership,
"teamScopes": TeamScopes,
"isTeam": true,
"savingsPlans": [SavingsPlan],
"savingsPlan": SavingsPlan,
"serverlessDiscount": Discount,
"serverlessDiscounts": [Discount],
"billing": UserBilling,
"costCenterBilling": [CostCenterBillingRecord],
"costCenterBillingSummary": CostCenterBillingSummary,
"costCenterBillingCreditCodes": [CreditTransfer],
"secrets": [Secret],
"globalStoreBuckets": [GlobalStoreBucket],
"byoObjectStores": [ByoObjectStore],
"impersonations": [Impersonation],
"activeImpersonation": Impersonation,
"nodeGroups": [NodeGroup],
"cluster": Cluster,
"clusters": [Cluster],
"clusterExpansionAvailability": ClusterExpansionAvailability,
"sandbox": Sandbox,
"sandboxes": [Sandbox],
"apiKeys": [ApiKey],
"sharedApiKeys": [SharedApiKey],
"paymentMethods": [PaymentMethod],
"paymentMethodsByPriority": [PaymentMethod],
"defaultPaymentMethod": PaymentMethod,
"reservations": [Reservation],
"flashApps": [FlashApp],
"tags": [Tag],
"costCenters": [CostCenter],
"subscription": AccountSubscription,
"entitlements": Entitlements,
"entitlementsForTier": Entitlements,
"storageEvictionAt": "2007-12-03T10:15:30Z"
}
UserBilling
Fields
| Field Name | Description |
|---|---|
gpuCloud - [UserGpuCloudBilling]
|
|
cpuCloud - [UserCpuCloudBilling]
|
|
serverless - [UserServerlessBilling]
|
|
Arguments
|
|
cluster - [UserClusterBilling]
|
|
Arguments
|
|
runpodEndpoint - [UserRunpodEndpointBilling]
|
|
storage - [UserStorageBilling]
|
|
globalVolumes - [UserGlobalVolumeBilling!]
|
|
summary - [UserSummaryBilling]
|
|
Example
{
"gpuCloud": [UserGpuCloudBilling],
"cpuCloud": [UserCpuCloudBilling],
"serverless": [UserServerlessBilling],
"cluster": [UserClusterBilling],
"runpodEndpoint": [UserRunpodEndpointBilling],
"storage": [UserStorageBilling],
"globalVolumes": [UserGlobalVolumeBilling],
"summary": [UserSummaryBilling]
}
UserBillingInput
Fields
| Input Field | Description |
|---|---|
granularity - BillingGranularity
|
|
startDate - DateTime
|
|
endDate - DateTime
|
Example
{
"granularity": "MINUTELY",
"startDate": "2007-12-03T10:15:30Z",
"endDate": "2007-12-03T10:15:30Z"
}
UserClusterBilling
UserClusterBillingGroupBy
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"GPU_TYPE"
UserClusterBillingInput
Fields
| Input Field | Description |
|---|---|
groupBy - UserClusterBillingGroupBy
|
Example
{"groupBy": "GPU_TYPE"}
UserCpuCloudBilling
UserGlobalVolumeBilling
Description
Global Store (object storage) usage. Source rows are one per UTC day: HOURLY and MINUTELY return the daily rows as-is (time = UTC midnight), WEEKLY and MONTHLY sum them per UTC week (Monday start) and month. storageBilledGb is the total GB stored for the period, not a delta; amount = storageAmount + requestAmount.
Example
{
"time": "2007-12-03T10:15:30Z",
"amount": 987.65,
"storageAmount": 987.65,
"requestAmount": 987.65,
"storageBilledGb": 123.45,
"classARequests": 987.65,
"classBRequests": 123.45,
"objectNotifications": 123.45
}
UserGpuCloudBilling
UserInformation
Example
{
"firstName": "abc123",
"lastName": "abc123",
"addressLine1": "abc123",
"addressLine2": "xyz789",
"countryCode": "abc123",
"companyName": "xyz789",
"companyIdentification": "abc123",
"taxIdentification": "xyz789"
}
UserMachinesFilter
UserPreference
Example
{
"id": "xyz789",
"userId": "xyz789",
"category": "GPU_TYPES",
"preferences": {},
"metadata": {},
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
UserPreferenceCategory
Values
| Enum Value | Description |
|---|---|
|
|
Example
"GPU_TYPES"
UserReferral
Fields
| Field Name | Description |
|---|---|
code - String!
|
|
currentMonth - UserReferralMonth
|
Example
{
"code": "abc123",
"currentMonth": UserReferralMonth
}
UserReferralMonth
UserReservation
Example
{
"userId": "xyz789",
"reservationId": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"user": User,
"reservation": Reservation
}
UserRunpodEndpointBilling
UserServerlessBilling
Example
{
"time": "2007-12-03T10:15:30Z",
"amount": 123.45,
"timeBilledSeconds": 123,
"endpointId": "xyz789",
"gpuTypeId": "abc123",
"instanceId": "abc123",
"slsWorkerType": "abc123"
}
UserServerlessBillingGroupBy
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"GPU_TYPE"
UserServerlessBillingInput
Fields
| Input Field | Description |
|---|---|
groupBy - UserServerlessBillingGroupBy
|
Example
{"groupBy": "GPU_TYPE"}
UserStorageBilling
Fields
| Field Name | Description |
|---|---|
time - DateTime
|
|
amount - Float
|
|
diskSpaceBilledGB - Int
|
|
networkStorageDiskSpaceBilledGB - Int
|
|
networkStorageAmount - Float
|
|
hpsDiskSpaceBilledGB - Int
|
|
hpsAmount - Float
|
|
gpuDiskSpaceBilledGB - Int
|
|
gpuStorageAmount - Float
|
|
cpuDiskSpaceBilledGB - Int
|
|
cpuStorageAmount - Float
|
|
slsDiskSpaceBilledGB - Int
|
|
slsStorageAmount - Float
|
Example
{
"time": "2007-12-03T10:15:30Z",
"amount": 123.45,
"diskSpaceBilledGB": 123,
"networkStorageDiskSpaceBilledGB": 123,
"networkStorageAmount": 123.45,
"hpsDiskSpaceBilledGB": 123,
"hpsAmount": 123.45,
"gpuDiskSpaceBilledGB": 123,
"gpuStorageAmount": 987.65,
"cpuDiskSpaceBilledGB": 123,
"cpuStorageAmount": 123.45,
"slsDiskSpaceBilledGB": 123,
"slsStorageAmount": 123.45
}
UserSummaryBilling
Example
{
"time": "2007-12-03T10:15:30Z",
"gpuCloudAmount": 987.65,
"cpuCloudAmount": 123.45,
"serverlessAmount": 987.65,
"storageAmount": 123.45,
"runpodEndpointAmount": 987.65,
"globalVolumesAmount": 987.65
}
VirtualizationRole
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"HOST"
Void
Description
Represents NULL values
WebhookRequestStatus
WebhookRequestsInput
Fields
| Input Field | Description |
|---|---|
granularity - EndpointStatisticGranularity
|
Example
{"granularity": "LIVE"}
WorkerLifecyclePhaseCount
Description
Count of this endpoint's current (non-terminated) workers stuck on a given model-dependency lifecycle phase (STO-529/STO-530). Unlike WorkerState, this is a live snapshot from ModelMachineAssignment, not a Tinybird time series -- it explains WorkerState.unhealthy, not replaces it.
phase is a String, not an enum (matches ModelVersionPodAssignment.failurePhase, STO-359). Reported worst-first, one phase per worker: "download_failed"/"mount_failed" -- the assignment failed in that phase. "stalled" -- the assignment is EVICTED or UNASSIGNED. Nothing re-drives either for a pod that is already running, so the worker is stuck, not queued; it will not recover without the endpoint being redeployed. "deferred" -- still in progress: no assignment row yet, ASSIGNED, or FAILED with no phase reported. "startup_failed"/"cuda_failed" exist in host's taxonomy but aren't persisted anywhere this can read yet -- see model/src/utils/modelLifecycle.ts.
Omits workers with no model dependency or a fully DEPLOYED one. Scans at most this endpoint's 5000 oldest-created non-terminated pods, same as Endpoint.pods -- an endpoint over that cap gets a partial count.
Example
{"phase": "xyz789", "count": 987}
WorkerState
WorkerStateInput
Fields
| Input Field | Description |
|---|---|
granularity - EndpointStatisticGranularity
|
Example
{"granularity": "LIVE"}