Navigation

Export an Existing Stitch Application

MongoDB Stitch applications can be exported to a local application directory from the Stitch UI or with the stitch-cli export command.

Exported application directories use the same name as the Stitch application by default. All entities in the application directory conform to the Application File Schema.

Procedure

Export from the Stitch UI

The simplest way to export a MongoDB Stitch application is directly from the Export tab of the Stitch UI.

Simply navigate to the Export tab and click the Export App button.

Export with stitch-cli

MongoDB Stitch applications can be exported programmatically via the Command Line Interface (stitch-cli).

Before beginning, ensure that you have properly installed stitch-cli.

1

Authenticate a MongoDB Atlas User

To export a MongoDB Stitch application with stitch-cli, users must authenticate with Atlas using an API Key.

See Generate API Keys for more information on generating an Atlas API key.

stitch-cli login --username=cloud.username --api-key=my-api-key
2

Run the Export Command

Run the following command to export your application as a directory in the specified output path:

stitch-cli export --app-id=myStitchApp-abcde --output=path/to/exported/dir

Warning

If the directory specified by --output already exists, stitch-cli will throw an error and the export will fail.

Output

Your application will be exported to a local application directory. If you did not specify a path for the directory with --output, it will be exported with the same name as the application into the current working directory.

Only entities that are configured in your application will appear in your exported application directory. See Application File Schema for more information on the schema and contents of MongoDB Stitch applications.

yourStitchApp/
├── stitch.json
├── secrets.json
├── auth_providers/
│   └── <provider name>.json
├── functions/
│   └── <function name>/
│       ├── config.json
│       └── source.js
├── services/
│   └── <service name>/
│       ├── config.json
│       ├── incoming_webhooks/
│       │   ├── config.json
│       │   └── source.js
│       └── rules/
│           └── <rule name>.json
└── values/
    └── <value name>.json