AMD Resource Manager API reference OpenAPI Swagger

AMD Resource Manager API Reference

This page documents the full AMD Resource Manager management API, which lets administrators manage clusters, organizations, projects, quotas, users, storage, secrets, and workloads programmatically. Every endpoint requires a Keycloak bearer token; see the Users and access documentation for how authentication and single sign-on are configured.

Interactive Swagger UI

Every Resource Manager deployment ships an interactive Swagger UI, which is the best way to try endpoints against a live environment:

• Swagger UI: https://<resource-manager-host>/docs

• Raw OpenAPI specification: https://<resource-manager-host>/openapi.json

Swagger UI includes a built-in Authorize button that performs the Keycloak OAuth2 flow, so you can sign in once and call endpoints directly from the browser. Obtain <resource-manager-host> from your platform administrator — the hostname is environment-specific.

What the API Covers

The management API is organized into the following capability groups:

• Clusters — register and inspect compute clusters and their capacity

• Organizations — manage organizations and teams

• Projects — manage projects, membership, and quotas

• Users — manage user accounts and access

• Storage — manage project storage

• Secrets — manage project-scoped secrets

• Workloads — submit and inspect workloads across the platform

Endpoint Reference

The complete endpoint and schema reference below is generated directly from the service’s OpenAPI specification, so it always matches the deployed API. All request and response bodies use camelCase field names.

Authentication

Security Schemes

Name	Type	Description	Scheme	Bearer Format
OpenIdAuthorization	openIdConnect

APIs

GET /v1/health

Perform a Health Check

Endpoint to perform a healthcheck on. Returns: HealthCheck: Returns a JSON response with the health status

Responses

200

Return HTTP Status Code 200 (OK)

HealthCheck

GET /v1/users

List users

List all active users. Requires platform administrator role. Returns user details including roles for user management workflows.

Responses

200

Successful Response

Users

POST /v1/users

Invite user

Send invitation to new user. Requires platform administrator role. Creates user account in Keycloak and sends email invitation. Foundation for user onboarding and access management.

Request Body

InviteUser

Responses

200

Successful Response

InvitedUser

422

Validation Error

HTTPValidationError

GET /v1/invited-users

List pending user invitations

List users with pending invitations who haven’t yet joined. Requires platform administrator role. Essential for tracking invitation status and managing onboarding workflows.

Responses

200

Successful Response

InvitedUsers

GET /v1/users/{user_id}

Get user details

Retrieve detailed information about a specific user including project memberships and roles. Requires platform administrator role. Used for user profile management and access auditing.

Parameters

Name	Type	Required	Description
user_id	string	True	The ID of the user to be retrieved

Responses

200

Successful Response

UserWithProjects

422

Validation Error

HTTPValidationError

DELETE /v1/users/{user_id}

Remove user

Permanently remove user and all associated projects. Requires platform administrator role. Removes Keycloak account and project memberships. Irreversible operation for offboarding workflows.

Parameters

Name	Type	Required	Description
user_id	string	True	The ID of the user to be deleted

Responses

204

Successful Response

422

Validation Error

HTTPValidationError

PUT /v1/users/{user_id}

Update user profile

Modify user profile information including name and contact details. Requires platform administrator role. Updates both local database and Keycloak identity provider for consistent user information.

Parameters

Name	Type	Required	Description
user_id	string	True	The ID of the user to update

Request Body

UserDetailsUpdate

Responses

204

Successful Response

422

Validation Error

HTTPValidationError

PUT /v1/users/{user_id}/roles

Assign user roles

Grant platform roles to user (Platform Administrator, etc.). Requires platform administrator role. Controls access to administrative functions and resource management capabilities.

Parameters

Name	Type	Required	Description
user_id	string	True	The ID of the user to add the role to

Request Body

UserRolesUpdate

Responses

204

Successful Response

422

Validation Error

HTTPValidationError

POST /v1/invited-users/{user_id}/resend-invitation

Resend user invitation

Resend invitation email to user with pending invitation status. Requires platform administrator role. Useful when original invitation emails are missed or expired during onboarding process.

Parameters

Name	Type	Required	Description
user_id	string	True	The ID of the user to resend invitation to

Responses

204

Successful Response

422

Validation Error

HTTPValidationError

GET /v1/organization

Get current organization details

Retrieves information about the current user’s organization.

Responses

200

Successful Response

OrganizationResponse

GET /v1/metrics/gpu_memory_utilization

Get GPU memory utilization timeseries

Retrieve GPU memory usage metrics across all organization clusters over time. Shows memory allocation patterns and utilization trends across the entire organization infrastructure. Critical for capacity planning and cost management.

Parameters

Name	Type	Required	Description
start	string	True
end	string	True
step		False

Responses

200

Successful Response

MetricsTimeseries

422

Validation Error

HTTPValidationError

GET /v1/metrics/gpu_device_utilization

Get GPU device utilization timeseries

Retrieve GPU compute utilization metrics across all organization clusters. Shows percentage of GPU compute capacity used across the entire organization infrastructure. Essential for resource optimization and capacity planning.

Parameters

Name	Type	Required	Description
start	string	True
end	string	True
step		False

Responses

200

Successful Response

MetricsTimeseries

422

Validation Error

HTTPValidationError

GET /v1/metrics/utilization

Get current cluster utilization

Get real-time GPU utilization and workload statistics across organization clusters. Provides immediate insights into resource usage, active workloads, and cluster health. Critical for operational monitoring and resource allocation decisions.

Responses

200

Successful Response

CurrentUtilization

GET /v1/clusters

List all accessible clusters

List GPU clusters accessible to the authenticated user. Platform administrators see all clusters with detailed resource information. Regular users see only clusters accessible through project memberships.

Responses

200

Successful Response

Clusters

POST /v1/clusters

Create a new cluster

Create a new GPU cluster for AI/ML workloads. Requires platform administrator role. Sets up infrastructure needed for running containerized workloads like training jobs, inference services, and development environments.

Request Body

ClusterIn

Responses

200

Successful Response

ClusterWithUserSecret

422

Validation Error

HTTPValidationError

GET /v1/clusters/stats

Get stats for all clusters

Retrieve aggregate statistics across all GPU clusters including total nodes, GPU counts, and resource utilization summaries. Platform administrators see statistics for all clusters. Regular users see statistics only for clusters accessible through their project memberships.

Responses

200

Successful Response

ClustersStats

GET /v1/clusters/{cluster_id}

Get detailed cluster information

Get detailed information about a specific cluster including resource allocation, node details, and workload distribution. Requires either platform administrator role or the user must belong to a project on the cluster.

Parameters

Name	Type	Required	Description
cluster_id	string	True	The ID of the cluster to be retrieved

Responses

