Snyk API Webs API Reference Documentation

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

api-user-roles

api-users

audit-log

credits-packs

dashboard

definitions

discovery

domains

events

findings

frameworks

integrations

labels

permissions

plans

profile

report

roles

scan-profiles

scanning-agents

scans

scheduledscans

stored-reports

targets

teams

user-roles

users

webhooks

wizard

Common Questions

Match user requests to endpoints in references/api-spec.lap. Key patterns:

• "List all available-slots?" -> GET /account/available-slots/
• "List all billing?" -> GET /account/billing/
• "List all credits?" -> GET /account/credits/
• "Create a top-up?" -> POST /account/credits/top-up/
• "List all settings?" -> GET /account/credits/top-up/settings/
• "Search usage?" -> GET /account/credits/usage/
• "List all report?" -> GET /account/credits/usage/report/
• "List all entitlements?" -> GET /account/entitlements/
• "Search invoices?" -> GET /account/invoices/
• "List all pdf?" -> GET /account/invoices/{id}/pdf/
• "List all settings?" -> GET /account/settings/
• "List all subscription?" -> GET /account/subscription/
• "Search unlimited?" -> GET /account/unlimited/
• "List all api-user-roles?" -> GET /api-user-roles/
• "Create a api-user-role?" -> POST /api-user-roles/
• "Get api-user-role details?" -> GET /api-user-roles/{id}/
• "Update a api-user-role?" -> PUT /api-user-roles/{id}/
• "Partially update a api-user-role?" -> PATCH /api-user-roles/{id}/
• "Delete a api-user-role?" -> DELETE /api-user-roles/{id}/
• "Create a create?" -> POST /api-user-roles/bulk/create/
• "Create a delete?" -> POST /api-user-roles/bulk/delete/
• "Create a operation?" -> POST /api-user-roles/bulk/operations/
• "Create a update?" -> POST /api-user-roles/bulk/update/
• "Search api-users?" -> GET /api-users/
• "Create a api-user?" -> POST /api-users/
• "Get api-user details?" -> GET /api-users/{id}/
• "Update a api-user?" -> PUT /api-users/{id}/
• "Partially update a api-user?" -> PATCH /api-users/{id}/
• "Delete a api-user?" -> DELETE /api-users/{id}/
• "Search targets?" -> GET /api-users/{user_id}/targets/
• "Create a update?" -> POST /api-users/bulk/update/
• "List all policy?" -> GET /api-users/policy/
• "Search audit-log?" -> GET /audit-log/
• "List all download?" -> GET /audit-log/download/
• "List all credits-packs?" -> GET /credits-packs/
• "Get credits-pack details?" -> GET /credits-packs/{id}/
• "Search aggregated-risk-trend?" -> GET /dashboard/aggregated-risk-trend/
• "Search average-fix-time?" -> GET /dashboard/average-fix-time/
• "Search fixed-vulnerabilities-trend?" -> GET /dashboard/fixed-vulnerabilities-trend/
• "Search needs-attention-pie?" -> GET /dashboard/needs-attention-pie/
• "Search needs-attention-top?" -> GET /dashboard/needs-attention-top/
• "Search risk-trend?" -> GET /dashboard/risk-trend/
• "Search severity-trend?" -> GET /dashboard/severity-trend/
• "Search top-vulnerabilities?" -> GET /dashboard/top-vulnerabilities/
• "Search definitions?" -> GET /definitions/
• "Get definition details?" -> GET /definitions/{id}/
• "Search assets?" -> GET /discovery/assets/
• "Search logs?" -> GET /discovery/assets/{discovery_asset_id}/logs/
• "Get asset details?" -> GET /discovery/assets/{id}/
• "Update a asset?" -> PUT /discovery/assets/{id}/
• "Partially update a asset?" -> PATCH /discovery/assets/{id}/
• "Create a create_target?" -> POST /discovery/assets/{id}/create_target/
• "List all download_api_schema_file?" -> GET /discovery/assets/{id}/download_api_schema_file/
• "List all stats?" -> GET /discovery/assets/stats/
• "List all settings?" -> GET /discovery/settings/
• "List all sources?" -> GET /discovery/sources/
• "List all status?" -> GET /discovery/status/
• "Search domains?" -> GET /domains/
• "Create a domain?" -> POST /domains/
• "Get domain details?" -> GET /domains/{id}/
• "Update a domain?" -> PUT /domains/{id}/
• "Partially update a domain?" -> PATCH /domains/{id}/
• "Delete a domain?" -> DELETE /domains/{id}/
• "Create a verify?" -> POST /domains/{id}/verify/
• "Search events?" -> GET /events/
• "Get event details?" -> GET /events/{id}/
• "Search findings?" -> GET /findings/
• "Get finding details?" -> GET /findings/{id}/
• "Update a finding?" -> PUT /findings/{id}/
• "Partially update a finding?" -> PATCH /findings/{id}/
• "Create a report?" -> POST /findings/bulk/report/
• "Create a retest?" -> POST /findings/bulk/retest/
• "Create a update?" -> POST /findings/bulk/update/
• "List all report?" -> GET /findings/report/
• "Search frameworks?" -> GET /frameworks/
• "Get framework details?" -> GET /frameworks/{id}/
• "List all akamai?" -> GET /integrations/akamai/
• "Create a refresh?" -> POST /integrations/akamai/refresh/
• "List all aws?" -> GET /integrations/aws/
• "Create a refresh?" -> POST /integrations/aws/refresh/
• "List all azure-devops?" -> GET /integrations/azure-devops/
• "List all cloudflare?" -> GET /integrations/cloudflare/
• "Create a refresh?" -> POST /integrations/cloudflare/refresh/
• "List all jira-server?" -> GET /integrations/jira-server/
• "List all postman?" -> GET /integrations/postman/
• "Create a postman?" -> POST /integrations/postman/
• "Search findings?" -> GET /labels/findings/
• "Create a finding?" -> POST /labels/findings/
• "Get finding details?" -> GET /labels/findings/{id}/
• "Update a finding?" -> PUT /labels/findings/{id}/
• "Partially update a finding?" -> PATCH /labels/findings/{id}/
• "Delete a finding?" -> DELETE /labels/findings/{id}/
• "Search targets?" -> GET /labels/targets/
• "Create a target?" -> POST /labels/targets/
• "Get target details?" -> GET /labels/targets/{id}/
• "Update a target?" -> PUT /labels/targets/{id}/
• "Partially update a target?" -> PATCH /labels/targets/{id}/
• "Delete a target?" -> DELETE /labels/targets/{id}/
• "Search users?" -> GET /labels/users/
• "Create a user?" -> POST /labels/users/
• "Get user details?" -> GET /labels/users/{id}/
• "Update a user?" -> PUT /labels/users/{id}/
• "Partially update a user?" -> PATCH /labels/users/{id}/
• "Delete a user?" -> DELETE /labels/users/{id}/
• "Search permissions?" -> GET /permissions/
• "List all plans?" -> GET /plans/
• "Search profile?" -> GET /profile/
• "Create a accept_to?" -> POST /profile/accept_tos/
• "Create a change_password?" -> POST /profile/change_password/
• "List all notifications?" -> GET /profile/notifications/
• "List all permissions?" -> GET /profile/permissions/
• "Search roles?" -> GET /profile/roles/
• "Search targets?" -> GET /profile/targets/
• "Search report?" -> GET /report/
• "Create a report?" -> POST /report/
• "Get report details?" -> GET /report/{id}/
• "Update a report?" -> PUT /report/{id}/
• "Partially update a report?" -> PATCH /report/{id}/
• "List all download?" -> GET /report/{id}/download/
• "List all status?" -> GET /report/{id}/status/
• "List all types?" -> GET /report/types/
• "Search roles?" -> GET /roles/
• "Create a role?" -> POST /roles/
• "Get role details?" -> GET /roles/{id}/
• "Update a role?" -> PUT /roles/{id}/
• "Partially update a role?" -> PATCH /roles/{id}/
• "Delete a role?" -> DELETE /roles/{id}/
• "Search scan-profiles?" -> GET /scan-profiles/
• "Create a scan-profile?" -> POST /scan-profiles/
• "Get scan-profile details?" -> GET /scan-profiles/{id}/
• "Update a scan-profile?" -> PUT /scan-profiles/{id}/
• "Partially update a scan-profile?" -> PATCH /scan-profiles/{id}/
• "Search scanning-agents?" -> GET /scanning-agents/
• "Create a scanning-agent?" -> POST /scanning-agents/
• "List all config-files?" -> GET /scanning-agents/{hek}/config-files/
• "Get scanning-agent details?" -> GET /scanning-agents/{id}/
• "Update a scanning-agent?" -> PUT /scanning-agents/{id}/
• "Partially update a scanning-agent?" -> PATCH /scanning-agents/{id}/
• "Delete a scanning-agent?" -> DELETE /scanning-agents/{id}/
• "Create a generate?" -> POST /scanning-agents/{id}/generate/
• "Search scans?" -> GET /scans/
• "Get scan details?" -> GET /scans/{id}/
• "Create a cancel?" -> POST /scans/bulk/cancel/
• "Create a pause?" -> POST /scans/bulk/pause/
• "Create a resume?" -> POST /scans/bulk/resume/
• "Create a start?" -> POST /scans/bulk/start/
• "List all warnings?" -> GET /scans/warnings/
• "Get warning details?" -> GET /scans/warnings/{id}/
• "Search scheduledscans?" -> GET /scheduledscans/
• "Create a bulk?" -> POST /scheduledscans/bulk/
• "Search stored-reports?" -> GET /stored-reports/
• "Create a stored-report?" -> POST /stored-reports/
• "Get stored-report details?" -> GET /stored-reports/{id}/
• "Update a stored-report?" -> PUT /stored-reports/{id}/
• "Partially update a stored-report?" -> PATCH /stored-reports/{id}/
• "Delete a stored-report?" -> DELETE /stored-reports/{id}/
• "Create a generate?" -> POST /stored-reports/{id}/generate/
• "Create a preview?" -> POST /stored-reports/preview/
• "Search targets?" -> GET /targets/
• "Create a target?" -> POST /targets/
• "Get target details?" -> GET /targets/{id}/
• "Update a target?" -> PUT /targets/{id}/
• "Partially update a target?" -> PATCH /targets/{id}/
• "Delete a target?" -> DELETE /targets/{id}/
• "List all average_fix_time?" -> GET /targets/{id}/average_fix_time/
• "Create a check_api_login?" -> POST /targets/{id}/check_api_login/
• "List all download_api_schema_file?" -> GET /targets/{id}/download_api_schema_file/
• "List all get_postman_collection_folders?" -> GET /targets/{id}/get_postman_collection_folders/
• "List all azure-devops?" -> GET /targets/{id}/integrations/azure-devops/
• "List all jira-cloud?" -> GET /targets/{id}/integrations/jira-cloud/
• "List all jira-server?" -> GET /targets/{id}/integrations/jira-server/
• "List all slack?" -> GET /targets/{id}/integrations/slack/
• "List all login-video?" -> GET /targets/{id}/login-video/
• "List all mle?" -> GET /targets/{id}/mle/
• "Create a move-team?" -> POST /targets/{id}/move-team/
• "List all mtls?" -> GET /targets/{id}/mtls/
• "Create a reset?" -> POST /targets/{id}/otp/reset/
• "List all postman-authentication?" -> GET /targets/{id}/postman-authentication/
• "List all risk_trend?" -> GET /targets/{id}/risk_trend/
• "Create a scan_now?" -> POST /targets/{id}/scan_now/
• "List all severity_trend?" -> GET /targets/{id}/severity_trend/
• "List all signature?" -> GET /targets/{id}/signature/
• "List all top_vulns?" -> GET /targets/{id}/top_vulns/
• "Create a upload_api_schema_file?" -> POST /targets/{id}/upload_api_schema_file/
• "List all azure-devops?" -> GET /targets/{scope}/findings/{id}/integrations/azure-devops/
• "List all jira-cloud?" -> GET /targets/{scope}/findings/{id}/integrations/jira-cloud/
• "List all jira-server?" -> GET /targets/{scope}/findings/{id}/integrations/jira-server/
• "Search assets?" -> GET /targets/{target_id}/assets/
• "Create a asset?" -> POST /targets/{target_id}/assets/
• "Get asset details?" -> GET /targets/{target_id}/assets/{id}/
• "Update a asset?" -> PUT /targets/{target_id}/assets/{id}/
• "Partially update a asset?" -> PATCH /targets/{target_id}/assets/{id}/
• "Delete a asset?" -> DELETE /targets/{target_id}/assets/{id}/
• "Search events?" -> GET /targets/{target_id}/events/
• "Get event details?" -> GET /targets/{target_id}/events/{id}/
• "Search findings?" -> GET /targets/{target_id}/findings/
• "Search logs?" -> GET /targets/{target_id}/findings/{finding_id}/logs/
• "Get finding details?" -> GET /targets/{target_id}/findings/{id}/
• "Update a finding?" -> PUT /targets/{target_id}/findings/{id}/
• "Partially update a finding?" -> PATCH /targets/{target_id}/findings/{id}/
• "Create a retest?" -> POST /targets/{target_id}/findings/{id}/retest/
• "Create a report?" -> POST /targets/{target_id}/findings/bulk/report/
• "Create a retest?" -> POST /targets/{target_id}/findings/bulk/retest/
• "Create a update?" -> POST /targets/{target_id}/findings/bulk/update/
• "List all report?" -> GET /targets/{target_id}/findings/report/
• "Search logout?" -> GET /targets/{target_id}/logout/
• "Create a logout?" -> POST /targets/{target_id}/logout/
• "Get logout details?" -> GET /targets/{target_id}/logout/{id}/
• "Update a logout?" -> PUT /targets/{target_id}/logout/{id}/
• "Partially update a logout?" -> PATCH /targets/{target_id}/logout/{id}/
• "Delete a logout?" -> DELETE /targets/{target_id}/logout/{id}/
• "Search reduced-scopes?" -> GET /targets/{target_id}/reduced-scopes/
• "Create a reduced-scope?" -> POST /targets/{target_id}/reduced-scopes/
• "Get reduced-scope details?" -> GET /targets/{target_id}/reduced-scopes/{id}/
• "Update a reduced-scope?" -> PUT /targets/{target_id}/reduced-scopes/{id}/
• "Partially update a reduced-scope?" -> PATCH /targets/{target_id}/reduced-scopes/{id}/
• "Delete a reduced-scope?" -> DELETE /targets/{target_id}/reduced-scopes/{id}/
• "List all scan?" -> GET /targets/{target_id}/scan/
• "Create a cancel?" -> POST /targets/{target_id}/scan/cancel/
• "Create a pause?" -> POST /targets/{target_id}/scan/pause/
• "Create a resume?" -> POST /targets/{target_id}/scan/resume/
• "Search scans?" -> GET /targets/{target_id}/scans/
• "Get scan details?" -> GET /targets/{target_id}/scans/{id}/
• "Update a scan?" -> PUT /targets/{target_id}/scans/{id}/
• "Partially update a scan?" -> PATCH /targets/{target_id}/scans/{id}/
• "Create a cancel?" -> POST /targets/{target_id}/scans/{id}/cancel/
• "List all endpoints?" -> GET /targets/{target_id}/scans/{id}/endpoints/
• "Create a pause?" -> POST /targets/{target_id}/scans/{id}/pause/
• "List all report?" -> GET /targets/{target_id}/scans/{id}/report/
• "Create a resume?" -> POST /targets/{target_id}/scans/{id}/resume/
• "List all dates?"

…(truncated)