Siteleaf

Cancel an active Siteleaf job by job ID. This irreversibly requests that the job stop.

Create a content collection in a Siteleaf site.

Upload one static file to a Siteleaf collection identified by its path. This action cannot create collection documents or content files with YAML front matter.

Create a document in a Siteleaf collection with content, taxonomy, metadata, and visibility.

Create a page in a Siteleaf site.

Grant a Siteleaf user an admin, publisher, or writer role on a site.

Create a Siteleaf site with its domain, timezone, metadata, and defaults.

Permanently delete a Siteleaf collection by site ID and collection path. This cannot be undone.

Permanently delete a Siteleaf document by ID. This cannot be undone.

Permanently delete a Siteleaf page by ID. This cannot be undone.

Delete a Siteleaf role by ID, removing the user's access to its site.

Permanently delete a Siteleaf site by ID. This cannot be undone.

Permanently delete one raw source file from a Siteleaf site. Directories and _config.yml are protected and cannot be deleted.

Get a collection by site ID and collection path.

Return the Siteleaf user authenticated by the connected API key.

Get a Siteleaf document by ID.

Get the complete buffered status stream for a Siteleaf job, including all status events and the latest status details. The call waits until Siteleaf closes the event stream.

Get a Siteleaf page by ID.

Get a Siteleaf site-access role by ID.

Get one Siteleaf site by ID, including its settings and current or most recent preview, publish, and synchronization job states.

Return the unique post tags and categories used by a Siteleaf site.

Get raw source-file metadata or list a source directory for a Siteleaf site.

Search and list static files in a Siteleaf collection with sorting and agent-controlled pagination.

List content collections in a Siteleaf site with agent-controlled pagination.

Search and list documents in a Siteleaf collection with visibility, extension, sorting, and pagination filters.

Search and list pages in a Siteleaf site with visibility, extension, sorting, and pagination filters.

List users who have access to a Siteleaf site with agent-controlled pagination.

List sites accessible to the connected Siteleaf account, with optional sorting and agent-controlled pagination.

Start an asynchronous compile-and-publish job for a Siteleaf site and return its job ID. This publishes externally visible site content and does not wait for job completion.

Update at least one of a collection's title, path, permalink, output behavior, or metadata.

Update at least one of a document's content, path, taxonomy, visibility, metadata, or date.

Update at least one of a page's content, path, visibility, metadata, or publication date.

Change an existing Siteleaf role to admin, publisher, or writer.

Update at least one of a site's title, domain, timezone, metadata, or Jekyll content defaults. Hosting credentials and repository sync are intentionally not accepted as agent inputs.

Create or replace one raw source file in a Siteleaf site.