200

Successful Response

ClusterWithResources

422

Validation Error

HTTPValidationError

PUT /v1/clusters/{cluster_id}

Update a cluster by ID

Update cluster configuration including name, description, and resource settings. Requires platform administrator role. Modifies cluster metadata without affecting running workloads.

Parameters

Name	Type	Required	Description
cluster_id	string	True	The ID of the cluster to be updated

Request Body

ClusterIn

Responses

200

Successful Response

ClusterWithResources

422

Validation Error

HTTPValidationError

DELETE /v1/clusters/{cluster_id}

Delete a cluster by ID

Remove a cluster from the platform. Requires platform administrator role. Deletes cluster configuration and associated metadata. Running workloads should be terminated before cluster deletion.

Parameters

Name	Type	Required	Description
cluster_id	string	True	The ID of the cluster to be deleted

Responses

204

Successful Response

422

Validation Error

HTTPValidationError

GET /v1/clusters/{cluster_id}/kube-config

Get the kubeconfig for the cluster as YAML string

Get the kubeconfig for accessing a specific cluster. This kubeconfig uses OIDC authentication via Keycloak with kubectl oidc-login plugin. The response contains a YAML string that can be displayed in the UI or saved as a file.

Parameters

Name	Type	Required	Description
cluster_id	string	True

Responses

200

Successful Response

ClusterKubeConfig

422

Validation Error

HTTPValidationError

GET /v1/clusters/{cluster_id}/nodes

Get all nodes for a cluster

List all compute nodes in a specific cluster with hardware details including GPU type, count, memory, and current status. Requires either platform administrator role or the user must belong to a project on the cluster.

Parameters

Name	Type	Required	Description
cluster_id	string	True

Responses

200

Successful Response

ClusterNodes

422

Validation Error

HTTPValidationError

GET /v1/clusters/{cluster_id}/nodes/{node_id}

Get a node for a cluster

Get a single compute node in a specific cluster with hardware details including GPU type, count, memory, and current status. Requires either platform administrator role or the user must belong to a project on the cluster.

Parameters

Name	Type	Required	Description
cluster_id	string	True
node_id	string	True	The ID of the node

Responses

200

Successful Response

ClusterNodeResponse

422

Validation Error

HTTPValidationError

GET /v1/clusters/{cluster_id}/nodes/{node_id}/metrics/pcie/bandwidth

Get PCIe bandwidth timeseries for a cluster node

Retrieve PCIe bandwidth usage over time for each GPU on a specific node. Supports time range via start/end query parameters (e.g. 1h, 24h, 7d). Requires either platform administrator role or the user must belong to a project on the cluster.

Parameters

Name	Type	Required	Description
cluster_id	string	True
node_id	string	True	The ID of the node
start	string	True
end	string	True
step		False

Responses

200

Successful Response

GpuDeviceSingleMetricResponse

422

Validation Error

HTTPValidationError

GET /v1/clusters/{cluster_id}/nodes/{node_id}/metrics/pcie/efficiency

Get PCIe efficiency timeseries for a cluster node

Retrieve PCIe efficiency (link speed / max speed as percentage) over time for each GPU on a specific node. Supports time range via start/end query parameters (e.g. 1h, 24h, 7d). Requires either platform administrator role or the user must belong to a project on the cluster.

Parameters

Name	Type	Required	Description
cluster_id	string	True
node_id	string	True	The ID of the node
start	string	True
end	string	True
step		False

Responses

200

Successful Response

GpuDeviceSingleMetricResponse

422

Validation Error

HTTPValidationError

GET /v1/clusters/{cluster_id}/projects

Get projects for the cluster

Get all projects in a specific cluster with resource allocation information. Shows GPU allocation, CPU allocation with percentages, and memory allocation with percentages. Requires either platform administrator role or the user must belong to a project on the cluster.

Parameters

Name	Type	Required	Description
cluster_id	string	True

Responses

200

Successful Response

ProjectsWithResourceAllocation

422

Validation Error

HTTPValidationError

GET /v1/clusters/{cluster_id}/workloads/stats

Get workload statistics for a specific cluster

Retrieve workload statistics for a specific cluster, including counts grouped by workload status (running, pending, failed, complete, etc.). Similar to project-level stats but aggregated across all projects in the cluster.

Parameters

Name	Type	Required	Description
cluster_id	string	True

Responses

200

Successful Response

WorkloadStatusStats

422

Validation Error

HTTPValidationError

GET /v1/clusters/{cluster_id}/workloads/metrics

Get cluster workload metrics

Retrieve comprehensive metrics for all workloads in a specific cluster. Includes resource usage, execution times, and performance statistics. Essential for cluster-level resource optimization and workload analysis.

Parameters

Name	Type	Required	Description
cluster_id	string	True	The unique ID of the cluster to retrieve workloads for
page	integer	False
pageSize	integer	False
sort		False
filter		False

Responses

200

Successful Response

WorkloadsWithMetrics

422

Validation Error

HTTPValidationError

GET /v1/clusters/{cluster_id}/metrics/gpu_device_utilization

Get cluster GPU utilization timeseries

Retrieve GPU compute utilization metrics for a specific cluster over time. Shows aggregate GPU usage across all workloads running on the cluster. Essential for cluster capacity planning and performance monitoring.

Parameters

Name	Type	Required	Description
cluster_id	string	True
start	string	True
end	string	True
step		False

Responses

200

Successful Response

MetricsTimeseries

422

Validation Error

HTTPValidationError

GET /v1/clusters/{cluster_id}/nodes/{node_id}/metrics/gpu-utilization/core-utilization

Get per-GPU core utilization timeseries for a cluster node

Retrieve GPU core activity (gpu_gfx_activity) percentage over time for each GPU device on the specified node. Returns per-device timeseries data. Requires cluster view access (platform administrator or project membership on the cluster).

Parameters

Name	Type	Required	Description
cluster_id	string	True
node_id	string	True	The ID of the node to get GPU utilization metrics for
start	string	True
end	string	True
step		False

Responses

200

Successful Response

GpuDeviceSingleMetricResponse

422

Validation Error

HTTPValidationError

GET /v1/clusters/{cluster_id}/nodes/{node_id}/metrics/gpu-utilization/memory-utilization

Get per-GPU VRAM utilization timeseries for a cluster node

Retrieve GPU VRAM utilization percentage over time for each GPU device on the specified node. Returns per-device timeseries data calculated as (used_vram / total_vram) * 100. Requires cluster view access (platform administrator or project membership on the cluster).

Parameters

Name	Type	Required	Description
cluster_id	string	True
node_id	string	True	The ID of the node to get GPU memory utilization metrics for
start	string	True
end	string	True
step		False

Responses

200

Successful Response

