Import and export a project

Move a project as a {{brand}} package, OpenAPI, Postman or Excel file.

In short

"Import a package…" and "Export package…" move a project as a file: a {{brand}} package that keeps everything, OpenAPI, Postman or Excel. An import is previewed first and nothing is saved until you choose "Import". Safe Share takes secrets out before an export.

Before you start

Who: exporting needs View; keeping secrets in an export needs Manage. Importing into an existing project needs Edit.
Plan: a new project counts toward the plan's project limit.
First: files up to 10 MB: .json, .yaml, .yml, .xlsx or .har.

Steps

Open the project's … menu and choose "Export package…".
Choose the format and press "Review export".
Leave Safe Share on, or choose "Keep sensitive values" and confirm.
Press "Download package".

Open the project's … menu, choose "Export package…" and open "Scheduled". You need to manage the project.
Choose the format, how often, the time and how many files to keep.
Press "Save schedule". The export runs as you, with secrets masked.
Anyone who can read the project downloads the files from the same tab. Older files are deleted once the newest ones take their place.

Open the chevron beside "New request" and choose "Import a package…" - or, in an empty project, press "Import…".
Choose the format and drop the file.
Read the preview: the requests it would add, grouped by test group, plus environments, suites, what it would change, anything sensitive and the values you must fill.
Under "When names match" choose "Rename", "Skip", "Replace" or "Merge", then press "Import 12 selected" - the number is how many rows are ticked.

Result: everything you selected is saved, or nothing is.

Good to know

"Import history…" in the project's … menu lists each import, including failed ones, and "Undo" reverses an import while the project still looks as it left it. Importing the same file again into an unchanged project is not applied twice.
Files can be up to 10 MB: .json for a package or Postman file, .json, .yaml or .yml for OpenAPI, .xlsx for Excel, .har for a capture.
Exporting needs View on the project; keeping secrets in an export needs Manage and is recorded. Importing into an existing project needs Edit.
The package (.core-api.json) loses nothing: requests with their checks, extraction rules, variables, time bands and order, environments with variables and tiers, and suites with their cases. Importing gives everything new identities and keeps the links between them.
Safe Share replaces authorization, cookie and API key headers, secret-looking variables, tokens, email addresses and likely card numbers with named placeholders such as {{SECRET_AUTHORIZATION}}. After an import, the result names each SECRET_ value to add to an environment.
Excel is for editing many requests at once. "Download template" gives the current workbook; the QueryParameters and DataSets sheets are not read on import yet. Text beginning with =, +, - or @ is protected on export, and refused on import.

If something goes wrong

"Exporting secret values needs permission to manage this project."
A package from a newer version is refused ("Schema version ... is newer than this server supports").
An Excel import error names the exact sheet, column and row: fix that cell and import again.
"A HAR capture can be imported but not exported; export the project as a Core package, OpenAPI or Postman instead."
"The package is empty." and "This is not a {{brand}} API package.": choose the file you exported.
"A project with this name already exists; choose Rename, Replace, or Merge."
"References to other files are not loaded; include everything in one document." and "The document describes no operations to import."
"The file is not valid YAML." and "The file is not UTF-8 text.": save the file again as plain text.
"A package may contain at most 5,000 requests.": split the project.
A message that begins "Missing required sheet" names an Excel sheet the file lacks. Download the template again.