Read a site's settings
get_siteReads one site's settings and state — serving mode, password, forms, scheduled takedown, folder, whether it is paused — and its versions, newest first, with the one being served marked.
Instructions
Reads one site's settings and state — serving mode, password, forms, scheduled takedown, folder, whether it is paused — and its versions, newest first, with the one being served marked. Also says which settings the account's plan does not include.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| site | Yes | Subdomain or site id, from list_sites. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | Its live URL. | |
| mode | Yes | How it serves its files. | |
| name | Yes | What it is called, or null. | |
| siteId | Yes | Identifier of the site. | |
| status | Yes | `active`, `paused`, or a state the platform put it in. | |
| comments | Yes | Who may comment on its pages: nobody, the people invited to comment (only while it is invite-only), or anybody signed in. Null when that could not be read. | |
| folderId | Yes | The folder it is filed in, or null at the top level. | |
| versions | Yes | Its versions, newest first. | |
| available | Yes | Which settings the account's plan includes. | |
| expiresAt | Yes | When it is scheduled to come down, or null. | |
| subdomain | Yes | Its subdomain. | |
| invitedOnly | Yes | Whether only invited people can open it, or null when that could not be read. Null does not mean public. | |
| expiryAction | Yes | What the takedown does: `pause` or `delete`, or null when none is scheduled. | |
| formsEnabled | Yes | Whether it accepts form submissions. | |
| passwordProtected | Yes | Whether visitors must type a password. |