Sign in

v32

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

Retrieve a list of API paths

Retrieve a list of API paths for a specific domain

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

Path parameters

domain_idinteger required

The domain ID

The domain ID

Query parameters

ordering'id' | 'path' | 'method' | 'api_version' | 'http_scheme' | 'first_detected' | 'last_detected' | 'status' | 'source' | '-id' | '-path' | '-method' | '-api_version' | '-http_scheme' | '-first_detected' | '-last_detected' | '-status' | '-source'

Sort the response by given field.

Sort the response by given field.

idsstring[] nullable

Filter by the path ID

Filter by the path ID

pathstring nullable

Filter by the path. Supports '*' as a wildcard character

Filter by the path. Supports '*' as a wildcard character

method'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'TRACE' | 'HEAD' | 'OPTIONS'

The different methods an API path can have

Filter by the API RESTful method

api_versionstring nullable

Filter by the API version

Filter by the API version

http_scheme'HTTP' | 'HTTPS'

The different HTTP schemes an API path can have

Filter by the HTTP version of the API path

api_groupstring nullable

Filter by the API group associated with the API path

Filter by the API group associated with the API path

statusApiPathStatus[] nullable

Filter by the status of the discovered API path

Filter by the status of the discovered API path

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

The different sources an API path can have

Filter by the source of the discovered API

limitinteger

Number of items to return

Number of items to return

offsetinteger

Number of items to skip

Number of items to skip

Response

Successful Response

limitinteger required

Number of items requested in the response

offsetinteger required

Items response offset used

countinteger required

Number of items contain in the response

Example response

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