Retrieve a list of API paths

Retrieve a list of API paths for a specific domain

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

Try it

Python

Python

import os
from gcore import Gcore

client = Gcore(
    api_key=os.environ.get("GCORE_API_KEY"),  # This is the default and can be omitted
)
page = client.waap.domains.api_paths.list(
    domain_id=1,
)
page = page.results[0]
print(page.id)

200

{
  "limit": 123,
  "offset": 123,
  "count": 123,
  "results": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "path": "<string>",
      "method": "GET",
      "api_version": "<string>",
      "http_scheme": "HTTP",
      "first_detected": "2023-11-07T05:31:56Z",
      "last_detected": "2023-11-07T05:31:56Z",
      "tags": [
        "<string>"
      ],
      "api_groups": [
        "<string>"
      ],
      "status": "CONFIRMED_API",
      "source": "API_DESCRIPTION_FILE",
      "request_count": 123
    }
  ]
}

Authorizations

Authorization · string · header · required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234$abcdef

Path Parameters

domain_id · integer · required

The domain ID

Query Parameters

ordering · enum<string>

Sort the response by given field.

Available options: 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

ids · string<uuid>[] | null

Filter by the path ID

path · string | null

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

Maximum string length: 1024

method · enum<string> | null

Filter by the API RESTful method

Available options: GET, POST, PUT, PATCH, DELETE, TRACE, HEAD, OPTIONS

api_version · string | null

Filter by the API version

Maximum string length: 32

http_scheme · enum<string> | null

Filter by the HTTP version of the API path

Available options: HTTP, HTTPS

api_group · string | null

Filter by the API group associated with the API path

status · enum<string>[] | null

Filter by the status of the discovered API path

The different statuses an API path can have

Available options: CONFIRMED_API, POTENTIAL_API, NOT_API, DELISTED_API

source · enum<string> | null

Filter by the source of the discovered API

Available options: API_DESCRIPTION_FILE, TRAFFIC_SCAN, USER_DEFINED

limit · integer · default: 10

Number of items to return

Required range: 0 <= x <= 10

offset · integer · default: 0

Number of items to skip

Required range: 0 <= x <= 100000

Response

200

application/json

Successful Response

limit · integer · required

Number of items requested in the response

offset · integer · required

Items response offset used

count · integer · required

Number of items contain in the response

results · ApiPathResponse · object[] · required

List of items returned in the response following given criteria

Show child attributes

results. id · string<uuid> · required

The path ID

results. path · string · required

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

Maximum string length: 1024

results. method · enum<string> · required

The API RESTful method

Available options: GET, POST, PUT, PATCH, DELETE, TRACE, HEAD, OPTIONS

results. api_version · string · required

The API version

Maximum string length: 32

results. http_scheme · enum<string> · required

The HTTP version of the API path

Available options: HTTP, HTTPS

results. first_detected · string<date-time> · required

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

results. last_detected · string<date-time> · required

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

results. tags · string[] · required

An array of tags associated with the API path

Maximum array length: 5

A user defined tag. Tags must start with a letter and can contain only letters, numbers and spaces.

Maximum string length: 50

results. api_groups · string[] · required

An array of api groups associated with the API path

results. status · enum<string> · required

The status of the discovered API path

Available options: CONFIRMED_API, POTENTIAL_API, NOT_API, DELISTED_API

results. source · enum<string> · required

The source of the discovered API

Available options: API_DESCRIPTION_FILE, TRAFFIC_SCAN, USER_DEFINED

results. request_count · integer · required

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