Understanding the App Model
The App Model is APIsec's step-by-step workflow for building up API test coverage. Instead of configuring everything before the first scan, you start with minimal setup, scan, and add one layer of configuration at a time — each step unlocking deeper testing than the last. You always know what the next step is, and you see your first scan results at Step 3 — before any credentials are configured.
The steps
- Create the application — the entry that anchors all further testing, even before you have a reachable URL (Step 1).
- Set the instance URL and confirm reachability — APIsec must reach the API before it can test it (Step 2).
- Run an unauthenticated scan — assess what an anonymous caller can reach and detect misconfigurations in open endpoints (Step 3).
- Configure authentication — add API keys, OAuth, or bearer credentials so scans can exercise protected endpoints (Step 4).
- Run an authenticated scan — test protected endpoints for authorization flaws and privilege-escalation risks (Step 5).
- Add parameter values — supply values APIsec cannot derive from the spec, so more requests succeed and more endpoints get exercised (Step 6).
- Configure RBAC — validate that each role can access only what it is permitted to (Step 7).
- Configure BOLA — test whether a user can reach objects belonging to another user or role (BOLA).
Skipping a step
Configure Credentials, Configure RBAC, and Configure BOLA can be skipped for an instance where they don't apply. Skipping raises the App Model percentage for that instance so it progresses through the Onboarding quadrants on the dashboard.
Skipping affects onboarding progress only. It doesn't disable security scanning or dismiss existing findings.
Skipping Configure Credentials also skips the dependent Authenticated Scan, RBAC, and BOLA steps.
Why work this way
Each layer is validated before the next depends on it: a reachable URL before any scan, working credentials before authorization testing, role definitions before RBAC checks. When a step fails, you know which layer broke. Coverage grows in a controlled sequence, and the workflow fits public APIs, enterprise applications, and microservices alike.
🌍 Creating App with unreachable URL
---
🌍 Updating with reachable URL, Check Application is Reachable
- In the App Model, observe Setup Application Reachability in the IN PROGRESS section
🌐 Unauthenticated scan execution
- To execute the Unauthenticated scan,
📖 Configure API Authentication
- To configure API authentication,
📖 Authenticated scan execution
- To execute the Authenticated scan,
📖 Discover parameters
APIsec inventories all parameters across all of your endpoints, then populates as many values as it can find in the API specification, the API gateway, or other API endpoints. Some parameters still need values you supply before a request can succeed.
📖 RBAC Configuration
- To configure RBAC, click Set Up RBAC in the App Model or select RBAC from the sidebar.