Skip to main content
New to Corsair? See API access, authentication, and error handling.

Assets

bulkDelete

assets.bulkDelete Delete several assets in one call, with the same effect as deleting each Risk: destructive · Irreversible
Input Output

delete

assets.delete Delete one asset, so any content referencing it shows a broken file Risk: destructive · Irreversible
Input Output

get

assets.get Read one asset with its file details and metadata Risk: read
Input Output

list

assets.list List assets with a search and a folder filter Risk: read
Input Output

update

assets.update Change an asset’s metadata: alt text, title, copyright, focus point, privacy and publish window. Uploading new bytes is a separate flow and is not wrapped Risk: write
Input Metadata only: alt text, title, copyright, focus point, privacy and the publish window. Uploading new bytes is a separate signed-upload flow that is not wrapped. Output

Components

create

components.create Create a component, which is the field schema a content type uses. Its name is the key content references Risk: write
Input Output

delete

components.delete Delete a component. Content that uses it can no longer render, and this cannot be undone Risk: destructive · Irreversible
Input Output

list

components.list List the components that define content types, with their field schemas Risk: read
Input Output

update

components.update Replace a component’s field schema. Existing content is not migrated: a removed field’s values stay in stories, hidden, until a migration removes them Risk: write
Input Replacing a component’s schema changes the shape every story of that type is parsed against, and a removed field’s values stay in existing stories, hidden from the editor, until a migration removes them. Output

Datasource Entries

create

datasourceEntries.create Add an entry to a datasource Risk: write
Input Output

delete

datasourceEntries.delete Delete a datasource entry; content using that option loses it Risk: destructive · Irreversible
Input Output

get

datasourceEntries.get Read one datasource entry with its name, value and position Risk: read
Input Output

list

datasourceEntries.list List datasource entries, optionally only those of one datasource or one dimension value Risk: read
Input Output

update

datasourceEntries.update Replace a datasource entry’s name and value Risk: write
Input Output

Datasources

create

datasources.create Create a datasource, whose slug is what content uses to reference it Risk: write
Input Output

delete

datasources.delete Delete a datasource along with its entries. Content that references it is left pointing at nothing Risk: destructive · Irreversible
Input Output

get

datasources.get Read one datasource with its dimensions Risk: read
Input Output

list

datasources.list List the datasources on the space, such as reusable option lists Risk: read
Input Output

update

datasources.update Replace a datasource name and slug Risk: write
Input Output

Releases

create

releases.create Create a release that stories can be grouped into and published together Risk: write
Input Output

delete

releases.delete Delete a release. The stories grouped in it stay, but the grouping is gone Risk: destructive · Irreversible
Input Output

get

releases.get Read one release with its schedule, released state and the branches it deploys Risk: read
Input Output

list

releases.list List releases with their schedules and released state Risk: read
Input Output

update

releases.update Change a release, or publish it in the same call with do_release Risk: write
Input Output

Spaces

get

spaces.get Read the configured space: its plan, counts, environments and defaults Risk: read
Input: empty object Output

list

spaces.list List the spaces the token can reach, which is how a space id is found Risk: read
Input Output

Stories

create

stories.create Create a story, optionally publishing it or grouping it in a release in the same call Risk: write
Input Storyblok requires both content and slug. content is the schema’s own JSON: one object per component field with a component key naming the content type. Output

delete

stories.delete Delete a story and trash it. Storyblok keeps it in the trash, but this plugin does not wrap a restore, so treat it as permanent Risk: destructive · Irreversible
Input Output

get

stories.get Read one story with its full content, published state, tags and version ids Risk: read
Input Output

list

stories.list List stories with filters for slug, tag, parent, publication state and release. This route omits each story’s content unless with_summary is set Risk: read
Input This route returns stories without their content; use with_summary for a summary or stories.get for the full story. Storyblok reports total and per_page in response headers, which this client cannot return with the body, so page until an array comes back short or empty. Output

publish

stories.publish Publish a story, or add it to a release with release_id. Storyblok implements this as a GET, but it changes published state Risk: write
Input Served as a GET, but it changes published state, so it is a write here and a retry repeats the change. Pass release_id to group the story in a release instead. Output

unpublish

stories.unpublish Unpublish a story, so the Content Delivery API stops serving it. Storyblok implements this as a GET Risk: write
Input Served as a GET, but it stops the Content Delivery API serving the story. Output

update

stories.update Replace a story’s fields and content. Sending publish also publishes it; without it the change stays a draft Risk: write
Input Output

Tags

create

tags.create Create a tag, optionally attaching it to a story as it is created Risk: write
Input Output

delete

tags.delete Delete a tag, removing it from every story that carried it. This cannot be undone Risk: destructive · Irreversible
Input Output

list

tags.list List the tags on the space with how many stories carry each Risk: read
Input Output

update

tags.update Rename a tag, which updates every story that carries it Risk: write
Input Output

Webhooks

create

webhooks.create Register a webhook endpoint for the given actions, optionally with a secret Storyblok signs each delivery with Risk: write
Input Output

delete

webhooks.delete Delete a webhook endpoint, so Storyblok stops posting to its URL Risk: destructive · Irreversible
Input Output

get

webhooks.get Read one webhook endpoint with its actions and activation Risk: read
Input Output

list

webhooks.list List the webhook endpoints on the space Risk: read
Input Output

listActions

webhooks.listActions List the action names a webhook may subscribe to, read from Storyblok so a new event needs no plugin change Risk: read
Input: empty object Reads the accepted action names from Storyblok rather than hardcoding them, so a new event needs no plugin change. Output

update

webhooks.update Replace a webhook endpoint, its action list or its activation Risk: write
Input Output