STstackhawk
Hosted OAS

Map application OpenAPI specs

Toggle includes an OpenAPI specification from a repository source with the specified application.

Requires write:scan_config permission.

post/api/v1/oas/{appId}/mapping

Request

  • Base URL
    https://api.stackhawk.com
  • URL
    https://api.stackhawk.com/api/v1/oas/{appId}/mapping
  • Auth
    HTTP bearer

Path parameters

appIdstring uuid required

UUID identifier for this StackHawk Application.

Request body

appIdstring

The applicationId to map the oas specs

includeboolean

Whether the spec is now included or now excluded from the application mapping

oasIdstring

UUID of the hosted OAS files

repositoryIdstring

Repository UUID

sourceRootPathstring

Source code path in repository from the OAS

Response

Get the OAS specs mapped to this application for use with HawkScan.

appIdstring

The requested applicationId

repoIdsstring[]

repository IDs mapped to this application

Changes

No recorded changes to this operation across all 8 revisions of this API.