Policy

Policies allow administrators to impose restrictions and set default values for researcher workloads. Restrictions and default values can be placed on CPUs, GPUs, and other resources or entities. For more information, see Policies.

List policies

Retrieve a list of all the applied policies.

SecuritybearerAuth
Request
query Parameters
workloadType
string non-empty

Policy for a specific workload type.

Enum: "Workspace" "Training" "Distributed" "Inference"
scope
string

filter by this scope.

Enum: "tenant" "cluster" "department" "project"
departmentId
string

Filter using the department id.

Example: departmentId=1
projectId
string

project id to filter by

Example: projectId=1
clusterId
string <uuid>

Filter using the Universally Unique Identifier (UUID) of the cluster.

Example: clusterId=d73a738f-fab3-430a-8fa3-5241493d7128
includeFallbackPolicies
boolean

whether to include fallback policies in the list. Default to false.

Responses
200

Request completed successfully.

401

Unauthorized

403

Forbidden

503

unexpected error

get/api/v2/policy
Response samples
application/json
{
  • "policies": [
    ]
}

Update a training policy.

Use to apply changes to training policy for a given organizational unit.

SecuritybearerAuth
Request
query Parameters
validateOnly
boolean

Validate the given policy payload without applying it

Request Body schema: application/json
object (PolicyCreationFields)
object or null (TrainingPolicyDefaultsAndRulesV2)
reset
Array of strings (FieldsToReset)

set of fields in jsonpath format that is requested to clear their policy (default and rules)

Responses
200

Policy applied.

400

Bad request.

401

Unauthorized

403

Forbidden

503

unexpected error

patch/api/v2/policy/trainings
Request samples
application/json
{
  • "meta": {
    },
  • "policy": {
    },
  • "reset": [
    ]
}
Response samples
application/json
{
  • "meta": {
    },
  • "policy": {
    },
  • "effective": {