Get application OpenAPI specs

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

Retrieves all OpenAPI specifications mapped to the specified application.

Requires read:scan_config permission.

appIdstring · uuidrequired

UUID identifier for this StackHawk Application.

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

application/json

appId

string

The requested applicationId

assets

open_api_spec.OASAsset[]

OASAssets that have been mapped included to this application

Hide child attributesShow child attributes

assets.oasId

string

UUID of the hosted OAS files

assets.repositoryId

string

Repository UUID

assets.repositoryName

string

The name of the repository

assets.sourceRootPath

string

Source code path in repository the OAS was derived from

repoIds

string[]

repository IDs mapped to this application

Bad Request

Unauthorized

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

cURL

curl --request GET \
  --url 'https://api.stackhawk.com/api/v1/oas/{appId}/mapping' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Copy

Your privacy settings