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
get
Retrieve a list of all the applied policies.
Authorizations
AuthorizationstringRequired
Bearer authentication
Query parameters
workloadTypestring · enum · min: 1Optional
Policy for a specific workload type.
Possible values:
scopestring · enumOptional
filter by this scope.
Possible values:
departmentIdstringOptional
Filter using the department id.
Example: 1
projectIdstringOptional
project id to filter by
Example: 1
clusterIdstring · uuidOptional
Filter using the Universally Unique Identifier (UUID) of the cluster.
Example: d73a738f-fab3-430a-8fa3-5241493d7128
includeFallbackPoliciesbooleanOptional
whether to include fallback policies in the list. Default to false.
Responses
200
Request completed successfully.
application/json
401
Unauthorized
application/json
403
Forbidden
application/json
503
unexpected error
application/json
get
/api/v2/policy
Get a training policy.
get
Retrieve the details of a training policy for a given organizational unit.
Authorizations
AuthorizationstringRequired
Bearer authentication
Query parameters
scopestring · enumRequired
The scope that the policy relates to.
Possible values:
departmentIdstringOptional
Filter using the department id.
Example: 1
projectIdstringOptional
project id to filter by
Example: 1
clusterIdstring · uuidOptional
Filter using the Universally Unique Identifier (UUID) of the cluster.
The time at which an event occurred. e.g. the time an effective policy has been updated
400
Bad request.
application/json
401
Unauthorized
application/json
403
Forbidden
application/json
404
The specified resource was not found
application/json
503
unexpected error
application/json
get
/api/v2/policy/trainings
Overwrite a training policy.
put
Use to apply a training policy for a given organizational unit.
Authorizations
AuthorizationstringRequired
Bearer authentication
Query parameters
validateOnlybooleanOptional
Validate the given policy payload without applying it
approveClusterDeletionbooleanOptional
Required when modifying or deleting a policy if the tenant includes one or more clusters running version 2.20 or earlier. In such cases, the platform must delete the policy from the affected clusters. This flag indicates that the administrator approves this deletion.
The time at which an event occurred. e.g. the time an effective policy has been updated
400
Bad request.
application/json
401
Unauthorized
application/json
403
Forbidden
application/json
503
unexpected error
application/json
put
/api/v2/policy/trainings
Delete a training policy.
delete
Use to delete a training policy for a given organizational unit.
Authorizations
AuthorizationstringRequired
Bearer authentication
Query parameters
scopestring · enumRequired
The scope that the policy relates to.
Possible values:
departmentIdstringOptional
Filter using the department id.
Example: 1
projectIdstringOptional
project id to filter by
Example: 1
clusterIdstring · uuidOptional
Filter using the Universally Unique Identifier (UUID) of the cluster.
Example: d73a738f-fab3-430a-8fa3-5241493d7128
approveClusterDeletionbooleanOptional
Required when modifying or deleting a policy if the tenant includes one or more clusters running version 2.20 or earlier. In such cases, the platform must delete the policy from the affected clusters. This flag indicates that the administrator approves this deletion.
Responses
204
The policy was deleted successfully.
400
Bad request.
application/json
401
Unauthorized
application/json
403
Forbidden
application/json
404
The specified resource was not found
application/json
503
unexpected error
application/json
delete
/api/v2/policy/trainings
No content
Update a training policy.
patch
Use to apply changes to a training policy for a given organizational unit.
Authorizations
AuthorizationstringRequired
Bearer authentication
Query parameters
validateOnlybooleanOptional
Validate the given policy payload without applying it
approveClusterDeletionbooleanOptional
Required when modifying or deleting a policy if the tenant includes one or more clusters running version 2.20 or earlier. In such cases, the platform must delete the policy from the affected clusters. This flag indicates that the administrator approves this deletion.
Body
resetstring[]Optional
set of fields in jsonpath format that is requested to clear their policy (default and rules)
The time at which an event occurred. e.g. the time an effective policy has been updated
400
Bad request.
application/json
401
Unauthorized
application/json
403
Forbidden
application/json
404
The specified resource was not found
application/json
503
unexpected error
application/json
get
/api/v2/policy/workspaces
Overwrite a workspace policy.
put
Ue to apply a workspace policy for a given organizational unit.
Authorizations
AuthorizationstringRequired
Bearer authentication
Query parameters
validateOnlybooleanOptional
Validate the given policy payload without applying it
approveClusterDeletionbooleanOptional
Required when modifying or deleting a policy if the tenant includes one or more clusters running version 2.20 or earlier. In such cases, the platform must delete the policy from the affected clusters. This flag indicates that the administrator approves this deletion.
The time at which an event occurred. e.g. the time an effective policy has been updated
400
Bad request.
application/json
401
Unauthorized
application/json
403
Forbidden
application/json
503
unexpected error
application/json
put
/api/v2/policy/workspaces
Delete a workspace policy.
delete
Use to delete a workspace policy for a given organizational unit.
Authorizations
AuthorizationstringRequired
Bearer authentication
Query parameters
scopestring · enumRequired
The scope that the policy relates to.
Possible values:
departmentIdstringOptional
Filter using the department id.
Example: 1
projectIdstringOptional
project id to filter by
Example: 1
clusterIdstring · uuidOptional
Filter using the Universally Unique Identifier (UUID) of the cluster.
Example: d73a738f-fab3-430a-8fa3-5241493d7128
approveClusterDeletionbooleanOptional
Required when modifying or deleting a policy if the tenant includes one or more clusters running version 2.20 or earlier. In such cases, the platform must delete the policy from the affected clusters. This flag indicates that the administrator approves this deletion.
Responses
204
The policy was deleted successfully.
400
Bad request.
application/json
401
Unauthorized
application/json
403
Forbidden
application/json
404
The specified resource was not found
application/json
503
unexpected error
application/json
delete
/api/v2/policy/workspaces
No content
Update a workspace policy.
patch
Use to apply changes to a workspace policy for a given organizational unit.
Authorizations
AuthorizationstringRequired
Bearer authentication
Query parameters
validateOnlybooleanOptional
Validate the given policy payload without applying it
approveClusterDeletionbooleanOptional
Required when modifying or deleting a policy if the tenant includes one or more clusters running version 2.20 or earlier. In such cases, the platform must delete the policy from the affected clusters. This flag indicates that the administrator approves this deletion.
Body
resetstring[]Optional
set of fields in jsonpath format that is requested to clear their policy (default and rules)
The time at which an event occurred. e.g. the time an effective policy has been updated
400
Bad request.
application/json
401
Unauthorized
application/json
403
Forbidden
application/json
404
The specified resource was not found
application/json
503
unexpected error
application/json
get
/api/v2/policy/distributed
Overwrite a distributed policy.
put
Use to apply a distributed policy for a given organizational unit.
Authorizations
AuthorizationstringRequired
Bearer authentication
Query parameters
validateOnlybooleanOptional
Validate the given policy payload without applying it
approveClusterDeletionbooleanOptional
Required when modifying or deleting a policy if the tenant includes one or more clusters running version 2.20 or earlier. In such cases, the platform must delete the policy from the affected clusters. This flag indicates that the administrator approves this deletion.
The time at which an event occurred. e.g. the time an effective policy has been updated
400
Bad request.
application/json
401
Unauthorized
application/json
403
Forbidden
application/json
503
unexpected error
application/json
put
/api/v2/policy/distributed
Delete a distributed policy.
delete
Use to delete a distributed policy for a given organizational unit.
Authorizations
AuthorizationstringRequired
Bearer authentication
Query parameters
scopestring · enumRequired
The scope that the policy relates to.
Possible values:
departmentIdstringOptional
Filter using the department id.
Example: 1
projectIdstringOptional
project id to filter by
Example: 1
clusterIdstring · uuidOptional
Filter using the Universally Unique Identifier (UUID) of the cluster.
Example: d73a738f-fab3-430a-8fa3-5241493d7128
approveClusterDeletionbooleanOptional
Required when modifying or deleting a policy if the tenant includes one or more clusters running version 2.20 or earlier. In such cases, the platform must delete the policy from the affected clusters. This flag indicates that the administrator approves this deletion.
Responses
204
The policy was deleted successfully.
400
Bad request.
application/json
401
Unauthorized
application/json
403
Forbidden
application/json
404
The specified resource was not found
application/json
503
unexpected error
application/json
delete
/api/v2/policy/distributed
No content
Update a distributed policy.
patch
Use to apply changes to a distributed policy for a given organizational unit.
Authorizations
AuthorizationstringRequired
Bearer authentication
Query parameters
validateOnlybooleanOptional
Validate the given policy payload without applying it
approveClusterDeletionbooleanOptional
Required when modifying or deleting a policy if the tenant includes one or more clusters running version 2.20 or earlier. In such cases, the platform must delete the policy from the affected clusters. This flag indicates that the administrator approves this deletion.
Body
resetstring[]Optional
set of fields in jsonpath format that is requested to clear their policy (default and rules)
The time at which an event occurred. e.g. the time an effective policy has been updated
400
Bad request.
application/json
401
Unauthorized
application/json
403
Forbidden
application/json
404
The specified resource was not found
application/json
503
unexpected error
application/json
get
/api/v2/policy/inferences
Overwrite an inference policy.
put
Use to apply an inference policy for a given organizational unit.
Authorizations
AuthorizationstringRequired
Bearer authentication
Query parameters
validateOnlybooleanOptional
Validate the given policy payload without applying it
approveClusterDeletionbooleanOptional
Required when modifying or deleting a policy if the tenant includes one or more clusters running version 2.20 or earlier. In such cases, the platform must delete the policy from the affected clusters. This flag indicates that the administrator approves this deletion.
The time at which an event occurred. e.g. the time an effective policy has been updated
400
Bad request.
application/json
401
Unauthorized
application/json
403
Forbidden
application/json
503
unexpected error
application/json
put
/api/v2/policy/inferences
Delete an inference policy.
delete
Use to delete an inference policy for a given organizational unit.
Authorizations
AuthorizationstringRequired
Bearer authentication
Query parameters
scopestring · enumRequired
The scope that the policy relates to.
Possible values:
departmentIdstringOptional
Filter using the department id.
Example: 1
projectIdstringOptional
project id to filter by
Example: 1
clusterIdstring · uuidOptional
Filter using the Universally Unique Identifier (UUID) of the cluster.
Example: d73a738f-fab3-430a-8fa3-5241493d7128
approveClusterDeletionbooleanOptional
Required when modifying or deleting a policy if the tenant includes one or more clusters running version 2.20 or earlier. In such cases, the platform must delete the policy from the affected clusters. This flag indicates that the administrator approves this deletion.
Responses
204
The policy was deleted successfully.
400
Bad request.
application/json
401
Unauthorized
application/json
403
Forbidden
application/json
404
The specified resource was not found
application/json
503
unexpected error
application/json
delete
/api/v2/policy/inferences
No content
Update an inference policy.
patch
Use to apply changes to an inference policy for a given organizational unit.
Authorizations
AuthorizationstringRequired
Bearer authentication
Query parameters
validateOnlybooleanOptional
Validate the given policy payload without applying it
approveClusterDeletionbooleanOptional
Required when modifying or deleting a policy if the tenant includes one or more clusters running version 2.20 or earlier. In such cases, the platform must delete the policy from the affected clusters. This flag indicates that the administrator approves this deletion.
Body
resetstring[]Optional
set of fields in jsonpath format that is requested to clear their policy (default and rules)
The time at which an event occurred. e.g. the time an effective policy has been updated
400
Bad request.
application/json
401
Unauthorized
application/json
403
Forbidden
application/json
404
The specified resource was not found
application/json
503
unexpected error
application/json
get
/api/v2/policy/distributed-inferences
Overwrite a distributed inference policy.
put
Use to apply a distributed inference policy for a given organizational unit.
Authorizations
AuthorizationstringRequired
Bearer authentication
Query parameters
validateOnlybooleanOptional
Validate the given policy payload without applying it
approveClusterDeletionbooleanOptional
Required when modifying or deleting a policy if the tenant includes one or more clusters running version 2.20 or earlier. In such cases, the platform must delete the policy from the affected clusters. This flag indicates that the administrator approves this deletion.
The time at which an event occurred. e.g. the time an effective policy has been updated
400
Bad request.
application/json
401
Unauthorized
application/json
403
Forbidden
application/json
503
unexpected error
application/json
put
/api/v2/policy/distributed-inferences
Delete a distributed inference policy.
delete
Use to delete a distributed inference policy for a given organizational unit.
Authorizations
AuthorizationstringRequired
Bearer authentication
Query parameters
scopestring · enumRequired
The scope that the policy relates to.
Possible values:
departmentIdstringOptional
Filter using the department id.
Example: 1
projectIdstringOptional
project id to filter by
Example: 1
clusterIdstring · uuidOptional
Filter using the Universally Unique Identifier (UUID) of the cluster.
Example: d73a738f-fab3-430a-8fa3-5241493d7128
approveClusterDeletionbooleanOptional
Required when modifying or deleting a policy if the tenant includes one or more clusters running version 2.20 or earlier. In such cases, the platform must delete the policy from the affected clusters. This flag indicates that the administrator approves this deletion.
Responses
204
The policy was deleted successfully.
400
Bad request.
application/json
401
Unauthorized
application/json
403
Forbidden
application/json
404
The specified resource was not found
application/json
503
unexpected error
application/json
delete
/api/v2/policy/distributed-inferences
No content
Update a distributed inference policy.
patch
Use to apply changes to a distributed inference policy for a given organizational unit.
Authorizations
AuthorizationstringRequired
Bearer authentication
Query parameters
validateOnlybooleanOptional
Validate the given policy payload without applying it
approveClusterDeletionbooleanOptional
Required when modifying or deleting a policy if the tenant includes one or more clusters running version 2.20 or earlier. In such cases, the platform must delete the policy from the affected clusters. This flag indicates that the administrator approves this deletion.
Body
resetstring[]Optional
set of fields in jsonpath format that is requested to clear their policy (default and rules)
The time at which an event occurred. e.g. the time an effective policy has been updated
400
Bad request.
application/json
401
Unauthorized
application/json
403
Forbidden
application/json
503
unexpected error
application/json
patch
/api/v2/policy/nim-services
Get minimal information about a mapping of a given workload type. [experimental]
post
Authorizations
AuthorizationstringRequired
Bearer authentication
Body
Responses
200
Mapping..
application/json
400
Bad request.
application/json
401
Unauthorized
application/json
403
Forbidden
application/json
404
The specified resource was not found
application/json
503
unexpected error
application/json
post
/api/v1/policies/mappings/minimal
Get field(s) info for a given mapping. [experimental]
post
Authorizations
AuthorizationstringRequired
Bearer authentication
Body
Responses
200
Policy found.
application/json
400
Bad request.
application/json
401
Unauthorized
application/json
403
Forbidden
application/json
404
The specified resource was not found
application/json
503
unexpected error
application/json
post
/api/v1/policies/mappings/field-info
List policies. [experimental]
get
Authorizations
AuthorizationstringRequired
Bearer authentication
Query parameters
filterBystring[] · max: 10Optional
Filter results by a parameter. Use the format field-name operator value. Operators are == Equals, != Not equals, <= Less than or equal, >= Greater than or equal, =@ contains, !@ Does not contain, =^ Starts with and =$ Ends with. Dates are in ISO 8601 timestamp format and available for operators ==, !=, <= and >=.
Example: ["scope==project"]
sortBystring · enumOptional
Sort results by a parameter.
Possible values:
offsetinteger · int32Optional
The offset of the first item returned in the collection.
Example: 100
limitinteger · int32 · min: 1 · max: 500Optional
The maximum number of entries to return.
Default: 50
sortOrderstring · enumOptional
Sort results in descending or ascending order.
Default: ascPossible values:
Responses
200
List policies.
application/json
400
Bad request.
application/json
401
Unauthorized
application/json
403
Forbidden
application/json
503
unexpected error
application/json
get
/api/v1/policies
Create a policy on a given workload type. [experimental]
post
Authorizations
AuthorizationstringRequired
Bearer authentication
Body
Scope and workload type (GVK) this policy applies to. Policies are identified by id; this describes where the policy is in effect.