snyk-api-webs-api-reference-documentation — quality + safety report

---
name: snyk-api-webs-api-reference-documentation
description: "Snyk API & Web's API Reference Documentation API skill. Use when working with Snyk API & Web's API Reference Documentation for account, api-user-roles, api-users. Covers 371 endpoints."
version: 1.0.0
generator: lapsh
---

# Snyk API & Web's API Reference Documentation
API version: 1.2.0

## Auth
ApiKey Authorization in header

## Base URL
https://api.probely.com/

## Setup
1. Set your API key in the appropriate header
2. GET /account/available-slots/ -- verify access
3. POST /account/credits/top-up/ -- create first top-up

## Endpoints

371 endpoints across 30 groups. See references/api-spec.lap for full details.

### account
| Method | Path | Description |
|--------|------|-------------|
| GET | /account/available-slots/ | Retrieve the Number of Free Slots for Targets with Unlimited Scans |
| GET | /account/billing/ | Retrieve Billing Information |
| PUT | /account/billing/ | Update Billing Information |
| PATCH | /account/billing/ | Partial Update Billing Information |
| GET | /account/credits/ | Retrieve Credits Details |
| POST | /account/credits/top-up/ | Purchase Credits |
| GET | /account/credits/top-up/settings/ | Retrieve Credits Auto Top-up Settings |
| PUT | /account/credits/top-up/settings/ | Update Credits Auto Top-up Settings |
| PATCH | /account/credits/top-up/settings/ | Partial Update Credits Auto Top-up Settings |
| GET | /account/credits/usage/ | List Credits Usage |
| GET | /account/credits/usage/report/ | Download a CSV file with Credits Usage entries. |
| GET | /account/entitlements/ | Retrieve Entitlements |
| GET | /account/invoices/ | List Invoices |
| GET | /account/invoices/{id}/pdf/ | Retrieve Invoice |
| GET | /account/settings/ | Retrieve Account Settings |
| PUT | /account/settings/ | Update Account Settings |
| PATCH | /account/settings/ | Partial Update Account Settings |
| GET | /account/subscription/ | Retrieve Subscription Information |
| GET | /account/unlimited/ | List Targets with Unlimited Scans |
| PUT | /account/unlimited/ | Bulk Update Targets with Unlimited Scans |
| PATCH | /account/unlimited/ | Bulk Partial Update Targets with Unlimited Scans |
| DELETE | /account/unlimited/ | Bulk Disable Targets with Unlimited Scans |

### api-user-roles
| Method | Path | Description |
|--------|------|-------------|
| GET | /api-user-roles/ | List API User Roles |
| POST | /api-user-roles/ | Create API User Role |
| GET | /api-user-roles/{id}/ | Retrieve API User Role |
| PUT | /api-user-roles/{id}/ | Update API User Role |
| PATCH | /api-user-roles/{id}/ | Partial Update API User Role |
| DELETE | /api-user-roles/{id}/ | Delete API User Role |
| POST | /api-user-roles/bulk/create/ | Bulk Create API User Roles |
| POST | /api-user-roles/bulk/delete/ | Bulk Delete API User Roles |
| POST | /api-user-roles/bulk/operations/ | Bulk Operations on API User Roles |
| POST | /api-user-roles/bulk/update/ | Bulk Update API User Roles |

### api-users
| Method | Path | Description |
|--------|------|-------------|
| GET | /api-users/ | List API Users |
| POST | /api-users/ | Create API User |
| GET | /api-users/{id}/ | Retrieve API User |
| PUT | /api-users/{id}/ | Update API User |
| PATCH | /api-users/{id}/ | Partial Update API User |
| DELETE | /api-users/{id}/ | Disable API User |
| GET | /api-users/{user_id}/targets/ | List API User Targets |
| POST | /api-users/bulk/update/ | Bulk Update API Users |
| GET | /api-users/policy/ | Retrieve API Key Policy |
| PUT | /api-users/policy/ | Update API Key Policy |

### audit-log
| Method | Path | Description |
|--------|------|-------------|
| GET | /audit-log/ | List Audit Log entries. |
| GET | /audit-log/download/ | Download a CSV file with Audit Log entries. |

### credits-packs
| Method | Path | Description |
|--------|------|-------------|
| GET | /credits-packs/ | List Credits Packs |
| GET | /credits-packs/{id}/ | Retrieve Credits Pack |

