# Sitepaste

> Publish a blog, a portfolio, or your documentation. Guides, concepts, and the API reference.

## API reference

- [Delete a section](https://docs.sitepaste.com/api/sections/delete-sections-contenttype/index.md): Delete a section, every page in it, and the metadata that names it.
- [Finish a direct upload](https://docs.sitepaste.com/api/media/post-uploads-complete/index.md): Validate an uploaded file and add it to the media library.
- [Write many event types at once](https://docs.sitepaste.com/api/events/post-event-types-batch/index.md): Upsert event types by slug, with deletes in the same call.
- [Write many events at once](https://docs.sitepaste.com/api/events/post-events-batch/index.md): Create, update, and delete events in one request.
- [Write many pages at once](https://docs.sitepaste.com/api/pages/post-pages-batch/index.md): Create, update, and delete pages in one request.
- [Abort an upload](https://docs.sitepaste.com/api/media/delete-uploads-uploadid/index.md): Abort an in-progress presigned upload.
- [Add a domain](https://docs.sitepaste.com/api/domains/post-domains/index.md): Add a custom domain and receive its DNS setup records.
- [Create a media folder](https://docs.sitepaste.com/api/media/post-media-folders/index.md): Create a media folder (photographer galleries).
- [Create a preview](https://docs.sitepaste.com/api/previews/post-previews/index.md): Build the site to a shareable preview before deploying.
- [Create a site](https://docs.sitepaste.com/api/sites/post-sites/index.md): Create a site within the paid allowance.
- [Create a subscriber](https://docs.sitepaste.com/api/data/post-newsletter-subscribers/index.md): Add a newsletter subscriber directly.
- [Create an author](https://docs.sitepaste.com/api/authors/post-authors/index.md): Create an author on a site.
- [Create an event](https://docs.sitepaste.com/api/events/post-events/index.md): Create one event on a site.
- [Create an event type](https://docs.sitepaste.com/api/events/post-event-types/index.md): Create one event type on a site.
- [Delete a contact submission](https://docs.sitepaste.com/api/data/delete-contact-submissions-id/index.md): Delete one contact form submission.
- [Delete a media file](https://docs.sitepaste.com/api/media/delete-media-fileid/index.md): Delete a single media file from the library and storage.
- [Delete a media folder](https://docs.sitepaste.com/api/media/delete-media-folders-folderid/index.md): Delete a media folder; its files return to the library root.
- [Delete a page](https://docs.sitepaste.com/api/pages/delete-pages-path/index.md): Delete a single page at its own URI.
- [Delete a preview](https://docs.sitepaste.com/api/previews/delete-previews-previewid/index.md): Expire a preview and remove its output.
- [Delete a site](https://docs.sitepaste.com/api/sites/delete-sites-siteid/index.md): Delete a site and everything on it.
- [Delete a subscriber](https://docs.sitepaste.com/api/data/delete-newsletter-subscribers-id/index.md): Remove a newsletter subscriber.
- [Delete a tag](https://docs.sitepaste.com/api/tags/delete-tags-slug/index.md): Remove a tag from every page and drop its metadata.
- [Delete an author](https://docs.sitepaste.com/api/authors/delete-authors-id/index.md): Delete an author by id.
- [Delete an event](https://docs.sitepaste.com/api/events/delete-events-id/index.md): Delete a single event by id.
- [Delete an event type](https://docs.sitepaste.com/api/events/delete-event-types-slug/index.md): Delete a single event type by slug.
- [Delete several media files](https://docs.sitepaste.com/api/media/delete-media/index.md): Delete a set of media files in one request.
- [Deploy history](https://docs.sitepaste.com/api/deployments/get-deployments/index.md): List recent deploys with status and attribution.
- [Get a deploy](https://docs.sitepaste.com/api/deployments/get-deployments-id/index.md): Read one deploy from the site's history.
- [Get deploy status](https://docs.sitepaste.com/api/deployments/get-deployments-latest/index.md): Get the most recent deploy's status for a site.
- [Get the live deploy](https://docs.sitepaste.com/api/deployments/get-deployments-live/index.md): Read the deploy currently serving the site.
- [List contact submissions](https://docs.sitepaste.com/api/data/get-contact-submissions/index.md): List a site's contact form submissions.
- [List domains](https://docs.sitepaste.com/api/domains/get-domains/index.md): List custom domains with status and capacity counts.
- [List event types](https://docs.sitepaste.com/api/events/get-event-types/index.md): List a site's event types in display order.
- [List events](https://docs.sitepaste.com/api/events/get-events/index.md): List a site's events, hidden ones included.
- [List media](https://docs.sitepaste.com/api/media/get-media/index.md): List the files in the workspace media library.
- [List media folders](https://docs.sitepaste.com/api/media/get-media-folders/index.md): List the workspace's media folders, alphabetically by name.
- [List previews](https://docs.sitepaste.com/api/previews/get-previews/index.md): List a site's active previews.
- [List sections](https://docs.sitepaste.com/api/sections/get-sections/index.md): List a site's sections with page counts and metadata.
- [List sites](https://docs.sitepaste.com/api/sites/get-sites/index.md): List the workspace's sites with capacity counts.
- [List subscribers](https://docs.sitepaste.com/api/data/get-newsletter-subscribers/index.md): List a site's newsletter subscribers.
- [List tags](https://docs.sitepaste.com/api/tags/get-tags/index.md): List a site's tags with page counts and metadata.
- [Pending changes](https://docs.sitepaste.com/api/deployments/get-pending-changes/index.md): See what changed since the last deploy.
- [Promote a preview](https://docs.sitepaste.com/api/previews/post-previews-promote/index.md): Swap a ready preview into the live site.
- [Read a contact submission](https://docs.sitepaste.com/api/data/get-contact-submissions-id/index.md): Read one contact form submission.
- [Read a domain](https://docs.sitepaste.com/api/domains/get-domains-domainid/index.md): Read one custom domain's status and DNS records.
- [Read a media file](https://docs.sitepaste.com/api/media/get-media-fileid/index.md): Read one file's record from the media library.
- [Read a media folder](https://docs.sitepaste.com/api/media/get-media-folders-folderid/index.md): Read one media folder.
- [Read a page](https://docs.sitepaste.com/api/pages/get-pages-path/index.md): Read a single page's full record, content included.
- [Read a preview](https://docs.sitepaste.com/api/previews/get-previews-previewid/index.md): Read one preview's status and URL.
- [Read a section](https://docs.sitepaste.com/api/sections/get-sections-contenttype/index.md): Read one section with its page count and metadata.
- [Read a site](https://docs.sitepaste.com/api/sites/get-sites-siteid/index.md): Read one site's full settings by id.
- [Read a subscriber](https://docs.sitepaste.com/api/data/get-newsletter-subscribers-id/index.md): Read one newsletter subscriber's record.
- [Read a tag](https://docs.sitepaste.com/api/tags/get-tags-slug/index.md): Read one tag with its page count and metadata.
- [Read an author](https://docs.sitepaste.com/api/authors/get-authors-id/index.md): Read one author's record.
- [Read an event](https://docs.sitepaste.com/api/events/get-events-id/index.md): Read one event's record, hidden ones included.
- [Read an event type](https://docs.sitepaste.com/api/events/get-event-types-slug/index.md): Read one event type by its slug.
- [Read an upload](https://docs.sitepaste.com/api/media/get-uploads-uploadid/index.md): Read an upload's state: whether its bytes have landed yet.
- [Read the workspace](https://docs.sitepaste.com/api/workspace/get-workspace/index.md): Read the workspace a token acts on, and which site is its default.
- [Reassign a domain](https://docs.sitepaste.com/api/domains/patch-domains-domainid/index.md): Point a domain at a different site in the workspace.
- [Rebuild a preview](https://docs.sitepaste.com/api/previews/post-previews-rebuild/index.md): Rebuild a preview with the current content.
- [Refresh domain status](https://docs.sitepaste.com/api/domains/post-domains-refresh/index.md): Re-check a verified domain's DNS and certificate state, and update its status.
- [Remove a domain](https://docs.sitepaste.com/api/domains/delete-domains-domainid/index.md): Remove a custom domain from the workspace.
- [Reorder event types](https://docs.sitepaste.com/api/events/patch-event-types/index.md): Set the display order of a site's event types by slug.
- [Reorder nav groups](https://docs.sitepaste.com/api/sections/patch-sections/index.md): Write the full nav-group order in one atomic request.
- [Set section metadata](https://docs.sitepaste.com/api/sections/patch-sections-contenttype/index.md): Set a section's display title, description, and nav position.
- [Set the default site](https://docs.sitepaste.com/api/workspace/patch-workspace/index.md): Make a site the workspace default.
- [Site metrics](https://docs.sitepaste.com/api/data/get-metrics/index.md): Read a site's traffic metrics.
- [Start a direct upload](https://docs.sitepaste.com/api/media/post-uploads/index.md): Get presigned URLs to send a file straight to storage.
- [Trigger a deploy](https://docs.sitepaste.com/api/deployments/post-deployments/index.md): Queue a deploy that publishes your saved pages as a static site.
- [Undeploy a site](https://docs.sitepaste.com/api/deployments/delete-deployments-live/index.md): Take a site offline, keeping all content.
- [Update a media file](https://docs.sitepaste.com/api/media/patch-media-fileid/index.md): Set a file's note, move it between folders, or both.
- [Update a media folder](https://docs.sitepaste.com/api/media/patch-media-folders-folderid/index.md): Rename a media folder, or reorder the media inside it.
- [Update a page](https://docs.sitepaste.com/api/pages/patch-pages-path/index.md): Update one page at its own URI, without sending a batch.
- [Update a preview](https://docs.sitepaste.com/api/previews/patch-previews-previewid/index.md): Change a preview's visibility or password.
- [Update a site](https://docs.sitepaste.com/api/sites/patch-sites-siteid/index.md): Update one site's settings by id.
- [Update a subscriber](https://docs.sitepaste.com/api/data/patch-newsletter-subscribers-id/index.md): Update a subscriber's fields or confirm them.
- [Update a tag](https://docs.sitepaste.com/api/tags/patch-tags-slug/index.md): Rename a tag across the site, set its display title and description, or both.
- [Update an author](https://docs.sitepaste.com/api/authors/patch-authors-id/index.md): Update an author's fields by id.
- [Update an event](https://docs.sitepaste.com/api/events/patch-events-id/index.md): Update one event at its own URL, without sending a batch.
- [Update an event type](https://docs.sitepaste.com/api/events/patch-event-types-slug/index.md): Update one event type at its own URL.
- [Update several media files](https://docs.sitepaste.com/api/media/patch-media/index.md): Move a set of files into a folder, or note them, in one request.
- [Verify a domain](https://docs.sitepaste.com/api/domains/post-domains-verify/index.md): Check the domain's ownership TXT record.
- [Get site settings](https://docs.sitepaste.com/api/site/get-site/index.md): Read a site's full settings, including protection state, theme, navigation, and typography.
- [List authors](https://docs.sitepaste.com/api/authors/get-authors/index.md): List a site's authors and the IDs used to credit pages to them.
- [Update site settings](https://docs.sitepaste.com/api/site/patch-site/index.md): Change a site's settings, including protection, theme, layout, navigation, footer, and typography.
- [Create a page](https://docs.sitepaste.com/api/pages/post-pages/index.md): Create one page on a site.
- [Get deploy status](https://docs.sitepaste.com/api/builds/get-builds-latest/index.md): Get the most recent deploy's status for a site.
- [Inline media](https://docs.sitepaste.com/api/media/inline-media/index.md): Attach files to a pages request and reference them with the file: prefix.
- [List pages](https://docs.sitepaste.com/api/pages/get-pages/index.md): List page metadata for a site, including the IDs used for renames.
- [Trigger a deploy](https://docs.sitepaste.com/api/builds/post-builds/index.md): Queue a deploy that publishes your saved pages as a static site.
- [Upload media](https://docs.sitepaste.com/api/media/post-media/index.md): Upload a single file and get its URL to reference in content.
- [API overview](https://docs.sitepaste.com/api/overview/index.md)
- [Authentication](https://docs.sitepaste.com/api/authentication/index.md)
- [Examples](https://docs.sitepaste.com/api/examples/index.md)

## Concepts

- [Agents](https://docs.sitepaste.com/concepts/agents/index.md): How AI agents read your site, through each page's Markdown source and the site's llms.txt.
- [Protection](https://docs.sitepaste.com/concepts/protection/index.md): Restrict who can view your site or individual pages, with a password or workspace sign-in. A Pro plan feature.
- [Plans](https://docs.sitepaste.com/concepts/plans/index.md): What the Free and Pro plans include, add-ons, and how deploys are counted.
- [Events](https://docs.sitepaste.com/concepts/events/index.md): Publish a schedule of classes, workshops, or sessions with dates, prices, and booking links. A Pro plan feature.
- [Content types](https://docs.sitepaste.com/concepts/content-types/index.md): How blog posts, docs pages, standalone pages, and your homepage are organized on a Sitepaste site.
- [Custom domains](https://docs.sitepaste.com/concepts/custom-domains/index.md): Connect your own domain to a Sitepaste site. A Pro plan feature.
- [Media](https://docs.sitepaste.com/concepts/media/index.md): Uploading images and files, how they are processed, and storage limits.
- [Sections](https://docs.sitepaste.com/concepts/sections/index.md): Group pages under paths you choose, like /docs/guides/ or a custom top-level path like /recipes/, nested one level deep.
- [Sites and workspaces](https://docs.sitepaste.com/concepts/sites-and-workspaces/index.md): How workspaces hold sites, team members, media, and billing.
- [Themes](https://docs.sitepaste.com/concepts/themes/index.md): The available themes and how to customize how your site looks.

## Guides

- [Apple Shortcuts](https://docs.sitepaste.com/guides/publish-from/apple-shortcuts/index.md): Publish to your Sitepaste site from Apple Notes or a Shortcuts automation on iPhone and Mac.
- [GitHub Actions](https://docs.sitepaste.com/guides/publish-from/github-actions/index.md): Deploy a directory of Markdown files to your Sitepaste site whenever you push.
- [Obsidian](https://docs.sitepaste.com/guides/publish-from/obsidian/index.md): Publish notes from your Obsidian vault to your Sitepaste site with the official plugin.
- [Getting started](https://docs.sitepaste.com/guides/getting-started/index.md): Create a Sitepaste site, write your first page, and deploy it.