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/graphql
Version

1.0.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": 987,
        "groupId": "abc123"
      }
    ]
  }
}
Queries

gpuTypes

Response

Returns [GpuType]

Arguments
Name Description
input - GpuTypeFilter

Example

Query
query gpuTypes($input: GpuTypeFilter) {
  gpuTypes(input: $input) {
    lowestPrice {
      ...LowestPriceFragment
    }
    maxGpuCount
    maxGpuCountCommunityCloud
    maxGpuCountSecureCloud
    minPodGpuCount
    id
    displayName
    manufacturer
    memoryInGb
    cudaCores
    secureCloud
    communityCloud
    securePrice
    communityPrice
    oneMonthPrice
    threeMonthPrice
    sixMonthPrice
    oneWeekPrice
    communitySpotPrice
    secureSpotPrice
  }
}
Variables
{"input": GpuTypeFilter}
Response
{
  "data": {
    "gpuTypes": [
      {
        "lowestPrice": LowestPrice,
        "maxGpuCount": 987,
        "maxGpuCountCommunityCloud": 987,
        "maxGpuCountSecureCloud": 987,
        "minPodGpuCount": 987,
        "id": "abc123",
        "displayName": "xyz789",
        "manufacturer": "xyz789",
        "memoryInGb": 987,
        "cudaCores": 987,
        "secureCloud": true,
        "communityCloud": false,
        "securePrice": 123.45,
        "communityPrice": 123.45,
        "oneMonthPrice": 123.45,
        "threeMonthPrice": 987.65,
        "sixMonthPrice": 123.45,
        "oneWeekPrice": 987.65,
        "communitySpotPrice": 987.65,
        "secureSpotPrice": 123.45
      }
    ]
  }
}
Queries

myself

Response

Returns a User

Example

Query
query myself {
  myself {
    pods {
      ...PodFragment
    }
    machines {
      ...MachineFragment
    }
    machinesSummary {
      ...MachineSummaryFragment
    }
    id
    authId
    email
    containerRegistryCreds {
      ...ContainerRegistryAuthFragment
    }
    currentSpendPerHr
    machineQuota
    referralEarned
    signedTermsOfService
    spendLimit
    stripeSavedPaymentId
    stripeSavedPaymentLast4
    templateEarned
    multiFactorEnabled
    machineEarnings {
      ...MachineEarningFragment
    }
    machineEarningsCustomRange {
      ...MachineEarningFragment
    }
    networkStorageEarnings {
      ...NetworkStorageEarningFragment
    }
    underBalance
    minBalance
    stripeAutoReloadAmount
    stripeAutoPaymentThreshold
    spendDetails {
      ...SpendDetailsFragment
    }
    maxServerlessConcurrency
    clientLifetimeSpend
    referralId
    datacenters {
      ...DataCenterFragment
    }
    clientBalance
    hostBalance
    hostStripeLinked
    stripeAccountId
    stripeReloadHistory {
      ...StripeReloadTransactionFragment
    }
    dailyCharges {
      ...ClientCreditChargeFragment
    }
    referral {
      ...UserReferralFragment
    }
    pubKey
    information {
      ...UserInformationFragment
    }
    notifyPodsStale
    notifyPodsGeneral
    notifyLowBalance
    creditAlertThreshold
    notifyOther
    podTemplates {
      ...PodTemplateFragment
    }
    creditCodes {
      ...CreditCodeFragment
    }
    endpoint {
      ...EndpointFragment
    }
    endpoints {
      ...EndpointFragment
    }
    networkVolumes {
      ...NetworkVolumeFragment
    }
    teams {
      ...TeamFragment
    }
    ownedTeams {
      ...TeamFragment
    }
    team {
      ...TeamFragment
    }
    teamMembership {
      ...TeamMembershipFragment
    }
    teamScopes {
      ...TeamScopesFragment
    }
    isTeam
    savingsPlans {
      ...SavingsPlanFragment
    }
    serverlessDiscount {
      ...DiscountFragment
    }
    billing {
      ...UserBillingFragment
    }
    csrRole
    secrets {
      ...SecretFragment
    }
    impersonations {
      ...ImpersonationFragment
    }
    activeImpersonation {
      ...ImpersonationFragment
    }
    apiKeys {
      ...ApiKeyFragment
    }
  }
}
Response
{
  "data": {
    "myself": {
      "pods": [Pod],
      "machines": [Machine],
      "machinesSummary": [MachineSummary],
      "id": "xyz789",
      "authId": "xyz789",
      "email": "xyz789",
      "containerRegistryCreds": [ContainerRegistryAuth],
      "currentSpendPerHr": 123.45,
      "machineQuota": 987,
      "referralEarned": 987.65,
      "signedTermsOfService": false,
      "spendLimit": 123,
      "stripeSavedPaymentId": "abc123",
      "stripeSavedPaymentLast4": "abc123",
      "templateEarned": 987.65,
      "multiFactorEnabled": false,
      "machineEarnings": [MachineEarning],
      "machineEarningsCustomRange": [MachineEarning],
      "networkStorageEarnings": [NetworkStorageEarning],
      "underBalance": false,
      "minBalance": 123.45,
      "stripeAutoReloadAmount": 987,
      "stripeAutoPaymentThreshold": 987,
      "spendDetails": SpendDetails,
      "maxServerlessConcurrency": 123,
      "clientLifetimeSpend": 123.45,
      "referralId": "abc123",
      "datacenters": [DataCenter],
      "clientBalance": 987.65,
      "hostBalance": 123.45,
      "hostStripeLinked": false,
      "stripeAccountId": "abc123",
      "stripeReloadHistory": [StripeReloadTransaction],
      "dailyCharges": [ClientCreditCharge],
      "referral": UserReferral,
      "pubKey": "abc123",
      "information": UserInformation,
      "notifyPodsStale": false,
      "notifyPodsGeneral": true,
      "notifyLowBalance": true,
      "creditAlertThreshold": 987.65,
      "notifyOther": false,
      "podTemplates": [PodTemplate],
      "creditCodes": [CreditCode],
      "endpoint": Endpoint,
      "endpoints": [Endpoint],
      "networkVolumes": [NetworkVolume],
      "teams": [Team],
      "ownedTeams": [Team],
      "team": Team,
      "teamMembership": TeamMembership,
      "teamScopes": TeamScopes,
      "isTeam": true,
      "savingsPlans": [SavingsPlan],
      "serverlessDiscount": Discount,
      "billing": UserBilling,
      "csrRole": "admin",
      "secrets": [Secret],
      "impersonations": [Impersonation],
      "activeImpersonation": Impersonation,
      "apiKeys": [ApiKey]
    }
  }
}
Queries

pod

Response

Returns a Pod

Arguments
Name Description
input - PodFilter

Example

Query
query pod($input: PodFilter) {
  pod(input: $input) {
    lowestBidPriceToResume
    aiApiId
    apiKey
    consumerUserId
    containerDiskInGb
    containerRegistryAuthId
    costMultiplier
    costPerHr
    createdAt
    adjustedCostPerHr
    desiredStatus
    dockerArgs
    dockerId
    env
    gpuCount
    gpuPowerLimitPercent
    gpus {
      ...GpuFragment
    }
    id
    imageName
    lastStatusChange
    locked
    machineId
    memoryInGb
    name
    podType
    port
    ports
    registry {
      ...PodRegistryFragment
    }
    templateId
    uptimeSeconds
    vcpuCount
    version
    volumeEncrypted
    volumeInGb
    volumeKey
    volumeMountPath
    lastStartedAt
    cpuFlavorId
    machineType
    slsVersion
    networkVolumeId
    cpuFlavor {
      ...CpuFlavorFragment
    }
    runtime {
      ...PodRuntimeFragment
    }
    machine {
      ...PodMachineInfoFragment
    }
    latestTelemetry {
      ...PodTelemetryFragment
    }
    endpoint {
      ...EndpointFragment
    }
    networkVolume {
      ...NetworkVolumeFragment
    }
    savingsPlans {
      ...SavingsPlanFragment
    }
  }
}
Variables
{"input": PodFilter}
Response
{
  "data": {
    "pod": {
      "lowestBidPriceToResume": 123.45,
      "aiApiId": "xyz789",
      "apiKey": "xyz789",
      "consumerUserId": "abc123",
      "containerDiskInGb": 123,
      "containerRegistryAuthId": "xyz789",
      "costMultiplier": 987.65,
      "costPerHr": 987.65,
      "createdAt": "2007-12-03T10:15:30Z",
      "adjustedCostPerHr": 123.45,
      "desiredStatus": "CREATED",
      "dockerArgs": "xyz789",
      "dockerId": "abc123",
      "env": ["xyz789"],
      "gpuCount": 123,
      "gpuPowerLimitPercent": 123,
      "gpus": [Gpu],
      "id": "abc123",
      "imageName": "xyz789",
      "lastStatusChange": "abc123",
      "locked": false,
      "machineId": "abc123",
      "memoryInGb": 123.45,
      "name": "abc123",
      "podType": "INTERRUPTABLE",
      "port": 1826,
      "ports": "xyz789",
      "registry": PodRegistry,
      "templateId": "xyz789",
      "uptimeSeconds": 123,
      "vcpuCount": 987.65,
      "version": 123,
      "volumeEncrypted": true,
      "volumeInGb": 123.45,
      "volumeKey": "abc123",
      "volumeMountPath": "abc123",
      "lastStartedAt": "2007-12-03T10:15:30Z",
      "cpuFlavorId": "xyz789",
      "machineType": "abc123",
      "slsVersion": 987,
      "networkVolumeId": "abc123",
      "cpuFlavor": CpuFlavor,
      "runtime": PodRuntime,
      "machine": PodMachineInfo,
      "latestTelemetry": PodTelemetry,
      "endpoint": Endpoint,
      "networkVolume": NetworkVolume,
      "savingsPlans": [SavingsPlan]
    }
  }
}

