User Guide
  • Fundamentals
    • Quick Start Guide
      • Signing Up
      • Package Discovery
        • Connecting to GitHub
        • Connecting to GitLab
        • Connecting to Azure DevOps
        • Connecting to the CI Pipeline
        • Connecting to the Artifact Server
      • Package Sealing
        • Integrating the CLI in the CI
        • Editing Dependencies
    • Deployments
      • Choosing Your Deployment
      • Automatic Remediation
      • Remote Configuration
      • Local Configuration
      • Artifact Server
    • CLI
      • Download and Installation
      • Scanning
      • Fixing All Dependencies
      • Fixing Specific Dependencies
      • Fixing OS Vulnerabilities
      • Integrating with the CI
      • Uploading Scan Results
      • Commands
      • SCA Integrations
      • JFrog Integration
      • Usage Examples
        • Sealing Application Dependencies
        • Sealing Linux Environments
    • Artifact Server
      • Generating a Token
      • Artifact Server Ordering
      • Configuring the Package Manager
        • Configuring apk
        • Configuring Composer
        • Configuring Go
        • Configuring Gradle
        • Configuring Maven
        • Configuring npm
        • Configuring pip
        • Configuring Poetry
        • Configuring yarn
        • Configuring yum
      • Clearing the Cache
      • Editing Your Dependencies
    • Web Interface
      • Rules Screen
  • APIs
    • List Vulnerable Packages
  • FAQ
  • Vulnerability Disclosure
Powered by GitBook
On this page

APIs

PreviousRules ScreenNextList Vulnerable Packages

Last updated 24 days ago

Welcome to the API Documentation

This API provides a simple and direct way to query the Seal platform for existing vulnerable and sealed packages.

Our goal is to make this process as straightforward as possible for developers.

How it Works

The API is a RESTful service that accepts and returns JSON data. It operates through a single, well-defined endpoint:

Endpoint: [https://external.sealsecurity.io/authenticated/api/v1/[endpoint-path]] (Replace with your actual base URL and endpoint path)

Authentication

To use the Seal API, you will need to authenticate your requests. You will need a to the Seal server - the same token used to download artifacts. Requests are authenticated using a Bearer Token in the Authorization header.

Making Your First Request

Here's a quick example of how to use our API:

Example Request (using cURL):

Bash

curl --location 'https://external.sealsecurity.io/authenticated/api/v1/packages/vulnerable?limit=2' \
--header 'Authorization: Bearer $TOKEN'

In the command above, replace $TOKEN with your access token to the Seal server.

token