usemip.com API

openapi: 3.1.0
info:
  title: usemip.com API
  version: '2026-10-22'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-22: 7 operation(s) read from 3 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; usemip.com has published no machine-readable contract that the
    pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 0
    documentation: 7
    pages-with-code: 0
    pages-read: 3
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-22'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://docs.usemip.com/version-history/v1-18-3-2
  - https://docs.usemip.com/version-history/v1-18-3-6
  - https://docs.usemip.com/version-history/v1-18-4-2
paths:
  /api/flows:
    delete:
      operationId: delete_api_flows
      tags:
      - Api
      summary: Deleting a deployed flow through the API is now refused with a 409 response that asks for the flow to be undeployed first; passing
        undeployIfDeployed undeploys the flow first and deletes it only if th
      x-source: https://docs.usemip.com/version-history/v1-18-3-2
      parameters:
      - name: undeployIfDeployed
        in: query
        required: false
        schema:
          type: string
        description: If true, the flow will be undeployed before deletion.
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteApiFlowsResponse'
      x-evidence:
        kind: documentation
  /api/flows/{flowid}:
    delete:
      operationId: delete_api_flows_flowid
      tags:
      - Api
      summary: Deleting a deployed flow through the API is now refused with a 409 response that asks for the flow to be undeployed first; passing
        undeployIfDeployed undeploys the flow first and deletes it only if th
      x-source: https://docs.usemip.com/version-history/v1-18-3-2
      parameters:
      - name: flowid
        in: path
        required: true
        schema:
          type: string
      - name: undeployIfDeployed
        in: query
        required: false
        schema:
          type: string
        description: If true, the flow will be undeployed before deletion.
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteApiFlowsFlowidResponse'
      x-evidence:
        kind: documentation
  /api/flows/{flowid}/deployment:
    get:
      operationId: get_api_flows_flowid_deployment
      tags:
      - Api
      summary: GET /api/flows/{flowId}/deployment reports whether a flow is deployed, the deployed version, who deployed it and when, who undeployed
        it and when, the flow's current version and last change, and wheth
      x-source: https://docs.usemip.com/version-history/v1-18-3-2
      parameters:
      - name: flowid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiFlowsFlowidDeploymentResponse'
      x-evidence:
        kind: documentation
  /api/global-flow-configurations/{configkey}/flows:
    get:
      operationId: get_api_global_flow_configurations_configkey_flows
      tags:
      - Api
      summary: Where-used list of flows that define a key locally
      x-source: https://docs.usemip.com/version-history/v1-18-3-6
      parameters:
      - name: configkey
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/global-flow-configurations/{configkey}/local-flows:
    get:
      operationId: get_api_global_flow_configurations_configkey_local_flows
      tags:
      - Api
      summary: Where-used list of flows that define a key locally
      x-source: https://docs.usemip.com/version-history/v1-18-3-6
      parameters:
      - name: configkey
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/monitoring/deployed-integrations/openapi:
    get:
      operationId: get_api_monitoring_deployed_integrations_openapi
      tags:
      - Api
      summary: Expose GET /api/monitoring/deployed-integrations/openapi for all roles
      x-source: https://docs.usemip.com/version-history/v1-18-4-2
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/number-ranges/{id}/flows:
    get:
      operationId: get_api_number_ranges_id_flows
      tags:
      - Api
      summary: GET /api/number-ranges/{id}/flows lists every deployed or saved flow whose Counter node uses the counter.
      x-source: https://docs.usemip.com/version-history/v1-18-3-2
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiNumberRangesIdFlowsResponse'
      x-evidence:
        kind: documentation
components:
  schemas:
    DeleteApiFlowsResponse:
      type: object
      properties:
        '409':
          type: string
          description: Flow is deployed; deletion refused unless undeployIfDeployed is used.
        '200':
          type: string
          description: Flow deleted successfully.
    DeleteApiFlowsFlowidResponse:
      type: object
      properties:
        '409':
          type: string
          description: Flow is deployed; deletion refused unless undeployIfDeployed is used.
        '200':
          type: string
          description: Flow deleted successfully.
    GetApiFlowsFlowidDeploymentResponse:
      type: object
      properties:
        deployed:
          type: boolean
          description: Indicates if the flow is currently deployed.
        deployed_version:
          type: string
          description: Version of the flow that is deployed.
        deployed_by:
          type: string
          description: User who deployed the flow.
        deployed_at:
          type: string
          description: Timestamp when the flow was deployed.
        undeployed_by:
          type: string
          description: User who undeployed the flow (if applicable).
        undeployed_at:
          type: string
          description: Timestamp when the flow was undeployed (if applicable).
        current_version:
          type: string
          description: Current version of the flow.
        last_change:
          type: string
          description: Timestamp of the last change to the flow.
        changed_since_deployment:
          type: boolean
          description: Indicates if the flow has changed since it was deployed.
    GetApiNumberRangesIdFlowsResponse:
      type: object
      properties:
        flows:
          type: array
          description: Array of flow objects that use the specified counter.
  securitySchemes:
    Basic:
      type: http
      scheme: basic
      x-source: https://docs.usemip.com/operations/security/credentials/
tags:
- name: Api
security:
- Basic: []