Mutations

podBidResume

Response

Returns a Pod

Arguments
Name Description
input - PodBidResumeInput!

Example

Query
mutation podBidResume($input: PodBidResumeInput!) {
  podBidResume(input: $input) {
    lowestBidPriceToResume
    aiApiId
    apiKey
    consumerUserId
    containerDiskInGb
    containerRegistryAuthId
    costMultiplier
    costPerHr
    createdAt
    adjustedCostPerHr
    desiredStatus
    dockerArgs
    dockerId
    env
    gpuCount
    gpuPowerLimitPercent
    gpus {
      ...GpuFragment
    }
    id
    imageName
    lastStatusChange
    locked
    machineId
    memoryInGb
    name
    podType
    port
    ports
    registry {
      ...PodRegistryFragment
    }
    templateId
    uptimeSeconds
    vcpuCount
    version
    volumeEncrypted
    volumeInGb
    volumeKey
    volumeMountPath
    lastStartedAt
    cpuFlavorId
    machineType
    slsVersion
    networkVolumeId
    cpuFlavor {
      ...CpuFlavorFragment
    }
    runtime {
      ...PodRuntimeFragment
    }
    machine {
      ...PodMachineInfoFragment
    }
    latestTelemetry {
      ...PodTelemetryFragment
    }
    endpoint {
      ...EndpointFragment
    }
    networkVolume {
      ...NetworkVolumeFragment
    }
    savingsPlans {
      ...SavingsPlanFragment
    }
  }
}
Variables
{"input": PodBidResumeInput}
Response
{
  "data": {
    "podBidResume": {
      "lowestBidPriceToResume": 123.45,
      "aiApiId": "xyz789",
      "apiKey": "xyz789",
      "consumerUserId": "abc123",
      "containerDiskInGb": 987,
      "containerRegistryAuthId": "xyz789",
      "costMultiplier": 987.65,
      "costPerHr": 987.65,
      "createdAt": "2007-12-03T10:15:30Z",
      "adjustedCostPerHr": 987.65,
      "desiredStatus": "CREATED",
      "dockerArgs": "xyz789",
      "dockerId": "xyz789",
      "env": ["abc123"],
      "gpuCount": 987,
      "gpuPowerLimitPercent": 987,
      "gpus": [Gpu],
      "id": "abc123",
      "imageName": "abc123",
      "lastStatusChange": "xyz789",
      "locked": false,
      "machineId": "abc123",
      "memoryInGb": 987.65,
      "name": "abc123",
      "podType": "INTERRUPTABLE",
      "port": 1826,
      "ports": "xyz789",
      "registry": PodRegistry,
      "templateId": "xyz789",
      "uptimeSeconds": 123,
      "vcpuCount": 123.45,
      "version": 123,
      "volumeEncrypted": false,
      "volumeInGb": 987.65,
      "volumeKey": "xyz789",
      "volumeMountPath": "xyz789",
      "lastStartedAt": "2007-12-03T10:15:30Z",
      "cpuFlavorId": "xyz789",
      "machineType": "xyz789",
      "slsVersion": 987,
      "networkVolumeId": "xyz789",
      "cpuFlavor": CpuFlavor,
      "runtime": PodRuntime,
      "machine": PodMachineInfo,
      "latestTelemetry": PodTelemetry,
      "endpoint": Endpoint,
      "networkVolume": NetworkVolume,
      "savingsPlans": [SavingsPlan]
    }
  }
}
Mutations

podEditJob

Response

Returns a Pod

Arguments
Name Description
input - PodEditJobInput!

Example

Query
mutation podEditJob($input: PodEditJobInput!) {
  podEditJob(input: $input) {
    lowestBidPriceToResume
    aiApiId
    apiKey
    consumerUserId
    containerDiskInGb
    containerRegistryAuthId
    costMultiplier
    costPerHr
    createdAt
    adjustedCostPerHr
    desiredStatus
    dockerArgs
    dockerId
    env
    gpuCount
    gpuPowerLimitPercent
    gpus {
      ...GpuFragment
    }
    id
    imageName
    lastStatusChange
    locked
    machineId
    memoryInGb
    name
    podType
    port
    ports
    registry {
      ...PodRegistryFragment
    }
    templateId
    uptimeSeconds
    vcpuCount
    version
    volumeEncrypted
    volumeInGb
    volumeKey
    volumeMountPath
    lastStartedAt
    cpuFlavorId
    machineType
    slsVersion
    networkVolumeId
    cpuFlavor {
      ...CpuFlavorFragment
    }
    runtime {
      ...PodRuntimeFragment
    }
    machine {
      ...PodMachineInfoFragment
    }
    latestTelemetry {
      ...PodTelemetryFragment
    }
    endpoint {
      ...EndpointFragment
    }
    networkVolume {
      ...NetworkVolumeFragment
    }
    savingsPlans {
      ...SavingsPlanFragment
    }
  }
}
Variables
{"input": PodEditJobInput}
Response
{
  "data": {
    "podEditJob": {
      "lowestBidPriceToResume": 123.45,
      "aiApiId": "xyz789",
      "apiKey": "xyz789",
      "consumerUserId": "xyz789",
      "containerDiskInGb": 987,
      "containerRegistryAuthId": "xyz789",
      "costMultiplier": 123.45,
      "costPerHr": 987.65,
      "createdAt": "2007-12-03T10:15:30Z",
      "adjustedCostPerHr": 123.45,
      "desiredStatus": "CREATED",
      "dockerArgs": "xyz789",
      "dockerId": "abc123",
      "env": ["xyz789"],
      "gpuCount": 987,
      "gpuPowerLimitPercent": 987,
      "gpus": [Gpu],
      "id": "xyz789",
      "imageName": "xyz789",
      "lastStatusChange": "xyz789",
      "locked": true,
      "machineId": "abc123",
      "memoryInGb": 987.65,
      "name": "abc123",
      "podType": "INTERRUPTABLE",
      "port": 1826,
      "ports": "xyz789",
      "registry": PodRegistry,
      "templateId": "xyz789",
      "uptimeSeconds": 987,
      "vcpuCount": 987.65,
      "version": 987,
      "volumeEncrypted": false,
      "volumeInGb": 123.45,
      "volumeKey": "xyz789",
      "volumeMountPath": "abc123",
      "lastStartedAt": "2007-12-03T10:15:30Z",
      "cpuFlavorId": "abc123",
      "machineType": "xyz789",
      "slsVersion": 987,
      "networkVolumeId": "xyz789",
      "cpuFlavor": CpuFlavor,
      "runtime": PodRuntime,
      "machine": PodMachineInfo,
      "latestTelemetry": PodTelemetry,
      "endpoint": Endpoint,
      "networkVolume": NetworkVolume,
      "savingsPlans": [SavingsPlan]
    }
  }
}
Mutations

podFindAndDeployOnDemand

Response

Returns a Pod

Arguments
Name Description
input - PodFindAndDeployOnDemandInput

Example

Query
mutation podFindAndDeployOnDemand($input: PodFindAndDeployOnDemandInput) {
  podFindAndDeployOnDemand(input: $input) {
    lowestBidPriceToResume
    aiApiId
    apiKey
    consumerUserId
    containerDiskInGb
    containerRegistryAuthId
    costMultiplier
    costPerHr
    createdAt
    adjustedCostPerHr
    desiredStatus
    dockerArgs
    dockerId
    env
    gpuCount
    gpuPowerLimitPercent
    gpus {
      ...GpuFragment
    }
    id
    imageName
    lastStatusChange
    locked
    machineId
    memoryInGb
    name
    podType
    port
    ports
    registry {
      ...PodRegistryFragment
    }
    templateId
    uptimeSeconds
    vcpuCount
    version
    volumeEncrypted
    volumeInGb
    volumeKey
    volumeMountPath
    lastStartedAt
    cpuFlavorId
    machineType
    slsVersion
    networkVolumeId
    cpuFlavor {
      ...CpuFlavorFragment
    }
    runtime {
      ...PodRuntimeFragment
    }
    machine {
      ...PodMachineInfoFragment
    }
    latestTelemetry {
      ...PodTelemetryFragment
    }
    endpoint {
      ...EndpointFragment
    }
    networkVolume {
      ...NetworkVolumeFragment
    }
    savingsPlans {
      ...SavingsPlanFragment
    }
  }
}
Variables
{"input": PodFindAndDeployOnDemandInput}
Response
{
  "data": {
    "podFindAndDeployOnDemand": {
      "lowestBidPriceToResume": 987.65,
      "aiApiId": "abc123",
      "apiKey": "abc123",
      "consumerUserId": "xyz789",
      "containerDiskInGb": 123,
      "containerRegistryAuthId": "xyz789",
      "costMultiplier": 123.45,
      "costPerHr": 123.45,
      "createdAt": "2007-12-03T10:15:30Z",
      "adjustedCostPerHr": 123.45,
      "desiredStatus": "CREATED",
      "dockerArgs": "abc123",
      "dockerId": "xyz789",
      "env": ["xyz789"],
      "gpuCount": 123,
      "gpuPowerLimitPercent": 987,
      "gpus": [Gpu],
      "id": "abc123",
      "imageName": "abc123",
      "lastStatusChange": "xyz789",
      "locked": false,
      "machineId": "abc123",
      "memoryInGb": 123.45,
      "name": "abc123",
      "podType": "INTERRUPTABLE",
      "port": 1826,
      "ports": "abc123",
      "registry": PodRegistry,
      "templateId": "xyz789",
      "uptimeSeconds": 123,
      "vcpuCount": 123.45,
      "version": 123,
      "volumeEncrypted": true,
      "volumeInGb": 123.45,
      "volumeKey": "abc123",
      "volumeMountPath": "xyz789",
      "lastStartedAt": "2007-12-03T10:15:30Z",
      "cpuFlavorId": "xyz789",
      "machineType": "abc123",
      "slsVersion": 123,
      "networkVolumeId": "xyz789",
      "cpuFlavor": CpuFlavor,
      "runtime": PodRuntime,
      "machine": PodMachineInfo,
      "latestTelemetry": PodTelemetry,
      "endpoint": Endpoint,
      "networkVolume": NetworkVolume,
      "savingsPlans": [SavingsPlan]
    }
  }
}
Mutations

