Get a specific workload.

GET

http://localhost:8080/api/v2/workloads/:WorkloadV2Id

GET

/api/v2/workloads/:WorkloadV2Id

curl http://localhost:8080/api/v2/workloads/WorkloadV2Id \
     -H "Authorization: Bearer <token>"

{
  "workload": {
    "metadata": {
      "name": "my-workload-name",
      "projectId": "1",
      "id": "string",
      "gvk": {
        "version": "v1",
        "kind": "Deployment",
        "group": "apps"
      },
      "projectName": "project-a",
      "clusterId": "71f69d83-ba66-4822-adf5-55ce55efd210",
      "tenantId": 1001,
      "departmentId": "2",
      "departmentName": "default",
      "createdAt": "2024-01-15T10:30:00Z",
      "createdBy": "user@run.ai",
      "updatedAt": "2024-01-15T10:35:00Z",
      "updatedBy": "user@run.ai",
      "priority": "string",
      "category": "string",
      "preemptibility": "preemptible",
      "configuration": {
        "mnnvl": "string",
        "userCredentials": {
          "sources": [
            {
              "ref": "my-hf-token-abc1234567"
            }
          ]
        }
      },
      "deletedAt": "2024-01-15T10:35:00Z",
      "deletedBy": "user@run.ai"
    },
    "desiredPhase": "Running",
    "workloadManifest": {
      "apiVersion": "apps/v1",
      "kind": "Deployment",
      "metadata": {
        "name": "my-app"
      },
      "spec": {
        "replicas": 1,
        "selector": {
          "matchLabels": {
            "app": "my-app"
          }
        },
        "template": {
          "metadata": {
            "labels": {
              "app": "my-app"
            }
          },
          "spec": {
            "containers": [
              {
                "image": "nginx:latest",
                "name": "app"
              }
            ]
          }
        }
      }
    },
    "rawManifest": {
      "apiVersion": "apps/v1",
      "kind": "Deployment",
      "metadata": {
        "name": "my-app"
      },
      "spec": {
        "replicas": 1,
        "selector": {
          "matchLabels": {
            "app": "my-app"
          }
        },
        "template": {
          "metadata": {
            "labels": {
              "app": "my-app"
            }
          },
          "spec": {
            "containers": [
              {
                "image": "nginx:latest",
                "name": "app"
              }
            ]
          }
        }
      }
    }
  },
  "syncInfo": {
    "status": "Queued",
    "message": "string"
  }
}

Retrieve details of a specific workload by ID

Authentication

AuthorizationBearer

Bearer authentication

Path parameters

WorkloadV2IdstringRequiredformat: "uuid"

Response

Successfully retrieved the workload

workloadobject

syncInfoobjectOptional

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

503

Service Unavailable Error