Developer APIResourcesRecipe lifecycle management

Import a package into a folder

Import a package in zip file format into a folder. This endpoint allows an API client to create or update assets, such as recipes, lookup tables, event topics, and message templates, through package imports.

When you provide an API client with privileges to this endpoint, it also grants the ability to create or update other assets like recipes, lookup tables, Event topics, and message templates through importing packages.

This is an asynchronous request. Use the GET package by ID endpoint to get details of the imported the package.

The input (zip file) is a application/octet-stream payload containing package content. URL parameter restart_recipes must be true if the running recipes must be restarted upon import.

PACKAGE IMPORT. RATE LIMIT
Workato enforces a strict limit of 500 package import requests per hour per workspace. If this limit is exceeded, the system denies additional requests until the following hour when the request allowance resets.

Path parameters

folder_idstringRequired
Folder ID.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
restart_recipesstringOptional

Set to true to allow running recipes to restart.

folder_id_for_home_assetsstringOptional

The ID of a folder to store assets in instead of the root folder. The folder specified must be accessible to the API client and cannot be the root folder. Defaults to blank.

FOLDER_ID_FOR_HOME_ASSETS SOMETIMES REQUIRED
The folder_id_for_home_assets parameter is required if you’re importing a package that contains root folder assets or if the customer’s workspace Home assets folder has been converted to a Home assets project. Refer to the Home assets project section for more information.

Response

OK
idinteger
Package ID.
operation_typestring

Operation type: import or export.

statusstring

Operation status: completed, in_progress, or failed.

errorstring
Error description if operation failed.
download_urlstring

Package download URL if completed, null otherwise.

Errors