find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/hacktron:hacktron-rest-api-scans-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Hacktron REST API - Scans API
  version: '1.0'
  contact: {}
  description: 'Operations tagged REST API - Scans across 2 of this provider''s published API definitions: hacktron-openapi.json, openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.hacktron.ai/v1
security:
- api-key: []
tags:
- name: REST API - Scans
paths:
  /scans:
    post:
      operationId: RestScanController_create
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RestCreateScanDto'
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestCreateScanResponseDto'
        '402':
          description: Insufficient credits
      summary: Trigger a pentest scan
      tags:
      - REST API - Scans
    get:
      operationId: RestScanController_list
      parameters:
      - name: page
        required: false
        in: query
        description: The page number to retrieve.
        schema:
          default: 1
          type: number
      - name: limit
        required: false
        in: query
        description: The number of items to retrieve per page.
        schema:
          default: 100
          type: number
      - name: scan_type
        required: false
        in: query
        schema:
          type: string
          enum:
          - pr
          - full
      - name: status
        required: false
        in: query
        schema:
          type: string
          enum:
          - pending
          - running
          - completed
          - failed
          - stopped
          - cancelled
          - skipped
          - pending_verification
          - pending_triage
          - draft
          - estimating
          - estimated
      - name: sort_by
        required: false
        in: query
        schema:
          type: string
          enum:
          - created_at
          - updated_at
          - status
      - name: sort_order
        required: false
        in: query
        schema:
          default: DESC
          type: string
          enum:
          - ASC
          - DESC
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestScanListResponseDto'
      summary: List scans with pagination and filters
      tags:
      - REST API - Scans
    servers:
    - url: https://api.hacktron.ai/v1
  /scans/{id}/status:
    get:
      operationId: RestScanController_getStatus
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestScanStatusResponseDto'
      summary: Get scan status
      tags:
      - REST API - Scans
    servers:
    - url: https://api.hacktron.ai/v1
  /scans/{id}/findings/export:
    get:
      operationId: RestScanController_exportFindings
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      - name: format
        required: true
        in: query
        description: Export format
        schema:
          type: string
          enum:
          - json
          - csv
          - sarif
      responses:
        '200':
          description: ''
      summary: Export findings for a scan
      tags:
      - REST API - Scans
    servers:
    - url: https://api.hacktron.ai/v1
  /scans/{id}/findings:
    get:
      operationId: RestScanController_listScanFindings
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      - name: page
        required: false
        in: query
        description: The page number to retrieve.
        schema:
          default: 1
          type: number
      - name: limit
        required: false
        in: query
        description: The number of items to retrieve per page.
        schema:
          default: 100
          type: number
      - name: severity
        required: false
        in: query
        schema:
          type: string
          enum:
          - critical
          - high
          - medium
          - low
          - info
      - name: state
        required: false
        in: query
        schema:
          type: string
          enum:
          - open
          - true_positive
          - false_positive
          - accepted_risk
          - resolved
          - closed
      - name: scan_id
        required: false
        in: query
        schema:
          type: string
      - name: scan_type
        required: false
        in: query
        description: Filter by scan type across all scans associated with the finding.
        schema:
          type: string
          enum:
          - pr
          - full
      - name: repo_url
        required: false
        in: query
        description: Filter by repository URL. Case-insensitive; a trailing slash or .git suffix is ignored.
        schema:
          type: string
      - name: found_since
        required: false
        in: query
        description: Only include findings discovered on/after this ISO 8601 timestamp.
        schema:
          type: string
      - name: found_until
        required: false
        in: query
        description: Only include findings discovered before this ISO 8601 timestamp.
        schema:
          type: string
      - name: sort_by
        required: false
        in: query
        schema:
          type: string
          enum:
          - found_at
          - updated_at
          - severity
      - name: sort_order
        required: false
        in: query
        schema:
          default: DESC
          type: string
          enum:
          - ASC
          - DESC
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestFindingListResponseDto'
      summary: List findings for a specific scan
      tags:
      - REST API - Scans
    servers:
    - url: https://api.hacktron.ai/v1
  /scans/{id}:
    get:
      operationId: RestScanController_getById
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestScanResponseDto'
      summary: Get scan by UUID
      tags:
      - REST API - Scans
    servers:
    - url: https://api.hacktron.ai/v1
