Skip to main content
GET
/
api
/
v1
/
scans
/
{scanId}
/
endpoints
Get scan endpoint definitions
curl --request GET \
  --url https://app.gecko.security/api/v1/scans/{scanId}/endpoints \
  --header 'X-API-Key: <api-key>'
{
  "version": "v1",
  "scan_id": "f5d35de5-8fc8-4a01-8e28-3bae5d6d26ad",
  "format": "yaml",
  "endpoints": "openapi: 3.1.0\ninfo:\n  title: Example API\npaths:\n  /health:\n    get:\n      summary: Health",
  "parsed": null
}

Authorizations

​
X-API-Key
string
header
required

Team-scoped Gecko API key. Keys start with gk_.

Path Parameters

​
scanId
string<uuid>
required

Scan UUID.

Response

The scan endpoint definition.

​
version
string
required
Allowed value: "v1"
​
scan_id
string<uuid>
required
​
format
enum<string> | null
required
Available options:
yaml,
json,
null
​
endpoints
string | null
required
​
parsed
object
required