{
  "opencollection": "1.0.0",
  "info": {
    "name": "Logto API references Account center Domains API",
    "version": "Cloud"
  },
  "request": {
    "auth": {
      "type": "oauth2",
      "flow": "client_credentials",
      "accessTokenUrl": "/oidc/token",
      "credentials": {
        "clientId": "{{clientId}}",
        "clientSecret": "{{clientSecret}}"
      }
    }
  },
  "items": [
    {
      "info": {
        "name": "Domains",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get domains",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://[tenant_id].logto.app/api/domains"
          },
          "docs": "Get all of your custom domains."
        },
        {
          "info": {
            "name": "Create domain",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://[tenant_id].logto.app/api/domains",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a new domain with the given data. The maximum domain number is 1, once created, can not be modified, you'll have to delete and recreate one."
        },
        {
          "info": {
            "name": "Get domain",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://[tenant_id].logto.app/api/domains/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the domain."
              }
            ]
          },
          "docs": "Get domain details by ID, by calling this API, the domain status will be synced from remote provider."
        },
        {
          "info": {
            "name": "Delete domain",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://[tenant_id].logto.app/api/domains/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the domain."
              }
            ]
          },
          "docs": "Delete domain by ID."
        },
        {
          "info": {
            "name": "Cleanup stale domains",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://[tenant_id].logto.app/api/domains/cleanup",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Clean up custom domains that have been inactive (not verified) for a specified number of days. This uses Cloudflare as the source of truth to determine domain activity."
        }
      ]
    }
  ],
  "bundled": true
}