podRentInterruptable

Response

Returns a Pod

Arguments
Name Description
input - PodRentInterruptableInput!

Example

Query
mutation podRentInterruptable($input: PodRentInterruptableInput!) {
  podRentInterruptable(input: $input) {
    lowestBidPriceToResume
    aiApiId
    apiKey
    consumerUserId
    containerDiskInGb
    containerRegistryAuthId
    costMultiplier
    costPerHr
    createdAt
    adjustedCostPerHr
    desiredStatus
    dockerArgs
    dockerId
    env
    gpuCount
    gpuPowerLimitPercent
    gpus {
      ...GpuFragment
    }
    id
    imageName
    lastStatusChange
    locked
    machineId
    memoryInGb
    name
    podType
    port
    ports
    registry {
      ...PodRegistryFragment
    }
    templateId
    uptimeSeconds
    vcpuCount
    version
    volumeEncrypted
    volumeInGb
    volumeKey
    volumeMountPath
    lastStartedAt
    cpuFlavorId
    machineType
    slsVersion
    networkVolumeId
    cpuFlavor {
      ...CpuFlavorFragment
    }
    runtime {
      ...PodRuntimeFragment
    }
    machine {
      ...PodMachineInfoFragment
    }
    latestTelemetry {
      ...PodTelemetryFragment
    }
    endpoint {
      ...EndpointFragment
    }
    networkVolume {
      ...NetworkVolumeFragment
    }
    savingsPlans {
      ...SavingsPlanFragment
    }
  }
}
Variables
{"input": PodRentInterruptableInput}
Response
{
  "data": {
    "podRentInterruptable": {
      "lowestBidPriceToResume": 987.65,
      "aiApiId": "abc123",
      "apiKey": "xyz789",
      "consumerUserId": "xyz789",
      "containerDiskInGb": 987,
      "containerRegistryAuthId": "abc123",
      "costMultiplier": 987.65,
      "costPerHr": 123.45,
      "createdAt": "2007-12-03T10:15:30Z",
      "adjustedCostPerHr": 123.45,
      "desiredStatus": "CREATED",
      "dockerArgs": "abc123",
      "dockerId": "abc123",
      "env": ["xyz789"],
      "gpuCount": 123,
      "gpuPowerLimitPercent": 987,
      "gpus": [Gpu],
      "id": "abc123",
      "imageName": "abc123",
      "lastStatusChange": "abc123",
      "locked": true,
      "machineId": "xyz789",
      "memoryInGb": 987.65,
      "name": "xyz789",
      "podType": "INTERRUPTABLE",
      "port": 1826,
      "ports": "abc123",
      "registry": PodRegistry,
      "templateId": "abc123",
      "uptimeSeconds": 123,
      "vcpuCount": 987.65,
      "version": 123,
      "volumeEncrypted": true,
      "volumeInGb": 123.45,
      "volumeKey": "abc123",
      "volumeMountPath": "abc123",
      "lastStartedAt": "2007-12-03T10:15:30Z",
      "cpuFlavorId": "xyz789",
      "machineType": "xyz789",
      "slsVersion": 123,
      "networkVolumeId": "abc123",
      "cpuFlavor": CpuFlavor,
      "runtime": PodRuntime,
      "machine": PodMachineInfo,
      "latestTelemetry": PodTelemetry,
      "endpoint": Endpoint,
      "networkVolume": NetworkVolume,
      "savingsPlans": [SavingsPlan]
    }
  }
}
Mutations

podResume

Response

Returns a Pod

Arguments
Name Description
input - PodResumeInput!

Example

Query
mutation podResume($input: PodResumeInput!) {
  podResume(input: $input) {
    lowestBidPriceToResume
    aiApiId
    apiKey
    consumerUserId
    containerDiskInGb
    containerRegistryAuthId
    costMultiplier
    costPerHr
    createdAt
    adjustedCostPerHr
    desiredStatus
    dockerArgs
    dockerId
    env
    gpuCount
    gpuPowerLimitPercent
    gpus {
      ...GpuFragment
    }
    id
    imageName
    lastStatusChange
    locked
    machineId
    memoryInGb
    name
    podType
    port
    ports
    registry {
      ...PodRegistryFragment
    }
    templateId
    uptimeSeconds
    vcpuCount
    version
    volumeEncrypted
    volumeInGb
    volumeKey
    volumeMountPath
    lastStartedAt
    cpuFlavorId
    machineType
    slsVersion
    networkVolumeId
    cpuFlavor {
      ...CpuFlavorFragment
    }
    runtime {
      ...PodRuntimeFragment
    }
    machine {
      ...PodMachineInfoFragment
    }
    latestTelemetry {
      ...PodTelemetryFragment
    }
    endpoint {
      ...EndpointFragment
    }
    networkVolume {
      ...NetworkVolumeFragment
    }
    savingsPlans {
      ...SavingsPlanFragment
    }
  }
}
Variables
{"input": PodResumeInput}
Response
{
  "data": {
    "podResume": {
      "lowestBidPriceToResume": 987.65,
      "aiApiId": "abc123",
      "apiKey": "abc123",
      "consumerUserId": "xyz789",
      "containerDiskInGb": 123,
      "containerRegistryAuthId": "xyz789",
      "costMultiplier": 123.45,
      "costPerHr": 987.65,
      "createdAt": "2007-12-03T10:15:30Z",
      "adjustedCostPerHr": 987.65,
      "desiredStatus": "CREATED",
      "dockerArgs": "xyz789",
      "dockerId": "abc123",
      "env": ["xyz789"],
      "gpuCount": 123,
      "gpuPowerLimitPercent": 123,
      "gpus": [Gpu],
      "id": "abc123",
      "imageName": "abc123",
      "lastStatusChange": "abc123",
      "locked": false,
      "machineId": "xyz789",
      "memoryInGb": 123.45,
      "name": "abc123",
      "podType": "INTERRUPTABLE",
      "port": 1826,
      "ports": "abc123",
      "registry": PodRegistry,
      "templateId": "abc123",
      "uptimeSeconds": 123,
      "vcpuCount": 987.65,
      "version": 123,
      "volumeEncrypted": false,
      "volumeInGb": 123.45,
      "volumeKey": "abc123",
      "volumeMountPath": "abc123",
      "lastStartedAt": "2007-12-03T10:15:30Z",
      "cpuFlavorId": "xyz789",
      "machineType": "abc123",
      "slsVersion": 123,
      "networkVolumeId": "abc123",
      "cpuFlavor": CpuFlavor,
      "runtime": PodRuntime,
      "machine": PodMachineInfo,
      "latestTelemetry": PodTelemetry,
      "endpoint": Endpoint,
      "networkVolume": NetworkVolume,
      "savingsPlans": [SavingsPlan]
    }
  }
}
Mutations

podStop

Response

Returns a Pod

Arguments
Name Description
input - PodStopInput!

Example

Query
mutation podStop($input: PodStopInput!) {
  podStop(input: $input) {
    lowestBidPriceToResume
    aiApiId
    apiKey
    consumerUserId
    containerDiskInGb
    containerRegistryAuthId
    costMultiplier
    costPerHr
    createdAt
    adjustedCostPerHr
    desiredStatus
    dockerArgs
    dockerId
    env
    gpuCount
    gpuPowerLimitPercent
    gpus {
      ...GpuFragment
    }
    id
    imageName
    lastStatusChange
    locked
    machineId
    memoryInGb
    name
    podType
    port
    ports
    registry {
      ...PodRegistryFragment
    }
    templateId
    uptimeSeconds
    vcpuCount
    version
    volumeEncrypted
    volumeInGb
    volumeKey
    volumeMountPath
    lastStartedAt
    cpuFlavorId
    machineType
    slsVersion
    networkVolumeId
    cpuFlavor {
      ...CpuFlavorFragment
    }
    runtime {
      ...PodRuntimeFragment
    }
    machine {
      ...PodMachineInfoFragment
    }
    latestTelemetry {
      ...PodTelemetryFragment
    }
    endpoint {
      ...EndpointFragment
    }
    networkVolume {
      ...NetworkVolumeFragment
    }
    savingsPlans {
      ...SavingsPlanFragment
    }
  }
}
Variables
{"input": PodStopInput}
Response
{
  "data": {
    "podStop": {
      "lowestBidPriceToResume": 987.65,
      "aiApiId": "abc123",
      "apiKey": "abc123",
      "consumerUserId": "abc123",
      "containerDiskInGb": 987,
      "containerRegistryAuthId": "xyz789",
      "costMultiplier": 123.45,
      "costPerHr": 987.65,
      "createdAt": "2007-12-03T10:15:30Z",
      "adjustedCostPerHr": 987.65,
      "desiredStatus": "CREATED",
      "dockerArgs": "xyz789",
      "dockerId": "abc123",
      "env": ["abc123"],
      "gpuCount": 123,
      "gpuPowerLimitPercent": 123,
      "gpus": [Gpu],
      "id": "xyz789",
      "imageName": "xyz789",
      "lastStatusChange": "xyz789",
      "locked": false,
      "machineId": "xyz789",
      "memoryInGb": 987.65,
      "name": "abc123",
      "podType": "INTERRUPTABLE",
      "port": 1826,
      "ports": "xyz789",
      "registry": PodRegistry,
      "templateId": "xyz789",
      "uptimeSeconds": 987,
      "vcpuCount": 987.65,
      "version": 987,
      "volumeEncrypted": true,
      "volumeInGb": 987.65,
      "volumeKey": "abc123",
      "volumeMountPath": "abc123",
      "lastStartedAt": "2007-12-03T10:15:30Z",
      "cpuFlavorId": "xyz789",
      "machineType": "abc123",
      "slsVersion": 123,
      "networkVolumeId": "abc123",
      "cpuFlavor": CpuFlavor,
      "runtime": PodRuntime,
      "machine": PodMachineInfo,
      "latestTelemetry": PodTelemetry,
      "endpoint": Endpoint,
      "networkVolume": NetworkVolume,
      "savingsPlans": [SavingsPlan]
    }
  }
}
Mutations

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}}
Mutations

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": "xyz789",
      "name": "xyz789",
      "userId": "abc123",
      "registryAuth": "abc123"
    }
  }
}

