Products Solutions Developer Pricing Get For Free Download Sign in Sign up
Show topics

Server Identity Settings Update

Updates server identity settings.

Request

Property Value
Method PATCH
URL /api/server/settings/identity
Content-Type application/json
Authentication Bearer Token

Request Body

Parameter Type Required Description
data.attributes.serverName string No Server display name
data.attributes.hostName string No Server hostname
data.attributes.groupName string No Server group name

Example Request

{
  "data": {
    "attributes": {
      "serverName": "Server 2",
      "hostName": "stormdev2.web-anatomy.com",
      "groupName": "Premise"
    }
  }
}

Response

Status Codes

Code Description
200 Success - Settings updated
400 Bad Request - Invalid parameters
401 Unauthorized - Invalid or missing token
429 Too Many Requests - Rate limit exceeded
500 Internal Server Error

Successful Response (200)

{
  "data": {
    "attributes": {
      "serverName": {
        "editable": true,
        "value": "name"
      },
      "hostName": {
        "editable": true,
        "value": "host"
      },
      "groupName": {
        "editable": true,
        "value": "group"
      }
    }
  },
  "meta": {
    "executionTime": 27,
    "generatedAt": 1764850757128
  },
  "message": "Identity Settings have been updated"
}

Response Body

Identity Settings

Parameter Type Description
data.attributes.serverName.value string Server display name
data.attributes.serverName.editable boolean Indicates if the field can be modified
data.attributes.serverName.lockedBy string Locked by environment variable (if present)
data.attributes.hostName.value string Server hostname
data.attributes.hostName.editable boolean Indicates if the field can be modified
data.attributes.hostName.lockedBy string Locked by environment variable (if present)
data.attributes.groupName.value string Server group name
data.attributes.groupName.editable boolean Indicates if the field can be modified
data.attributes.groupName.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)

Error Response (4xx/5xx)

{
  "message": "Error message"
}

Error Response Body

Parameter Type Description
message string Human-readable error message