GpuDeviceSingleMetricResponse

422

Validation Error

HTTPValidationError

GET /v1/clusters/{cluster_id}/nodes/{node_id}/metrics/gpu-utilization/clock-speed

Get per-GPU system clock speed timeseries for a cluster node

Retrieve GPU system clock speed (MHz) over time for each GPU device on the specified node. Returns per-device timeseries data using the GPU_CLOCK_TYPE_SYSTEM clock type. Requires cluster view access (platform administrator or project membership on the cluster).

Parameters

Name	Type	Required	Description
cluster_id	string	True
node_id	string	True	The ID of the node to get GPU clock speed metrics for
start	string	True
end	string	True
step		False

Responses

200

Successful Response

GpuDeviceSingleMetricResponse

422

Validation Error

HTTPValidationError

GET /v1/clusters/{cluster_id}/nodes/{node_id}/metrics/power-usage

Get per-GPU power usage timeseries for a cluster node

Retrieve GPU power draw (watts) over time for each GPU device on the specified node. Returns per-device timeseries data from the gpu_package_power Prometheus metric. Requires cluster view access (platform administrator or project membership on the cluster).

Parameters

Name	Type	Required	Description
cluster_id	string	True
node_id	string	True	The ID of the node to get GPU power usage metrics for
start	string	True
end	string	True
step		False

Responses

200

Successful Response

GpuDeviceSingleMetricResponse

422

Validation Error

HTTPValidationError

GET /v1/clusters/{cluster_id}/nodes/{node_id}/metrics/temperature/junction

Get per-GPU junction temperature timeseries for a cluster node

Retrieve GPU junction temperature (Celsius) over time for each GPU device on the specified node. Returns per-device timeseries data from the gpu_junction_temperature Prometheus metric. Requires cluster view access (platform administrator or project membership on the cluster).

Parameters

Name	Type	Required	Description
cluster_id	string	True
node_id	string	True	The ID of the node to get GPU junction temperature metrics for
start	string	True
end	string	True
step		False

Responses

200

Successful Response

GpuDeviceSingleMetricResponse

422

Validation Error

HTTPValidationError

GET /v1/clusters/{cluster_id}/nodes/{node_id}/metrics/temperature/memory

Get per-GPU memory temperature timeseries for a cluster node

Retrieve GPU memory temperature (Celsius) over time for each GPU device on the specified node. Returns per-device timeseries data from the gpu_memory_temperature Prometheus metric. Requires cluster view access (platform administrator or project membership on the cluster).

Parameters

Name	Type	Required	Description
cluster_id	string	True
node_id	string	True	The ID of the node to get GPU memory temperature metrics for
start	string	True
end	string	True
step		False

Responses

200

Successful Response

GpuDeviceSingleMetricResponse

422

Validation Error

HTTPValidationError

GET /v1/clusters/{cluster_id}/nodes/{node_id}/gpu-devices

Get latest GPU device metrics for a cluster node

Retrieve the most recent snapshot of per-GPU device metrics on the specified node, including junction temperature, power consumption, VRAM utilization, and health status. Requires cluster view access (platform administrator or project membership on the cluster).

Parameters

Name	Type	Required	Description
cluster_id	string	True
node_id	string	True	The ID of the node to get GPU device metrics for

Responses

200

Successful Response

NodeGpuDevicesResponse

422

Validation Error

HTTPValidationError

GET /v1/clusters/{cluster_id}/nodes/{node_id}/workloads/metrics

Get workload metrics for a cluster node

Retrieve workloads that have GPU activity on the specified node, including per-workload GPU device assignments across the entire cluster. Useful for understanding which workloads consume resources on a node and which GPU devices they span. Restricted to platform administrators, as workloads may span projects the requesting user does not belong to.

Parameters

Name	Type	Required	Description
cluster_id	string	True	The ID of the cluster the node belongs to
node_id	string	True	The ID of the node to get workload metrics for

Responses

200

Successful Response

NodeWorkloadsWithMetrics

422

Validation Error

HTTPValidationError

POST /v1/workloads

Submit a new workload

Deploy a containerized workload (training, inference, workspace, or custom) to a GPU cluster. Requires active project with available quota, valid Kubernetes YAML manifest (max 2MB), and healthy cluster. Workload will be queued and scheduled based on resource availability.

Parameters

Name	Type	Required	Description
workloadType	string	False	Type of workload being submitted.
displayName	string	True	display name for the workload.
projectId	string	True	The ID of the project for the request

Request Body

Body_submit_workload

Responses

200

Successful Response

WorkloadResponse

422

Validation Error

HTTPValidationError

GET /v1/workloads

Get all workloads accessible to the user, optionally scoped by the specified project

List workloads accessible to the authenticated user. Can be filtered by project. Returns workload metadata including status, creation time, and resource requests. Results limited to projects where the user has membership.

Parameters

Name	Type	Required	Description
projectId		False	The ID of the project for which to retrieve workloads

Responses

200

Successful Response

Workloads

422

Validation Error

HTTPValidationError

DELETE /v1/workloads/{workload_id}

Delete a submitted workload

Terminate and remove a workload from the cluster. Sends deletion request to the cluster Agent which handles graceful shutdown. Requires project membership and workload ownership or administrator role.

Parameters

Name	Type	Required	Description
workload_id	string	True	The ID of the workload to be deleted

Responses

204

Successful Response

422

Validation Error

HTTPValidationError

GET /v1/workloads/{workload_id}

Get a workload by ID, including its components

Retrieve detailed information about a specific workload including status, resource allocation, and component details (pods, services). Requires project membership for the workload’s project.

Parameters

Name	Type	Required	Description
workload_id	string	True

Responses

200

Successful Response

WorkloadWithComponents

422

Validation Error

HTTPValidationError

GET /v1/workloads/stats

Get workload stats

Retrieve aggregate workload statistics across accessible clusters including counts by status (running, pending, completed, failed). Platform administrators see statistics for all clusters. Regular users see statistics only for clusters accessible through their project memberships.

Responses

200

Successful Response

WorkloadsStats

GET /v1/workloads/{workload_id}/metrics/gpu-devices/vram-utilization

Get per-GPU VRAM utilization for a workload

Retrieve VRAM utilization percentage over time for each GPU device of a workload. Platform administrators can access any workload; regular users only workloads in projects they belong to.

Parameters

Name	Type	Required	Description
workload_id	string	True
start	string	True
end	string	True
step		False

Responses

200

Successful Response

GpuDeviceSingleMetricResponse

422

Validation Error

HTTPValidationError

GET /v1/workloads/{workload_id}/metrics/gpu-devices/gpu-utilization

Get per-GPU utilization for a workload

