Settings
Configure project settings, manage API keys, set up team members and roles, and customize your account preferences.
Settings Overview
The Settings area is accessible from the sidebar and is organized into these sections:
| Section | Description |
|---|---|
| General | Project name, description, and locale |
| Team | Team members, invitations, and member management |
| Roles & Permissions | Role management and permission configuration |
| API Keys | Project mock key, MCP keys for AI tools, and notes on Management API keys |
| Project Settings | Latency profile, stateful mocks, rate limiting, pagination, delete project |
| Scenarios | Named presets; select at runtime with the X-MockAPI-Scenario header |
| Drift Detection | Compare an OpenAPI spec to your models and REST endpoints |
| Account Settings | Personal account management |
| SSO | Enterprise single sign-on with Okta, Azure AD, or other OIDC providers |
General Settings
The General settings page lets you update your project's basic information:
- Project Name: The display name for your project. This appears in the project selector and throughout the dashboard.
- Project Description: An optional description to help team members understand the purpose of this project.
- Locale: The locale used for data generation. Changing the locale affects the language and regional format of generated names, addresses, phone numbers, and dates. See Data Generation for supported locales.
Team Management
The Team page shows all current members and pending invitations for the project.
- Members list: View all team members with their roles and avatars
- Role assignment: Change a member's role from the dropdown
- Remove members: Remove a member from the project
- Pending invitations: View, resend, or cancel pending invitations
- Invite members: Send new invitations by email with a role assignment
For detailed information, see Collaboration.
Roles & Permissions
Manage roles and their associated permissions from the Roles & Permissions page. MockAPI includes four system roles (Super Admin, Admin, Editor, Viewer) and supports custom roles on paid plans.
- View roles: List all system and custom roles
- Create roles: Define custom roles with specific permission sets
- Edit roles: Modify permissions for custom roles
- Delete roles: Remove custom roles (system roles cannot be deleted)
Note
Permissions are grouped into categories: Projects, Models, Endpoints, GraphQL Schemas, GraphQL Endpoints, Team, API Keys, and Roles. Some permissions automatically include others (implicit permissions). See Collaboration for full details.
API Keys
The API Keys page displays your project's unique API key used to authenticate mock API requests.
Viewing your key
Your API key is masked by default for security. Use the Show/Hide toggle to reveal it, and the Copy button to copy it to your clipboard.
Regenerating your key
Click Regenerate to generate a new API key. The old key is immediately invalidated. All applications using the old key will need to be updated.
Warning
Regenerating your API key is irreversible. Make sure to update all clients and integrations before or immediately after regenerating.
Authentication guide
The API Keys page includes code examples for all four authentication methods:
- x-api-key header (recommended)
- Bearer token in Authorization header
- Query parameter
- Request body
For detailed examples, see Authentication.
MCP API keys
Create scoped keys (mcp:read / mcp:write) for Cursor, Claude, and other MCP clients. See MCP (AI Integration).
Management API & automation keys
CI/CD automation against the dashboard backend uses separate credentials with mgmt:read and mgmt:write scopes (not the mock project key or MCP keys). See API simulation under Management API.
Project Settings
Advanced project configuration options:
Full reference
For detailed information on stateful CRUD, seeding, rate-limit behavior, scenario evaluation order, drift detection, and the Management API, see API Simulation & Automation.
Latency profile
Configure simulated network delays under Project Settings → Advanced. Select a latency mode from the dropdown (Fixed, Random, Spike, or Slow 3G), then configure the parameters that appear. Your latency settings are saved to the project and applied immediately to all mock responses.
| Mode | What you configure in the UI |
|---|---|
| Fixed | A single Delay (ms) field. |
| Random | Min delay (ms) and Max delay (ms). |
| Spike | Min and Max delay (ms), Spike probability (%), and Spike duration (ms) when a spike occurs. |
| Slow 3G | No extra fields; built-in Slow 3G pacing (on the order of hundreds of ms to ~1.5s with occasional multi-second spikes). |
Stateful mock data
On Developer plans and above, you can persist REST CRUD data across requests. Configure the default seed count (capped by your plan limit), TTL in days for stored records, and review your plan’s record limits.
- Toggle stateful mode and set how many records to generate when a model is first seeded.
- TTL controls automatic expiry of stored records. Use the dashboard’s endpoint actions to clear or re-seed data at any time.
Full HTTP semantics (GET/POST/PUT/PATCH/DELETE, list filters, record limits, reseed API): API Simulation & Automation.
Simulated rate limiting
When enabled, every mock REST request is counted against a per-minute window. The API returns X-RateLimit-* and Retry-After headers on every response, and returns HTTP 429 when the configured requests-per-minute threshold is exceeded. Configure the threshold here; changes take effect immediately.
Pagination settings
Enable and configure pagination for list (range) responses from REST endpoints. When enabled, array responses are wrapped in a pagination metadata object.
Configurable parameters:
| Setting | Default | Description |
|---|---|---|
| Page parameter | page | Query parameter name for the page number |
| Limit parameter | limit | Query parameter name for items per page |
| Response label | data | Field name for the data array in the response |
| Page field | page | Field name for current page number in metadata |
| Page size field | pageSize | Field name for page size in metadata |
| Total pages field | totalPages | Field name for total page count in metadata |
| Total records field | totalRecords | Field name for total record count in metadata |
| Previous page field | prevPage | Field name for previous page number in metadata |
| Next page field | nextPage | Field name for next page number in metadata |
Delete project
You can delete the current project from the Project Settings page. This action is permanent and removes all models, endpoints, schemas, logs, and team data associated with the project.
Warning
You cannot delete your last remaining project. You must always have at least one project.
Scenarios
Open Settings → Scenarios to create, edit, and delete named presets with optional per-endpoint overrides (path, method, status, body, delay) and optional latency overrides. Clients send the X-MockAPI-Scenario header on mock requests to select a preset, or rely on your default scenario. For behavior details and evaluation order: API Simulation & Automation.
Drift Detection
On Settings → Drift Detection, paste an OpenAPI specification (YAML or JSON) to compare it with your project’s models and REST endpoints. The analysis categorizes differences as breaking or non-breaking. For technical details: API Simulation & Automation.
Account Settings
Manage your personal account from the Account Settings page:
Profile information
Update your personal details:
- First Name and Last Name
- Email Address
- Company Name and Company Domain (if applicable)
Change password
Update your password by entering your current password and choosing a new one. Passwords must be at least 6 characters and include at least one digit and one non-alphanumeric character.
Delete account
You can permanently delete your account from the Account Settings page. This action:
- Soft-deletes your account (can potentially be recovered by contacting support)
- Removes your access to all projects
- Cancels any active subscriptions
Warning
Account deletion is a serious action. Make sure to export any data you need before deleting your account.
SSO (Single Sign-On)
Enterprise plan users can configure SSO so that users with matching email domains (e.g. @acme.com) sign in via your identity provider (Okta, Azure AD, Google Workspace, etc.) instead of email/password.
Note
SSO configuration is available on the Enterprise plan only.
- Redirect URI: Add the provided URL as a callback in your IdP
- Company name: Display name for your organization
- Client ID & Secret: From your IdP application registration
- Authority: Issuer URL (e.g. https://dev-xxx.okta.com or https://login.microsoftonline.com/{tenant}/v2.0)
- Setup guides: Step-by-step instructions for Okta and Azure AD
Deleting your SSO config does not delete user accounts. Users with your domain can still sign in with email and password.
Theme
MockAPI supports light and dark themes. Toggle the theme using the sun/moon icon in the top navigation bar. Your preference is saved in your browser and persists across sessions.
Notifications
MockAPI sends in-app notifications for important events:
- Schema-Model sync: When discrepancies are detected between schemas and models
- Team invitations: When you receive a project invitation
- Payment issues: When a payment fails or subscription changes (see Plans & Billing)
- System announcements: Important platform updates
Access notifications from the bell icon in the header. You can mark notifications as read individually or all at once.