Sign in
security-servers

update the security server's address

Changed on
<h3>CS administrator changes the address of a security server.</h3>
patch/security-servers/{server_id}

Request

  • Base URL: /api/v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/security-servers/{server_id}
  • Auth: API key in header Authorization

Request body

server_addressstring text required

security server address (ip or name)

Example request

{
  "server_address": "192.168.1.100"
}

Response

the updated security server

server_addressstring text required

security server address (ip or name)

created_atstring date-time

object creation time

updated_atstring date-time

last time updated

owner_namestring
in_maintenance_modeboolean required

true if the security server is in maintenance mode, false otherwise

maintenance_mode_messagestring

optional message of maintenance mode

Example response

{
  "server_address": "192.168.1.100",
  "created_at": "2022-01-20T00:00:00.001Z",
  "updated_at": "2022-01-22T07:30:00.001Z",
  "server_id": {
    "instance_id": "FI",
    "member_class": "GOV",
    "server_code": "server123"
  }
}

Changes

  • 72c3c9c00de3Revision changes
    • ○

      mapped value for discriminator key MEMBER changed from ClientId to for //// response property for the response status

    • ○

      mapped value for discriminator key SERVER changed from SecurityServerId to for //// response property for the response status

    • ○

      mapped value for discriminator key SUBSYSTEM changed from ClientId to for //// response property for the response status

  • 49854d95889cRevision changes
    • ▲

      the ///// response's property format changed from text§ to text for status