Retrieve GPU core activity percentage over time for each GPU device of a workload. Platform administrators can access any workload; regular users only workloads in projects they belong to.

Parameters

Name	Type	Required	Description
workload_id	string	True
start	string	True
end	string	True
step		False

Responses

200

Successful Response

GpuDeviceSingleMetricResponse

422

Validation Error

HTTPValidationError

GET /v1/workloads/{workload_id}/metrics/gpu-devices/power-usage

Get per-GPU power usage for a workload

Retrieve GPU power draw (watts) over time for each GPU device of a workload. Platform administrators can access any workload; regular users only workloads in projects they belong to.

Parameters

Name	Type	Required	Description
workload_id	string	True
start	string	True
end	string	True
step		False

Responses

200

Successful Response

GpuDeviceSingleMetricResponse

422

Validation Error

HTTPValidationError

GET /v1/workloads/{workload_id}/metrics

Get workload information card details

Retrieve static workload details for the information cards, including basic information, cluster and resources, and timeline data. Requires project membership for the workload’s project.

Parameters

Name	Type	Required	Description
workload_id	string	True

Responses

200

Successful Response

WorkloadMetricsDetailsResponse

422

Validation Error

HTTPValidationError

GET /v1/projects/submittable

List projects where user can submit workloads

List projects where the authenticated user can submit workloads. Regular users see only projects they’re members of, platform administrators see all projects. Project membership determines workload submission rights.

Responses

200

Successful Response

Projects

GET /v1/projects

List all accessible projects

List all projects with resource allocation and quota information. Shows GPU allocation, CPU allocation with percentages, and memory allocation with percentages. Platform administrators see all projects in the platform. Regular users see all projects in clusters they have access to.

Responses

200

Successful Response

ProjectsWithResourceAllocation

POST /v1/projects

Create a new project

Create a new project with resource quotas on a specified cluster. Requires platform administrator role. Projects provide isolated environments for organizing workloads and managing team access.

Request Body

ProjectCreate

Responses

200

Successful Response

ProjectResponse

422

Validation Error

HTTPValidationError

GET /v1/projects/{project_id}

Get a project by ID

Retrieve detailed project information including members, resource quotas, and cluster assignment. Requires project membership or platform administrator role.

Parameters

Name	Type	Required	Description
project_id	string	True

Responses

200

Successful Response

ProjectWithUsers

422

Validation Error

HTTPValidationError

PUT /v1/projects/{project_id}

Update a project

Update project configuration including name, description, and resource quotas. Requires platform administrator role. Modifies project settings without affecting running workloads.

Parameters

Name	Type	Required	Description
project_id	string	True	The ID of the project to be updated

Request Body

ProjectEdit

Responses

200

Successful Response

ProjectResponse

422

Validation Error

HTTPValidationError

DELETE /v1/projects/{project_id}

Delete a project

Remove a project and its associated resources. Requires platform administrator role. All workloads in the project should be terminated before deletion.

Parameters

Name	Type	Required	Description
project_id	string	True	The ID of the project to be deleted

Responses

204

Successful Response

422

Validation Error

HTTPValidationError

POST /v1/projects/{project_id}/users

Add existing users to a project

Grant project membership to existing platform users. Requires platform administrator role. Members can submit workloads and access project resources.

Parameters

Name	Type	Required	Description
project_id	string	True	The ID of the project to which users are to be added

Request Body

ProjectAddUsers

Responses

204

Successful Response

422

Validation Error

HTTPValidationError

DELETE /v1/projects/{project_id}/users/{user_id}

Remove a user from a project

Revoke project membership from a user. Requires platform administrator role. User will lose access to project resources and workload submission rights.

Parameters

Name	Type	Required	Description
project_id	string	True	The ID of the project from which the user is to be removed
user_id	string	True	The ID of the user to be removed from the project

Responses

204

Successful Response

422

Validation Error

HTTPValidationError

GET /v1/projects/{project_id}/workloads

Get workloads for the cluster

List all workloads in a specific project with status and resource information. Requires project membership or platform administrator role.

Parameters

Name	Type	Required	Description
project_id	string	True	The ID of the project for which to retrieve workloads

Responses

200

Successful Response

Workloads

422

Validation Error

HTTPValidationError

GET /v1/projects/{project_id}/workloads/stats

Get workload statistics for a specific project

Retrieve workload counts grouped by status (running, pending, completed, failed) for a specific project. Requires project membership or platform administrator role.

Parameters

Name	Type	Required	Description
project_id	string	True

Responses

200

Successful Response

WorkloadStatusStats

422

Validation Error

HTTPValidationError

GET /v1/projects/{project_id}/metrics/gpu_device_utilization

Get project GPU utilization timeseries

Retrieve GPU compute utilization metrics for a specific project over time. Shows percentage of GPU compute capacity used by project workloads during specified time period. Essential for resource planning and cost optimization.

Parameters

Name	Type	Required	Description
project_id	string	True
start	string	True	The start timestamp for the timeseries
end	string	True	The end timestamp for the timeseries

Responses

200

Successful Response

MetricsTimeseries

422

Validation Error

HTTPValidationError

GET /v1/projects/{project_id}/metrics/gpu_memory_utilization

Get project GPU memory timeseries

Retrieve GPU memory usage metrics for a specific project over time. Shows memory allocation and utilization patterns for project workloads. Critical for understanding memory requirements and optimizing resource allocation.

Parameters

Name	Type	Required	Description
project_id	string	True
start	string	True
end	string	True
step		False

Responses

200

Successful Response

MetricsTimeseries

422

Validation Error

HTTPValidationError

GET /v1/projects/{project_id}/workloads/metrics

Get project workload metrics

Retrieve comprehensive metrics for all workloads in a specific project. Includes resource usage, execution times, and performance statistics. Essential for project-level resource optimization and workload analysis.

Parameters

Name	Type	Required	Description
project_id	string	True
page	integer	False
pageSize	integer	False
sort		False
filter		False

Responses

200

Successful Response

WorkloadsWithMetrics

422

Validation Error

HTTPValidationError

GET /v1/projects/{project_id}/metrics/average_wait_time

Get project average wait time

Calculate average workload queue wait time for a project over specified period. Measures time from workload submission to execution start. Key indicator for resource availability and queue efficiency within the project.

Parameters

Name	Type	Required	Description
project_id	string	True
start	string	True
end	string	True
step		False

Responses

200

Successful Response

MetricsScalarWithRange

422

Validation Error

HTTPValidationError

GET /v1/projects/{project_id}/metrics/average_gpu_idle_time

Get project GPU idle time

Calculate average GPU idle time for a project over specified period. Measures unused GPU capacity within allocated resources. Helps identify optimization opportunities and resource allocation efficiency.

Parameters

