Skip to content

Partial update of project attributes

PATCH
/projects/{projectId}

Partial update — send only changed fields. Updates the project name, description, or visibility. Requires admin role on the project. Returns a canonical toast response.

Authorizations

tokenAuth

Personal access token authentication. Send via Authorization header: Authorization: Token vulcan_xxx. Tokens are SHA-256 hashed server-side (never stored in plaintext). Scopes: read (GET), write (mutations), admin (everything). Create tokens via Settings → API Tokens in the web UI.

Type
HTTP (token)

Request Body

application/json
JSON
{
  
"project": {
  
  
"name": "Container Platform v2"
  
}
}

Responses

Project updated

application/json
JSON
{
  
"toast": {
  
  
"title": "Project updated.",
  
  
"message": [
  
  
  
"Successfully updated project."
  
  
],
  
  
"variant": "success"
  
}
}

Playground

Server
Authorization
Body

Samples

Powered by VitePress OpenAPI

Part of the MITRE Security Automation Framework (SAF)