Assets
bulkDelete
assets.bulkDelete
Delete several assets in one call, with the same effect as deleting each
Risk: destructive · Irreversible
delete
assets.delete
Delete one asset, so any content referencing it shows a broken file
Risk: destructive · Irreversible
asset full type
asset full type
get
assets.get
Read one asset with its file details and metadata
Risk: read
asset full type
asset full type
list
assets.list
List assets with a search and a folder filter
Risk: read
assets full type
assets full type
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
asset full type
asset full type
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
component full type
component full type
delete
components.delete
Delete a component. Content that uses it can no longer render, and this cannot be undone
Risk: destructive · Irreversible
component full type
component full type
list
components.list
List the components that define content types, with their field schemas
Risk: read
components full type
components full type
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
component full type
component full type
Datasource Entries
create
datasourceEntries.create
Add an entry to a datasource
Risk: write
datasource_entry full type
datasource_entry full type
delete
datasourceEntries.delete
Delete a datasource entry; content using that option loses it
Risk: destructive · Irreversible
get
datasourceEntries.get
Read one datasource entry with its name, value and position
Risk: read
datasource_entry full type
datasource_entry full type
list
datasourceEntries.list
List datasource entries, optionally only those of one datasource or one dimension value
Risk: read
datasource_entries full type
datasource_entries full type
update
datasourceEntries.update
Replace a datasource entry’s name and value
Risk: write
datasource_entry full type
datasource_entry full type
Datasources
create
datasources.create
Create a datasource, whose slug is what content uses to reference it
Risk: write
datasource full type
datasource full type
delete
datasources.delete
Delete a datasource along with its entries. Content that references it is left pointing at nothing
Risk: destructive · Irreversible
get
datasources.get
Read one datasource with its dimensions
Risk: read
datasource full type
datasource full type
list
datasources.list
List the datasources on the space, such as reusable option lists
Risk: read
datasources full type
datasources full type
update
datasources.update
Replace a datasource name and slug
Risk: write
datasource full type
datasource full type
Releases
create
releases.create
Create a release that stories can be grouped into and published together
Risk: write
release full type
release full type
delete
releases.delete
Delete a release. The stories grouped in it stay, but the grouping is gone
Risk: destructive · Irreversible
release full type
release full type
get
releases.get
Read one release with its schedule, released state and the branches it deploys
Risk: read
release full type
release full type
list
releases.list
List releases with their schedules and released state
Risk: read
releases full type
releases full type
update
releases.update
Change a release, or publish it in the same call with do_release
Risk: write
release full type
release full type
Spaces
get
spaces.get
Read the configured space: its plan, counts, environments and defaults
Risk: read
space full type
space full type
list
spaces.list
List the spaces the token can reach, which is how a space id is found
Risk: read
spaces full type
spaces full type
Stories
create
stories.create
Create a story, optionally publishing it or grouping it in a release in the same call
Risk: write
story full type
story full type
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
story full type
story full type
get
stories.get
Read one story with its full content, published state, tags and version ids
Risk: read
story full type
story full type
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
stories full type
stories full type
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
story full type
story full type
unpublish
stories.unpublish
Unpublish a story, so the Content Delivery API stops serving it. Storyblok implements this as a GET
Risk: write
story full type
story full type
update
stories.update
Replace a story’s fields and content. Sending publish also publishes it; without it the change stays a draft
Risk: write
story full type
story full type
Tags
create
tags.create
Create a tag, optionally attaching it to a story as it is created
Risk: write
tag full type
tag full type
delete
tags.delete
Delete a tag, removing it from every story that carried it. This cannot be undone
Risk: destructive · Irreversible
list
tags.list
List the tags on the space with how many stories carry each
Risk: read
update
tags.update
Rename a tag, which updates every story that carries it
Risk: write
tag full type
tag full type
Webhooks
create
webhooks.create
Register a webhook endpoint for the given actions, optionally with a secret Storyblok signs each delivery with
Risk: write
webhook_endpoint full type
webhook_endpoint full type
delete
webhooks.delete
Delete a webhook endpoint, so Storyblok stops posting to its URL
Risk: destructive · Irreversible
webhook_endpoint full type
webhook_endpoint full type
get
webhooks.get
Read one webhook endpoint with its actions and activation
Risk: read
webhook_endpoint full type
webhook_endpoint full type
list
webhooks.list
List the webhook endpoints on the space
Risk: read
webhook_endpoints full type
webhook_endpoints full type
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
allowed_actions full type
allowed_actions full type
update
webhooks.update
Replace a webhook endpoint, its action list or its activation
Risk: write
webhook_endpoint full type
webhook_endpoint full type