DevArmor

DevArmor Documents API

The documents API from DevArmor — 4 operation(s) for documents.

GitHub OpenAPI

Operations 10

GET /projects/{project_id}/docs List documents in a project #
POST /projects/{project_id}/docs Create a new document in a project #
GET /projects/{project_id}/docs/{document_id} Get a document from a project #
PUT /projects/{project_id}/docs/{document_id} Update a document in a project #
DELETE /projects/{project_id}/docs/{document_id} Delete a document from a project #
GET /projects/{project_id}/design-reviews/{design_review_id}/docs List design review documents #
POST /projects/{project_id}/design-reviews/{design_review_id}/docs Create a design review document #
GET /projects/{project_id}/design-reviews/{design_review_id}/docs/{document_id} Get a design review document #
PUT /projects/{project_id}/design-reviews/{design_review_id}/docs/{document_id} Update a design review document #
DELETE /projects/{project_id}/design-reviews/{design_review_id}/docs/{document_id} Delete a design review document #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/devarmor/openapi/devarmor-documents-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-documents-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-documents-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: DevArmor Security Reviews Documents API
  version: 1.14.0
tags:
- name: Documents
paths:
  /projects/{project_id}/docs:
    get:
      tags:
      - Documents
      summary: List documents in a project
      operationId: list_project_docs
      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/Document'
                title: Response List Project Docs
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    post:
      tags:
      - Documents
      summary: Create a new document in a project
      operationId: create_project_doc
      security:
      - APIGatewayAuth: []
      parameters:
      - 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/DocumentCreate'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Document'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /projects/{project_id}/docs/{document_id}:
    get:
      tags:
      - Documents
      summary: Get a document from a project
      operationId: get_project_doc
      security:
      - APIGatewayAuth: []
      parameters:
      - name: document_id
        in: path
        required: true
        schema:
          type: string
          title: Document 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/Document'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    put:
      tags:
      - Documents
      summary: Update a document in a project
      operationId: update_project_doc
      security:
      - APIGatewayAuth: []
      parameters:
      - name: document_id
        in: path
        required: true
        schema:
          type: string
          title: Document Id
      - name: project_id
        in: path
        required: true
        schema:
          type: string
          title: Project Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DocumentUpdate'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Document'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - Documents
      summary: Delete a document from a project
      operationId: delete_project_doc
      security:
      - APIGatewayAuth: []
      parameters:
      - name: document_id
        in: path
        required: true
        schema:
          type: string
          title: Document 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
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentDelete'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /projects/{project_id}/design-reviews/{design_review_id}/docs:
    get:
      tags:
      - Documents
      summary: List design review documents
      description: Deprecated in favor of `GET /projects/{project_id}/docs`, which lists project documents including those attached to design reviews.
      operationId: list_project_design_review_docs
      deprecated: true
      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/Document'
                title: Response List Project Design Review Docs
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-deprecation: '@1793274312'
    post:
      tags:
      - Documents
      summary: Create a design review document
      description: Deprecated in favor of `POST /projects/{project_id}/docs` with `design_review_id` in the body.
      operationId: create_project_design_review_doc
      deprecated: true
      security:
      - APIGatewayAuth: []
      parameters:
      - 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: 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/DocumentCreate'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Document'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-deprecation: '@1793274312'
  /projects/{project_id}/design-reviews/{design_review_id}/docs/{document_id}:
    get:
      tags:
      - Documents
      summary: Get a design review document
      description: Deprecated in favor of `GET /projects/{project_id}/docs/{document_id}`.
      operationId: get_project_design_review_doc
      deprecated: true
      security:
      - APIGatewayAuth: []
      parameters:
      - name: document_id
        in: path
        required: true
        schema:
          type: string
          title: Document 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/Document'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-deprecation: '@1793274312'
    put:
      tags:
      - Documents
      summary: Update a design review document
      description: Deprecated in favor of `PUT /projects/{project_id}/docs/{document_id}`.
      operationId: update_project_design_review_doc
      deprecated: true
      security:
      - APIGatewayAuth: []
      parameters:
      - name: document_id
        in: path
        required: true
        schema:
          type: string
          title: Document 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
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DocumentUpdate'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Document'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-deprecation: '@1793274312'
    delete:
      tags:
      - Documents
      summary: Delete a design review document
      description: Deprecated in favor of `DELETE /projects/{project_id}/docs/{document_id}`.
      operationId: delete_project_design_review_doc
      deprecated: true
      security:
      - APIGatewayAuth: []
      parameters:
      - name: document_id
        in: path
        required: true
        schema:
          type: string
          title: Document 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
      - name: force
        in: query
        required: false
        schema:
          type: boolean
          default: false
          title: Force
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentDelete'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-deprecation: '@1793274312'
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
    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
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    DocumentPlatform:
      type: string
      enum:
      - atlassian
      - atlassian_jira
      - atlassian_confluence
      - google
      - github_wiki
      title: DocumentPlatform
    DocumentCreate:
      properties:
        symbolic_name:
          type: 'null'
          title: Symbolic Name
        title:
          type: string
          title: Title
        text:
          anyOf:
          - type: string
          - type: 'null'
          title: Text
        topics:
          items:
            type: string
            pattern: ^[0-9a-z-]+$
          type: array
          title: Topics
        source_platform:
          anyOf:
          - $ref: '#/components/schemas/DocumentPlatform'
          - type: 'null'
        source_view_url:
          anyOf:
          - type: string
          - type: 'null'
          title: Source View Url
        source_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Source Id
        mime_type:
          anyOf:
          - type: string
          - type: 'null'
          title: Mime Type
        blob_id:
          anyOf:
          - type: integer
          - type: 'null'
          title: Blob Id
        threat_model_version:
          anyOf:
          - type: string
            pattern: ^\d+(\.\d+)*$
          - type: 'null'
          title: Threat Model Version
        threat_model_id:
          anyOf:
          - type: integer
          - type: 'null'
          title: Threat Model Id
        design_review_id:
          anyOf:
          - type: integer
          - type: 'null'
          title: Design Review Id
      type: object
      required:
      - title
      title: DocumentCreate
    DesignReview:
      properties:
        symbolic_name:
          type: string
          pattern: ^[0-9a-z-]+$
          title: Symbolic Name
        title:
          type: string
          title: Title
        description:
          anyOf:
          - type: string
          - type: 'null'
          title: Description
        use_memory:
          type: boolean
          title: Use Memory
          default: true
        parent_ext_task_key:
          anyOf:
          - type: string
          - type: 'null'
          title: Parent Ext Task Key
        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
        scope_id:
          anyOf:
          - type: integer
          - type: 'null'
          title: Scope Id
        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
      title: DesignReview
    DocumentDelete:
      properties:
        symbolic_name:
          type: string
          pattern: ^[0-9a-z-]+$
          title: Symbolic Name
        title:
          type: string
          title: Title
        text:
          type: string
          title: Text
        topics:
          items:
            type: string
            pattern: ^[0-9a-z-]+$
          type: array
          title: Topics
        source_platform:
          anyOf:
          - $ref: '#/components/schemas/DocumentPlatform'
          - type: 'null'
        source_view_url:
          anyOf:
          - type: string
          - type: 'null'
          title: Source View Url
        source_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Source Id
        mime_type:
          anyOf:
          - type: string
          - type: 'null'
          title: Mime Type
      type: object
      required:
      - symbolic_name
      - title
      - text
      title: DocumentDelete
    DocumentUpdate:
      properties:
        symbolic_name:
          type: 'null'
          title: Symbolic Name
        title:
          anyOf:
          - type: string
          - type: 'null'
          title: Title
        text:
          anyOf:
          - type: string
          - type: 'null'
          title: Text
        topics:
          items:
            type: string
            pattern: ^[0-9a-z-]+$
          type: array
          title: Topics
        source_platform:
          anyOf:
          - $ref: '#/components/schemas/DocumentPlatform'
          - type: 'null'
        source_view_url:
          anyOf:
          - type: string
          - type: 'null'
          title: Source View Url
        source_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Source Id
        mime_type:
          type: 'null'
          title: Mime Type
      type: object
      title: DocumentUpdate
    Document:
      properties:
        symbolic_name:
          type: string
          pattern: ^[0-9a-z-]+$
          title: Symbolic Name
        title:
          type: string
          title: Title
        text:
          type: string
          title: Text
        topics:
          items:
            type: string
            pattern: ^[0-9a-z-]+$
          type: array
          title: Topics
        source_platform:
          anyOf:
          - $ref: '#/components/schemas/DocumentPlatform'
          - type: 'null'
        source_view_url:
          anyOf:
          - type: string
          - type: 'null'
          title: Source View Url
        source_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Source Id
        mime_type:
          anyOf:
          - type: string
          - type: 'null'
          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
        blob:
          anyOf:
          - $ref: '#/components/schemas/Blob'
          - type: 'null'
        threat_model_versions:
          items:
            type: string
            pattern: ^\d+(\.\d+)*$
          type: array
          title: Threat Model Versions
        threat_model_id:
          anyOf:
          - type: integer
          - type: 'null'
          title: Threat Model Id
        design_reviews:
          items:
            $ref: '#/components/schemas/DesignReview'
          type: array
          title: Design Reviews
      type: object
      required:
      - symbolic_name
      - title
      - text
      - id
      - threat_model_versions
      - design_reviews
      title: Document
  securitySchemes:
    APIGatewayAuth:
      type: http
      scheme: bearer