Import Options

During both Manual import and Scheduled import, you can customize how data is processed using the Import Options.

General Settings

Target & Destination

Option	Description
Basic Auth	Used for URL imports requiring username/password authentication.
Target Branch	Select the specific branch to import data into (defaults to `main`).
Import Into	Choose to import into an existing folder/module or create a new one.
Auto Generate Case	If enabled, Apidog automatically creates a "Success" test case if the spec lacks examples.

Environment Importing

If your OpenAPI/Swagger file defines multiple servers, enable Import Servers as Environments to automatically create matching environments in Apidog.

📷 Visual Reference

Security & Naming

Security Schemes

Control how securitySchemes from OpenAPI are handled.

Global Auth: Map the spec's global security to the Root folder's auth in Apidog.

Undefined Auth: Decide behavior for endpoints with no specific security (e.g., "Inherit from parent" or "No auth").

📷 Visual Reference

Endpoint Naming

If an endpoint lacks a descriptive Summary field, you can choose a fallback sources for the name:

operationId (Default)

URL Path

Description extraction

📷 Visual Reference

Conflict Resolution

When imported data matches existing data (based on Method & Path), use these rules to decide the outcome.

Endpoint Conflicts

Strategy	Behavior
Overwrite	Completely replaces the old endpoint with the new data.
Keep Both	Creates a duplicate; both old and new exist side-by-side.
Ignore	Skips the new endpoint; keeps the old one unchanged.
Merge	Smart update: retains manual changes like Name, Mock rules, and Descriptions while updating the definition.
Overwrite Selected	Only updates specific fields you select, preserving others.

📷 Visual Reference

Other Resources (Schemas / Docs)

For Markdown docs, Schemas, and Components, similar Overwrite vs Merge options apply.

📷 Visual Reference

Advanced Sync Logic

Folder Synchronization

When an imported endpoint matches an existing endpoint in the project, but their folder locations differ:

Keep existing folder: Ignores the folder path in the imported file. The endpoint remains in its current folder in Apidog.

Update endpoint folder: Moves the endpoint to the folder structure defined in the imported file.

📷 Visual Reference

Resource Cleanup

Decide what happens to resources that existed in the project but are missing from the new import file.

Do not delete (Safe): Keeps orphaned resources in your project.

Delete (Sync): Removes any resource not present in the new file. Use with caution to maintain an exact mirror of the spec.

📷 Visual Reference

General Settings#

Target & Destination#

Environment Importing#

Security & Naming#

Security Schemes#

Endpoint Naming#

Conflict Resolution#

Endpoint Conflicts#

Other Resources (Schemas / Docs)#

Advanced Sync Logic#

Folder Synchronization#

Resource Cleanup#

General Settings

Target & Destination

Environment Importing

Security & Naming

Security Schemes

Endpoint Naming

Conflict Resolution

Endpoint Conflicts

Other Resources (Schemas / Docs)

Advanced Sync Logic

Folder Synchronization

Resource Cleanup