Policy

Update Policy

Update a Policy.

Restrictions

  • Only data policies can be updated; requests targeting other policy types are rejected.
  • Only name and description may be modified.
  • name must be unique among the tenant's data policies.
patch/api/v3/policy/{policy_id}

Request

  • Base URL
    https://{tenant_name}.benchling.com
  • Auth
    HTTP bearer

Path parameters

policy_idstring required

ID of the Policy.

Request body

descriptionstring nullable

The description of the Policy. Pass null to clear the description.

namestring

The name of the Policy

Response

OK

__typenamestring
createdAtstring datetime
descriptionstring nullable
idstring
modifiedAtstring datetime
namestring
policyType'DATA_POLICY' | 'SCHEMA_POLICY' | 'POLICY'

Changes

No recorded changes to this operation across all 1 revision of this API.