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 Policiesarrow-up-right.

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
chevron-right
200

Request completed successfully.

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.

Example: d73a738f-fab3-430a-8fa3-5241493d7128
Responses
chevron-right
200

Request completed successfully.

application/json
effectiveUpdatedAtstring · date-time · min: 1Optional

The time at which an event occurred. e.g. the time an effective policy has been updated

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.

Body
Responses
chevron-right
200

Policy applied.

application/json
effectiveUpdatedAtstring · date-time · min: 1Optional

The time at which an event occurred. e.g. the time an effective policy has been updated

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
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)

Example: ["master.security.runAsGpu","worker.compute.gpu"]
Responses
chevron-right
200

Policy applied.

application/json
effectiveUpdatedAtstring · date-time · min: 1Optional

The time at which an event occurred. e.g. the time an effective policy has been updated

patch
/api/v2/policy/trainings

Get a workspace policy.

get

Retrieve the details of 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
Responses
chevron-right
200

Request completed successfully.

application/json
effectiveUpdatedAtstring · date-time · min: 1Optional

The time at which an event occurred. e.g. the time an effective policy has been updated

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.

Body
Responses
chevron-right
200

Policy applied.

application/json
effectiveUpdatedAtstring · date-time · min: 1Optional

The time at which an event occurred. e.g. the time an effective policy has been updated

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
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)

Example: ["master.security.runAsGpu","worker.compute.gpu"]
Responses
chevron-right
200

Policy applied.

application/json
effectiveUpdatedAtstring · date-time · min: 1Optional

The time at which an event occurred. e.g. the time an effective policy has been updated

patch
/api/v2/policy/workspaces

Get a distributed policy.

get

Retrieve the details of 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
Responses
chevron-right
200

Request completed successfully.

application/json
effectiveUpdatedAtstring · date-time · min: 1Optional

The time at which an event occurred. e.g. the time an effective policy has been updated

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.

Body
Responses
chevron-right
200

Policy applied.

application/json
effectiveUpdatedAtstring · date-time · min: 1Optional

The time at which an event occurred. e.g. the time an effective policy has been updated

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
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)

Example: ["master.security.runAsGpu","worker.compute.gpu"]
Responses
chevron-right
200

Policy applied.

application/json
effectiveUpdatedAtstring · date-time · min: 1Optional

The time at which an event occurred. e.g. the time an effective policy has been updated

patch
/api/v2/policy/distributed

Get an inference policy.

get

Retrieve the details of 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
Responses
chevron-right
200

Request completed successfully.

application/json
effectiveUpdatedAtstring · date-time · min: 1Optional

The time at which an event occurred. e.g. the time an effective policy has been updated

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.

Body
Responses
chevron-right
200

Policy applied.

application/json
effectiveUpdatedAtstring · date-time · min: 1Optional

The time at which an event occurred. e.g. the time an effective policy has been updated

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
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)

Example: ["master.security.runAsGpu","worker.compute.gpu"]
Responses
chevron-right
200

Policy applied.

application/json
effectiveUpdatedAtstring · date-time · min: 1Optional

The time at which an event occurred. e.g. the time an effective policy has been updated

patch
/api/v2/policy/inferences

Get a distributed inference policy.

get

Retrieve the details of 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
Responses
chevron-right
200

Request completed successfully.

application/json
effectiveUpdatedAtstring · date-time · min: 1Optional

The time at which an event occurred. e.g. the time an effective policy has been updated

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.

Body
Responses
chevron-right
200

Policy applied.

application/json
effectiveUpdatedAtstring · date-time · min: 1Optional

The time at which an event occurred. e.g. the time an effective policy has been updated

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
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)

Example: ["master.security.runAsGpu","worker.compute.gpu"]
Responses
chevron-right
200

Policy applied.

application/json
effectiveUpdatedAtstring · date-time · min: 1Optional

The time at which an event occurred. e.g. the time an effective policy has been updated

patch
/api/v2/policy/distributed-inferences

Get NVIDIA NIM service policy.

get

Retrieve the details of NVIDIA NIM service 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
Responses
chevron-right
200

Request completed successfully.

application/json
effectiveUpdatedAtstring · date-time · min: 1Optional

The time at which an event occurred. e.g. the time an effective policy has been updated

get
/api/v2/policy/nim-services

Overwrite NVIDIA NIM service policy.

put

Use to apply NVIDIA NIM service policy for a given organizational unit.

Authorizations
AuthorizationstringRequired

Bearer authentication

Query parameters
validateOnlybooleanOptional

Validate the given policy payload without applying it

Body
Responses
chevron-right
200

Policy applied.

application/json
effectiveUpdatedAtstring · date-time · min: 1Optional

The time at which an event occurred. e.g. the time an effective policy has been updated

put
/api/v2/policy/nim-services

Delete NVIDIA NIM service policy.

delete

Use to delete NVIDIA NIM service 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
Responses
delete
/api/v2/policy/nim-services

No content

Update NVIDIA NIM service policy.

patch

Use to apply changes to NVIDIA NIM service policy for a given organizational unit.

Authorizations
AuthorizationstringRequired

Bearer authentication

Query parameters
validateOnlybooleanOptional

Validate the given policy payload without applying it

Body
resetstring[]Optional

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

Example: ["master.security.runAsGpu","worker.compute.gpu"]
Responses
chevron-right
200

Policy applied.

application/json
effectiveUpdatedAtstring · date-time · min: 1Optional

The time at which an event occurred. e.g. the time an effective policy has been updated

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
chevron-right
200

Mapping..

