Onboard an API with an OpenAPI spec
If your API already has an OpenAPI Specification (OAS), uploading it is the fastest way to onboard. APIsec reads the spec to learn your API's endpoints, methods, and parameters, then generates a tailored suite of security tests.
An OpenAPI Specification is a standardized, machine-readable description of your API. It gives APIsec:
- Consistent, complete endpoint definitions
- Parameter, header, and payload details for each operation
- A reliable basis for security test generation
Validate your OpenAPI spec with a tool such as Swagger Editor to catch errors before you upload it.
Onboard with an OpenAPI spec
You need an OpenAPI spec file (.json or .yaml) for your API.
-
Navigate to the API Management dashboard.
-
Click Add Application to begin onboarding.

-
Choose OpenAPI Spec.

-
Provide an application name.
-
Click Browse Files and upload your API's OpenAPI file.
-
After the file uploads, click Continue.

-
Validate the environment URL, then click Onboard.

-
When onboarding completes, you can view the application.

The application details page shows the application name, reachability status, scan status, and environment URL.
After your API is onboarded, you can:
- Run a security scan to identify vulnerabilities
- Enable monitoring to track API usage and performance
- Integrate with API gateways for traffic management and security enforcement
Related
- Manage applications and environments — rename the application and manage its environments.
- Manage endpoints — configure parameters, headers, and request bodies, and add endpoints.
- Check endpoint readiness — validate an endpoint before running a full scan.