Skip to content

API reference

Generated from the Kpal API 1.4.0. See the guide for worked examples.

GET /api/health

Health

POST /api/auth/login

Login

Body: application/json

POST /api/auth/logout

Logout

GET /api/me

Me

POST /api/auth/password-reset

Password Reset

Body: application/json

POST /api/auth/password-reset/confirm

Password Reset Confirm

Body: application/json

GET /api/auth/sso/login

Sso Login

GET /api/auth/sso/callback

Sso Callback

Parameter In Required
code query yes
state query yes

GET /api/v1/org

Get Org

PATCH /api/v1/org

Patch Org

Body: application/json

GET /api/v1/users

List Users

POST /api/v1/users

Invite User

Body: application/json

GET /api/v1/api-keys

List Keys

POST /api/v1/api-keys

Create Key

Body: application/json

DELETE /api/v1/api-keys/{key_id}

Revoke Key

Parameter In Required
key_id path yes

DELETE /api/v1/users/{user_id}

Remove User

Parameter In Required
user_id path yes

PATCH /api/v1/users/{user_id}

Change Role

Parameter In Required
user_id path yes

Body: application/json

POST /api/v1/users/{user_id}/resend-invite

Resend Invite

Parameter In Required
user_id path yes

GET /api/v1/assets

List Assets

Parameter In Required
q query no
type query no
owner query no
tag query no
verified query no
page query no
page_size query no

POST /api/v1/assets

Create Asset

Body: application/json

POST /api/v1/assets/import

Import Csv

Body: multipart/form-data

GET /api/v1/assets/imports/latest

Latest Import

GET /api/v1/assets/imports/{run_id}

Get Import

Parameter In Required
run_id path yes

GET /api/v1/assets/{asset_id}

Get Asset

Parameter In Required
asset_id path yes

DELETE /api/v1/assets/{asset_id}

Delete Asset

Parameter In Required
asset_id path yes

PATCH /api/v1/assets/{asset_id}

Patch Asset

Parameter In Required
asset_id path yes

Body: application/json

POST /api/v1/assets/{asset_id}/verify

Verify Asset

Parameter In Required
asset_id path yes

Body: application/json

GET /api/v1/scans

List Scans

Parameter In Required
page query no
page_size query no
asset_id query no

POST /api/v1/scans

Create Scan

Body: application/json

GET /api/v1/scans/{scan_id}

Get Scan

Parameter In Required
scan_id path yes

GET /api/v1/findings

List Findings

Parameter In Required
status query no
severity query no
kev query no
owner query no
q query no
asset_id query no
page query no
page_size query no

GET /api/v1/findings/summary

Summary

GET /api/v1/findings/{finding_id}

Get Finding

Parameter In Required
finding_id path yes

PATCH /api/v1/findings/{finding_id}

Patch Finding

Parameter In Required
finding_id path yes

Body: application/json

POST /api/v1/findings/{finding_id}/rescan

Rescan

Parameter In Required
finding_id path yes

GET /api/v1/reports/findings.csv

Findings Csv

GET /api/v1/reports/summary.pdf

Summary Pdf