Skip to content

REST PUT profiles id

Timon Home edited this page Mar 19, 2026 · 1 revision

REST: PUT /profiles/:id

Updates an existing profile. Replaces the stored profile with the provided object. Partial updates are not supported — send the full profile.


Request

PUT /profiles/:id
Content-Type: application/json

Path parameters

Parameter Type Description
id string Profile UUID

Body

Complete Profile object. The id in the body must match the path parameter.

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "My Server",
  "jarPath": "C:\\servers\\app.jar",
  "workingDir": "C:\\servers",
  "jvmArgs": [
    { "value": "-Xmx4g", "enabled": true }
  ],
  "systemProperties": [
    { "key": "server.port", "value": "9090", "enabled": true }
  ],
  "programArgs": [],
  "javaPath": "",
  "autoStart": true,
  "autoRestart": true,
  "autoRestartInterval": 30,
  "color": "#60a5fa",
  "createdAt": 1700000000000,
  "updatedAt": 1700000000000
}

Response

200 OK

Returns the updated profile with a new updatedAt timestamp:

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "My Server",
  ...
  "updatedAt": 1700000999000
}

404 Not Found — if no profile with the given id exists.

400 Bad Request — if the body id does not match the path id.


Notes

If the profile being updated has a running process, the update is stored and takes effect on the next restart. The running process is not restarted automatically. Use POST /profiles/:id/stop then POST /profiles/:id/start to apply changes immediately.

The processManager snapshot for this profile is updated on save so auto-restart will use the new configuration.

Clone this wiki locally