DevArmor

DevArmor Reports API

The reports API from DevArmor — 8 operation(s) for reports.

GitHub OpenAPI

Operations 8

GET /projects/{project_id}/reports List reports in a project #
GET /projects/{project_id}/reports/{report_id}/pdf Get a PDF report from a project #
GET /projects/{project_id}/reports/{report_id} Get a report from a project #
POST /projects/{project_id}/reports/{report_id}/export Export a project report to a 3rd party platform (e.g., Google Docs) #
GET /projects/{project_id}/design-reviews/{design_review_id}/reports List design review reports #
GET /projects/{project_id}/design-reviews/{design_review_id}/reports/{report_id} Get a design review report #
GET /projects/{project_id}/threat-models/{threat_model_id}/versions/{version}/reports List threat model reports in a project #
GET /projects/{project_id}/threat-models/{threat_model_id}/versions/{version}/reports/{report_id} Get a threat model report from a project #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/devarmor/openapi/devarmor-reports-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/devarmor/json-schema/devarmor-task-schema.json
📊
JSONSchema
https://artifacts.apis.io/devarmor/json-schema/devarmor-policy-schema.json
📊
JSONSchema
https://artifacts.apis.io/devarmor/json-schema/devarmor-control-schema.json
📊
JSONSchema
https://artifacts.apis.io/devarmor/json-schema/devarmor-threat-schema.json
📊
JSONSchema
https://artifacts.apis.io/devarmor/json-schema/devarmor-trust-boundary-schema.json
📊
JSONSchema
https://artifacts.apis.io/devarmor/json-schema/devarmor-rule-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • 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/devarmor:devarmor-reports-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

devarmor-reports-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: DevArmor Security Reviews Reports API
  version: 1.14.0
