> ## Documentation Index
> Fetch the complete documentation index at: https://docs.oasm.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Project runs

> Runs of the project, newest first, with steps and the vulnerabilities each found.



## OpenAPI

````yaml /api-reference/openapi.json get /api/projects/{id}/runs
openapi: 3.0.0
info:
  title: Open Attack Surface Management
  description: Open-source platform for cybersecurity Attack Surface Management (ASM)
  version: '1.0'
  contact: {}
servers:
  - url: https://{baseUrl}/api/v1
    variables:
      baseUrl:
        default: localhost:3000
        description: API server hostname with port (e.g. localhost:3000, api.example.com)
security: []
tags: []
externalDocs:
  description: Authentication Docs
  url: auth/docs
paths:
  /api/projects/{id}/runs:
    get:
      tags:
        - Projects
      summary: Project runs
      description: >-
        Runs of the project, newest first, with steps and the vulnerabilities
        each found.
      operationId: ProjectsController_getRuns
      parameters:
        - name: id
          required: true
          in: path
          schema:
            type: string
        - name: search
          required: false
          in: query
          schema:
            type: string
        - name: page
          required: false
          in: query
          schema:
            example: 1
            type: number
        - name: limit
          required: false
          in: query
          schema:
            example: 10
            type: number
        - name: sortBy
          required: false
          in: query
          schema:
            example: createdAt
            type: string
        - name: sortOrder
          required: false
          in: query
          schema:
            example: DESC
            type: string
        - name: projectWorkflowId
          required: false
          in: query
          schema:
            type: string
        - name: jobRunType
          required: false
          in: query
          schema:
            $ref: '#/components/schemas/JobRunType'
        - name: X-Workspace-Id
          in: header
          description: Workspace ID
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetManyProjectRunDtoDto'
                allOf:
                  - $ref: '#/components/schemas/AppResponseSerialization'
components:
  schemas:
    JobRunType:
      type: string
      enum:
        - manual
        - scheduled
        - event
    GetManyProjectRunDtoDto:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ProjectRunDto'
        total:
          type: number
        page:
          type: number
        limit:
          type: number
        hasNextPage:
          type: boolean
        pageCount:
          type: number
      required:
        - data
        - total
        - page
        - limit
        - hasNextPage
        - pageCount
    AppResponseSerialization:
      type: object
      properties: {}
    ProjectRunDto:
      type: object
      properties:
        id:
          type: string
        createdAt:
          format: date-time
          type: string
        updatedAt:
          format: date-time
          type: string
        isCompleted:
          type: boolean
        status:
          allOf:
            - $ref: '#/components/schemas/JobStatus'
        jobRunType:
          allOf:
            - $ref: '#/components/schemas/JobRunType'
        projectWorkflowId:
          type: string
          nullable: true
        workflowName:
          type: string
        triggerType:
          nullable: true
          allOf:
            - $ref: '#/components/schemas/ProjectTriggerType'
        scopeSize:
          type: number
          description: Assets in the run scope
        stepsTotal:
          type: number
        stepsDone:
          type: number
          description: Steps that finished (done, or nothing to scan)
        stepsFailed:
          type: number
        newVulnerabilities:
          type: number
          description: Vulnerabilities this run found first
        recurringVulnerabilities:
          type: number
          description: Vulnerabilities this run reported again
      required:
        - id
        - createdAt
        - updatedAt
        - isCompleted
        - status
        - jobRunType
        - workflowName
        - scopeSize
        - stepsTotal
        - stepsDone
        - stepsFailed
        - newVulnerabilities
        - recurringVulnerabilities
    JobStatus:
      type: string
      enum:
        - pending
        - in_progress
        - completed
        - failed
        - cancelled
        - skipped
    ProjectTriggerType:
      type: string
      enum:
        - cron
        - assets_added

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.