Skip to main content

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
tip

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.

  1. Navigate to the API Management dashboard.

  2. Click Add Application to begin onboarding.

    Add Application button on the API Management dashboard

  3. Choose OpenAPI Spec.

    OpenAPI Spec selected as the onboarding method

  4. Provide an application name.

  5. Click Browse Files and upload your API's OpenAPI file.

  6. After the file uploads, click Continue.

    Application name entered and OpenAPI file uploaded

  7. Validate the environment URL, then click Onboard.

    Environment URL validated before onboarding

  8. When onboarding completes, you can view the application.

    Onboarded application shown after clicking Onboard

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