Types

ApiKey

Fields
Field Name Description
id - String
permissions - String!
createdAt - DateTime!
lastUsed - DateTime
name - String
Example
{
  "id": "xyz789",
  "permissions": "abc123",
  "createdAt": "2007-12-03T10:15:30Z",
  "lastUsed": "2007-12-03T10:15:30Z",
  "name": "abc123"
}
Types

AuditLog

Fields
Field Name Description
actorId - String
email - String
ownerId - String
resourceType - String
resourceId - String
action - String
value - String
timestamp - DateTime
Example
{
  "actorId": "abc123",
  "email": "xyz789",
  "ownerId": "abc123",
  "resourceType": "abc123",
  "resourceId": "xyz789",
  "action": "abc123",
  "value": "xyz789",
  "timestamp": "2007-12-03T10:15:30Z"
}
Types

AuditLogConnection

Fields
Field Name Description
edges - [AuditLog]
pageInfo - PageInfo
Example
{
  "edges": [AuditLog],
  "pageInfo": PageInfo
}
Types

BenchmarkPod

Fields
Field Name Description
id - String
desiredStatus - String
Example
{
  "id": "xyz789",
  "desiredStatus": "xyz789"
}
Types

BillingGranularity

Values
Enum Value Description

HOURLY

DAILY

WEEKLY

MONTHLY
Example
"HOURLY"
Types

Boolean

Description

The Boolean scalar type represents true or false.

Example
true
Types

ClientCreditCharge

Fields
Field Name Description
amount - Float
updatedAt - DateTime
diskCharges - Float
podCharges - Float
apiCharges - Float
serverlessCharges - Float
type - ClientCreditChargeType
Example
{
  "amount": 987.65,
  "updatedAt": "2007-12-03T10:15:30Z",
  "diskCharges": 123.45,
  "podCharges": 987.65,
  "apiCharges": 123.45,
  "serverlessCharges": 987.65,
  "type": "CHARGE_SERVERLESS"
}
Types

ClientCreditChargeType

Values
Enum Value Description

CHARGE_SERVERLESS

CHARGE_POD

CHARGE_API

CHARGE_STORAGE

CHARGE_SAVINGS_PLAN
Example
"CHARGE_SERVERLESS"
Types

CloudTypeEnum

Values
Enum Value Description

SECURE

COMMUNITY

ALL
Example
"SECURE"
Types

Compliance

Values
Enum Value Description

GDPR

ISO_IEC_27001

ISO_14001

PCI_DSS

HITRUST

SOC_1_TYPE_2

SOC_2_TYPE_2

SOC_3_TYPE_2

ITAR

FISMA_HIGH
Example
"GDPR"
Types

ComputeType

Values
Enum Value Description

CPU

GPU
Example
"CPU"
Types

ContainerRegistryAuth

Fields
Field Name Description
id - String
name - String
userId - String
registryAuth - String
Example
{
  "id": "xyz789",
  "name": "xyz789",
  "userId": "xyz789",
  "registryAuth": "xyz789"
}
Types

CpuFlavor

Fields
Field Name Description
id - String
groupId - String
groupName - String
displayName - String
minVcpu - Float
maxVcpu - Int
vcpuBurstable - Boolean
ramMultiplier - Float
diskLimitPerVcpu - Int
specifics - Specifics
Arguments
input - SpecificsInput
Example
{
  "id": "xyz789",
  "groupId": "xyz789",
  "groupName": "abc123",
  "displayName": "abc123",
  "minVcpu": 987.65,
  "maxVcpu": 987,
  "vcpuBurstable": true,
  "ramMultiplier": 123.45,
  "diskLimitPerVcpu": 123,
  "specifics": Specifics
}
Types

CpuType

Fields
Field Name Description
id - String
displayName - String
manufacturer - String
cores - Int
threadsPerCore - Int
groupId - String
Example
{
  "id": "xyz789",
  "displayName": "xyz789",
  "manufacturer": "xyz789",
  "cores": 123,
  "threadsPerCore": 123,
  "groupId": "xyz789"
}
Types

CreditCode

Fields
Field Name Description
id - String
issuerId - String
createdAt - DateTime
redeemedAt - DateTime
amount - Int
Example
{
  "id": "abc123",
  "issuerId": "abc123",
  "createdAt": "2007-12-03T10:15:30Z",
  "redeemedAt": "2007-12-03T10:15:30Z",
  "amount": 987
}
Types

CsrRole

Values
Enum Value Description

admin

support_write

support_read
Example
"admin"
Types

DataCenter

Fields
Field Name Description
id - String
name - String
location - String
storage - DataCenterStorage
storageSupport - Boolean
listed - Boolean
gpuAvailability - [GpuAvailability]
Arguments
input - GpuAvailabilityInput
compliance - [Compliance]
Example
{
  "id": "xyz789",
  "name": "abc123",
  "location": "xyz789",
  "storage": DataCenterStorage,
  "storageSupport": true,
  "listed": false,
  "gpuAvailability": [GpuAvailability],
  "compliance": ["GDPR"]
}
Types

DataCenterStorage

Fields
Field Name Description
hostname - String
ips - [String]
pw - String
type - String
user - String
list - [DataCenterStorageList]
Example
{
  "hostname": "xyz789",
  "ips": ["xyz789"],
  "pw": "abc123",
  "type": "xyz789",
  "user": "abc123",
  "list": [DataCenterStorageList]
}
Types

DataCenterStorageList

Fields
Field Name Description
mnt - String
pw - String
servers - [String]
type - String
versions - [Int]
primary - Boolean
Example
{
  "mnt": "abc123",
  "pw": "xyz789",
  "servers": ["xyz789"],
  "type": "abc123",
  "versions": [123],
  "primary": false
}
Types

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"
Types

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"
Types

Discount

Fields
Field Name Description
userId - String!
type - DiscountType!
discountFactor - Float!
expirationDate - DateTime!
activeDiscountFactor - Float
activeWorkers - Int
Example
{
  "userId": "xyz789",
  "type": "SERVERLESS",
  "discountFactor": 987.65,
  "expirationDate": "2007-12-03T10:15:30Z",
  "activeDiscountFactor": 123.45,
  "activeWorkers": 987
}
Types

DiscountType

Values
Enum Value Description

SERVERLESS
Example
"SERVERLESS"
Types

EarningsCustomRangeInput

Fields
Input Field Description
startDate - Date!
endDate - Date!
Example
{
  "startDate": "2007-12-03",
  "endDate": "2007-12-03"
}
Types

Endpoint

Fields
Field Name Description
aiKey - String
gpuIds - String
id - String
idleTimeout - Int
name - String
networkVolumeId - String
locations - String
pods - [Pod]
scalerType - String
scalerValue - Int
template - PodTemplate
templateId - String
type - String
userId - String
version - Int
workersMax - Int
workersMin - Int
workersStandby - Int
gpuCount - Int
env - [EnvironmentVariable]
createdAt - DateTime
allowedCudaVersions - String
executionTimeoutMs - Int
instanceIds - [String]
computeType - ComputeType
workerState - [WorkerState]
Arguments
input - WorkerStateInput!
webhookRequests - [WebhookRequestStatus]
Arguments
input - WebhookRequestsInput!
networkVolume - NetworkVolume
Example
{
  "aiKey": "xyz789",
  "gpuIds": "abc123",
  "id": "xyz789",
  "idleTimeout": 987,
  "name": "abc123",
  "networkVolumeId": "abc123",
  "locations": "xyz789",
  "pods": [Pod],
  "scalerType": "xyz789",
  "scalerValue": 987,
  "template": PodTemplate,
  "templateId": "xyz789",
  "type": "xyz789",
  "userId": "abc123",
  "version": 987,
  "workersMax": 123,
  "workersMin": 987,
  "workersStandby": 987,
  "gpuCount": 987,
  "env": [EnvironmentVariable],
  "createdAt": "2007-12-03T10:15:30Z",
  "allowedCudaVersions": "abc123",
  "executionTimeoutMs": 123,
  "instanceIds": ["xyz789"],
  "computeType": "CPU",
  "workerState": [WorkerState],
  "webhookRequests": [WebhookRequestStatus],
  "networkVolume": NetworkVolume
}
Types

EndpointStatisticGranularity

Values
Enum Value Description

LIVE

HOURLY

DAILY

WEEKLY

MONTHLY
Example
"LIVE"
Types

EnvironmentVariable

Fields
Field Name Description
key - String
value - String
Example
{
  "key": "abc123",
  "value": "abc123"
}
Types

EnvironmentVariableInput

Fields
Input Field Description
key - String!
value - String!
Example
{
  "key": "abc123",
  "value": "abc123"
}
Types

Float

Description

The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.

Example
123.45
Types

Gpu

Fields
Field Name Description
id - String!
podId - String
Example
{
  "id": "xyz789",
  "podId": "abc123"
}
Types

GpuAvailability

