Map application OpenAPI specs

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

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

Requires write:scan_config permission.

Path parameters

appIdstring · uuidrequired

UUID identifier for this StackHawk Application.

Body

appId

string

The applicationId to map the oas specs

include

boolean

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

oasId

string

UUID of the hosted OAS files

repositoryId

string

Repository UUID

sourceRootPath

string

Source code path in repository from the OAS

Response

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

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

cURL

curl --request POST \
  --url 'https://api.stackhawk.com/api/v1/oas/{appId}/mapping' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{}'

Copy

Map application OpenAPI specs

Path parameters

Body

Response

Your privacy settings