v32

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-151,1412,2144.5 MB

API Discovery

Create an API path

Create an API path for a domain

post/waap/v1/domains/{domain_id}/api-paths

Path parameters

domain_idinteger required

The domain ID

Request body

pathstring required

The API path, locations that are saved for resource IDs will be put in curly brackets

The different methods an API path can have

http_scheme'HTTP' | 'HTTPS' required

The different HTTP schemes an API path can have

api_versionstring

tagsstring[]

api_groupsstring[]

Example request

{
  "path": "/api/v1/paths/{path_id}",
  "api_version": "v1",
  "tags": [
    "sensitivedataurl",
    "highriskurl"
  ],
  "api_groups": [
    "accounts",
    "internal"
  ]
}

Response

Successful Response

idstring uuid required

The path ID

pathstring required

The API path, locations that are saved for resource IDs will be put in curly brackets

The different methods an API path can have

api_versionstring required

The API version

http_scheme'HTTP' | 'HTTPS' required

The different HTTP schemes an API path can have

first_detectedstring date-time required

The date and time in ISO 8601 format the API path was first detected.

last_detectedstring date-time required

The date and time in ISO 8601 format the API path was last detected.

tagsstring[] required

An array of tags associated with the API path

api_groupsstring[] required

An array of api groups associated with the API path

status'CONFIRMED_API' | 'POTENTIAL_API' | 'NOT_API' | 'DELISTED_API' required

The different statuses an API path can have

source'API_DESCRIPTION_FILE' | 'TRAFFIC_SCAN' | 'USER_DEFINED' required

The different sources an API path can have

request_countinteger required

The number of requests for this path in the last 24 hours

Example response

{
  "path": "/api/v1/paths/{path_id}",
  "api_version": "v1",
  "tags": [
    "sensitivedataurl",
    "highriskurl"
  ],
  "api_groups": [
    "accounts",
    "internal"
  ]
}