application/json
post
/api/v1/policies/mappings/minimal

Get field(s) info for a given mapping. [experimental]

post
Authorizations
AuthorizationstringRequired

Bearer authentication

Body
Responses
chevron-right
200

Policy found.

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
chevron-right
200

List policies.

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.

descriptionstring · min: 1 · max: 1023 · nullableOptional

Optional human-readable description of the policy.

Example: a short description of the policyPattern: .*
scopestring · enumRequiredPossible values:
projectIdstringOptional

The id of the project.

Example: 1Pattern: .*
Responses
chevron-right
200

Policy updated.

application/json

A policy resource. The server assigns a unique id; scope and workload type describe where it applies.

descriptionstring · min: 1 · max: 1023 · nullableOptional

Optional human-readable description of the policy.

Example: a short description of the policyPattern: .*
scopestring · enumRequiredPossible values:
projectIdstringOptional

The id of the project.

Example: 1Pattern: .*
idstring · uuidRequired
createdBystring · min: 1Required

The user who created the policy.

createdAtstring · date-time · min: 1Required

The time at which the policy was created.

updatedBystring · min: 1Required

The user who updated the policy.

updatedAtstring · date-time · min: 1Required

The time at which the policy was updated.

post
/api/v1/policies

Get a policy identified by id. [experimental]

get
Authorizations
AuthorizationstringRequired

Bearer authentication

Path parameters
PolicyIdstring · uuidRequired

The unique id of the policy

Responses
chevron-right
200

Policy found.

application/json

A policy resource. The server assigns a unique id; scope and workload type describe where it applies.

descriptionstring · min: 1 · max: 1023 · nullableOptional

Optional human-readable description of the policy.

Example: a short description of the policyPattern: .*
scopestring · enumRequiredPossible values:
projectIdstringOptional

The id of the project.

Example: 1Pattern: .*
idstring · uuidRequired
createdBystring · min: 1Required

The user who created the policy.

createdAtstring · date-time · min: 1Required

The time at which the policy was created.

updatedBystring · min: 1Required

The user who updated the policy.

updatedAtstring · date-time · min: 1Required

The time at which the policy was updated.

get
/api/v1/policies/{PolicyId}

Replace a policy identified by id. [experimental]

put
Authorizations
AuthorizationstringRequired

Bearer authentication

Path parameters
PolicyIdstring · uuidRequired

The unique id of the policy

Body
descriptionstring · min: 1 · max: 1023 · nullableOptional

Optional human-readable description of the policy.

Example: a short description of the policyPattern: .*
Responses
chevron-right
200

Policy updated.

application/json

A policy resource. The server assigns a unique id; scope and workload type describe where it applies.

descriptionstring · min: 1 · max: 1023 · nullableOptional

Optional human-readable description of the policy.

Example: a short description of the policyPattern: .*
scopestring · enumRequiredPossible values:
projectIdstringOptional

The id of the project.

Example: 1Pattern: .*
idstring · uuidRequired
createdBystring · min: 1Required

The user who created the policy.

createdAtstring · date-time · min: 1Required

The time at which the policy was created.

updatedBystring · min: 1Required

The user who updated the policy.

updatedAtstring · date-time · min: 1Required

The time at which the policy was updated.

put
/api/v1/policies/{PolicyId}

Delete a policy identified by id. [experimental]

delete
Authorizations
AuthorizationstringRequired

Bearer authentication

Path parameters
PolicyIdstring · uuidRequired

The unique id of the policy

Responses
delete
/api/v1/policies/{PolicyId}

No content

Patch a policy identified by id with set of updates. [experimental]

patch
Authorizations
AuthorizationstringRequired

Bearer authentication

Path parameters
PolicyIdstring · uuidRequired

The unique id of the policy

Body
descriptionstring · min: 1 · max: 1023 · nullableOptional

Optional human-readable description of the policy.

Example: a short description of the policyPattern: .*
Responses
chevron-right
200

Policy updated.

application/json

A policy resource. The server assigns a unique id; scope and workload type describe where it applies.

descriptionstring · min: 1 · max: 1023 · nullableOptional

Optional human-readable description of the policy.

Example: a short description of the policyPattern: .*
scopestring · enumRequiredPossible values:
projectIdstringOptional

The id of the project.

Example: 1Pattern: .*
idstring · uuidRequired
createdBystring · min: 1Required

The user who created the policy.

createdAtstring · date-time · min: 1Required

The time at which the policy was created.

updatedBystring · min: 1Required

The user who updated the policy.

updatedAtstring · date-time · min: 1Required

The time at which the policy was updated.

patch
/api/v1/policies/{PolicyId}

Delete rule(s) from a policy. [experimental]

delete
Authorizations
AuthorizationstringRequired

Bearer authentication

Path parameters
PolicyIdstring · uuidRequired

The unique id of the policy

Body
Responses
chevron-right
200

Policy updated.

application/json

A policy resource. The server assigns a unique id; scope and workload type describe where it applies.

descriptionstring · min: 1 · max: 1023 · nullableOptional

Optional human-readable description of the policy.

Example: a short description of the policyPattern: .*
scopestring · enumRequiredPossible values:
projectIdstringOptional

The id of the project.

Example: 1Pattern: .*
idstring · uuidRequired
createdBystring · min: 1Required

The user who created the policy.

createdAtstring · date-time · min: 1Required

The time at which the policy was created.

updatedBystring · min: 1Required

The user who updated the policy.

updatedAtstring · date-time · min: 1Required

The time at which the policy was updated.

delete
/api/v1/policies/{PolicyId}/rules

Last updated