tags:
- name: Reports
paths:
  /projects/{project_id}/reports:
    get:
      tags:
      - Reports
      summary: List reports in a project
      operationId: list_project_reports
      security:
      - APIGatewayAuth: []
      parameters:
      - name: project_id
        in: path
        required: true
        schema:
          type: string
          title: Project Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Report'
                title: Response List Project Reports
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /projects/{project_id}/reports/{report_id}/pdf:
    get:
      tags:
      - Reports
      summary: Get a PDF report from a project
      operationId: get_project_pdf_report
      security:
      - APIGatewayAuth: []
      parameters:
      - name: report_id
        in: path
        required: true
        schema:
          type: string
          title: Report Id
      - name: project_id
        in: path
        required: true
        schema:
          type: string
          title: Project Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                anyOf:
                - $ref: '#/components/schemas/Blob'
                - $ref: '#/components/schemas/Build'
                title: Response Get Project Pdf Report
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /projects/{project_id}/reports/{report_id}:
    get:
      tags:
      - Reports
      summary: Get a report from a project
      operationId: get_project_report
      security:
      - APIGatewayAuth: []
      parameters:
      - name: report_id
        in: path
        required: true
        schema:
          type: string
          title: Report Id
      - name: project_id
        in: path
        required: true
        schema:
          type: string
          title: Project Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Report'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /projects/{project_id}/reports/{report_id}/export:
    post:
      tags:
      - Reports
      summary: Export a project report to a 3rd party platform (e.g., Google Docs)
      operationId: export_project_report
      security:
      - APIGatewayAuth: []
      parameters:
      - name: report_id
        in: path
        required: true
        schema:
          type: string
          title: Report Id
      - name: project_id
        in: path
        required: true
        schema:
          type: string
          title: Project Id
      - name: Google-Access-Token
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Google-Access-Token
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExportReportPayload'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleDocsReport'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /projects/{project_id}/design-reviews/{design_review_id}/reports:
    get:
      tags:
      - Reports
      summary: List design review reports
      operationId: list_project_design_review_reports
      security:
      - APIGatewayAuth: []
      parameters:
      - name: design_review_id
        in: path
        required: true
        schema:
          type: string
          title: Design Review Id
      - name: project_id
        in: path
        required: true
        schema:
          type: string
          title: Project Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Report'
                title: Response List Project Design Review Reports
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /projects/{project_id}/design-reviews/{design_review_id}/reports/{report_id}:
    get:
      tags:
      - Reports
      summary: Get a design review report
      operationId: get_project_design_review_report
      security:
      - APIGatewayAuth: []
      parameters:
      - name: report_id
        in: path
        required: true
        schema:
          type: string
          title: Report Id
      - name: design_review_id
        in: path
        required: true
        schema:
          type: string
          title: Design Review Id
      - name: project_id
        in: path
        required: true
        schema:
          type: string
          title: Project Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Report'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /projects/{project_id}/threat-models/{threat_model_id}/versions/{version}/reports:
    get:
      tags:
      - Reports
      summary: List threat model reports in a project
      operationId: list_project_threat_model_reports
      security:
      - APIGatewayAuth: []
      parameters:
      - name: version
        in: path
        required: true
        schema:
          type: string
          title: Version
      - name: threat_model_id
        in: path
        required: true
        schema:
          type: string
          title: Threat Model Id
      - name: project_id
        in: path
        required: true
        schema:
          type: string
          title: Project Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Report'
                title: Response List Project Threat Model Reports
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /projects/{project_id}/threat-models/{threat_model_id}/versions/{version}/reports/{report_id}:
    get:
      tags:
      - Reports
      summary: Get a threat model report from a project
      operationId: get_project_threat_model_report
      security:
      - APIGatewayAuth: []
      parameters:
      - name: report_id
        in: path
        required: true
        schema:
          type: string
          title: Report Id
      - name: version
        in: path
        required: true
        schema:
          type: string
          title: Version
      - name: threat_model_id
        in: path
        required: true
        schema:
          type: string
          title: Threat Model Id
      - name: project_id
        in: path
        required: true
        schema:
          type: string
          title: Project Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Report'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    UserRole:
      type: string
      enum:
      - admin
      - customer_support
      title: UserRole
    ExportReportPayload:
      properties:
        folder_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Folder Id
      type: object
      title: ExportReportPayload
    Project:
      properties:
        symbolic_name:
          type: string
          pattern: ^[0-9a-z-]+$
          title: Symbolic Name
        title:
          type: string
          title: Title
        default:
          type: boolean
          title: Default
          default: false
        description:
          anyOf:
          - type: string
          - type: 'null'
          title: Description
        use_memory:
          type: boolean
          title: Use Memory
          default: true
        created_at:
          type: string
          format: date-time
          title: Created At
        updated_at:
          type: string
          format: date-time
          title: Updated At
        id:
          type: integer
          title: Id
        owner_user:
          $ref: '#/components/schemas/User'
        memory_effective:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Memory Effective
        memory_effective_reason:
          anyOf:
          - type: string
          - type: 'null'
          title: Memory Effective Reason
      type: object
      required:
      - symbolic_name
      - title
      - id
      - owner_user
      title: Project
    Blob:
      properties:
        name:
          type: string
          title: Name
        is_uploaded:
          type: boolean
          title: Is Uploaded
        file_id:
          type: string
          format: uuid
          title: File Id
        mime_type:
          type: string
          title: Mime Type
        created_at:
          type: string
          format: date-time
          title: Created At
        updated_at:
          type: string
          format: date-time
          title: Updated At
        id:
          type: integer
          title: Id
        url:
          anyOf:
          - type: string
          - type: 'null'
          title: Url
      type: object
      required:
      - name
      - is_uploaded
      - file_id
      - mime_type
      - id
      title: Blob
    Build:
      properties:
        family:
          $ref: '#/components/schemas/BuildFamily'
        type:
          $ref: '#/components/schemas/BuildType'
        parameters:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Parameters
        state:
          $ref: '#/components/schemas/JobState'
        eta:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Eta
        completed_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Completed At
        success:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Success
        result:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Result
        log:
          type: string
          title: Log
          default: ''
        created_at:
          type: string
          format: date-time
          title: Created At
        updated_at:
          type: string
          format: date-time
          title: Updated At
        id:
          type: integer
          title: Id
        project:
          $ref: '#/components/schemas/Project'
        parent_id:
          type: integer
          title: Parent Id
      type: object
      required:
      - family
      - type
      - state
      - id
      - project
      - parent_id
      title: Build
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    Report:
      properties:
        symbolic_name:
          type: string
          pattern: ^[0-9a-z-]+$
          title: Symbolic Name
        title:
          type: string
          title: Title
        created_at:
          type: string
          format: date-time
          title: Created At
        updated_at:
          type: string
          format: date-time
          title: Updated At
        id:
          type: integer
          title: Id
        text:
          type: string
          title: Text
        threat_model_versions:
          items:
            type: string
            pattern: ^\d+(\.\d+)*$
          type: array
          title: Threat Model Versions
        description:
          anyOf:
          - type: string
          - type: 'null'
          title: Description
        summary:
          anyOf:
          - type: string
          - type: 'null'
          title: Summary
        sections:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Sections
      type: object
      required:
      - symbolic_name
      - title
      - id
      - text
      - threat_model_versions
      - description
      - summary
      - sections
      title: Report
    User:
      properties:
        email:
          type: string
          title: Email
        name:
          type: string
          title: Name
        state:
          $ref: '#/components/schemas/UserState'
          default: active
        roles:
          items:
            $ref: '#/components/schemas/UserRole'
          type: array
          title: Roles
          default: []
        created_at:
          type: string
          format: date-time
          title: Created At
        updated_at:
          type: string
          format: date-time
          title: Updated At
        id:
          type: integer
          title: Id
      type: object
      required:
      - email
      - name
      - id
      title: User
    GoogleDocsReport:
      properties:
        source_view_url:
          type: string
          title: Source View Url
      type: object
      required:
      - source_view_url
      title: GoogleDocsReport
    BuildFamily:
      type: string
      enum:
      - test
      - threat_model
      - design_review
      - diagram
      - code_review
      - report
      - rule
      - data_flow_diagram
      title: BuildFamily
    JobState:
      type: string
      enum:
      - queued
      - running
      - completed
      title: JobState
    BuildType:
      type: string
      enum:
      - main
      - architecture
      - architecture_from_code
      - architecture_from_diagrams
      - architecture_from_docs
      - assumptions
      - requirements
      - findings
      - action_items
      - rules
      - pull_request_review
      - threat_model_impact
      - diagram_from_image
      - pdf
      - version_diff
      - interpretation
      title: BuildType
    UserState:
      type: string
      enum:
      - active
      - inactive
      - pending_org_approval
      title: UserState
  securitySchemes:
    APIGatewayAuth:
      type: http
      scheme: bearer