GET
/
waap
/
v1
/
domains
/
{domain_id}
/
api-paths
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=0,
)
page = page.results[0]
print(page.id)
{
  "limit": 123,
  "offset": 123,
  "count": 123,
  "results": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "path": "/api/v1/paths/{path_id}",
      "method": "GET",
      "api_version": "v1",
      "http_scheme": "HTTP",
      "first_detected": "2023-11-07T05:31:56Z",
      "last_detected": "2023-11-07T05:31:56Z",
      "tags": [
        "sensitivedataurl",
        "highriskurl"
      ],
      "api_groups": [
        "accounts",
        "internal"
      ],
      "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 length: 1024
​
method
enum<string> | null

Filter by the API RESTful method The different methods an API path can have

Available options:
GET,
POST,
PUT,
PATCH,
DELETE,
TRACE,
HEAD,
OPTIONS
​
api_version
string | null

Filter by the API version

Maximum length: 32
​
http_scheme
enum<string> | null

Filter by the HTTP version of the API path The different HTTP schemes an API path can have

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

​
source
enum<string> | null

Filter by the source of the discovered API The different sources an API path can have

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

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