Exporting workflows

Export a workflow and all its dependencies. The exported data is downloaded as a compressed file to your local computer.

Before you begin

To export the workflows from a project, you need admin access. Only admins have the necessary permissions for this activity. If you do not have admin access but hold a custom role, verify that you have the write access. Specifically for the project where you intend to export workflows.

Procedure

  1. In a REST client platform, add the authentication details of the tenant from where you want to export a workflow.
    
    //In case of Instance API key 
    Headers:
    {
    "x-instance-api-key": "instance_api_key"
    }
     
    // In case of MCSP or ISV token
    Headers:
    {
    "Authorization": "mcsp_or_isv_token"
    }
  2. Use a POST request at the URL of the workflow that you want to export.

    URL Syntax - <domain>/apis/v1/rest/projects/:project/workflows/:workflow/export

    In this URL request, /:project is the name of the project that is associated with the workflow you want to export. /:workflow is the UID or name of the workflow that you want to export.

    Note: If multiple workflows share name, a list of all matching workflows, including their UIDs and names, is provided. You can then select the relevant workflow UID from this list and use it in the URL path.
    If the request is successful, you receive the response code for success.
    {
    output: 
    	{
    		download_link: <download_link>,
    		valid_till: <valid_till>
    	}
    }
    Note: The value in valid_till indicates the validity period for downloading the link.