domains

Get domain by FQDN

Get domain by FQDN

get/domain/fqdn/{fqdn}

Request

  • Base URL: https://api.faable.com
  • URL: https://api.faable.com/domain/fqdn/{fqdn}
  • Auth: one of:
    • OAuth 2 (authorization code, authorization URL https://faable.auth.faable.link/authorize, token URL https://faable.auth.faable.link/oauth/token)
    • HTTP bearer
    • OAuth 2 (client credentials, token URL https://faable.auth.faable.link/oauth/token)
    • HTTP bearer
    • HTTP basic
    • API key in query parameter apikey

Path parameters

fqdnstring required

Response

Domain

idstring required

Domain ID

teamstring required
fqdnstring required

Unique identifier of the domain

tlsboolean required

TLS is enabled for this domain

app_idstring nullable

Linked App

verifiedboolean required

If the domain has the ownership verified

activeboolean required
dns_aliasstring nullable

Internal DNS alias override host

dormant_atstring date-time nullable

Set when the domain went dormant: it served no active app and had not pointed at Faable for two days. It is not checked nor served until POST /domain/:id/recheck.

recheck_atstring date-time nullable

Last manual re-check (Retry) of this domain

metadataobject required
createdAtstring required

Domain creation date

updatedAtstring

Domain updated date

Changes

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