SOsocket-dev
alerts

List latest alerts (Beta)

Changed on

List latest alerts.

Pagination: keep requesting pages (passing the previous response's endCursor as startAfterCursor) until endCursor is null. Do not stop when items is empty — an empty page can be returned while more results still remain on later pages, so endCursor being null is the only reliable end-of-results signal. The cursor, startAfter, endCursor, after, nextCursor, and page[after] query parameters are not supported and return a 400 response; use startAfterCursor instead.

This endpoint consumes 10 units of your quota.

This endpoint requires the following org token scopes:

  • alerts:list
get/orgs/{org_slug}/alerts

Request

  • Base URL
    https://api.socket.dev/v0
  • URL
    https://api.socket.dev/v0/orgs/{org_slug}/alerts
  • Auth
    • HTTP bearer
    • or HTTP basic

Path parameters

org_slugstring required

The slug of the organization

Query parameters

per_pageinteger

Specify the maximum number of results to return per page (intermediate pages may have fewer than this limit and callers should always check "endCursor" in response body to know if there are more pages)

startAfterCursorstring

The pagination cursor that was returned as the "endCursor" property in previous request. Unsupported cursor aliases return 400; unrelated query parameters are unchanged.

narrowLocationsToActiveFiltersboolean

Set to true to return only locations matching the active per-location filters, such as repository and branch. The dashboardUrl and any truncated description link point to the first matching location. With multiple repositories selected, the link points to the first matching repository. Defaults to false, preserving all accessible locations for each matching alert. Repeat this parameter on every cursor-paginated request.

filters.alertActionstring

Comma-separated list of alert actions ("error", "warn", "monitor", or "ignore) that should be included

filters.alertAction.notInstring

Comma-separated list of alert actions ("error", "warn", "monitor", or "ignore) that should be excluded

filters.alertActionSourceTypestring

Comma-separated list of alert action source types ("resolution", "alert-policy", "fallback", "injected-alert", "org-policy", "reachability", "repo-label-policy", "socket-yml", or "triage") that should be included

filters.alertActionSourceType.notInstring

Comma-separated list of alert action source types ("resolution", "alert-policy", "fallback", "injected-alert", "org-policy", "reachability", "repo-label-policy", "socket-yml", or "triage") that should be excluded

filters.alertCategorystring

Comma-separated list of alert categories ("supplyChainRisk", "maintenance", "quality", "license", or "vulnerability") that should be included

filters.alertCategory.notInstring

Comma-separated list of alert categories ("supplyChainRisk", "maintenance", "quality", "license", or "vulnerability") that should be excluded

filters.alertClearedAt.eqstring

Alert cleared at (YYYY-MM-DD HH:MM:SS in UTC time zone)

filters.alertClearedAt.ltstring

Alert cleared at (YYYY-MM-DD HH:MM:SS in UTC time zone)

filters.alertClearedAt.ltestring

Alert cleared at (YYYY-MM-DD HH:MM:SS in UTC time zone)

filters.alertClearedAt.gtstring

Alert cleared at (YYYY-MM-DD HH:MM:SS in UTC time zone)

filters.alertClearedAt.gtestring

Alert cleared at (YYYY-MM-DD HH:MM:SS in UTC time zone)

filters.alertCreatedAt.eqstring

Alert created at (YYYY-MM-DD HH:MM:SS in UTC time zone)

filters.alertCreatedAt.ltstring

Alert created at (YYYY-MM-DD HH:MM:SS in UTC time zone)

filters.alertCreatedAt.ltestring

Alert created at (YYYY-MM-DD HH:MM:SS in UTC time zone)

filters.alertCreatedAt.gtstring

Alert created at (YYYY-MM-DD HH:MM:SS in UTC time zone)

filters.alertCreatedAt.gtestring

Alert created at (YYYY-MM-DD HH:MM:SS in UTC time zone)

filters.alertCveIdstring

CVE ID

filters.alertCveId.notInstring

CVE ID

filters.alertCveTitlestring

CVE title

filters.alertCveTitle.notInstring

CVE title

filters.alertCweIdstring

CWE ID

filters.alertCweId.notInstring

CWE ID

filters.alertCweNamestring

CWE name

filters.alertCweName.notInstring

CWE name

filters.alertEPSSstring

Alert EPSS ("low", "medium", "high", "critical")

filters.alertEPSS.notInstring

Alert EPSS ("low", "medium", "high", "critical")

filters.alertFixTypestring

Comma-separated list of alert fix types ("upgrade", "cve", or "remove") that should be included

filters.alertFixType.notInstring

Comma-separated list of alert fix types ("upgrade", "cve", or "remove") that should be excluded

filters.alertKEVboolean

Alert KEV (Known Exploited Vulnerability) filter flag

filters.alertKEV.notInboolean

Alert KEV (Known Exploited Vulnerability) filter flag

filters.alertPolicyRulestring

Comma-separated list of alert policy rules, each as "<policy id>:<rule id>", that should be included. Baseline rules use the alert type as the rule id.

filters.alertPolicyRule.notInstring

Comma-separated list of alert policy rules, each as "<policy id>:<rule id>", that should be excluded. Baseline rules use the alert type as the rule id.

filters.alertPrioritystring

Alert priority ("low", "medium", "high", or "critical")

filters.alertPriority.notInstring

Alert priority ("low", "medium", "high", or "critical")

filters.alertReachabilityAnalysisTypestring

Comma-separated list of alert CVE reachability analysis types ("full-scan" or "precomputed") that should be included

filters.alertReachabilityAnalysisType.notInstring

Comma-separated list of alert CVE reachability analysis types ("full-scan" or "precomputed") that should be excluded

filters.alertReachabilityTypestring

Comma-separated list of alert CVE reachability types ("direct_dependency", "error", "maybe_reachable", "missing_support", "pending", "reachable", "undeterminable_reachability", "unknown", or "unreachable") that should be included

filters.alertReachabilityType.notInstring

Comma-separated list of alert CVE reachability types ("direct_dependency", "error", "maybe_reachable", "missing_support", "pending", "reachable", "undeterminable_reachability", "unknown", or "unreachable") that should be excluded

filters.alertSeveritystring

Comma-separated list of alert severities ("low", "medium", "high", or "critical") that should be included

filters.alertSeverity.notInstring

Comma-separated list of alert severities ("low", "medium", "high", or "critical") that should be excluded

filters.alertStatusstring

A single alert status ("open" or "cleared")

filters.alertStatus.notInstring

A single alert status ("open" or "cleared")

filters.alertTypestring

Comma-separated list of alert types (e.g. "usesEval", "unmaintained", etc.) that should be included

filters.alertType.notInstring

Comma-separated list of alert types (e.g. "usesEval", "unmaintained", etc.) that should be excluded

filters.alertUpdatedAt.eqstring

Alert updated at (YYYY-MM-DD HH:MM:SS in UTC time zone)

filters.alertUpdatedAt.ltstring

Alert updated at (YYYY-MM-DD HH:MM:SS in UTC time zone)

filters.alertUpdatedAt.ltestring

Alert updated at (YYYY-MM-DD HH:MM:SS in UTC time zone)

filters.alertUpdatedAt.gtstring

Alert updated at (YYYY-MM-DD HH:MM:SS in UTC time zone)

filters.alertUpdatedAt.gtestring

Alert updated at (YYYY-MM-DD HH:MM:SS in UTC time zone)

filters.artifactNamestring

Name of artifact

filters.artifactName.notInstring

Name of artifact

filters.artifactTypestring

Comma-separated list of artifact types (e.g. "npm", "pypi", "gem", "maven", "golang", etc.) that should be included

filters.artifactType.notInstring

Comma-separated list of artifact types (e.g. "npm", "pypi", "gem", "maven", "golang", etc.) that should be excluded

filters.branchstring

Comma-separated list of branch names that should be included

filters.branch.notInstring

Comma-separated list of branch names that should be excluded

filters.cvePatchStatusstring

Comma-separated list of patch statuses ("patch_unavailable", "patch_available", or "patch_applied") that should be included

filters.cvePatchStatus.notInstring

Comma-separated list of patch statuses ("patch_unavailable", "patch_available", or "patch_applied") that should be excluded

filters.dependencyDeadboolean

Dead/reachable dependency filter flag

filters.dependencyDead.notInboolean

Dead/reachable dependency filter flag

filters.dependencyDevboolean

Development/production dependency filter flag

filters.dependencyDev.notInboolean

Development/production dependency filter flag

filters.dependencyDirectboolean

Direct/transitive dependency filter flag

filters.dependencyDirect.notInboolean

Direct/transitive dependency filter flag

filters.repoFullNamestring

Comma-separated list of repo full names that should be included

filters.repoFullName.notInstring

Comma-separated list of repo full names that should be excluded

filters.repoLabelsstring

Comma-separated list of repo labels that should be included. Use "" to filter for repositories with no labels.

filters.repoLabels.notInstring

Comma-separated list of repo labels that should be excluded. Use "" to filter for repositories with no labels.

filters.repoSlugstring

Comma-separated list of repo slugs that should be included

filters.repoSlug.notInstring

Comma-separated list of repo slugs that should be excluded

Response

The paginated array of alert items for the organization and related metadata.

endCursorstring nullable required

Changes

  • 5ad8bf36b1e7Revision changes
    • info

      added the new optional query request parameter filters.alertPolicyRule

    • info

      added the new optional query request parameter filters.alertPolicyRule.notIn

    • info

      added the new optional query request parameter narrowLocationsToActiveFilters

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the required property ///// to the response with the status