Skip to main content

Management API

The Management API is available on the adapter as:

$appStoryblok->managementApi

Use it for write operations and administration tasks in the configured Storyblok space.

Main Methods​

syncComponent()​

Creates or updates a component definition.

$appStoryblok->managementApi->syncComponent($componentConfig);

getOrCreatedComponentGroupUuid()​

Resolves or creates a component group uuid.

$appStoryblok->managementApi->getOrCreatedComponentGroupUuid("Content");

fetchAllRegisteredComponents()​

Returns all component keys currently registered in the space.

$appStoryblok->managementApi->fetchAllRegisteredComponents();

fetchComponentDefinitions()​

Fetches all component definitions.

$appStoryblok->managementApi->fetchComponentDefinitions();

syncDatasourceEntries()​

Syncs datasource entries from your local mapping.

$appStoryblok->managementApi->syncDatasourceEntries("countries", $values);

fetchDatasourceEntries()​

Fetches datasource entries via the Management API.

$appStoryblok->managementApi->fetchDatasourceEntries("countries");

fetchAllAssets()​

Fetches metadata of all assets.

$appStoryblok->managementApi->fetchAllAssets();

updateAsset()​

Updates an asset by id.

$appStoryblok->managementApi->updateAsset($assetId, $payload);

fetchAssetFolders()​

Fetches the full asset folder tree.

$appStoryblok->managementApi->fetchAssetFolders();

fetchAssetData()​

Fetches metadata for a specific asset id.

$appStoryblok->managementApi->fetchAssetData($assetId);

exportTranslationsXmlFile()​

Exports the translation XML for a story.

$appStoryblok->managementApi->exportTranslationsXmlFile($storyId);

importTranslationsXmlFile()​

Imports translation XML for a story.

$appStoryblok->managementApi->importTranslationsXmlFile($storyId, $xmlContent);

fetchStory()​

Fetches a raw management API story payload by story id.

$appStoryblok->managementApi->fetchStory($storyId);

updateStory()​

Updates a story by story id.

$appStoryblok->managementApi->updateStory($storyId, $storyJson);

sendRequest()​

Low-level method to send arbitrary requests to the Storyblok Management API.

$appStoryblok->managementApi->sendRequest("components");

Deprecated​

fetchFolderTitleMap() and fetchFoldersInPath() are deprecated in ManagementApi. Use the Content API equivalents instead.