Update department

PUT

http://localhost:8080/api/v1/org-unit/departments/:departmentId

PUT

/api/v1/org-unit/departments/:departmentId

curl -X PUT http://localhost:8080/api/v1/org-unit/departments/1 \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "resources": [
    {}
  ]
}'

{
  "description": "string",
  "name": "organization1",
  "clusterId": "71f69d83-ba66-4822-adf5-55ce55efd210",
  "id": "50",
  "createdAt": "2024-01-15T09:30:00Z",
  "updatedAt": "2024-01-15T09:30:00Z",
  "totalResources": {
    "gpuQuota": 1.1,
    "cpuQuota": 1.1,
    "memoryQuota": 1.1
  },
  "resources": [
    {
      "gpu": {
        "deserved": 1000,
        "limit": 0,
        "overQuotaWeight": 2
      },
      "nodePool": {
        "id": "22",
        "name": "default"
      },
      "cpu": {
        "deserved": 1000,
        "limit": 0,
        "overQuotaWeight": 2
      },
      "memory": {
        "units": "Mib",
        "deserved": 1000,
        "limit": 0,
        "overQuotaWeight": 2
      },
      "rank": "High"
    }
  ],
  "schedulingRules": {
    "interactiveJobTimeLimitSeconds": 100,
    "interactiveJobMaxIdleDurationSeconds": 100,
    "interactiveJobPreemptIdleDurationSeconds": 100,
    "trainingJobMaxIdleDurationSeconds": 100,
    "trainingJobTimeLimitSeconds": 100
  },
  "defaultNodePools": [
    "string"
  ],
  "nodeTypes": {
    "training": [
      "string"
    ],
    "workspace": [
      "string"
    ],
    "names": {}
  },
  "overtimeData": {
    "range24hData": {
      "averageGpuAllocation": 10,
      "averageGpuUtilization": 95,
      "averageGpuMemoryUtilization": 95,
      "updatedAt": "2021-08-01T00:00:00Z"
    },
    "range7dData": {
      "averageGpuAllocation": 10,
      "averageGpuUtilization": 95,
      "averageGpuMemoryUtilization": 95,
      "updatedAt": "2021-08-01T00:00:00Z"
    },
    "range30dData": {
      "averageGpuAllocation": 10,
      "averageGpuUtilization": 95,
      "averageGpuMemoryUtilization": 95,
      "updatedAt": "2021-08-01T00:00:00Z"
    }
  },
  "createdBy": "string",
  "updatedBy": "string",
  "children": [
    {
      "id": "9f55253e-11ed-47c7-acef-fc4054768dbc",
      "name": "organization1",
      "children": [
        null
      ]
    }
  ],
  "projectsAggregatedResources": [
    {
      "nodePool": {
        "id": "22",
        "name": "default"
      },
      "gpu": {
        "deserved": 1000
      },
      "cpu": {
        "deserved": 1000
      },
      "memory": {
        "units": "Mib",
        "deserved": 1000
      }
    }
  ],
  "status": {
    "nodePoolQuotaStatuses": [
      {
        "nodePoolName": "string",
        "nodePoolId": "string",
        "allocated": {
          "gpu": 0,
          "cpu": 1000,
          "memory": 1000
        },
        "allocatedNonPreemptible": {
          "gpu": 0,
          "cpu": 1000,
          "memory": 1000
        },
        "requested": {
          "gpu": 0,
          "cpu": 1000,
          "memory": 1000
        }
      }
    ],
    "quotaStatus": {
      "allocated": {
        "gpu": 0,
        "cpu": 1000,
        "memory": 1000
      },
      "allocatedNonPreemptible": {
        "gpu": 0,
        "cpu": 1000,
        "memory": 1000
      },
      "requested": {
        "gpu": 0,
        "cpu": 1000,
        "memory": 1000
      }
    }
  }
}

Update department by Id

Authentication

AuthorizationBearer

Bearer authentication

Path parameters

departmentIdstringRequiredformat: ".*"

The id of the department.

Request

Department to update.

resourceslist of objectsRequired

Resources assigned to this Organization per Node Pool

descriptionstringOptional

The description of the department.

schedulingRulesobjectOptional

Scheduling rules that define time limits and idle GPU timeouts for workloads in this org-unit. These rules help manage resource utilization by automatically terminating or preempting idle or long-running workloads.

defaultNodePoolslist of strings or nullOptional

An ordered list of node pools that defines the default scheduling preference for workloads in this department. The Scheduler will attempt to schedule workloads on node pools in this order. This setting is enforced if no node pool list is defined in the workload policy.

nodeTypesobjectOptional

Deprecated: use a workload policy node selector to target node types instead. Node type configurations for different workload types (training, workspace). Specifies which node types are allowed for each workload type. Enforced when no node type is configured in the workload policy.

Response

Updated

descriptionstring

The description of the department.

namestring<=63 characters

The unique name of the department within the cluster. Must be a valid Kubernetes name (lowercase, alphanumeric, hyphens allowed).

clusterIdstringformat: "uuid"

The id of the cluster.

idstring

createdAtdatetime

updatedAtdatetime

totalResourcesobject

resourceslist of objects

Resources assigned to this Organization per Node Pool

schedulingRulesobjectOptional

defaultNodePoolslist of strings or nullOptional

nodeTypesobjectOptional

overtimeDataobjectOptional

createdBystringOptional

updatedBystringOptional

childrenlist of objects or nullOptional

projectsAggregatedResourceslist of objects or nullOptional

statusobjectOptional

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

503

Service Unavailable Error