Name	Type	Required	Description
project_id	string	True
start	string	True
end	string	True
step		False

Responses

200

Successful Response

MetricsScalarWithRange

422

Validation Error

HTTPValidationError

GET /v1/projects/{project_id}/secrets

Retrieve secrets for a specific project

List all secrets assigned to a specific project including both project-scoped and inherited organization secrets. Requires project membership or platform administrator role.

Parameters

Name	Type	Required	Description
project_id	string	True
useCase		False	Filter secrets by use case
secretType		False	Filter secrets by type

Responses

200

Successful Response

ProjectSecretsWithParentSecret

422

Validation Error

HTTPValidationError

POST /v1/projects/{project_id}/secrets

Create a new project-scoped secret

Create a new secret scoped to a specific project. Requires project membership or platform administrator role. Project-scoped secrets are only accessible to workloads within that project.

Parameters

Name	Type	Required	Description
project_id	string	True	The ID of the project to create the secret in

Request Body

ProjectSecretIn

Responses

200

Successful Response

SecretWithProjects

422

Validation Error

HTTPValidationError

PUT /v1/projects/{project_id}/secrets/{secret_id}/assign

Assign secret for a specific project

Assign an organization-level secret to a project making it available for workloads in that project. Requires platform administrator role.

Parameters

Name	Type	Required	Description
project_id	string	True	The unique ID of the project to retrieve secrets for
secret_id	string	True	The ID of the secret to be assigned to the project

Responses

204

Successful Response

422

Validation Error

HTTPValidationError

DELETE /v1/projects/{project_id}/secrets/{secret_id}

Delete secret for a specific project

Remove a secret assignment from a project. For project-scoped secrets, deletes the secret. For inherited secrets, removes the assignment. Requires project membership or platform administrator role.

Parameters

Name	Type	Required	Description
project_id	string	True	The unique ID of the project to retrieve secrets for
secret_id	string	True	The ID of the secret to be unassigned from the project

Responses

204

Successful Response

422

Validation Error

HTTPValidationError

GET /v1/projects/{project_id}/storages

Retrieve storages for a specific project

List all storage volumes assigned to a specific project including both project-scoped and inherited organization storages. Requires project membership or platform administrator role.

Parameters

Name	Type	Required	Description
project_id	string	True

Responses

200

Successful Response

ProjectStoragesWithParentStorage

422

Validation Error

HTTPValidationError

PUT /v1/projects/{project_id}/storages/{storage_id}/assign

Assign storage for a specific project

Assign an organization-level storage volume to a project making it available for workloads in that project. Requires platform administrator role.

Parameters

Name	Type	Required	Description
project_id	string	True	The unique ID of the project to assign a storage to
storage_id	string	True	The ID of the storage to be assigned to the project

Responses

204

Successful Response

422

Validation Error

HTTPValidationError

DELETE /v1/projects/{project_id}/storages/{storage_id}

Delete storage for a specific project

Remove a storage assignment from a project. Removes the storage-project association. Requires platform administrator role.

Parameters

Name	Type	Required	Description
project_id	string	True	The unique ID of the project to retrieve storages for
storage_id	string	True	The ID of the storage to be unassigned from the project

Responses

204

Successful Response

422

Validation Error

HTTPValidationError

GET /v1/secrets

Get secrets for the user’s organization

List all secrets, project and organization scoped. Requires platform administrator role. Returns secret metadata without exposing actual secret values.

Responses

200

Successful Response

Secrets

POST /v1/secrets

Create a new secret

Create a new organization-level secret that can be assigned to projects. Requires platform administrator role. Secrets are stored securely and can be mounted into workload containers.

Request Body

OrganizationSecretIn

Responses

200

Successful Response

SecretWithProjects

422

Validation Error

HTTPValidationError

DELETE /v1/secrets/{secret_id}

Delete a secret

Remove an organization-level secret. Requires platform administrator role. Removes all project assignments and deletes the secret from secure storage.

Parameters

Name	Type	Required	Description
secret_id	string	True	The ID of the secret to be deleted

Responses

204

Successful Response

422

Validation Error

HTTPValidationError

PUT /v1/secrets/{secret_id}/assign

Assign a secret to a project

Update project assignments for a secret. Requires platform administrator role. Specify project IDs to grant access; projects not listed will lose access.

Parameters

Name	Type	Required	Description
secret_id	string	True	The ID of the secret to be assigned

Request Body

ProjectAssignments

Responses

200

Successful Response

422

Validation Error

HTTPValidationError

GET /v1/storages

Get storages in the system

List all organization-level storage volumes. Requires platform administrator role. Returns storage metadata including name, type, and project assignments.

Responses

200

Successful Response

Storages

POST /v1/storages

Create a new storage

Create a new organization-level storage volume that can be assigned to projects. Requires platform administrator role. Storage can be mounted into workload containers for persistent data access.

Request Body

StorageIn

Responses

200

Successful Response

StorageWithProjects

422

Validation Error

HTTPValidationError

DELETE /v1/storages/{storage_id}

Delete a storage

Remove an organization-level storage volume. Requires platform administrator role. Removes all project assignments and deletes the storage configuration.

Parameters

Name	Type	Required	Description
storage_id	string	True	The ID of the storage to be deleted

Responses

204

Successful Response

422

Validation Error

HTTPValidationError

PUT /v1/storages/{storage_id}/assign

Assign a storage to a project

Update project assignments for a storage volume. Requires platform administrator role. Specify project IDs to grant access; projects not listed will lose access.

Parameters

Name	Type	Required	Description
storage_id	string	True	The ID of the storage to be assigned

Request Body

ProjectAssignments

Responses

200

Successful Response

422

Validation Error

HTTPValidationError

Components

AIMServiceStatus

Body_submit_workload

Field	Type	Description
manifest	string	The YAML file to be uploaded.

ClusterIn

Field	Type	Description
workbenchBaseUrl		The Workbench base URL of the cluster.
kubeApiUrl		The kube-api URL of the cluster

ClusterKubeConfig

Field	Type	Description
kubeConfig	string	Kubeconfig in YAML format

ClusterNodeResponse

Field	Type	Description
id	string	The ID of the node.
name	string	The name of the node.
cpuMilliCores	integer	The number of CPU milli-cores available in the node.
memoryBytes	integer	The total memory in bytes.
ephemeralStorageBytes	integer	The total ephemeral storage in bytes.
gpuCount	integer	The number of GPUs available in the node.
gpuInfo		The GPU information available in the node.
updatedAt	string	The timestamp the node was last updated.
status	string	The status of the node.

ClusterNodes

Field	Type	Description
data	array

ClusterResources

