Apidog Docs
πΊπΈ English
πΊπΈ English
π―π΅ ζ₯ζ¬θͺ
Home
Learning Center
Support Center
API References
Download
Changelog
Home
Learning Center
Support Center
API References
Download
Changelog
πΊπΈ English
πΊπΈ English
π―π΅ ζ₯ζ¬θͺ
πΊπΈ English
πΊπΈ English
π―π΅ ζ₯ζ¬θͺ
Data & Security
Copy Page
Apidog Learning Center
Getting Started
Introduction to Apidog
Basic Concepts in Apidog
Navigating Apidog
Quick Start
Overview
Creating an Endpoint
Making a Request
Adding an Assertion
Creating Test Scenarios
Sharing API Documentation
Explore More
Migration to Apidog
Overview
Manual Import
Scheduled Import (Bind Data Sources)
Import Options
Export Data
Import From
Import from Postman
Import OpenAPI Spec
Import cURL
Import Markdowns
Import from Insomnia
Import from apiDoc
Import .har File
Import WSDL
Design APIs
Overview
Create a New API Project
Endpoint Basics
APl Design Guidelines
Module
Configure Multiple Request Body Examples
Components
Common Fields
Global Parameters
Endpoint Change History
Comments
Batch Endpoint Management
Custom Protocol API
Schemas
Overview
Create a New Schema
Build a Schema
Generate Schemas from JSON Etc
oneOf, allOf, anyOf
Using Discriminator
Security Schemes
Overview
Create a Security Scheme
Use the Security Scheme
Security Scheme in Online Documentation
Advanced Features
Custom Endpoint Fields
Associated Test Scenarios
Endpoint Status
Appearance of Parameter Lists
Endpoint Unique Identification
Develop and Debug APIs
Overview
Generating Requests
Sending Requests
Debugging Cases
Test Cases
Dynamic Values
Validating Responses
Design-First vs Request-First
Generating Code
Environments & Variables
Overview
Environment Management
Using Variables
Vault Secrets
Overview
HashiCorp Vault
Azure Key Vault
AWS Secrets Manager
Pre and Post Processors
Assertion
Extract Variable
Wait
Overview
Database Operations
Overview
MySQL
MongoDB
Redis
Oracle Client
Using Scripts
Overview
Pre Processor Scripts
Post Processor Scripts
Public Scripts
Postman Scripts Reference
Calling Other Programming Languages
Using JS Libraries
Visualizing Responses
Script Examples
Assertion Scripts
Using Variables
Modifying Requests
Other Examples
Dynamic Values Modules
Mock API Data
Overview
Smart Mock
Custom Mock
Mock Priority Sequence
Mock Scripts
Cloud Mock
Self-Hosted Runner Mock
Mock Language (Locales)
API Testing
Overview
Test Scenarios
Create a Test Scenario
Pass Data Between Requests
Flow Control Conditions
Sync Data from Endpoints and Endpoint Cases
Import Endpoints and Endpoint Cases from Other Projects
Export Test Scenarios
Run Test Scenarios
Run a Test Scenario
Run Test Scenarios in Batch
Manage Runtime Environment of APIs from Other Projects
Data-Driven Testing
Scheduled Tasks
Test Suite
Overview
Create A Test Suite
Orchestrate Test Suite
Run Test Suites Locally
Run Test Suites Via CLI
Scheduled tasks
Test Reports
Test Reports
Test APIs
Integration Testing
Performance Testing
End-to-End Testing
Regression Testing
Contract Testing
Apidog CLI
Overview
Installing and Running Apidog CLI
Apidog CLI Options
CI CD
Overview
Integrate with Gitlab
Integrate with Jenkins
Trigger Test by Git Commit
Integrate with Github Actions
Publish API Docs
Overview
API Technologies Supported
Quick Share
Viewing API Documentation
Markdown Documentation
Publishing Documentation Sites
Custom Layouts
Custom CSS, JavaScript, HTML
Custom Domain
LLM-Friendly Features
SEO Settings
Advanced Settings
Documentation Search
CORS Proxy
Integrating Google Analytics with Doc Sites
Folder Tree Settings
Visibility Settings
Embedding Values in Document URLs
API Versions
Overview
Creating API Versions
Publishing API Versions
Sharing Endpoints with API Versions
Send Requests
Overview
SSE Debugging
MCP Client
Socket.IO
WebSocket
Webhook
SOAP or WebService
GraphQL
gRPC
Use Request Proxy Agents for Debugging
Create Requests
Request History
Request Basics
Parameters and Body
Request Headers
Request Settings
Debug Requests
Saving Requests as Endpoints
HTTP/2
Response and Cookies
Viewing API Responses
Managing Cookies
Overview
Authentication and Authorization
Overview
CA and Client Certificates
Authorization Types
Digest Auth
OAuth 1.0
OAuth 2.0
Hawk Authentication
Kerberos
NTLM
Akamai EdgeGrid
Branches
Overview
Creating a Sprint Branch
Testing APIs in a Branch
Designing APIs in a Branch
Merging Sprint Branches
Managing Sprint Branches
AI Features
Overview
Enabling AI Features
Generating Test Cases
Modifying Schemas with AI
Endpoint Compliance Check
API Documentation Completeness Check
AI-Powered Field Naming
FAQs
Apidog MCP Server
Overview
Connect Apidog Project to AI
Connect Published Documentation to AI
Connect OpenAPI Files to AI
Best Practices
Handling API Signatures
Accessing OAuth 2.0 Protected APIs
Collaboration Workflow
Managing Authentication State
Offline Space
Overview
Administration
Managing Teams
Managing Teams
Managing Team Members
Member Roles & Permission Settings
Team Activities
Team Resources
General Runner
Team Variables
Request Proxy Agent
Real-time Collaborations
Team Collaboration
Onboarding Checklist
Basic Concepts
Onboarding Guide
Managing Projects
Managing Projects
Managing Project Members
Notification Settings
Project Resources
Database Connection
Git Connection
Managing Organization
Managing Organization
Single Sign-On (SSO)
SSO Overview
Configuring Microsoft Entra ID
Configuring Okta
Configuring SSO for an Organization
Managing User Accounts
Mapping Groups to Teams
SCIM Provisioning
Introduction to SCIM Provisioning
Microsoft Entra ID
Okta
Plans Management
Billing Managers in Organizations
Organization Resources
Self-Hosted Runner
Billing
Overview
Credits
Alternative Payment Methods
Managing Subscriptions
Upgrading Your Plan
Moving Paid Teams to Organizations
Data & Security
Data Storage and Security
User Data Privacy and Security
Request Routing and Data Security
Add-ons
API Hub
Apidog Intellij IDEA Plugin
Browser Extension
Chrome
Microsoft Edge
Request Proxy
Request Proxy in Web
Request Proxy in Shared Docs
Request Proxy in Client
Account & Preferences
Account Settings
Generating OpenAPI Access Token
Notification
Language Settings
Hot Keys
Network Proxy Configuration
Backing Up Data
Updating Apidog
Deleting Account
Experimental Features
References
API Design-First Approach
Apidog OpenAPI Specificaiton Extensions
JSONPath
XPath
Regular Expressions
JSON Schema
CSV File Format
Installing Java Environment
Runner Deployment Environment
Apidog flavored Markdown
Apidog Europe
Apidog Europe
Support Center
Home
Learning Center
Support Center
API References
Download
Changelog
Home
Learning Center
Support Center
API References
Download
Changelog
πΊπΈ English
πΊπΈ English
π―π΅ ζ₯ζ¬θͺ
πΊπΈ English
πΊπΈ English
π―π΅ ζ₯ζ¬θͺ
Data & Security
Copy Page
User Data Privacy and Security
Understanding how Apidog stores your data and maintains privacy is essential for secure API development and testing.
Apidog SaaS
#
Cloud Data
#
In the SaaS version of Apidog, most data is stored in the cloud, including:
API specifications
Testing scenarios
Project configurations
Team collaboration data
Privacy and access:
All user data is kept private
Only visible to team members
Not publicly accessible by default
Exception: Published API Documentation
Publicly published API documentation is visible to the public. However, you can restrict access using:
Password protection
IP allowlists
Other
visibility settings
Security measures:
Apidog employs various methods to ensure data security. For detailed information, see
Apidog Security Measures
.
Local Data
#
Certain sensitive data is stored exclusively on your local computer and never synchronized to the cloud:
Data Type
Storage Location
Cloud Sync
Current values
in environment/global variables
Local only
β No
Vault Secrets
Local only
β No
API specifications
Cloud
β Yes
Testing scenarios
Cloud
β Yes
Best Practice
Store sensitive data such as passwords, API keys, and credentials in:
Current values
of environment/global variables
Vault Secrets
This ensures sensitive information never leaves your local machine.
Apidog On-Premises
#
In Apidog On-Premises deployments:
Complete data control:
All data resides on your own self-hosted servers
No data stored on Apidog's cloud
No data sent to Apidog servers
Benefits:
Complete control over your data
Full privacy and security
Compliance with internal security policies
Custom security implementations
Related Topics
#
Data Storage and Security
Request Routing and Data Security
Modified atΒ
2026-01-28 07:37:51
Previous
Data Storage and Security
Next
Request Routing and Data Security