Sign in
latestOpenAPI 3.1.02026-08-20263333766.3 KB

d56798d2b3b3

Projects

Update Project

Updates the project.

patch/v2/projects/{proj_id}

Path parameters

proj_idstring required

Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").

Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").

Request body

namestring

The name of the project

descriptionstring

a longer description outlining the project objectives

settingsobject

the settings for this project

active_policy_repo_idstring uuid

the id of the policy repo to use for this project

Response

Successful Response

keystring required

A URL-friendly name of the project (i.e: slug). You will be able to query later using this key instead of the id (UUID) of the project.

urn_namespacestring

Optional namespace for URNs. If empty, URNs will be generated from project key.

idstring uuid required

Unique id of the project

organization_idstring uuid required

Unique id of the organization that the project belongs to.

created_atstring date-time required

Date and time when the project was created (ISO_8601 format).

updated_atstring date-time required

Date and time when the project was last updated/modified (ISO_8601 format).

namestring required

The name of the project

descriptionstring

a longer description outlining the project objectives

settingsobject

the settings for this project

active_policy_repo_idstring uuid

the id of the policy repo to use for this project