Field	Type	Description
cpuMilliCores	integer	The number of CPUs.
memoryBytes	integer	The total memory in bytes.
ephemeralStorageBytes	integer	The total ephemeral storage in bytes.
gpuCount	integer	The number of GPUs.

ClusterResponse

Field	Type	Description
id	string
createdAt	string
updatedAt	string
createdBy
updatedBy
workbenchBaseUrl		The Workbench base URL of the cluster.
kubeApiUrl		The kube-api URL of the cluster
name		The name of the cluster
lastHeartbeatAt		The heartbeat timestamp of the cluster.
status

ClusterStatus

ClusterWithResources

Field	Type	Description
id	string
createdAt	string
updatedAt	string
createdBy
updatedBy
workbenchBaseUrl		The Workbench base URL of the cluster.
kubeApiUrl		The kube-api URL of the cluster
name		The name of the cluster
lastHeartbeatAt		The heartbeat timestamp of the cluster.
availableResources		The available resources in the cluster.
allocatedResources		The allocated resources in the cluster.
totalNodeCount	integer	The total number of nodes in the cluster.
availableNodeCount	integer	The number of available nodes in the cluster.
assignedQuotaCount	integer	The number of quotas assigned to the cluster.
gpuInfo		The GPU information available in the cluster
status
priorityClasses	array	The priority classes available in the cluster.
gpuAllocationPercentage	number	GPU allocation percentage.
cpuAllocationPercentage	number	CPU allocation percentage.
memoryAllocationPercentage	number	Memory allocation percentage.

ClusterWithUserSecret

Field	Type	Description
id	string
createdAt	string
updatedAt	string
createdBy
updatedBy
workbenchBaseUrl		The Workbench base URL of the cluster.
kubeApiUrl		The kube-api URL of the cluster
name		The name of the cluster
lastHeartbeatAt		The heartbeat timestamp of the cluster.
userSecret	string	Secret to access a cluster’s virtual host in RabbitMQ.
status

Clusters

Field	Type	Description
data	array

ClustersStats

Field	Type	Description
totalClusterCount	integer	The total number of clusters.
totalNodeCount	integer	The total number of nodes across all clusters.
availableNodeCount	integer	The number of available nodes across all clusters.
totalGpuNodeCount	integer	The total number of GPU nodes across all clusters.
totalGpuCount	integer	The total number of GPUs across all clusters.
availableGpuCount	integer	The number of available GPUs across all clusters.
allocatedGpuCount	integer	The number of allocated GPUs across all clusters.

CommonComponentStatus

Common status values shared by all component types. These represent fundamental states that apply regardless of component kind.

ConfigMapStatus

CronJobStatus

CurrentUtilization

Field	Type	Description
timestamp	string	The timestamp of the current utilization data.
utilizationByProject	array	The GPU utilization by project.
totalUtilizedGpusCount	integer	The number of GPUs currently in use.
totalRunningWorkloadsCount	integer	The number of running workloads.
totalPendingWorkloadsCount	integer	The number of pending workloads.

DaemonSetStatus

Datapoint

Field	Type	Description
value		The value of the datapoint.
timestamp	string	The timestamp of the datapoint.

DatapointMetadataBase

Field	Type	Description
label	string	The label for the series that the datapoint belongs to.

DatapointsWithMetadata

Field	Type	Description
metadata		Metadata for the datapoints.
values	array	The list of datapoints corresponding to the metadata.

DateRange

Field	Type	Description
start	string	Start of the requested time range.
end	string	End of the requested time range.

DeploymentStatus

DeviceDatapointMetadata

Field	Type	Description
label	string	The label for the series that the datapoint belongs to.
gpuUuid	string	The unique identifier of the GPU device.
hostname	string	The hostname of the node the GPU is on.

DeviceMetricTimeseries

Field	Type	Description
seriesLabel	string	Label identifying this metric series.
values	array	Timeseries datapoints.

GPUInfo

Field	Type	Description
vendor		The vendor of the GPU(s) available.
type	string	The type of GPU available.
memoryBytesPerDevice	integer	The available GPU memory in bytes, per GPU.
name	string	The name of the GPU available.

GPUVendor

GpuDeviceSingleMetricResponse

Response for a single GPU device metric (VRAM utilization, GPU utilization, or power usage).

Field	Type	Description
gpuDevices	array	Per-GPU device timeseries for this metric.
range		The requested time range.

GpuDeviceWithSingleMetric

Per-GPU device with a single timeseries metric (for dedicated metric endpoints).

Field	Type	Description
gpuUuid	string	The unique identifier of the GPU device.
gpuId	string	The GPU device index identifier.
hostname	string	The hostname of the node the GPU is on.
metric		The timeseries for this metric.

GpuPreemptionConfig

Field	Type	Description
enabled	boolean	Whether GPU preemption is enabled for this project.
threshold		GPU utilization threshold (0-100%) that triggers preemption.
gracePeriod		Grace period in seconds before preemption takes effect. Must be a multiple of 60 so values align with the UI (whole minutes).
policy		The GPU preemption policy.

GpuPreemptionPolicy

HTTPRouteStatus

HTTPValidationError

Field	Type	Description
detail	array

HealthCheck

Response model to validate and return when performing a health check.

Field	Type	Description
status	string

IngressStatus

InviteUser

Field	Type	Description
email	string	The user’s email/user name
roles	array	The roles to be assigned to the user
projectIds		The IDs of the project to be assigned to the user.
temporaryPassword		The temporary password to be set for the user

InvitedUser

Field	Type	Description
id	string
createdAt	string
updatedAt	string
createdBy
updatedBy
email	string	The user’s email/user name
role	string	The highest role the user has
invitedAt	string	The timestamp the user was invited
invitedBy	string	The user who invited this user

InvitedUsers

Field	Type	Description
data	array

JobStatus

KaiwoJobStatus

KaiwoServiceStatus

MetricsScalarWithRange

Represents a scalar metric value aggregated over a time range. Used for metrics computed over a specified range.

Field	Type	Description
data	number	The scalar metric value.
range		The range for which the scalar metric was computed.

MetricsTimeRange

Validated start/end time range for metrics queries.

Field	Type	Description
start	string	Start time. ISO 8601 with timezone (e.g. UTC: …Z or +00:00).
end	string	End time. ISO 8601 with timezone (e.g. UTC: …Z or +00:00).
step		Interval in seconds between returned datapoints. If not provided, a suitable interval is determined automatically from the time range.

MetricsTimeseries

Field	Type	Description
data	array	The metrics timeseries data points.
range		The range of the timeseries.

NodeGpuDevice

Snapshot of a single GPU device on a cluster node with its latest metric values.

