Skip to navigation
Benchling APIPolicy

Update Policy

Beta

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.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

policy_idstringRequired
ID of the Policy.

Headers

EARLY-ACCESSstringOptional

Set to true to access beta operations via /api/v3.

Request

This endpoint expects an object.
descriptionstring or nullOptional
The description of the Policy. Pass null to clear the description.
namestringOptional
The name of the Policy

Response

OK
__typenamestringOptional
createdAtstringOptional
descriptionstring or nullOptional
idstringOptional
modifiedAtstringOptional
namestringOptional
policyStatementslist of objectsOptional
policyTypeenumOptional
Allowed values:

Errors

400
Policy Update Request Bad Request Error
403
Policy Update Request Forbidden Error
404
Policy Update Request Not Found Error
409
Policy Update Request Conflict Error
429
Policy Update Request Too Many Requests Error
500
Policy Update Request Internal Server Error