Fields
Field Name Description
available - Boolean
stockStatus - String
gpuTypeId - String
gpuType - GpuType
gpuTypeDisplayName - String
displayName - String
id - String
Example
{
  "available": true,
  "stockStatus": "abc123",
  "gpuTypeId": "xyz789",
  "gpuType": GpuType,
  "gpuTypeDisplayName": "xyz789",
  "displayName": "abc123",
  "id": "abc123"
}
Types

GpuAvailabilityInput

Fields
Input Field Description
gpuCount - Int
minDisk - Int
minMemoryInGb - Int
minVcpuCount - Int
secureCloud - Boolean
allowedCudaVersions - [String]
includeAiApi - Boolean
Example
{
  "gpuCount": 987,
  "minDisk": 123,
  "minMemoryInGb": 123,
  "minVcpuCount": 987,
  "secureCloud": true,
  "allowedCudaVersions": ["abc123"],
  "includeAiApi": false
}
Types

GpuLowestPriceInput

Fields
Input Field Description
countryCode - String
dataCenterId - 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]
compliance - [Compliance]
Example
{
  "countryCode": "xyz789",
  "dataCenterId": "xyz789",
  "gpuCount": 987,
  "includeAiApi": true,
  "minDisk": 987,
  "minDownload": 987,
  "minMemoryInGb": 123,
  "minUpload": 123,
  "minVcpuCount": 987,
  "secureCloud": false,
  "supportPublicIp": true,
  "totalDisk": 987,
  "cudaVersion": "abc123",
  "allowedCudaVersions": ["xyz789"],
  "compliance": ["GDPR"]
}
Types

GpuTelemetry

Fields
Field Name Description
id - String
percentUtilization - Float
temperatureCelcius - Float
memoryUtilization - Float
powerWatts - Float
Example
{
  "id": "xyz789",
  "percentUtilization": 987.65,
  "temperatureCelcius": 123.45,
  "memoryUtilization": 987.65,
  "powerWatts": 123.45
}
Types

GpuType

Fields
Field Name Description
lowestPrice - LowestPrice
Arguments
input - GpuLowestPriceInput
maxGpuCount - Int
maxGpuCountCommunityCloud - Int
maxGpuCountSecureCloud - Int
minPodGpuCount - Int
id - String
displayName - String
manufacturer - String
memoryInGb - Int
cudaCores - Int
secureCloud - Boolean
communityCloud - Boolean
securePrice - Float
communityPrice - Float
oneMonthPrice - Float
threeMonthPrice - Float
sixMonthPrice - Float
oneWeekPrice - Float
communitySpotPrice - Float
secureSpotPrice - Float
Example
{
  "lowestPrice": LowestPrice,
  "maxGpuCount": 987,
  "maxGpuCountCommunityCloud": 987,
  "maxGpuCountSecureCloud": 987,
  "minPodGpuCount": 123,
  "id": "xyz789",
  "displayName": "xyz789",
  "manufacturer": "abc123",
  "memoryInGb": 123,
  "cudaCores": 987,
  "secureCloud": true,
  "communityCloud": false,
  "securePrice": 123.45,
  "communityPrice": 987.65,
  "oneMonthPrice": 987.65,
  "threeMonthPrice": 987.65,
  "sixMonthPrice": 123.45,
  "oneWeekPrice": 123.45,
  "communitySpotPrice": 123.45,
  "secureSpotPrice": 123.45
}
Types

GpuTypeFilter

Fields
Input Field Description
id - String
ids - [String!]
Example
{
  "id": "xyz789",
  "ids": ["xyz789"]
}
Types

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"
Types

Impersonation

Fields
Field Name Description
auditLogs - AuditLogConnection
id - ID!
zendeskTicketId - ID!
impersonateUserId - String!
createdAt - DateTime!
expiresAt - DateTime!
accepted - Boolean!
acceptedAt - DateTime
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"
}
Types

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
Types

JSON

Description

The JSON scalar type represents JSON values as specified by ECMA-404.

Example
{}
Types

LowestPrice

Fields
Field Name Description
gpuName - String
gpuTypeId - String
minimumBidPrice - Float
uninterruptablePrice - Float
minMemory - Int
minVcpu - Int
rentalPercentage - Float
rentedCount - Int
totalCount - Int
stockStatus - String
minDownload - Int
minDisk - Int
minUpload - Int
countryCode - String
supportPublicIp - Boolean
compliance - [Compliance]
Example
{
  "gpuName": "abc123",
  "gpuTypeId": "abc123",
  "minimumBidPrice": 987.65,
  "uninterruptablePrice": 123.45,
  "minMemory": 123,
  "minVcpu": 123,
  "rentalPercentage": 123.45,
  "rentedCount": 987,
  "totalCount": 987,
  "stockStatus": "abc123",
  "minDownload": 123,
  "minDisk": 987,
  "minUpload": 123,
  "countryCode": "xyz789",
  "supportPublicIp": true,
  "compliance": ["GDPR"]
}
Types

Machine

Fields
Field Name Description
pods - [Pod]
id - String
userId - String
name - String
registered - Boolean
aiApiOnly - 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
gpuTotal - Int
pcieLink - Int
pcieLinkWidth - Int
memoryReserved - Int
memoryTotal - Int
uploadMbps - Int
vcpuReserved - 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
lastBenchmark - MachineBenchmark
upcomingMaintenances - [MachineMaintenance]
nextMaintenance - MachineMaintenance
backgroundPodTelemetry - PodTelemetry
Arguments
input - backgroundPodTelemetryInput
latestTelemetry - MachineTelemetry
uptime - MachineUptime
runpodIp - String
publicIp - String
Example
{
  "pods": [Pod],
  "id": "abc123",
  "userId": "abc123",
  "name": "xyz789",
  "registered": false,
  "aiApiOnly": true,
  "priority": 987,
  "minPodGpuCount": 123,
  "gpuTypeId": "xyz789",
  "gpuType": GpuType,
  "gpuPowerLimitPercentageRented": 987,
  "gpuPowerLimitPercentageSelf": 123,
  "cpuCount": 987,
  "cpuTypeId": "xyz789",
  "cpuType": CpuType,
  "dataCenter": DataCenter,
  "moboName": "abc123",
  "hidden": true,
  "hostPricePerGpu": 123.45,
  "hostMinBidPerGpu": 123.45,
  "defaultImageName": "xyz789",
  "defaultStartScript": "xyz789",
  "defaultArguments": "abc123",
  "defaultDiskInGb": 123,
  "defaultPort": 1826,
  "defaultEnv": ["abc123"],
  "location": "abc123",
  "listed": false,
  "verified": false,
  "machineId": "abc123",
  "diskReserved": 987,
  "diskTotal": 987,
  "diskMBps": 987,
  "downloadMbps": 123,
  "gpuReserved": 987,
  "gpuTotal": 987,
  "pcieLink": 987,
  "pcieLinkWidth": 123,
  "memoryReserved": 123,
  "memoryTotal": 123,
  "uploadMbps": 123,
  "vcpuReserved": 987,
  "vcpuTotal": 987,
  "installCert": "abc123",
  "uptimePercentListedOneWeek": 987.65,
  "uptimePercentListedFourWeek": 123.45,
  "uptimePercentListedTwelveWeek": 987.65,
  "uptimePercentAbsoluteTwelveWeek": 987.65,
  "margin": 987.65,
  "gpuCloudPrice": 987.65,
  "supportPublicIp": false,
  "secureCloud": false,
  "ownedByMe": false,
  "idleJobTemplateId": "xyz789",
  "idleJobTemplate": PodTemplate,
  "maintenanceStart": "2007-12-03T10:15:30Z",
  "maintenanceEnd": "2007-12-03T10:15:30Z",
  "maintenanceNote": "xyz789",
  "maintenanceMode": false,
  "note": "xyz789",
  "machineBalance": MachineBalance,
  "machineSystem": MachineSystem,
  "dataCenterId": "abc123",
  "machineType": "abc123",
  "lastBenchmark": MachineBenchmark,
  "upcomingMaintenances": [MachineMaintenance],
  "nextMaintenance": MachineMaintenance,
  "backgroundPodTelemetry": PodTelemetry,
  "latestTelemetry": MachineTelemetry,
  "uptime": MachineUptime,
  "runpodIp": "abc123",
  "publicIp": "xyz789"
}
Types

MachineBalance

Fields
Field Name Description
hostDiskEarnings - Float
hostGpuEarnings - Float
hostTotalEarnings - Float
Example
{
  "hostDiskEarnings": 987.65,
  "hostGpuEarnings": 123.45,
  "hostTotalEarnings": 987.65
}
Types

MachineBenchmark

Fields
Field Name Description
errors - String
benchmarkedAt - DateTime
gpuCount - Int
pod - BenchmarkPod
Example
{
  "errors": "xyz789",
  "benchmarkedAt": "2007-12-03T10:15:30Z",
  "gpuCount": 987,
  "pod": BenchmarkPod
}
Types

MachineEarning

Fields
Field Name Description
name - String
date - DateTime
machineId - String
hostTotalEarnings - Float
hostGpuEarnings - Float
hostDiskEarnings - Float
Example
{
  "name": "abc123",
  "date": "2007-12-03T10:15:30Z",
  "machineId": "xyz789",
  "hostTotalEarnings": 123.45,
  "hostGpuEarnings": 123.45,
  "hostDiskEarnings": 987.65
}
Types

MachineMaintenance

Fields
Field Name Description
id - String
machineId - String
maintenanceStart - DateTime
maintenanceEnd - DateTime
maintenanceNote - String
Example
{
  "id": "xyz789",
  "machineId": "abc123",
  "maintenanceStart": "2007-12-03T10:15:30Z",
  "maintenanceEnd": "2007-12-03T10:15:30Z",
  "maintenanceNote": "xyz789"
}
Types

MachineSummary