Field	Type	Description
gpuUuid	string	The unique identifier of the GPU device.
gpuId	string	The GPU device index identifier.
productName		The GPU product name (e.g. Instinct MI300).
temperature		Junction temperature in Celsius.
powerConsumption		Power draw in Watts.
vramUtilization		VRAM utilization percentage (0-100).
lastUpdated		Timestamp of the most recent metric datapoint.

NodeGpuDevicesResponse

Response containing the latest GPU device metrics for a cluster node.

Field	Type	Description
gpuDevices	array	Per-GPU device snapshot metrics.

NodeWorkloadWithMetrics

Workload with metrics and GPU device details, used for node-scoped workload listings.

Field	Type	Description
id	string
createdAt		The timestamp of when the workload was created.
updatedAt	string
createdBy	string	The user who created the workload.
updatedBy
projectId	string	The ID of the project
clusterId	string	The ID of the cluster
status		The status of the workload
displayName		The display name of the workload
type		The type of the workload
gpuCount	integer	The number of GPU devices the workload is using.
vram	number	The amount of VRAM used by the workload in megabytes.
gpuDevices	array	All GPU devices the workload runs on across the cluster.

NodeWorkloadsWithMetrics

Response for workloads running on a specific node.

Field	Type	Description
data	array	Workloads with GPU activity on the node.

OrganizationResponse

Field	Type	Description
idpLinked	boolean	Whether the organization has an identity provider linked
smtpEnabled	boolean	Whether the organization has an SMTP server enabled

OrganizationSecretIn

Field	Type	Description
name	string	The name of the secret.
type		The type of the secret
scope		The scope of the secret
manifest	string	The YAML contents of the Kubernetes manifest.
useCase		Optional use case classification for the secret.
projectIds	array	List of project IDs to assign the secret

PodStatus

PriorityClass

Field	Type	Description
name	string	The name of the priority class
priority	integer	The priority value (0-100)

ProjectAddUsers

Field	Type	Description
userIds	array	The IDs of the users to be added to the project.

ProjectAssignment

Field	Type	Description
id	string
createdAt	string
updatedAt	string
createdBy
updatedBy
project		The project information
status	string	The status of the project assignment.
statusReason		Details if any about the status

ProjectAssignments

Field	Type	Description
projectIds	array	List of project IDs to assign the resource to.

ProjectCreate

Field	Type	Description
name	string	The name of the project.
description	string	The description of the project.
clusterId	string	The cluster ID the project belongs to
quota		The quota for the project.
gpuPreemption		GPU preemption configuration.

ProjectDatapointMetadata

Field	Type	Description
label	string	The label for the series that the datapoint belongs to.
project		The project the datapoint corresponds to

ProjectEdit

Field	Type	Description
description	string	The description of the project.
quota		The quota for the project.
gpuPreemption		GPU preemption configuration.

ProjectResponse

Field	Type	Description
id	string
createdAt	string
updatedAt	string
createdBy
updatedBy
name	string	The name of the project.
description	string	The description of the project.
clusterId	string	The cluster ID the project belongs to
status		The status of the project.
statusReason		The reason for the project’s status.
gpuPreemption		GPU preemption configuration.

ProjectSecretIn

Field	Type	Description
name	string	The name of the secret.
type		The type of the secret
scope		The scope of the secret
manifest	string	The YAML contents of the Kubernetes manifest.
useCase		Optional use case classification for the secret.

ProjectSecretWithParentSecret

Field	Type	Description
id	string
createdAt	string
updatedAt	string
createdBy
updatedBy
project		The project information
status	string	The status of the project assignment.
statusReason		Details if any about the status
secret		The parent secret associated with the project secret.

ProjectSecretsWithParentSecret

Field	Type	Description
data	array	The secrets in a given project.

ProjectStatus

ProjectStorageWithParentStorage

Field	Type	Description
id	string
createdAt	string
updatedAt	string
createdBy
updatedBy
project		The project information
status	string	The status of the project assignment.
statusReason		Details if any about the status
storage		The parent secret associated with the project storage.

ProjectStoragesWithParentStorage

Field	Type	Description
data	array	The storages in a given project.

ProjectWithClusterAndQuota

Field	Type	Description
id	string
createdAt	string
updatedAt	string
createdBy
updatedBy
name	string	The name of the project.
description	string	The description of the project.
clusterId	string	The cluster ID the project belongs to
status		The status of the project.
statusReason		The reason for the project’s status.
gpuPreemption		GPU preemption configuration.
quota		The quota assigned to the project.
cluster		The cluster the project belongs to.

ProjectWithResourceAllocation

Field	Type	Description
id	string
createdAt	string
updatedAt	string
createdBy
updatedBy
name	string	The name of the project.
description	string	The description of the project.
clusterId	string	The cluster ID the project belongs to
status		The status of the project.
statusReason		The reason for the project’s status.
gpuPreemption		GPU preemption configuration.
quota		The quota assigned to the project.
cluster		The cluster the project belongs to with resource information.
gpuAllocationPercentage	number	GPU allocation percentage.
gpuAllocationExceeded	boolean	True if GPU allocation exceeds available resources.
cpuAllocationPercentage	number	CPU allocation percentage.
cpuAllocationExceeded	boolean	True if CPU allocation exceeds available resources.
memoryAllocationPercentage	number	Memory allocation percentage.
memoryAllocationExceeded	boolean	True if memory allocation exceeds available resources.

ProjectWithUsers

Field	Type	Description
id	string
createdAt	string
updatedAt	string
createdBy
updatedBy
name	string	The name of the project.
description	string	The description of the project.
clusterId	string	The cluster ID the project belongs to
status		The status of the project.
statusReason		The reason for the project’s status.
gpuPreemption		GPU preemption configuration.
quota		The quota assigned to the project.
cluster		The cluster the project belongs to.
users	array	The users in the project.
invitedUsers	array	The invited users to the project.

Projects

Field	Type	Description
data	array	The projects present in the system.

ProjectsWithResourceAllocation

Field	Type	Description
data	array	The projects, with resource allocation information.

QuotaResponse

Field	Type	Description
id	string
createdAt	string
updatedAt	string
createdBy
updatedBy
cpuMilliCores	integer	The number of CPU milli-cores assigned in the quota.
memoryBytes	integer	The amount of memory assigned in the quota.
ephemeralStorageBytes	integer	The amount of ephemeral storage assigned in the quota.
gpuCount	integer	The number of GPUs assigned in the quota.
status		The status of the quota.
statusReason		The reason for the status of the quota, if any.

QuotaStatus

QuotaUpdate

Field	Type	Description
cpuMilliCores	integer	The number of CPU milli-cores assigned in the quota.
memoryBytes	integer	The amount of memory assigned in the quota.
ephemeralStorageBytes	integer	The amount of ephemeral storage assigned in the quota.
gpuCount	integer	The number of GPUs assigned in the quota.

