API Secure: How to manually import your APIs

The manual import feature allows you to add a new RESTful API using an OpenAPI/Swagger document.

Steps

Navigate to the API Secure product if you haven’t opened it yet.

Open

Locate the “ASM Setup” menu item in the sidebar on the left-hand side, and click it.

Open

At this point, you should see the “Cloud Access” page with the diagram representing our services.

Press the “Add source” button and select the “OpenAPI Definition“option in the list that appears.

You should now see the manual import wizard. Fill in the fields and press submit once ready. We require that you validate the OpenAPI document before uploading it.

In order to fully analyze the API, the analyzers need to be able to make authenticated requests against the API. A dedicated set of credentials are expected, such as an API key. You’ll need to specify the precise query as CURL command in the wizard. The authentication process is described in this article.

If the upload fails, Data Theorem’s support team will provide assistance and try to import the API on your behalf. We are made aware of import errors and will act on them as soon as we can, so no further action will be required on your part.

Please note that while the servers field is optional according to the OpenAPI specification, we do require that you specify it on all the API definitions that you upload through this wizard.