Fields
Field Name Description
cpuTypeId - String
diskProfitPerHr - Float
displayName - String
gpuTotal - Int
gpuTypeId - String
id - String
listed - Int
machineType - String
onDemandPods - Int
podProfitPerHr - Float
spotPods - Int
gpuRented - Int
cpuRented - Int
vcpuTotal - Int
Example
{
  "cpuTypeId": "abc123",
  "diskProfitPerHr": 987.65,
  "displayName": "xyz789",
  "gpuTotal": 987,
  "gpuTypeId": "abc123",
  "id": "abc123",
  "listed": 123,
  "machineType": "abc123",
  "onDemandPods": 123,
  "podProfitPerHr": 987.65,
  "spotPods": 987,
  "gpuRented": 123,
  "cpuRented": 123,
  "vcpuTotal": 123
}
Types

MachineSystem

Fields
Field Name Description
os - String
cudaVersion - String
diskTotal - Int
diskFree - Int
dockerVersion - String
kernelVersion - String
Example
{
  "os": "xyz789",
  "cudaVersion": "xyz789",
  "diskTotal": 987,
  "diskFree": 123,
  "dockerVersion": "abc123",
  "kernelVersion": "xyz789"
}
Types

MachineTelemetry

Fields
Field Name Description
time - DateTime
cpuUtilization - Float
memoryUtilization - Float
averageGpuMetrics - GpuTelemetry
individualGpuMetrics - [GpuTelemetry]
Example
{
  "time": "2007-12-03T10:15:30Z",
  "cpuUtilization": 987.65,
  "memoryUtilization": 123.45,
  "averageGpuMetrics": GpuTelemetry,
  "individualGpuMetrics": [GpuTelemetry]
}
Types

MachineUptime

Fields
Field Name Description
error - String
lastSyncTimestamp - Int
seconds - Int
sysUptimeSeconds - Int
Example
{
  "error": "abc123",
  "lastSyncTimestamp": 123,
  "seconds": 123,
  "sysUptimeSeconds": 123
}
Types

NetworkStorageEarning

Fields
Field Name Description
date - DateTime
dailyNetworkVolumeEarn - Float
dataCenterId - String
runpodEarnings - Float
Example
{
  "date": "2007-12-03T10:15:30Z",
  "dailyNetworkVolumeEarn": 987.65,
  "dataCenterId": "xyz789",
  "runpodEarnings": 987.65
}
Types

NetworkStorageEarningInput

Fields
Input Field Description
granularity - String
Example
{"granularity": "abc123"}
Types

NetworkVolume

Fields
Field Name Description
id - String
name - String
size - Int
dataCenterId - String
dataCenter - DataCenter
Example
{
  "id": "abc123",
  "name": "xyz789",
  "size": 123,
  "dataCenterId": "xyz789",
  "dataCenter": DataCenter
}
Types

PageInfo

Fields
Field Name Description
endCursor - DateTime
hasNextPage - Boolean
Example
{
  "endCursor": "2007-12-03T10:15:30Z",
  "hasNextPage": false
}
Types

Pod

Fields
Field Name Description
lowestBidPriceToResume - Float
aiApiId - String
apiKey - String
consumerUserId - String
containerDiskInGb - Int
containerRegistryAuthId - String
costMultiplier - Float
costPerHr - Float!
createdAt - DateTime
adjustedCostPerHr - Float!
desiredStatus - PodStatus!
dockerArgs - String
dockerId - String
env - [String]
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
registry - PodRegistry
templateId - String
uptimeSeconds - Int
vcpuCount - Float!
version - Int
volumeEncrypted - Boolean!
volumeInGb - Float
volumeKey - String
volumeMountPath - String
lastStartedAt - DateTime
cpuFlavorId - String
machineType - String
slsVersion - Int
networkVolumeId - String
cpuFlavor - CpuFlavor
runtime - PodRuntime
machine - PodMachineInfo
latestTelemetry - PodTelemetry
endpoint - Endpoint
networkVolume - NetworkVolume
savingsPlans - [SavingsPlan]
Example
{
  "lowestBidPriceToResume": 123.45,
  "aiApiId": "xyz789",
  "apiKey": "abc123",
  "consumerUserId": "abc123",
  "containerDiskInGb": 987,
  "containerRegistryAuthId": "xyz789",
  "costMultiplier": 987.65,
  "costPerHr": 987.65,
  "createdAt": "2007-12-03T10:15:30Z",
  "adjustedCostPerHr": 987.65,
  "desiredStatus": "CREATED",
  "dockerArgs": "abc123",
  "dockerId": "xyz789",
  "env": ["abc123"],
  "gpuCount": 987,
  "gpuPowerLimitPercent": 987,
  "gpus": [Gpu],
  "id": "abc123",
  "imageName": "xyz789",
  "lastStatusChange": "xyz789",
  "locked": true,
  "machineId": "abc123",
  "memoryInGb": 123.45,
  "name": "abc123",
  "podType": "INTERRUPTABLE",
  "port": 1826,
  "ports": "abc123",
  "registry": PodRegistry,
  "templateId": "abc123",
  "uptimeSeconds": 987,
  "vcpuCount": 123.45,
  "version": 123,
  "volumeEncrypted": false,
  "volumeInGb": 123.45,
  "volumeKey": "abc123",
  "volumeMountPath": "xyz789",
  "lastStartedAt": "2007-12-03T10:15:30Z",
  "cpuFlavorId": "xyz789",
  "machineType": "abc123",
  "slsVersion": 123,
  "networkVolumeId": "abc123",
  "cpuFlavor": CpuFlavor,
  "runtime": PodRuntime,
  "machine": PodMachineInfo,
  "latestTelemetry": PodTelemetry,
  "endpoint": Endpoint,
  "networkVolume": NetworkVolume,
  "savingsPlans": [SavingsPlan]
}
Types

PodBidResumeInput

Fields
Input Field Description
podId - String!
gpuCount - Int!
bidPerGpu - Float!
Example
{
  "podId": "xyz789",
  "gpuCount": 987,
  "bidPerGpu": 987.65
}
Types

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
Example
{
  "podId": "abc123",
  "dockerArgs": "xyz789",
  "imageName": "xyz789",
  "env": [EnvironmentVariableInput],
  "port": 1826,
  "ports": "abc123",
  "containerDiskInGb": 123,
  "volumeInGb": 987,
  "volumeMountPath": "xyz789",
  "containerRegistryAuthId": "abc123"
}
Types

PodFilter

Fields
Input Field Description
podId - String!
Example
{"podId": "xyz789"}
Types

PodFindAndDeployOnDemandInput

