List all domains

List every hostname across your applications with GET /v2/apps/domains: custom domains first, then the default squareweb.app subdomains, each with its app.

GET /v2/apps/domains

List all domains

cURL

curl --request GET \
  --url https://api.squarecloud.app/v2/apps/domains \
  --header 'Authorization: <authorization>'

{
  "status": "success",
  "response": [
    { "app_id": "a1b2c3d4e5f64a7b8c9d0e1f2a3b4c5d", "hostname": "example.com", "type": "custom" },
    { "app_id": "a1b2c3d4e5f64a7b8c9d0e1f2a3b4c5d", "hostname": "my-app.squareweb.app", "type": "subdomain" }
  ]
}

Authorization · string · required

The API key for your account. You can find this in your account settings.

Requires an API key with the apps:read scope.

Use this endpoint to get a single, account-wide view of every hostname you have configured, useful for populating a domains overview page without calling Get Application Info once per application. To attach or change a custom domain on a specific application, see Set Custom Domain; DNS records for a domain are retrieved separately via Get DNS Records.

This endpoint accepts either your API key or a session token (JWT) in the Authorization header. Authentication is required: requests without it return 401.

Response

status · string

Indicates whether the call was successful: success if it was, error if not.

The response array is a flattened list of every hostname across the applications you own. Custom domains come first, followed by the default *.squareweb.app subdomains. Applications without a web domain (e.g. workers and bots) are omitted.

This list is served from the cached project list, so it does not count against the per-application network rate limits.

response · array

The list of hostnames.

Show Toggle object

app_id · string

The 32-character hex identifier of the application that owns the domain.

hostname · string

The fully qualified hostname.

type · string

"subdomain" for the default *.squareweb.app host; "custom" for an attached custom domain.

{
  "status": "success",
  "response": [
    { "app_id": "a1b2c3d4e5f64a7b8c9d0e1f2a3b4c5d", "hostname": "example.com", "type": "custom" },
    { "app_id": "a1b2c3d4e5f64a7b8c9d0e1f2a3b4c5d", "hostname": "my-app.squareweb.app", "type": "subdomain" }
  ]
}

Related

• CLI: squarecloud app domains
• SDKs: api.apps.domains() (JavaScript), client.apps.domains() (Python), c.Apps.Domains() (Go)