Documentation & API Reference

Quick Start

Four Steps to Secure CI

01

Get your API key

Sign up and grab a project API key from your dashboard. Every key is scoped to a single project.

02

Add the GitHub Action

Drop the workflow below into .github/workflows/secopspipe.yml and store your key as a repo secret.

.github/workflows/secopspipe.yml

name: SecOpsPipe Scan
on: [push, pull_request]

jobs:
  scan:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Run SecOpsPipe Scan
        uses: secopspipe/scan-action@v1
        with:
          api-key: ${{ secrets.SECOPSPIPE_API_KEY }}
          fail-on: high

03

Open a pull request

SecOpsPipe scans the diff at the edge and posts findings back as a check on your PR — usually in under a second.

04

Or call the API directly

Prefer to trigger scans yourself? Hit the scan endpoint from any pipeline, script, or terminal.

Trigger a scan

# Trigger a scan for a repo + ref
curl -X POST https://api.secopspipe.dev/v1/scan \
  -H "Authorization: Bearer $SECOPSPIPE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"repo": "your-org/your-repo", "ref": "main"}'

Response

{
  "scan_id": "scn_8f3a1c2d",
  "status": "queued",
  "repo": "your-org/your-repo",
  "ref": "main"
}

Reference

API Overview

POST /v1/scan Trigger a new scan for a repo and ref

GET /v1/scan/{id} Fetch scan status and summary

GET /v1/scan/{id}/results Fetch full findings — dependencies, secrets, and SAST

GET /v1/projects List every project connected to your account

DELETE /v1/scan/{id} Cancel a running scan

SDKs

Use Your Language

Node.js

Official SDK for Node and TypeScript projects.

npm install @secopspipe/sdk

Python

Drop-in client for scripts, CI tools, and notebooks.

pip install secopspipe

Go

Lightweight client for Go services and CLIs.

go get github.com/secopspipe/secopspipe-go

GitHub Action

Zero-install scanning straight from your workflow.

uses: secopspipe/scan-action@v1

Get Scanning in Minutes