Skip to main content

Account

To scan targets with Snyk API & Web you need to have an account and subscribe to one of the available pricing plans. Once created, you can manage your account regarding the subscribed plan, payment and billing information, invoices, targets with unlimited scans, and credits for scanning targets.
Within your account, explore the features provided by Snyk API & Web, such as:

  • Create and manage targets.
  • Start and manage target scans.
  • List and take action on vulnerability findings from target scans.
  • Create and manage users, teams, and roles and permissions.
  • Create and manage webhooks to handle events from the account and targets.
  • Integrate with other systems like Jira or Azure to synchornize findings.

See the Related Tags section for further details.

Functionality​

The endpoints under Account provide the following functionality:

  • Retrieve the subscription information and entitlements.
  • List and retrieve invoices.
  • List all pricing plans.
  • Targets:
    • Retrieve the number of free slots for targets with unlimited scans.
    • List and manage targets with unlimited scans.
  • Credits:
    • Retrieve your credits information and list the credits usage.
    • List and retrieve credits packs.
    • Purchase credits.
    • Retrieve and set auto top-up of credits.

Further functionality related to Account is provided in the following tags:

  • Targets
    • Targets - Manage the targets in the account.
  • Scans
    • Scans - Manage scans of targets in the account.
    • Scheduled Scans - Manage scheduled scans of targets in the account.
  • Findings
    • Findings - Manage findings obtained from scans of targets in the account.
    • Vulnerabilities - List and retrieve vulnerability descriptions.
  • Reports
    • Reports - Retrieve reports on findings from scans of targets in the account.
    • Dashboards - Retrieve statistical information on scans of targets in the account.
  • Users
    • User Management - Manage Snyk API & Web app users in the account.
    • User - Manage specific user settings, like passwords or notifications.
    • API Users - Manage API users and API roles in the account.
    • User Roles - Manage roles assigned to the Snyk API & Web app users in the account.
    • Audit Log - Download the audit log of the user activity in the account.
  • Teams
    • Teams - Manage groups of users and targets in the account.
  • Roles & Permissions
  • Events
    • Events - Manage notifications of events from the account and targets.
  • Integrations
    • Jira Server Integration - Manage the integration with Jira to synchronize findings from target scans in the account.
    • Azure DevOps Integration - Manage the integration with Azure DevOps to synchronize findings from target scans in the account.