Skip to content
English
  • There are no suggestions because the search field is empty.

Set project archived state

PUT /api/v1/projects/{projectId}/archived Select code sample Fetch cURL
const url = 'https://localhost:10001/api/v1/projects/1/archived';const options = {  method: 'PUT',  headers: {Authorization: '
  
   ', 'Content-Type': 'application/json'}, body: '{"archived":true}'}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}
  
curl --request PUT \  --url https://localhost:10001/api/v1/projects/1/archived \  --header 'Authorization: 
  
   ' \ --header 'Content-Type: application/json' \ --data '{ "archived": true }'
  

Archive or unarchive a specific project; archiving requires all project policies to be archived first

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ” projectId required integer

Project ID

Request Body

Section titled “Request Body ”

Archived state

Media type application/json object archived boolean
Example generated
{  "archived": true}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Updated project

Media type application/json object archivedAt string createdAt string description string id integer isArchived boolean name string organizationId integer status

Status field from auth-service

string updatedAt string uuid string
Example generated
{  "archivedAt": "example",  "createdAt": "example",  "description": "example",  "id": 1,  "isArchived": true,  "name": "example",  "organizationId": 1,  "status": "example",  "updatedAt": "example",  "uuid": "example"}

400

Section titled “400 ”

Bad request - Invalid project ID, missing archived flag, or active policies remain

Media type application/json object key additional properties string
Example generated
{  "additionalProperty": "example"}

401

Section titled “401 ”

Unauthorized - Authentication required

Media type application/json object key additional properties string
Example generated
{  "additionalProperty": "example"}

403

Section titled “403 ”

Forbidden - No project access or insufficient permissions

Media type application/json object key additional properties string
Example generated
{  "additionalProperty": "example"}

404

Section titled “404 ”

Project not found

Media type application/json object key additional properties string
Example generated
{  "additionalProperty": "example"}

500

Section titled “500 ”

Internal server error

Media type application/json object key additional properties string
Example generated
{  "additionalProperty": "example"}
Previous
Get project
Next
Get project by UUID