Ssh Monitors

Update SSH Monitor

PATCH /api/ssh-monitors/:sshMonitorPublicId

patch/api/ssh-monitors/{id}

Request

  • Base URL: https://uptimeify.io
  • URL: https://uptimeify.io/api/ssh-monitors/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Request body

customerIdinteger

Move to another customer of the organization.

namestring
hostnamestring
status'active' | 'inactive' | 'maintenance' | 'disabled'

inactive is stored as disabled.

checkIntervalinteger
timeoutSecondsinteger
allowedCheckCountryCodesstring[] nullable
managementType'managed' | 'self_service'
portinteger nullable
checkMode'protocol' | 'tcp'

tcp only checks that the port accepts connections.

sshConfigobject

Merged; missing secrets keep the stored ones.

configobject

Alias of sshConfig.

Response

OK

idinteger required
allowedCheckCountryCodesstring[] nullable required

ISO country codes of the allowed check locations; null = all.

publicIdstring uuid required
organizationIdinteger required
customerIdinteger required
namestring required
hostnamestring required
checkIntervalinteger required

Minutes.

timeoutSecondsinteger required
status'active' | 'maintenance' | 'disabled' required
managementType'managed' | 'self_service' required
notificationPhoneNumberstring nullable required
notificationEmailstring nullable required
lastCheckedAtstring date-time nullable required
createdAtstring date-time required
updatedAtstring date-time required
portinteger required
configobject required

Protocol settings. Secrets (password, privateKey, passphrase, auth.pass) are always null.

checkMode'protocol' | 'tcp' required

tcp only checks that the port accepts connections.

sshConfigobject required

Protocol settings. Secrets (password, privateKey, passphrase, auth.pass) are always null.

hasPasswordboolean required
hasPrivateKeyboolean required

Changes

No recorded changes to this operation across all 1 revision of this API.