projects

Update project

Update a specific project

put/v1-beta/projects/{projectId}

Request

  • Base URL: https://platform.lakera.ai/api
  • URL: https://platform.lakera.ai/api/v1-beta/projects/{projectId}
  • Auth: HTTP bearer

Path parameters

projectIdstring required

Request body

namestring required

A descriptive name for the project

policy_idstring

ID of the policy to be applied to this project. If not provided, uses default policy.

project_metadataobject

Custom metadata tags for analysis and cross referencing

action'detect' | 'enforce'

Controls whether Guard enforces flagging on this project. enforce (the default) means full enforcement: the top-level flagged in a guard response is true whenever any of the enabled detectors triggers. detect surfaces detections in the breakdown but forces the top-level flagged to false, letting you observe detector behavior without blocking traffic. Always returned when reading a project. Optional when creating — defaults to enforce. Optional when updating — omit to keep the existing value. More information in Project Mode.

Response

Project updated

namestring required

A descriptive name for the project

policy_idstring

ID of the policy to be applied to this project. If not provided, uses default policy.

project_metadataobject

Custom metadata tags for analysis and cross referencing

action'detect' | 'enforce'

Controls whether Guard enforces flagging on this project. enforce (the default) means full enforcement: the top-level flagged in a guard response is true whenever any of the enabled detectors triggers. detect surfaces detections in the breakdown but forces the top-level flagged to false, letting you observe detector behavior without blocking traffic. Always returned when reading a project. Optional when creating — defaults to enforce. Optional when updating — omit to keep the existing value. More information in Project Mode.

Changes

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