### dashboard
| Method | Path | Description |
|--------|------|-------------|
| GET | /dashboard/aggregated-risk-trend/ | List Aggregated Risk Trends |
| GET | /dashboard/average-fix-time/ | List Average Fix Times |
| GET | /dashboard/fixed-vulnerabilities-trend/ | Get Fixed Vulnerabilities Trend |
| GET | /dashboard/needs-attention-pie/ | Retrieve Attention Pie |
| GET | /dashboard/needs-attention-top/ | List Top Items needing attention |
| GET | /dashboard/risk-trend/ | List Risk Trends |
| GET | /dashboard/severity-trend/ | List Severity Trends |
| GET | /dashboard/top-vulnerabilities/ | List Top Vulnerabilities |

### definitions
| Method | Path | Description |
|--------|------|-------------|
| GET | /definitions/ | List Vulnerability Definitions |
| GET | /definitions/{id}/ | Retrieve Vulnerability Definition |

### discovery
| Method | Path | Description |
|--------|------|-------------|
| GET | /discovery/assets/ | List Discovered Assets |
| GET | /discovery/assets/{discovery_asset_id}/logs/ | List Discovered Asset's Logs |
| GET | /discovery/assets/{id}/ | Retrieve Discovered Asset |
| PUT | /discovery/assets/{id}/ | Update Discovered Asset |
| PATCH | /discovery/assets/{id}/ | Partial Update Discovered Asset |
| POST | /discovery/assets/{id}/create_target/ | Create Target for Discovered Asset |
| GET | /discovery/assets/{id}/download_api_schema_file/ | Download API Schema File |
| GET | /discovery/assets/stats/ | Get Asset Discovery Statistics |
| GET | /discovery/settings/ | Retrieve Discovery settings |
| PUT | /discovery/settings/ | Update Asset Discovery Settings |
| PATCH | /discovery/settings/ | Partially Update Asset Discovery Settings |
| GET | /discovery/sources/ | List Asset Discovery Sources |
| GET | /discovery/status/ | Get Asset Discovery Status |

### domains
| Method | Path | Description |
|--------|------|-------------|
| GET | /domains/ | List Domains |
| POST | /domains/ | Create Domain |
| GET | /domains/{id}/ | Retrieve Domain |
| PUT | /domains/{id}/ | Update Domain |
| PATCH | /domains/{id}/ | Partial Update to Domain |
| DELETE | /domains/{id}/ | Delete Domain |
| POST | /domains/{id}/verify/ | Verify Domain Ownership |

### events
| Method | Path | Description |
|--------|------|-------------|
| GET | /events/ | List Account's Events |
| GET | /events/{id}/ | Retrieve Account's Event |

### findings
| Method | Path | Description |
|--------|------|-------------|
| GET | /findings/ | List Account's Findings |
| GET | /findings/{id}/ | Retrieve Account's Finding |
| PUT | /findings/{id}/ | Update Account's Finding |
| PATCH | /findings/{id}/ | Partial Update Account's Finding |
| POST | /findings/bulk/report/ | Select Findings for Report |
| POST | /findings/bulk/retest/ | Bulk Retest Account's Findings |
| POST | /findings/bulk/update/ | Bulk Update Account's Findings |
| GET | /findings/report/ | Retrieve Selected Findings Report |

### frameworks
| Method | Path | Description |
|--------|------|-------------|
| GET | /frameworks/ | List Frameworks |
| GET | /frameworks/{id}/ | Retrieve Framework |

