Skip to content

REST POST profiles

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

REST: POST /profiles

Creates a new profile.


Request

POST /profiles
Content-Type: application/json

Body

All fields are optional except where noted. Omitted fields receive defaults.

{
  "name": "My Server",
  "jarPath": "C:\\servers\\app.jar",
  "workingDir": "",
  "jvmArgs": [
    { "value": "-Xmx2g", "enabled": true }
  ],
  "systemProperties": [],
  "programArgs": [],
  "javaPath": "",
  "autoStart": false,
  "autoRestart": false,
  "autoRestartInterval": 10,
  "color": "#4ade80"
}
Field Required Default Description
name No "New Profile" Display name
jarPath No "" Must be set before the profile can be started
workingDir No "" Empty = directory of the JAR
jvmArgs No [{"-Xmx1g", true}] JVM argument list
systemProperties No [] -D property list
programArgs No [] Program argument list
javaPath No "" Empty = java from PATH
autoStart No false Start when JRC launches
autoRestart No false Restart on non-zero exit
autoRestartInterval No 10 Seconds between restart attempts
color No first available color Hex accent color

Response

201 Created

Returns the created profile with server-assigned id, createdAt, and updatedAt:

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "My Server",
  "jarPath": "C:\\servers\\app.jar",
  "workingDir": "",
  "jvmArgs": [{ "value": "-Xmx2g", "enabled": true }],
  "systemProperties": [],
  "programArgs": [],
  "javaPath": "",
  "autoStart": false,
  "autoRestart": false,
  "autoRestartInterval": 10,
  "color": "#4ade80",
  "createdAt": 1700000000000,
  "updatedAt": 1700000000000
}

400 Bad Request — if name is provided but is not a string, or if argument array items are malformed.

Clone this wiki locally