DevArmor

DevArmor Data Flows API

The data-flows API from DevArmor — 2 operation(s) for data-flows.

Documentation GitHub OpenAPI

Operations 5

GET /projects/{project_id}/threat-models/{threat_model_id}/versions/{version}/data-flows List data flow in a project #

POST /projects/{project_id}/threat-models/{threat_model_id}/versions/{version}/data-flows Create a data flow in a project #

GET /projects/{project_id}/threat-models/{threat_model_id}/versions/{version}/data-flows/{resource_id} Get a data flow from a project #

PUT /projects/{project_id}/threat-models/{threat_model_id}/versions/{version}/data-flows/{resource_id} Update a threat model data-flow in a project #

DELETE /projects/{project_id}/threat-models/{threat_model_id}/versions/{version}/data-flows/{resource_id} Delete a threat model data flow from a project #

Specifications

⚙

OpenAPI

https://artifacts.apis.io/devarmor/openapi/devarmor-data-flows-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-data-flows-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 Data Flows API
  version: 1.14.0
tags:
- name: data-flows
paths:
  /projects/{project_id}/threat-models/{threat_model_id}/versions/{version}/data-flows:
    get:
      tags:
      - data-flows
      summary: List data flow in a project
      operationId: list_project_threat_model_data_flow
      security:
      - APIGatewayAuth: []
      parameters:
      - 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
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DataFlow'
                title: Response List Project Threat Model Data Flow
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    post:
      tags:
      - data-flows
      summary: Create a data flow in a project
      operationId: create_project_threat_model_data_flow
      security:
      - APIGatewayAuth: []
      parameters:
      - 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
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataFlowCreate'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataFlow'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /projects/{project_id}/threat-models/{threat_model_id}/versions/{version}/data-flows/{resource_id}:
    get:
      tags:
      - data-flows
      summary: Get a data flow from a project
      operationId: get_project_threat_model_data_flow
      security:
      - APIGatewayAuth: []
      parameters:
      - name: resource_id
        in: path
        required: true
        schema:
          type: string
          title: Resource Id
      - 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
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataFlow'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    put:
      tags:
      - data-flows
      summary: Update a threat model data-flow in a project
      operationId: update_project_threat_model_data_flow
      security:
      - APIGatewayAuth: []
      parameters:
      - name: resource_id
        in: path
        required: true
        schema:
          type: string
          title: Resource Id
      - 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
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataFlowUpdate'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataFlow'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - data-flows
      summary: Delete a threat model data flow from a project
      operationId: delete_project_threat_model_data_flow
      security:
      - APIGatewayAuth: []
      parameters:
      - name: resource_id
        in: path
        required: true
        schema:
          type: string
          title: Resource Id
      - 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
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataFlowDelete'
        '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
    DataStore:
      properties:
        symbolic_name:
          type: string
          pattern: ^[0-9a-z-]+$
          title: Symbolic Name
        title:
          type: string
          title: Title
        description:
          type: string
          title: Description
        type:
          $ref: '#/components/schemas/DataStoreType'
        vendor:
          anyOf:
          - type: string
          - type: 'null'
          title: Vendor
        product:
          anyOf:
          - type: string
          - type: 'null'
          title: Product
        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'
        threat_model_versions:
          items:
            type: string
            pattern: ^\d+(\.\d+)*$
          type: array
          title: Threat Model Versions
        trust_zone:
          anyOf:
          - $ref: '#/components/schemas/TrustZone'
          - type: 'null'
      type: object
      required:
      - symbolic_name
      - title
      - description
      - type
      - vendor
      - product
      - id
      - project
      - threat_model_versions
      title: DataStore
    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
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    DataFlow:
      properties:
        symbolic_name:
          type: string
          pattern: ^[0-9a-z-]+$
          title: Symbolic Name
        title:
          type: string
          title: Title
        description:
          type: string
          title: Description
        has_sensitive_data:
          type: boolean
          title: Has Sensitive Data
        encrypted:
          type: boolean
          title: Encrypted
        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'
        threat_model_versions:
          items:
            type: string
            pattern: ^\d+(\.\d+)*$
          type: array
          title: Threat Model Versions
        source_type:
          $ref: '#/components/schemas/DataFlowNodeType'
        source:
          anyOf:
          - $ref: '#/components/schemas/Component'
          - $ref: '#/components/schemas/DataStore'
          - $ref: '#/components/schemas/Actor'
          title: Source
        destination_type:
          $ref: '#/components/schemas/DataFlowNodeType'
        destination:
          anyOf:
          - $ref: '#/components/schemas/Component'
          - $ref: '#/components/schemas/DataStore'
          - $ref: '#/components/schemas/Actor'
          title: Destination
      type: object
      required:
      - symbolic_name
      - title
      - description
      - has_sensitive_data
      - encrypted
      - id
      - project
      - threat_model_versions
      - source_type
      - source
      - destination_type
      - destination
      title: DataFlow
    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
    Component:
      properties:
        symbolic_name:
          type: string
          pattern: ^[0-9a-z-]+$
          title: Symbolic Name
        title:
          type: string
          title: Title
        description:
          type: string
          title: Description
        repo_link:
          anyOf:
          - type: string
            maxLength: 2083
            minLength: 1
            format: uri
          - type: 'null'
          title: Repo Link
        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'
        threat_model_versions:
          items:
            type: string
            pattern: ^\d+(\.\d+)*$
          type: array
          title: Threat Model Versions
        parent_component:
          anyOf:
          - $ref: '#/components/schemas/Component'
          - type: 'null'
        trust_zone:
          anyOf:
          - $ref: '#/components/schemas/TrustZone'
          - type: 'null'
      type: object
      required:
      - symbolic_name
      - title
      - description
      - repo_link
      - id
      - project
      - threat_model_versions
      - trust_zone
      title: Component
    DataStoreType:
      type: string
      enum:
      - sql
      - key_value
      - document
      - object
      - graph
      - time_series
      title: DataStoreType
    DataFlowNodeType:
      type: string
      enum:
      - component
      - data_store
      - actor
      title: DataFlowNodeType
    DataFlowUpdate:
      properties:
        symbolic_name:
          type: 'null'
          title: Symbolic Name
        title:
          anyOf:
          - type: string
          - type: 'null'
          title: Title
        description:
          anyOf:
          - type: string
          - type: 'null'
          title: Description
        has_sensitive_data:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Has Sensitive Data
        encrypted:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Encrypted
        source_type:
          anyOf:
          - $ref: '#/components/schemas/DataFlowNodeType'
          - type: 'null'
        source_id:
          anyOf:
          - type: integer
          - type: 'null'
          title: Source Id
        destination_type:
          anyOf:
          - $ref: '#/components/schemas/DataFlowNodeType'
          - type: 'null'
        destination_id:
          anyOf:
          - type: integer
          - type: 'null'
          title: Destination Id
      type: object
      title: DataFlowUpdate
    TrustZone:
      properties:
        symbolic_name:
          type: string
          pattern: ^[0-9a-z-]+$
          title: Symbolic Name
        title:
          type: string
          title: Title
        description:
          type: string
          title: Description
        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'
        threat_model_versions:
          items:
            type: string
            pattern: ^\d+(\.\d+)*$
          type: array
          title: Threat Model Versions
      type: object
      required:
      - symbolic_name
      - title
      - description
      - id
      - project
      - threat_model_versions
      title: TrustZone
    DataFlowCreate:
      properties:
        symbolic_name:
          type: 'null'
          title: Symbolic Name
        title:
          type: string
          title: Title
        description:
          type: string
          title: Description
        has_sensitive_data:
          type: boolean
          title: Has Sensitive Data
          default: false
        encrypted:
          type: boolean
          title: Encrypted
          default: false
        source_type:
          $ref: '#/components/schemas/DataFlowNodeType'
        source_id:
          type: integer
          title: Source Id
        destination_type:
          $ref: '#/components/schemas/DataFlowNodeType'
        destination_id:
          type: integer
          title: Destination Id
      type: object
      required:
      - title
      - description
      - source_type
      - source_id
      - destination_type
      - destination_id
      title: DataFlowCreate
    Actor:
      properties:
        symbolic_name:
          type: string
          pattern: ^[0-9a-z-]+$
          title: Symbolic Name
        title:
          type: string
          title: Title
        description:
          type: string
          title: Description
        type:
          $ref: '#/components/schemas/ActorType'
        permissions:
          anyOf:
          - type: string
          - type: 'null'
          title: Permissions
        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'
        threat_model_versions:
          items:
            type: string
            pattern: ^\d+(\.\d+)*$
          type: array
          title: Threat Model Versions
        trust_zone:
          anyOf:
          - $ref: '#/components/schemas/TrustZone'
          - type: 'null'
      type: object
      required:
      - symbolic_name
      - title
      - description
      - type
      - permissions
      - id
      - project
      - threat_model_versions
      title: Actor
    DataFlowDelete:
      properties:
        symbolic_name:
          type: string
          pattern: ^[0-9a-z-]+$
          title: Symbolic Name
        title:
          type: string
          title: Title
        description:
          type: string
          title: Description
        has_sensitive_data:
          type: boolean
          title: Has Sensitive Data
        encrypted:
          type: boolean
          title: Encrypted
      type: object
      required:
      - symbolic_name
      - title
      - description
      - has_sensitive_data
      - encrypted
      title: DataFlowDelete
    ActorType:
      type: string
      enum:
      - system
      - user
      - power_user
      - administrator
      - engineer
      - third_party
      title: ActorType
    UserState:
      type: string
      enum:
      - active
      - inactive
      - pending_org_approval
      title: UserState
  securitySchemes:
    APIGatewayAuth:
      type: http
      scheme: bearer