### integrations
| Method | Path | Description |
|--------|------|-------------|
| GET | /integrations/akamai/ | Retrieve Akamai Configuration |
| PUT | /integrations/akamai/ | Update Akamai Configuration |
| PATCH | /integrations/akamai/ | Partial Update Akamai Configuration |
| DELETE | /integrations/akamai/ | Delete Akamai Configuration |
| POST | /integrations/akamai/refresh/ | Refresh Akamai Records |
| GET | /integrations/aws/ | Retrieve AWS Configuration |
| PUT | /integrations/aws/ | Update AWS Configuration |
| PATCH | /integrations/aws/ | Partial Update AWS Configuration |
| DELETE | /integrations/aws/ | Delete AWS Configuration |
| POST | /integrations/aws/refresh/ | Refresh AWS Records |
| GET | /integrations/azure-devops/ | Retrieve Azure DevOps Account Config |
| PUT | /integrations/azure-devops/ | Update Azure DevOps Account Config |
| PATCH | /integrations/azure-devops/ | Patch Azure DevOps Account Config |
| DELETE | /integrations/azure-devops/ | Delete Azure DevOps Account Config |
| GET | /integrations/cloudflare/ | Get Cloudflare Account instance data |
| PUT | /integrations/cloudflare/ | Update a Cloudflare Account instance |
| PATCH | /integrations/cloudflare/ | Partial Update a Cloudflare Account instance |
| DELETE | /integrations/cloudflare/ | Delete a Cloudflare Account instance |
| POST | /integrations/cloudflare/refresh/ | Refresh Cloudflare Records |
| GET | /integrations/jira-server/ | Get Jira Server Account instance data |
| PUT | /integrations/jira-server/ | Update a Jira Server Account instance |
| PATCH | /integrations/jira-server/ | Partial Update a Jira Server Account instance |
| DELETE | /integrations/jira-server/ | Delete a Jira Server Account instance |
| GET | /integrations/postman/ | Retrieve Account's Postman Integration Settings |
| POST | /integrations/postman/ | Add Account's Postman Settings |
| PUT | /integrations/postman/ | Update Account's Postman Settings |
| PATCH | /integrations/postman/ | Partial Update Account's Postman Settings |
| DELETE | /integrations/postman/ | Delete Account's Postman Setting |

### labels
| Method | Path | Description |
|--------|------|-------------|
| GET | /labels/findings/ | List Finding Labels |
| POST | /labels/findings/ | Create Finding Label |
| GET | /labels/findings/{id}/ | Retrieve Finding Label |
| PUT | /labels/findings/{id}/ | Update Finding Label |
| PATCH | /labels/findings/{id}/ | Partial Update Finding Label |
| DELETE | /labels/findings/{id}/ | Delete Finding Label |
| GET | /labels/targets/ | List Target Labels |
| POST | /labels/targets/ | Create Target Label |
| GET | /labels/targets/{id}/ | Retrieve Target Label |
| PUT | /labels/targets/{id}/ | Update Target Label |
| PATCH | /labels/targets/{id}/ | Partial Update Target Label |
| DELETE | /labels/targets/{id}/ | Delete Target Label |
| GET | /labels/users/ | List User Labels |
| POST | /labels/users/ | Create User Label |
| GET | /labels/users/{id}/ | Retrieve User Label |
| PUT | /labels/users/{id}/ | Update User Label |
| PATCH | /labels/users/{id}/ | Partial Update User Label |
| DELETE | /labels/users/{id}/ | Delete User Label |

### permissions
| Method | Path | Description |
|--------|------|-------------|
| GET | /permissions/ | List Permissions |

### plans
| Method | Path | Description |
|--------|------|-------------|
| GET | /plans/ | List Plans |

### profile
| Method | Path | Description |
|--------|------|-------------|
| GET | /profile/ | Retrieve Profile |
| POST | /profile/accept_tos/ | Accept User Terms of Service |
| POST | /profile/change_password/ | Change Password |
| GET | /profile/notifications/ | Retrieve Notifications Configuration |
| PUT | /profile/notifications/ | Update Notifications Configuration |
| PATCH | /profile/notifications/ | Partial Update Notifications Configuration |
| GET | /profile/permissions/ | List Permissions |
| GET | /profile/roles/ | List Roles |
| GET | /profile/targets/ | List Targets |

### report
| Method | Path | Description |
|--------|------|-------------|
| GET | /report/ | List Report Requests |
| POST | /report/ | Generate Report |
| GET | /report/{id}/ | Retrieve Report Request |
| PUT | /report/{id}/ | Update Report Request |
| PATCH | /report/{id}/ | Partial Update to Report Request |
| GET | /report/{id}/download/ | Download Report |
| GET | /report/{id}/status/ | Report Generation Status |
| GET | /report/types/ | Get all stored report types |

### roles
| Method | Path | Description |
|--------|------|-------------|
| GET | /roles/ | List Roles |
| POST | /roles/ | Create Role |
| GET | /roles/{id}/ | Retrieve Role |
| PUT | /roles/{id}/ | Update Role |
| PATCH | /roles/{id}/ | Partial Update Role |
| DELETE | /roles/{id}/ | Delete Role |

### scan-profiles
| Method | Path | Description |
|--------|------|-------------|
| GET | /scan-profiles/ | List Scan Profiles |
| POST | /scan-profiles/ | Create Custom Scan Profile |
| GET | /scan-profiles/{id

… (truncated)