Need to export all features from Behave Pro for your own processing purposes?
If you're looking to download features as part of a build, please see our test automation articles.
You can use our API to export by project and have your features all delivered in one tidy zip file. This article applies both to Behave Pro Cloud and Server; the same instructions can also be loosely used for our legacy product Behave for Jira.
Authorization
Once you've determined which product you're using, you need to grab API keys from within Behave Pro in Jira to authorize the API export request.
You can find your API keys from the project settings page of your Jira project, located in the sidebar navigation of the project.
You'll need to make a note of the project ID, username and password or API Key for the cloud.
Downloading
Now we have our authentication details, you're ready to download the features zip over HTTP using a tool such as wget or curl, or programmatically using your favourite language.
Note: If you're building an automated build tool, please see our existing tools first to see if they fit your needs.
The export API requires Basic HTTP Auth, so you'll need to send either the API keys or Jira user/pass from above with the request. See the examples below.
Behave Pro Cloud:
https://behave.pro/rest/cucumber/1.0/project/{projectId}/features?manual={true|false}
Where {projectId}
is noted from the previous step, and the manual true/false
flag is whether to include scenarios marked as manual or not.
A complete URL could look like this:
https://behave.pro/rest/cucumber/1.0/project/10000/features?manual=true
curl:
$ curl --fail -u {user}:{pass} "https://behave.pro/rest/cucumber/1.0/project/{projectId}/features?manual={true|false}" --output features.zip
wget:
$ wget "https://behave.pro/rest/cucumber/1.0/project/{projectId}/features?manual={true|false}" --user={user} --password={pass} --auth-no-challenge
Where {user}
and {pass}
are the API keys noted earlier.
Behave Pro Server:
{http|https}//:{Jira}/rest/cucumber/1.0/project/{projectId}/features?manual={true|false}
Where {Jira}
is your Jira instances URL, {projectId}
is noted from the previous step, and the manual true/false
flag is whether to include scenarios marked as manual or not.
A complete URL could look like this:
http://localhost:2990/jira/rest/cucumber/1.0/project/10000/features?manual=true
curl:
$ curl --fail -u {user}:{pass} "{http|https}//:{Jira}/rest/cucumber/1.0/project/{projectId}/features?manual={true|false}" --output features.zip
wget:
$ wget "{http|https}//:{Jira}/rest/cucumber/1.0/project/{projectId}/features?manual={true|false}" --user={user} --password={pass} --auth-no-challenge
Where {user}
and {pass}
are the username and password noted earlier.