DevArmor

DevArmor Builds API

The builds API from DevArmor — 5 operation(s) for builds.

Documentation GitHub OpenAPI

Operations 8

POST /projects/{project_id}/rules/{rule_id}/generate Request a rule generation #

GET /projects/{project_id}/rules/{rule_id}/generate Get a generated rule #

POST /projects/{project_id}/design-reviews/{design_review_id}/build/{build_type} Request a design review build #

GET /projects/{project_id}/design-reviews/{design_review_id}/build/{build_type} Get a design review build #

GET /projects/{project_id}/design-reviews/{design_review_id}/builds List design review builds in a project #

POST /projects/{project_id}/threat-models/{threat_model_id}/versions/{version}/builds/{build_type} Request a threat model build in a project #

GET /projects/{project_id}/threat-models/{threat_model_id}/versions/{version}/builds/{build_type} Get a threat model build from a project #

GET /projects/{project_id}/threat-models/{threat_model_id}/versions/{version}/builds List threat model builds in a project #

Specifications

⚙

OpenAPI

https://artifacts.apis.io/devarmor/openapi/devarmor-builds-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-builds-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: DevArmor Security Reviews Builds API
  version: 1.14.0
tags:
- name: Builds
paths:
  /projects/{project_id}/rules/{rule_id}/generate:
    post:
      tags:
      - Builds
      summary: Request a rule generation
      operationId: create_project_rule_generate
      security:
      - APIGatewayAuth: []
      parameters:
      - name: project_id
        in: path
        required: true
        schema:
          type: string
          title: Project Id
      - name: rule_id
        in: path
        required: true
        schema:
          type: string
          title: Rule Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RuleGenerate'
      responses:
        '202':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Build'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    get:
      tags:
      - Builds
      summary: Get a generated rule
      operationId: get_project_generated_rule
      security:
      - APIGatewayAuth: []
      parameters:
      - name: rule_id
        in: path
        required: true
        schema:
          type: string
          title: Rule 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/Build'
                title: Response Get Project Generated Rule
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /projects/{project_id}/design-reviews/{design_review_id}/build/{build_type}:
    post:
      tags:
      - Builds
      summary: Request a design review build
      operationId: create_project_design_review_build
      security:
      - APIGatewayAuth: []
      parameters:
      - name: build_type
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/BuildType'
      - name: project_id
        in: path
        required: true
        schema:
          type: string
          title: Project Id
      - name: design_review_id
        in: path
        required: true
        schema:
          type: string
          title: Design Review Id
      - name: force
        in: query
        required: false
        schema:
          type: boolean
          default: false
          title: Force
      - name: policy_id
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
          - type: 'null'
          title: Policy Id
      - name: platform
        in: query
        required: false
        schema:
          anyOf:
          - $ref: '#/components/schemas/AICodePlatform'
          - type: 'null'
          title: Platform
      responses:
        '202':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Build'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    get:
      tags:
      - Builds
      summary: Get a design review build
      operationId: get_project_design_review_build
      security:
      - APIGatewayAuth: []
      parameters:
      - name: build_type
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/BuildType'
      - 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
      - name: force
        in: query
        required: false
        schema:
          type: boolean
          default: false
          title: Force
      - name: policy_id
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
          - type: 'null'
          title: Policy Id
      - name: platform
        in: query
        required: false
        schema:
          anyOf:
          - $ref: '#/components/schemas/AICodePlatform'
          - type: 'null'
          title: Platform
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Build'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /projects/{project_id}/design-reviews/{design_review_id}/builds:
    get:
      tags:
      - Builds
      summary: List design review builds in a project
      operationId: list_project_design_review_builds
      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/Build'
                title: Response List Project Design Review Builds
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /projects/{project_id}/threat-models/{threat_model_id}/versions/{version}/builds/{build_type}:
    post:
      tags:
      - Builds
      summary: Request a threat model build in a project
      operationId: create_project_threat_model_version_build
      security:
      - APIGatewayAuth: []
      parameters:
      - name: build_type
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/BuildType'
      - name: project_id
        in: path
        required: true
        schema:
          type: string
          title: Project 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: force
        in: query
        required: false
        schema:
          type: boolean
          default: false
          title: Force
      - name: policy_id
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
          - type: 'null'
          title: Policy Id
      - name: platform
        in: query
        required: false
        schema:
          anyOf:
          - $ref: '#/components/schemas/AICodePlatform'
          - type: 'null'
          title: Platform
      responses:
        '202':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    get:
      tags:
      - Builds
      summary: Get a threat model build from a project
      operationId: get_project_threat_model_version_build
      security:
      - APIGatewayAuth: []
      parameters:
      - name: build_type
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/BuildType'
      - name: project_id
        in: path
        required: true
        schema:
          type: string
          title: Project 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: force
        in: query
        required: false
        schema:
          type: boolean
          default: false
          title: Force
      - name: policy_id
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
          - type: 'null'
          title: Policy Id
      - name: platform
        in: query
        required: false
        schema:
          anyOf:
          - $ref: '#/components/schemas/AICodePlatform'
          - type: 'null'
          title: Platform
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Build'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /projects/{project_id}/threat-models/{threat_model_id}/versions/{version}/builds:
    get:
      tags:
      - Builds
      summary: List threat model builds in a project
      operationId: list_project_threat_model_version_builds
      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/Build'
                title: Response List Project Threat Model Version Builds
        '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
    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
    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
    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
    BuildFamily:
      type: string
      enum:
      - test
      - threat_model
      - design_review
      - diagram
      - code_review
      - report
      - rule
      - data_flow_diagram
      title: BuildFamily
    AICodePlatform:
      type: string
      enum:
      - augment
      - cursor
      - github
      title: AICodePlatform
    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
    RuleGenerate:
      properties:
        control_ids:
          anyOf:
          - items:
              type: integer
            type: array
          - type: 'null'
          title: Control Ids
        requirement_ids:
          anyOf:
          - items:
              type: integer
            type: array
          - type: 'null'
          title: Requirement Ids
      type: object
      title: RuleGenerate
    UserState:
      type: string
      enum:
      - active
      - inactive
      - pending_org_approval
      title: UserState
  securitySchemes:
    APIGatewayAuth:
      type: http
      scheme: bearer