Get domain

GET /api/domains/{id}
OAuth2

Get domain details by ID, by calling this API, the domain status will be synced from remote provider.

Path parameters

  • id string Required

    The unique identifier of the domain.

Responses

  • 200 application/json

    Details of the domain.

    Hide response attributes Show response attributes object
    • id string Required

      Minimum length is 1, maximum length is 21.

    • domain string Required

      Minimum length is 1, maximum length is 256.

    • status string Required

      Values are PendingVerification, PendingSsl, Active, or Error.

    • errorMessage string | null Required

      Maximum length is 1024.

    • dnsRecords array[object] Required
      Hide dnsRecords attributes Show dnsRecords attributes object
  • 400

    Bad Request

  • 401

    Unauthorized

  • 403

    Forbidden

  • 404

    The domain with the specified ID was not found.

GET /api/domains/{id} 
curl \
 -X GET https://[tenant_id].logto.app/api/domains/{id} \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "id": "string",
  "domain": "string",
  "status": "PendingVerification",
  "errorMessage": "string",
  "dnsRecords": [
    {
      "name": "string",
      "type": "string",
      "value": "string"
    }
  ]
}