All Quiet Inbound Integration Monitoring Resource API

The InboundIntegrationMonitoringResource API from All Quiet — 3 operation(s) for inboundintegrationmonitoringresource.

Documentation GitHub OpenAPI

Operations 3

GET /api/public/v1/inbound-integration/{integrationId}/heartbeat-result Get heartbeat monitor result #

GET /api/public/v1/inbound-integration/{integrationId}/http-monitoring-results/{resultId} Get a single HTTP monitoring execution result #

GET /api/public/v1/inbound-integration/{integrationId}/http-monitoring-results/search/list List HTTP monitoring execution results #

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/allquiet:allquiet-inboundintegrationmonitoringresource-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: All Quiet Public Inbound Integration Monitoring Resource API
  version: v1
tags:
- name: InboundIntegrationMonitoringResource
paths:
  /api/public/v1/inbound-integration/{integrationId}/heartbeat-result:
    get:
      tags:
      - InboundIntegrationMonitoringResource
      summary: Get heartbeat monitor result
      description: 'Returns the current heartbeat monitor state for an inbound integration.


        **Required API key permissions**


        - **Scope:** `inbound-integrations:get`

        - **Accepted key types:** organization API key (org-wide), organization API key (team-scoped), personal access token (org-wide), personal access token (team-scoped)

        - **Access:** Access is checked against the specific resource (team or organization reachability).

        - **Required team role (user-linked keys only):** Member

        - Organization API keys are not subject to organization or team role checks.'
      parameters:
      - name: integrationId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/AllQuiet.Api.Public.InboundIntegrations.HeartbeatResultResourceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/AllQuiet.Api.Public.InboundIntegrations.HeartbeatResultResourceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/AllQuiet.Api.Public.InboundIntegrations.HeartbeatResultResourceResponse'
        '404':
          description: Not Found
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
      security:
      - ApiKey: []
      x-api-key-requirements:
        resource: inbound-integrations
        permission: get
        scope: inbound-integrations:get
        accessModel: resource-scoped
        allowedKeyTypes:
        - organization API key (org-wide)
        - organization API key (team-scoped)
        - personal access token (org-wide)
        - personal access token (team-scoped)
        acceptsDerivedOrgMembershipForUserKeys: false
        grantsRootOrganizationUserReadAccess: false
        grantsUserSelfWriteAccess: false
        requiredOrgRoleForUserKeys: null
        requiredTeamRoleForUserKeys: Member
        notes: null
      operationId: getApiPublicV1InboundIntegrationByIntegrationIdHeartbeatResult
      x-operation-id-source: derived
  /api/public/v1/inbound-integration/{integrationId}/http-monitoring-results/{resultId}:
    get:
      tags:
      - InboundIntegrationMonitoringResource
      summary: Get a single HTTP monitoring execution result
      description: 'Returns one HTTP monitoring execution result for an inbound integration.


        **Required API key permissions**


        - **Scope:** `inbound-integrations:get`

        - **Accepted key types:** organization API key (org-wide), organization API key (team-scoped), personal access token (org-wide), personal access token (team-scoped)

        - **Access:** Access is checked against the specific resource (team or organization reachability).

        - **Required team role (user-linked keys only):** Member

        - Organization API keys are not subject to organization or team role checks.'
      parameters:
      - name: integrationId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: resultId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/AllQuiet.Api.Public.InboundIntegrations.InboundIntegrationHttpMonitoringResultResourceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/AllQuiet.Api.Public.InboundIntegrations.InboundIntegrationHttpMonitoringResultResourceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/AllQuiet.Api.Public.InboundIntegrations.InboundIntegrationHttpMonitoringResultResourceResponse'
        '404':
          description: Not Found
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
      security:
      - ApiKey: []
      x-api-key-requirements:
        resource: inbound-integrations
        permission: get
        scope: inbound-integrations:get
        accessModel: resource-scoped
        allowedKeyTypes:
        - organization API key (org-wide)
        - organization API key (team-scoped)
        - personal access token (org-wide)
        - personal access token (team-scoped)
        acceptsDerivedOrgMembershipForUserKeys: false
        grantsRootOrganizationUserReadAccess: false
        grantsUserSelfWriteAccess: false
        requiredOrgRoleForUserKeys: null
        requiredTeamRoleForUserKeys: Member
        notes: null
      operationId: getApiPublicV1InboundIntegrationByIntegrationIdHttpMonitoringResultsByResultId
      x-operation-id-source: derived
  /api/public/v1/inbound-integration/{integrationId}/http-monitoring-results/search/list:
    get:
      tags:
      - InboundIntegrationMonitoringResource
      summary: List HTTP monitoring execution results
      description: 'Returns paginated HTTP monitoring execution results for an inbound integration (default limit 20, max 100).


        **Required API key permissions**


        - **Scope:** `inbound-integrations:list`

        - **Accepted key types:** organization API key (org-wide), organization API key (team-scoped), personal access token (org-wide), personal access token (team-scoped)

        - **Access:** Access is checked against the specific resource (team or organization reachability).

        - **Required team role (user-linked keys only):** Member

        - Organization API keys are not subject to organization or team role checks.'
      parameters:
      - name: integrationId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: From
        in: query
        schema:
          type: string
          format: date-time
      - name: Until
        in: query
        schema:
          type: string
          format: date-time
      - name: Status
        in: query
        schema:
          type: array
          items:
            type: string
      - name: Offset
        in: query
        schema:
          maximum: 2147483647
          minimum: 0
          type: integer
          format: int32
      - name: Limit
        in: query
        schema:
          maximum: 100
          minimum: 1
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/AllQuiet.Api.Public.InboundIntegrations.InboundIntegrationHttpMonitoringResultListResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/AllQuiet.Api.Public.InboundIntegrations.InboundIntegrationHttpMonitoringResultListResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/AllQuiet.Api.Public.InboundIntegrations.InboundIntegrationHttpMonitoringResultListResponse'
      security:
      - ApiKey: []
      x-api-key-requirements:
        resource: inbound-integrations
        permission: list
        scope: inbound-integrations:list
        accessModel: resource-scoped
        allowedKeyTypes:
        - organization API key (org-wide)
        - organization API key (team-scoped)
        - personal access token (org-wide)
        - personal access token (team-scoped)
        acceptsDerivedOrgMembershipForUserKeys: false
        grantsRootOrganizationUserReadAccess: false
        grantsUserSelfWriteAccess: false
        requiredOrgRoleForUserKeys: null
        requiredTeamRoleForUserKeys: Member
        notes: null
      operationId: getApiPublicV1InboundIntegrationByIntegrationIdHttpMonitoringResultsSearchList
      x-operation-id-source: derived
