Sign in
CMServerService

UpdateCMServer

Changed on
patch/api/v2/cmservers/{id}

Request

  • The document declares no server URL.
  • Auth: none declared

Path parameters

idinteger required

The id of the CMServer

Request body

sshPortinteger
credentialIdstring
serverNamestring required
tagIdsstring[]
servicePortinteger required

Response

A successful response.

idinteger
namestring
createTimestring date-time required
updateTimestring date-time required
hostIdstring
hostIpstring
domainIdinteger
domainNamestring
status'STATE_UNSPECIFIED' | 'ONLINE' | 'OFFLINE'
  • STATE_UNSPECIFIED: unspecified
  • ONLINE: online
  • OFFLINE: offline
serviceStatus'SERVICE_STATE_UNSPECIFIED' | 'RUNNING' | 'STARTING' | 'RESTARTING' | 'UPGRADING' | 'ABNORMAL' | 'STOPPED'
  • SERVICE_STATE_UNSPECIFIED: unspecified
  • RUNNING: running
  • STARTING: starting
  • RESTARTING: starting
  • UPGRADING: upgrading
  • ABNORMAL: abnormal
  • STOPPED: stopped
credentialIdstring required
serviceVersionstring
servicePortinteger required
serviceHomestring required

Changes