Check site status
get_siteCheck a beacon.host site: whether it is live, its URL, whether it has a password, and when it expires. With the site's claim_token (or an API key that owns the site) it also returns the file list, total size, live version and claim link. Use it to confirm a publish worked, to see when an anonymous site expires, or to see what is published at a slug.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| slug | Yes | The site's slug, i.e. the subdomain in <slug>.beacon.host. A full URL also works. | |
| claim_token | No | Optional claim_token (ctk_...) of the site. Unlocks the file list and other details. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | No | ||
| slug | Yes | ||
| files | No | File paths of the live version (first 200). | |
| title | No | ||
| status | Yes | live, not_live (created but nothing published yet) or not_found (never published, expired or deleted). | |
| claimed | No | Whether an account owns the site. Only returned when can_manage is true. | |
| summary | Yes | ||
| claim_url | No | ||
| can_manage | Yes | True when the claim_token or API key you sent lets you update this site. | |
| created_at | No | ||
| expires_at | No | When the site will be deleted (RFC 3339). Empty for sites that never expire. | |
| file_count | No | ||
| updated_at | No | ||
| total_bytes | No | ||
| files_truncated | No | ||
| current_version_id | No | ||
| password_protected | Yes |