Recipe lifecycle management

Use the following endpoints to automate the import and export of packages.

Supported Formats

• Json

Export package based on a manifest

POST /api/packages/export/:manifest_id

Description

Export package based on a manifest. Manifest ID is required. This is an asynchronous request. Please use the GET package by ID endpoint to get details of the exported package after this endpoint is used.

GET /api/packages/242
200
{  
   "id":242,
   "operation_type":"export",
   "status":"completed",
   "export_manifest_id":3,
   "download_url":"https://workato-staging-assets,com/packages/zip_files/000/000/242/original/exportdemo.zip"
}

Import package into a folder

POST /api/packages/import/:folder_id

Description

Import a package (zip file) into the folder. The input is a “application/octet-stream” payload containing package content. restart_recipes should be “true” if running recipes need to be restarted upon import.

This is an asynchronous request. Please use the GET package by ID endpoint to get details of the imported package after this endpoint is used.

POST /api/packages/import/2617
200
{  
   "id":251,
   "operation_type":"import",
   "status":"completed",
   "download_url":"https://workato-staging-assets,com/packages/zip_files/000/000/242/original/exportdemo.zip"
}

Get package by ID

GET /api/packages/:id

Description

Get details of an imported or exported package.

GET /api/packages/242
200
{  
   "id":242,
   "operation_type":"export",
   "status":"completed",
   "export_manifest_id":3,
   "download_url":"https://workato-staging-assets,com/packages/zip_files/000/000/242/original/exportdemo.zip"
}

GET /api/packages/245
200
{  
   "id":242,
   "operation_type":"export",
   "status":"failed",
   "error":"error_message"
   "export_manifest_id":4,
   "download_url":"null"
}

Download package

GET /api/packages/:id/download

Description

If successful, redirects to package content. Returns 404 if package not found or doesn't have content.

Responses

Parameters