Fields
Input Field Description
aiApiId - String
cloudType - CloudTypeEnum
containerDiskInGb - Int
countryCode - String
deployCost - Float
dockerArgs - String
env - [EnvironmentVariableInput]
gpuCount - Int
gpuTypeId - String
gpuTypeIdList - [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 - DateTime
supportPublicIp - Boolean
templateId - String
terminateAfter - DateTime
volumeInGb - Int
volumeKey - String
volumeMountPath - String
dataCenterId - String
savingsPlan - SavingsPlanInput
cudaVersion - String
allowedCudaVersions - [String]
instanceIds - [String]
computeType - ComputeType
Example
{
  "aiApiId": "abc123",
  "cloudType": "SECURE",
  "containerDiskInGb": 987,
  "countryCode": "xyz789",
  "deployCost": 123.45,
  "dockerArgs": "abc123",
  "env": [EnvironmentVariableInput],
  "gpuCount": 123,
  "gpuTypeId": "abc123",
  "gpuTypeIdList": ["abc123"],
  "imageName": "abc123",
  "minDisk": 123,
  "minDownload": 987,
  "minMemoryInGb": 123,
  "minUpload": 123,
  "minVcpuCount": 987,
  "name": "xyz789",
  "networkVolumeId": "xyz789",
  "port": 1826,
  "ports": "abc123",
  "startJupyter": false,
  "startSsh": true,
  "stopAfter": "2007-12-03T10:15:30Z",
  "supportPublicIp": true,
  "templateId": "abc123",
  "terminateAfter": "2007-12-03T10:15:30Z",
  "volumeInGb": 123,
  "volumeKey": "abc123",
  "volumeMountPath": "abc123",
  "dataCenterId": "abc123",
  "savingsPlan": SavingsPlanInput,
  "cudaVersion": "abc123",
  "allowedCudaVersions": ["abc123"],
  "instanceIds": ["xyz789"],
  "computeType": "CPU"
}
Types

PodMachineInfo

Fields
Field Name Description
id - String
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
Example
{
  "id": "xyz789",
  "costPerHr": 987.65,
  "currentPricePerGpu": 123.45,
  "diskMBps": 987,
  "gpuAvailable": 123,
  "gpuDisplayName": "xyz789",
  "gpuTypeId": "xyz789",
  "gpuType": GpuType,
  "listed": false,
  "location": "abc123",
  "machineType": "xyz789",
  "maintenanceEnd": "2007-12-03T10:15:30Z",
  "maintenanceNote": "abc123",
  "maintenanceStart": "2007-12-03T10:15:30Z",
  "maxDownloadSpeedMbps": 123,
  "maxUploadSpeedMbps": 123,
  "note": "xyz789",
  "podHostId": "xyz789",
  "runpodIp": "abc123",
  "secureCloud": false,
  "supportPublicIp": false,
  "minPodGpuCount": 987,
  "machineSystem": MachineSystem,
  "dataCenterId": "xyz789",
  "cpuTypeId": "abc123",
  "cpuType": CpuType,
  "cpuCount": 123,
  "vcpuTotal": 123,
  "vcpuReserved": 123.45,
  "memoryTotal": 123,
  "memoryReserved": 987.65
}
Types

PodRegistry

Fields
Field Name Description
auth - String
pass - String
url - String
user - String
username - String
Example
{
  "auth": "abc123",
  "pass": "xyz789",
  "url": "xyz789",
  "user": "abc123",
  "username": "xyz789"
}
Types

PodRentInterruptableInput

Fields
Input Field Description
bidPerGpu - Float
cloudType - CloudTypeEnum
containerDiskInGb - Int
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
dataCenterId - String
cudaVersion - String
allowedCudaVersions - [String]
Example
{
  "bidPerGpu": 123.45,
  "cloudType": "SECURE",
  "containerDiskInGb": 987,
  "countryCode": "xyz789",
  "dockerArgs": "abc123",
  "env": [EnvironmentVariableInput],
  "gpuCount": 123,
  "gpuTypeId": "xyz789",
  "imageName": "xyz789",
  "minDisk": 123,
  "minDownload": 123,
  "minMemoryInGb": 123,
  "minUpload": 123,
  "minVcpuCount": 123,
  "name": "abc123",
  "networkVolumeId": "xyz789",
  "port": 1826,
  "ports": "abc123",
  "startJupyter": true,
  "startSsh": true,
  "stopAfter": "xyz789",
  "supportPublicIp": false,
  "templateId": "xyz789",
  "terminateAfter": "abc123",
  "volumeInGb": 123,
  "volumeKey": "xyz789",
  "volumeMountPath": "abc123",
  "dataCenterId": "abc123",
  "cudaVersion": "abc123",
  "allowedCudaVersions": ["abc123"]
}
Types

PodResumeInput

Fields
Input Field Description
podId - String!
gpuCount - Int
syncMachine - Boolean
computeType - ComputeType
Example
{
  "podId": "abc123",
  "gpuCount": 987,
  "syncMachine": true,
  "computeType": "CPU"
}
Types

PodRuntime

Fields
Field Name Description
container - PodRuntimeContainer
gpus - [PodRuntimeGpus]
ports - [PodRuntimePorts]
uptimeInSeconds - Int
Example
{
  "container": PodRuntimeContainer,
  "gpus": [PodRuntimeGpus],
  "ports": [PodRuntimePorts],
  "uptimeInSeconds": 123
}
Types

PodRuntimeContainer

Fields
Field Name Description
cpuPercent - Int
memoryPercent - Int
Example
{"cpuPercent": 123, "memoryPercent": 987}
Types

PodRuntimeGpus

Fields
Field Name Description
id - String
gpuUtilPercent - Int
memoryUtilPercent - Int
Example
{
  "id": "xyz789",
  "gpuUtilPercent": 987,
  "memoryUtilPercent": 987
}
Types

PodRuntimePorts

Fields
Field Name Description
ip - String
isIpPublic - Boolean
privatePort - Int
publicPort - Int
type - String
Example
{
  "ip": "xyz789",
  "isIpPublic": true,
  "privatePort": 123,
  "publicPort": 987,
  "type": "abc123"
}
Types

PodStatus

Values
Enum Value Description

CREATED

RUNNING

RESTARTING

EXITED

PAUSED

DEAD

TERMINATED
Example
"CREATED"
Types

PodStopInput

Fields
Input Field Description
podId - String!
incrementVersion - Boolean
Example
{
  "podId": "abc123",
  "incrementVersion": true
}
Types

PodTelemetry

Fields
Field Name Description
state - String
time - DateTime
cpuUtilization - Float
memoryUtilization - Float
averageGpuMetrics - GpuTelemetry
individualGpuMetrics - [GpuTelemetry]
lastStateTransitionTimestamp - Int
Example
{
  "state": "abc123",
  "time": "2007-12-03T10:15:30Z",
  "cpuUtilization": 123.45,
  "memoryUtilization": 123.45,
  "averageGpuMetrics": GpuTelemetry,
  "individualGpuMetrics": [GpuTelemetry],
  "lastStateTransitionTimestamp": 123
}
Types

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
isServerless - Boolean
boundEndpointId - String
name - String
ports - String
readme - String
runtimeInMin - Int
startJupyter - Boolean
startScript - String
startSsh - Boolean
volumeInGb - Int
volumeMountPath - String
config - JSON
category - String
Example
{
  "advancedStart": false,
  "containerDiskInGb": 987,
  "containerRegistryAuthId": "abc123",
  "dockerArgs": "abc123",
  "earned": 123.45,
  "env": [EnvironmentVariable],
  "id": "abc123",
  "imageName": "xyz789",
  "isPublic": true,
  "isRunpod": false,
  "isServerless": true,
  "boundEndpointId": "xyz789",
  "name": "xyz789",
  "ports": "xyz789",
  "readme": "abc123",
  "runtimeInMin": 123,
  "startJupyter": false,
  "startScript": "xyz789",
  "startSsh": false,
  "volumeInGb": 123,
  "volumeMountPath": "abc123",
  "config": {},
  "category": "abc123"
}
Types

PodTerminateInput

Fields
Input Field Description
podId - String!
Example
{"podId": "xyz789"}
Types

PodType

Values
Enum Value Description

INTERRUPTABLE

RESERVED

BID

BACKGROUND
Example
"INTERRUPTABLE"
Types

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
1826
Types

SaveRegistryAuthInput

Fields
Input Field Description
name - String!
username - String!
password - String!
Example
{
  "name": "xyz789",
  "username": "xyz789",
  "password": "xyz789"
}
Types

SavingsPlan

Fields
Field Name Description
endTime - DateTime
startTime - DateTime
gpuType - GpuType
podId - String
gpuTypeId - String
pod - Pod
savingsPlanType - String
costPerHr - Float
upfrontCost - Float
planLength - String
Example
{
  "endTime": "2007-12-03T10:15:30Z",
  "startTime": "2007-12-03T10:15:30Z",
  "gpuType": GpuType,
  "podId": "xyz789",
  "gpuTypeId": "abc123",
  "pod": Pod,
  "savingsPlanType": "xyz789",
  "costPerHr": 987.65,
  "upfrontCost": 123.45,
  "planLength": "abc123"
}
Types

SavingsPlanInput

Fields
Input Field Description
planLength - String
upfrontCost - Float
Example
{
  "planLength": "abc123",
  "upfrontCost": 987.65
}
Types

Scope

Values
Enum Value Description

CSR_ADMIN

CSR_IMPERSONATION

CSR_READ

CSR_WRITE

TEAM_ADMIN

TEAM_DEV

TEAM_BILLING

TEAM_BASIC

HOST
Example
"CSR_ADMIN"
Types

Secret

Fields
Field Name Description
id - ID!
name - String!
createdAt - DateTime!
updatedAt - DateTime
description - String
lastRetrievedAt - DateTime
lastUpdatedAt - DateTime
Example
{
  "id": "4",
  "name": "xyz789",
  "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"
}
Types

Specifics

Fields
Field Name Description
stockStatus - String
securePrice - Float
slsPrice - Float
Example
{
  "stockStatus": "xyz789",
  "securePrice": 123.45,
  "slsPrice": 123.45
}
Types

SpecificsInput

Fields
Input Field Description
instanceId - String
dataCenterId - String
Example
{
  "instanceId": "xyz789",
  "dataCenterId": "abc123"
}
Types

SpendDetails

Fields
Field Name Description
localStoragePerHour - Float
networkStoragePerHour - Float
gpuComputePerHour - Float
Example
{
  "localStoragePerHour": 987.65,
  "networkStoragePerHour": 123.45,
  "gpuComputePerHour": 123.45
}
Types

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"
Types

StripeReloadTransaction

Fields
Field Name Description
id - String
mediumId - String
transactionCompletedAt - DateTime
receiptLink - String
amount - Float
medium - TransactionMedium
type - TransactionType
Example
{
  "id": "abc123",
  "mediumId": "abc123",
  "transactionCompletedAt": "2007-12-03T10:15:30Z",
  "receiptLink": "abc123",
  "amount": 987.65,
  "medium": "STRIPE",
  "type": "RELOAD"
}
Types

Team

Fields
Field Name Description
id - String
name - String
owner - User!
memberships - [TeamMembership!]
membership - TeamMembership
members - [TeamMembership!]
invites - [TeamInvite]
isOwner - Boolean
availableRoles - [String]
Example
{
  "id": "xyz789",
  "name": "abc123",
  "owner": User,
  "memberships": [TeamMembership],
  "membership": TeamMembership,
  "members": [TeamMembership],
  "invites": [TeamInvite],
  "isOwner": false,
  "availableRoles": ["abc123"]
}
Types

TeamInvite

Fields
Field Name Description
id - ID!
team - TeamInviteTeam!
role - TeamRole!
createdAt - DateTime!
expiresAt - DateTime!
Example
{
  "id": 4,
  "team": TeamInviteTeam,
  "role": "owner",
  "createdAt": "2007-12-03T10:15:30Z",
  "expiresAt": "2007-12-03T10:15:30Z"
}
Types

TeamInviteOwner

Fields
Field Name Description
email - String
Example
{"email": "xyz789"}
Types

TeamInviteTeam

Fields
Field Name Description
id - ID!
name - String
owner - TeamInviteOwner
Example
{
  "id": "4",
  "name": "abc123",
  "owner": TeamInviteOwner
}
Types

TeamMembership

Fields
Field Name Description
id - ID!
member - User!
team - Team!
scopes - JSON
createdAt - DateTime!
updatedAt - DateTime!
Example
{
  "id": 4,
  "member": User,
  "team": Team,
  "scopes": {},
  "createdAt": "2007-12-03T10:15:30Z",
  "updatedAt": "2007-12-03T10:15:30Z"
}
Types

TeamRole

Values
Enum Value Description

owner

admin

member

dev

billing

basic
Example
"owner"
Types

TeamScopes

Fields
Field Name Description
role - String
Example
{"role": "xyz789"}
Types

TransactionMedium

Values
Enum Value Description

STRIPE

CRYPTO

RUNPOD

COINBASE

WIRE

REFERRAL
Example
"STRIPE"
Types

TransactionType

Values
Enum Value Description

RELOAD

CREDIT

DEBIT

PAYOUT
Example
"RELOAD"
Types

User

Fields
Field Name Description
pods - [Pod]
machines - [Machine]
Arguments
input - UserMachinesFilter
machinesSummary - [MachineSummary]
id - String
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
input - EarningsCustomRangeInput
networkStorageEarnings - [NetworkStorageEarning]
Arguments
input - NetworkStorageEarningInput
underBalance - Boolean
minBalance - Float
stripeAutoReloadAmount - Int
stripeAutoPaymentThreshold - Int
spendDetails - SpendDetails
maxServerlessConcurrency - Int
clientLifetimeSpend - Float
referralId - String
datacenters - [DataCenter]
clientBalance - Float
hostBalance - Float
hostStripeLinked - Boolean
stripeAccountId - String
stripeReloadHistory - [StripeReloadTransaction]
dailyCharges - [ClientCreditCharge]!
referral - UserReferral!
pubKey - String
information - UserInformation
notifyPodsStale - Boolean
notifyPodsGeneral - Boolean
notifyLowBalance - Boolean
creditAlertThreshold - Float
notifyOther - Boolean
podTemplates - [PodTemplate]
creditCodes - [CreditCode]
endpoint - Endpoint
Arguments
id - String!
endpoints - [Endpoint]!
networkVolumes - [NetworkVolume]
teams - [Team]
ownedTeams - [Team]
team - Team
teamMembership - TeamMembership
teamScopes - TeamScopes
isTeam - Boolean
savingsPlans - [SavingsPlan]
serverlessDiscount - Discount
billing - UserBilling
Arguments
input - UserBillingInput!
csrRole - CsrRole
secrets - [Secret!]!
impersonations - [Impersonation]
activeImpersonation - Impersonation
apiKeys - [ApiKey!]
Example
{
  "pods": [Pod],
  "machines": [Machine],
  "machinesSummary": [MachineSummary],
  "id": "abc123",
  "authId": "xyz789",
  "email": "xyz789",
  "containerRegistryCreds": [ContainerRegistryAuth],
  "currentSpendPerHr": 123.45,
  "machineQuota": 123,
  "referralEarned": 123.45,
  "signedTermsOfService": true,
  "spendLimit": 987,
  "stripeSavedPaymentId": "abc123",
  "stripeSavedPaymentLast4": "abc123",
  "templateEarned": 987.65,
  "multiFactorEnabled": true,
  "machineEarnings": [MachineEarning],
  "machineEarningsCustomRange": [MachineEarning],
  "networkStorageEarnings": [NetworkStorageEarning],
  "underBalance": true,
  "minBalance": 123.45,
  "stripeAutoReloadAmount": 987,
  "stripeAutoPaymentThreshold": 123,
  "spendDetails": SpendDetails,
  "maxServerlessConcurrency": 123,
  "clientLifetimeSpend": 123.45,
  "referralId": "xyz789",
  "datacenters": [DataCenter],
  "clientBalance": 987.65,
  "hostBalance": 123.45,
  "hostStripeLinked": false,
  "stripeAccountId": "abc123",
  "stripeReloadHistory": [StripeReloadTransaction],
  "dailyCharges": [ClientCreditCharge],
  "referral": UserReferral,
  "pubKey": "abc123",
  "information": UserInformation,
  "notifyPodsStale": true,
  "notifyPodsGeneral": true,
  "notifyLowBalance": true,
  "creditAlertThreshold": 987.65,
  "notifyOther": true,
  "podTemplates": [PodTemplate],
  "creditCodes": [CreditCode],
  "endpoint": Endpoint,
  "endpoints": [Endpoint],
  "networkVolumes": [NetworkVolume],
  "teams": [Team],
  "ownedTeams": [Team],
  "team": Team,
  "teamMembership": TeamMembership,
  "teamScopes": TeamScopes,
  "isTeam": false,
  "savingsPlans": [SavingsPlan],
  "serverlessDiscount": Discount,
  "billing": UserBilling,
  "csrRole": "admin",
  "secrets": [Secret],
  "impersonations": [Impersonation],
  "activeImpersonation": Impersonation,
  "apiKeys": [ApiKey]
}
Types

UserBilling

Fields
Field Name Description
gpuCloud - [UserGpuCloudBilling]
cpuCloud - [UserCpuCloudBilling]
serverless - [UserServerlessBilling]
Arguments
input - UserServerlessBillingInput
runpodEndpoint - [UserRunpodEndpointBilling]
storage - [UserStorageBilling]
summary - [UserSummaryBilling]
Example
{
  "gpuCloud": [UserGpuCloudBilling],
  "cpuCloud": [UserCpuCloudBilling],
  "serverless": [UserServerlessBilling],
  "runpodEndpoint": [UserRunpodEndpointBilling],
  "storage": [UserStorageBilling],
  "summary": [UserSummaryBilling]
}
Types

UserBillingInput

Fields
Input Field Description
granularity - BillingGranularity
Example
{"granularity": "HOURLY"}
Types

UserCpuCloudBilling

Fields
Field Name Description
cpuFlavorId - String
time - DateTime
timeBilledSeconds - Int
amount - Float
Example
{
  "cpuFlavorId": "xyz789",
  "time": "2007-12-03T10:15:30Z",
  "timeBilledSeconds": 123,
  "amount": 987.65
}
Types

UserGpuCloudBilling

Fields
Field Name Description
gpuTypeId - String
time - DateTime
timeBilledSeconds - Int
amount - Float
Example
{
  "gpuTypeId": "xyz789",
  "time": "2007-12-03T10:15:30Z",
  "timeBilledSeconds": 987,
  "amount": 987.65
}
Types

UserInformation

Fields
Field Name Description
firstName - String
lastName - String
addressLine1 - String
addressLine2 - String
countryCode - String
companyName - String
companyIdentification - String
taxIdentification - String
Example
{
  "firstName": "xyz789",
  "lastName": "xyz789",
  "addressLine1": "xyz789",
  "addressLine2": "abc123",
  "countryCode": "abc123",
  "companyName": "abc123",
  "companyIdentification": "abc123",
  "taxIdentification": "xyz789"
}
Types

UserMachinesFilter

Fields
Input Field Description
start - Int
end - Int
Example
{"start": 123, "end": 987}
Types

UserReferral

Fields
Field Name Description
code - String!
currentMonth - UserReferralMonth
Example
{
  "code": "xyz789",
  "currentMonth": UserReferralMonth
}
Types

UserReferralMonth

Fields
Field Name Description
totalReferrals - Int
totalSpend - Int
Example
{"totalReferrals": 123, "totalSpend": 987}
Types

UserRunpodEndpointBilling

Fields
Field Name Description
time - DateTime
amount - Float
Example
{
  "time": "2007-12-03T10:15:30Z",
  "amount": 987.65
}
Types

UserServerlessBilling

Fields
Field Name Description
time - DateTime
amount - Float
timeBilledSeconds - Int
endpointId - String
gpuTypeId - String
instanceId - String
Example
{
  "time": "2007-12-03T10:15:30Z",
  "amount": 123.45,
  "timeBilledSeconds": 987,
  "endpointId": "abc123",
  "gpuTypeId": "xyz789",
  "instanceId": "xyz789"
}
Types

UserServerlessBillingGroupBy

Values
Enum Value Description

GPU_TYPE

ENDPOINT

INSTANCE_ID
Example
"GPU_TYPE"
Types

UserServerlessBillingInput

Fields
Input Field Description
groupBy - UserServerlessBillingGroupBy
Example
{"groupBy": "GPU_TYPE"}
Types

UserStorageBilling

Fields
Field Name Description
time - DateTime
amount - Float
diskSpaceBilledGB - Int
networkStorageDiskSpaceBilledGB - Int
networkStorageAmount - Float
gpuDiskSpaceBilledGB - Int
gpuStorageAmount - Float
cpuDiskSpaceBilledGB - Int
cpuStorageAmount - Float
slsDiskSpaceBilledGB - Int
slsStorageAmount - Float
Example
{
  "time": "2007-12-03T10:15:30Z",
  "amount": 987.65,
  "diskSpaceBilledGB": 987,
  "networkStorageDiskSpaceBilledGB": 987,
  "networkStorageAmount": 987.65,
  "gpuDiskSpaceBilledGB": 987,
  "gpuStorageAmount": 987.65,
  "cpuDiskSpaceBilledGB": 123,
  "cpuStorageAmount": 123.45,
  "slsDiskSpaceBilledGB": 987,
  "slsStorageAmount": 987.65
}
Types

UserSummaryBilling

Fields
Field Name Description
time - DateTime
gpuCloudAmount - Float
cpuCloudAmount - Float
serverlessAmount - Float
storageAmount - Float
runpodEndpointAmount - Float
Example
{
  "time": "2007-12-03T10:15:30Z",
  "gpuCloudAmount": 123.45,
  "cpuCloudAmount": 123.45,
  "serverlessAmount": 123.45,
  "storageAmount": 123.45,
  "runpodEndpointAmount": 123.45
}
Types

Void

Description

Represents NULL values

Types

WebhookRequestStatus

Fields
Field Name Description
time - DateTime
responses - [Int]
Example
{
  "time": "2007-12-03T10:15:30Z",
  "responses": [123]
}
Types

WebhookRequestsInput

Fields
Input Field Description
granularity - EndpointStatisticGranularity
Example
{"granularity": "LIVE"}
Types

WorkerState

Fields
Field Name Description
time - DateTime
initialized - Int
ready - Int
running - Int
throttled - Int
Example
{
  "time": "2007-12-03T10:15:30Z",
  "initialized": 123,
  "ready": 987,
  "running": 123,
  "throttled": 123
}
Types

WorkerStateInput

Fields
Input Field Description
granularity - EndpointStatisticGranularity
Example
{"granularity": "LIVE"}
Types

backgroundPodTelemetryInput

Fields
Input Field Description
machineId - String
gpuIndex - Int
Example
{"machineId": "xyz789", "gpuIndex": 123}