Imap Pop Monitors

Create IMAP/POP Monitor

POST /api/imap-pop-monitors

post/api/imap-pop-monitors

Request

  • Base URL: https://uptimeify.io
  • URL: https://uptimeify.io/api/imap-pop-monitors
  • Auth: HTTP bearer

Request body

namestring required
hostnamestring required
portinteger nullable
status'active' | 'inactive' | 'maintenance' | 'disabled'
checkIntervalinteger
timeoutSecondsinteger
imapPopConfigobject

Required with checkMode protocol: user and password; protocol imap or pop3, tls.

allowedCheckCountryCodesstring[]
managementType'managed' | 'self_service'
checkMode'protocol' | 'tcp'

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.

imapPopConfigobject required

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

hasPasswordboolean required

Changes

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