Domains

Add a website

Creates the website with its monitors (uptime, certificate, DNS, registration, plus a keyword check, a content check and a port check that stay disabled until PUT /domains/{id}/keyword, /content and /port give them something to look at) and probes it inline, so the response usually already carries a first result; anything too slow is finished by the scheduler within a minute. The uptime check requests the root over GET until PUT /domains/{id}/http gives it HTTP options. If the organization has no alert rules yet, one email rule per check is created so alerts reach the key's creator with no further setup.

post/v1/domains

Request

  • Base URL: https://api.upcheck.so
  • URL: https://api.upcheck.so/v1/domains
  • Auth: HTTP bearer

Request body

domainstring required

A hostname. A scheme, path or port is stripped, so a full URL is accepted.

friendlyNamestring

A label shown instead of the hostname.

Example request

{
  "domain": "www.example.com",
  "friendlyName": "Marketing site"
}

Response

Created.

idstring required

Opaque identifier.

organizationIdstring required

Opaque identifier.

domainstring required
friendlyNamestring nullable required
hostnamestring required
certificateStatus'checking' | 'healthy' | 'expiring_soon' | 'expired' | 'invalid' | 'unreachable' required
certificateIssuerstring required
certificateExpiresAtnumber required

Unix ms.

certificateDaysRemainingnumber required
certificateLastCheckednumber required
certificateNextChecknumber required
certificateAutoRenewboolean nullable required
certificateLastErrorstring nullable required
registrationStatus'checking' | 'healthy' | 'expiring_soon' | 'expired' | 'at_risk' | 'unsupported' | 'lookup_failed' nullable required
registrarstring required
registrationExpiresAtnumber required
registrationDaysRemainingnumber required
registrationLastCheckednumber nullable required
registrationNextChecknumber nullable required
registrationLastErrorstring nullable required

Example response

{
  "id": "9b1d...",
  "organizationId": "9b1d...",
  "domain": "www.example.com"
}

Changes

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