components:
  schemas:
    AllQuiet.Api.Public.InboundIntegrations.InboundIntegrationHttpMonitoringResultListResponse:
      type: object
      properties:
        httpMonitoringResults:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/AllQuiet.Api.Public.InboundIntegrations.InboundIntegrationHttpMonitoringResultResourceResponse'
        hasMore:
          type: boolean
      additionalProperties: false
    AllQuiet.Api.Public.InboundIntegrations.InboundIntegrationHttpMonitoringResultResourceResponse:
      type: object
      properties:
        id:
          type: string
          format: uuid
        integrationId:
          type: string
          format: uuid
        timestamp:
          type: string
          format: date-time
        status:
          type:
          - string
          - 'null'
        statusReason:
          type:
          - string
          - 'null'
        totalElapsedInMs:
          type:
          - integer
          - 'null'
          format: int64
      additionalProperties: false
    AllQuiet.Api.Public.InboundIntegrations.HeartbeatResultResourceResponse:
      type: object
      properties:
        integrationId:
          type: string
          format: uuid
        lastHeartbeatReceivedAt:
          type:
          - string
          - 'null'
          format: date-time
        nextHeartbeatExpectedAt:
          type:
          - string
          - 'null'
          format: date-time
        isHeartbeatOverdue:
          type:
          - boolean
          - 'null'
      additionalProperties: false
    Microsoft.AspNetCore.Mvc.ProblemDetails:
      type: object
      properties:
        type:
          type:
          - string
          - 'null'
        title:
          type:
          - string
          - 'null'
        status:
          type:
          - integer
          - 'null'
          format: int32
        detail:
          type:
          - string
          - 'null'
        instance:
          type:
          - string
          - 'null'
      additionalProperties: {}
  securitySchemes:
    ApiKey:
      type: apiKey
      description: 'API key authentication. Pass the key as `Authorization: Bearer <key>` or `X-Api-Key: <key>`. Each operation documents required scopes and accepted key types.'
      name: Authorization
      in: header
x-provenance:
  method: harvested
  publisher: All Quiet
  source: https://allquiet.app/api/swagger/public-v1/swagger.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)