Parameter Update

Updates an existing parameter configuration.

Request

Property	Value
Method	`PUT`
URL	`/api/server/settings/parameters/{parameterId}`
Content-Type	`application/json`
Authentication	Bearer Token

Request

bash

curl -X PUT "{BASE_URL}/api/server/settings/parameters/{parameterId}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"key": "value"}'

Path Parameters

Parameter	Type	Required	Description
`parameterId`	integer	Yes	Unique identifier of the parameter

Request With Parameters

bash

curl -X PUT "{BASE_URL}/api/server/settings/parameters/{parameterId}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"

Request Body

Parameter	Type	Required	Description
`data.attributes.name`	string	No	Parameter name
`data.attributes.value`	string	No	Parameter value

Request Body

json

{
  "data": {
    "attributes": {
      "name": "name1",
      "value": "value1"
    }
  }
}

Response Body

Parameter

Parameter	Type	Description
`data.id`	integer	Unique identifier of the parameter
`data.attributes.name.value`	string	Parameter name
`data.attributes.name.editable`	boolean	Indicates if the field can be modified
`data.attributes.name.lockedBy`	string	Locked by environment variable (if present)
`data.attributes.value.value`	string	Parameter value
`data.attributes.value.editable`	boolean	Indicates if the field can be modified
`data.attributes.value.lockedBy`	string	Locked by environment variable (if present)
`message`	string	Response status message

Metadata

Parameter	Type	Description
`meta.executionTime`	integer	Request processing time in milliseconds
`meta.generatedAt`	integer	Response generation timestamp (Unix timestamp in ms)

Successful Response (200)

json

{
  "data": {
    "attributes": {
      "name": {
        "editable": true,
        "value": "name1"
      },
      "value": {
        "editable": true,
        "value": "value1"
      }
    },
    "id": 0
  },
  "meta": {
    "executionTime": 33,
    "generatedAt": 1771936623127
  },
  "message": "New Parameter has been updated."
}

Error Response (4xx/5xx)

Parameter	Type	Description
`message`	string	Human-readable error message

Parameter Not Found (404)

json

{
  "message": "Parameter Entity not found"
}

Error Response

json

{
  "message": "Error message"
}

Support Needed?

Create a free ticket and our support team will provide you necessary assistance.