Update system

Update an existing system. Only the fields provided in the request body will be updated. If a field is provided, the new content will replace the existing content. If a field is not provided, the existing content will remain unchanged.

patch/systems/{systemId}

Path parameters

systemIdstring uuid required

Example:12345678-0a8b-4f66-b6f3-2ddcfa097257

The ID of the system to update.

Request body

namestring

The name of the system. Unique within the project.

descriptionstring

The description of the system.

productionVersionIdstring uuid

The ID of the production version of the system.

Response

System updated successfully

idstring uuid required

The ID of the system.

namestring required

The name of the system. Unique within the project.

descriptionstring required

The description of the system.

Changes

Changed in 1 of the 37 revisions of this API.335

Jun 27, 2025013895a80cfe335See the full diff
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ●
  removed the request property
  request-property-removed
- ●
  removed the request property
  request-property-removed
- ●
  removed the request property
  request-property-removed
- ○
  added the new optional request property
  new-optional-request-property
- ○
  the request property default value was added
  request-property-default-value-added
- ○
  the response's property default value was added for the status
  response-property-default-value-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added

Full history