components:
  schemas:
    RestFindingListResponseDto:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/RestFindingResponseDto'
        total:
          type: number
        page:
          type: number
        limit:
          type: number
      required:
      - data
      - total
      - page
      - limit
    RestScanStatusResponseDto:
      type: object
      properties:
        id:
          type: string
        task_id:
          type: string
        status:
          type: string
          enum:
          - pending
          - running
          - completed
          - failed
          - stopped
          - cancelled
          - skipped
          - pending_verification
          - pending_triage
          - draft
          - estimating
          - estimated
        created_at:
          type: string
        updated_at:
          type: string
      required:
      - id
      - task_id
      - status
      - created_at
      - updated_at
    RestCreateScanResponseDto:
      type: object
      properties:
        id:
          type: string
        task_id:
          type: string
        status:
          type: string
        message:
          type: string
      required:
      - id
      - task_id
      - status
      - message
    RestScanFindingsSummaryDto:
      type: object
      properties:
        critical:
          type: number
        high:
          type: number
        medium:
          type: number
        low:
          type: number
        info:
          type: number
      required:
      - critical
      - high
      - medium
      - low
      - info
    RestCreateScanDto:
      type: object
      properties:
        cost_estimation_id:
          type: string
          description: Completed cost estimation UUID
        repos:
          description: Repositories to scan
          type: array
          items:
            $ref: '#/components/schemas/RestRepoDto'
        target_urls:
          description: Target URLs for pentest
          type: array
          items:
            type: string
        auth_instructions:
          type: string
          description: Target websites and browser login instructions, including URLs and credentials
          maxLength: 2000
        custom_context:
          type: string
          description: Custom context for the pentest
          maxLength: 2000
        context_document_ids:
          description: Context document UUIDs to include
          type: array
          items:
            type: string
      required:
      - cost_estimation_id
      - repos
    RestFindingResponseDto:
      type: object
      properties:
        id:
          type: string
          description: Finding UUID
        display_id:
          type: string
          description: Human-readable id (KEY-FD-NUMBER).
          example: HAC-FD-1104
        number:
          type: integer
          description: Per-organization sequence number behind display_id.
          example: 1104
        title:
          type: string
        category:
          type: string
        severity:
          type: string
          enum:
          - critical
          - high
          - medium
          - low
          - info
        state:
          type: string
          enum:
          - open
          - true_positive
          - false_positive
          - accepted_risk
          - resolved
          - closed
        description:
          type: string
        affected_file:
          type: string
        affected_code:
          type: string
        proof_of_concept:
          type:
          - string
          - 'null'
        tags:
          type: array
          items:
            type: string
        scan_id:
          type:
          - string
          - 'null'
        found_at:
          type: string
        updated_at:
          type: string
        resolved_at:
          type:
          - string
          - 'null'
          description: Timestamp of the most recent transition to resolved (ISO 8601). Null if never resolved.
      required:
      - id
      - display_id
      - number
      - title
      - category
      - severity
      - state
      - description
      - affected_file
      - affected_code
      - proof_of_concept
      - tags
      - scan_id
      - found_at
      - updated_at
      - resolved_at
    RestScanListResponseDto:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/RestScanResponseDto'
        total:
          type: number
        page:
          type: number
        limit:
          type: number
      required:
      - data
      - total
      - page
      - limit
    RestScanResponseDto:
      type: object
      properties:
        id:
          type: string
        task_id:
          type: string
        scan_type:
          type: string
          enum:
          - pr
          - full
        status:
          type: string
        name:
          type:
          - string
          - 'null'
        repo_url:
          type:
          - string
          - 'null'
        branch:
          type:
          - string
          - 'null'
        pr_number:
          type:
          - number
          - 'null'
        target_urls:
          type:
          - array
          - 'null'
          items:
            type: string
        findings_summary:
          $ref: '#/components/schemas/RestScanFindingsSummaryDto'
        created_at:
          type: string
        updated_at:
          type: string
      required:
      - id
      - task_id
      - scan_type
      - status
      - name
      - repo_url
      - branch
      - pr_number
      - target_urls
      - findings_summary
      - created_at
      - updated_at
    RestRepoDto:
      type: object
      properties:
        url:
          type: string
          description: Repository URL
        branch:
          type: string
          description: Branch name
        source:
          type: string
          description: Repository source
          enum:
          - connected
          - public
          - upload
          default: connected
      required:
      - url
      - branch
  securitySchemes:
    api-key:
      type: apiKey
      in: header
      name: X-Api-Key
x-refined-from:
- hacktron-openapi.json
- openapi.json