ReplicaSetStatus

S3Spec

Field	Type	Description
bucketUrl	string	URL to the S3 or S3-compatible bucket.
accessKeyName	string	The Name of the secret key used for access key name.
secretKeyName	string	The Name of the secret key that stores the secret access name.

SecretKind

SecretResponse

Field	Type	Description
id	string
createdAt	string
updatedAt	string
createdBy
updatedBy
name	string	The name of the secret.
type		The type of the secret
scope		The scope of the secret
status		The status of the secret
statusReason		Details if any about the status
useCase		The use case this secret is associated with.

SecretScope

SecretStatus

SecretUseCase

Use case classification for secrets. Shared by AIRM and AIWB.

SecretWithProjects

Field	Type	Description
id	string
createdAt	string
updatedAt	string
createdBy
updatedBy
name	string	The name of the secret.
type		The type of the secret
scope		The scope of the secret
status		The status of the secret
statusReason		Details if any about the status
useCase		The use case this secret is associated with.
projectSecrets	array	The projects assigned to the secret

Secrets

Field	Type	Description
data	array	The secrets in the organization.

ServiceStatus

StatefulSetStatus

StorageIn

Field	Type	Description
name	string	The name of the storage.
type		The type of the secret
scope		The scope of the secret
secretId	string	The ID of the secret that holds the credentials for this storage.
projectIds	array	List of project IDs to assign the storage
spec		The storage specification.

StorageResponse

Field	Type	Description
id	string
createdAt	string
updatedAt	string
createdBy
updatedBy
name	string	The name of the storage.
type		The type of the secret
scope		The scope of the secret
secretId	string	The ID of the secret that holds the credentials for this storage.
status		The status of the storage
statusReason		Details if any about the status

StorageScope

StorageStatus

StorageType

StorageWithProjects

Field	Type	Description
id	string
createdAt	string
updatedAt	string
createdBy
updatedBy
name	string	The name of the storage.
type		The type of the secret
scope		The scope of the secret
secretId	string	The ID of the secret that holds the credentials for this storage.
status		The status of the storage
statusReason		Details if any about the status
projectStorages	array	The projects assigned to the storage

Storages

Field	Type	Description
data	array	The list of storages.

TimeseriesRange

Field	Type	Description
start	string	The start of the timeseries range.
end	string	The end of the timeseries range.
intervalSeconds	integer	The interval in seconds for the timeseries data.
timestamps	array	The keys for the datapoints in the timeseries.

UserDetailsUpdate

Field	Type	Description
firstName	string	The user’s first name
lastName	string	The user’s last name

UserResponse

Field	Type	Description
id	string
createdAt	string
updatedAt	string
createdBy
updatedBy
email	string	The user’s email/user name
role	string	The highest role the user has
firstName	string	The user’s first name
lastName	string	The user’s last name
lastActiveAt		The timestamp the user was last active

UserRoleEnum

UserRolesUpdate

Field	Type	Description
roles	array	The roles to be assigned to the user

UserWithProjects

Field	Type	Description
id	string
createdAt	string
updatedAt	string
createdBy
updatedBy
email	string	The user’s email/user name
role	string	The highest role the user has
firstName	string	The user’s first name
lastName	string	The user’s last name
lastActiveAt		The timestamp the user was last active
projects	array	Projects the user belongs to

Users

Field	Type	Description
data	array

UtilizationByProject

Field	Type	Description
project		The project the utilization corresponds to.
allocatedGpusCount	integer	The number of GPUs allocated to the project.
utilizedGpusCount	integer	The number of GPUs currently being utilized by the project.
runningWorkloadsCount	integer	The number of running workloads for the project.
pendingWorkloadsCount	integer	The number of pending workloads for the project.

ValidationError

Field	Type	Description
loc	array
msg	string
type	string
input
ctx	object

WorkloadComponent

Field	Type	Description
id	string
createdAt	string
updatedAt	string
createdBy
updatedBy
name	string	The name of the component.
kind		The kind of the component.
apiVersion	string	The component API version.
status		The status of the component.
statusReason		Details if any about the status

WorkloadComponentKind

WorkloadGpuDevice

A single GPU device assignment for a workload.

Field	Type	Description
gpuId	string	The GPU device index identifier (e.g. ‘0’, ‘1’).
hostname	string	The hostname of the node the GPU device is on.

WorkloadMetricsDetailsResponse

Field	Type	Description
name		The display name of the workload
workloadId	string	The unique identifier of the workload
createdBy		The user who created the workload
clusterName		The name of the cluster running the workload
clusterId	string	The ID of the cluster running the workload
nodesInUse	integer	The number of nodes in use by the workload
gpuDevicesInUse	integer	The number of GPU devices in use by the workload
createdAt	string	The timestamp when the workload was created
updatedAt	string	The timestamp when the workload was last updated
queueTime	integer	Total time the workload spent queued (pending) in seconds
runningTime	integer	Total running time of the workload in seconds

WorkloadResponse

Field	Type	Description
id	string
createdAt	string
updatedAt	string
createdBy
updatedBy
projectId	string	The ID of the project
clusterId	string	The ID of the cluster
status		The status of the workload
displayName		The display name of the workload
type		The type of the workload

WorkloadStatus

WorkloadStatusCount

Field	Type	Description
status		The workload status category.
count	integer	The number of workloads currently in this status.

WorkloadStatusStats

Field	Type	Description
name	string	The name of the entity (project or cluster).
totalWorkloads	integer	The total number of workloads.
statusCounts	array	The total count of workloads grouped by status.

WorkloadType

WorkloadWithComponents

Field	Type	Description
id	string
createdAt	string
updatedAt	string
createdBy
updatedBy
projectId	string	The ID of the project
clusterId	string	The ID of the cluster
status		The status of the workload
displayName		The display name of the workload
type		The type of the workload
components	array	The components of the workload

WorkloadWithMetrics

Field	Type	Description
id	string
createdAt		The timestamp of when the workload was created
updatedAt	string
createdBy	string	The user who created the workload
updatedBy
projectId	string	The ID of the project
clusterId	string	The ID of the cluster
status		The status of the workload
displayName		The display name of the workload
type		The type of the workload
gpuCount	integer	The number of GPUs allocated to the workload
vram	number	The amount of VRAM used by the workload
runTime	integer	The total run time of the workload in seconds

Workloads

Field	Type	Description
data	array

WorkloadsStats

Field	Type	Description
runningWorkloadsCount	integer	The number of running workloads
pendingWorkloadsCount	integer	The number of pending workloads

WorkloadsWithMetrics

Flat envelope preserved; migration to nested envelope tracked in EAI-6519.

Field	Type	Description
data	array
total	integer
page	integer
pageSize	integer