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/everbridge:everbridge-agent-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:
  contact:
    email: support@everbridge.com
  description: Integration with Everbridge Incidents, Scenarios and Safety via IPAAS
  title: Everbridge iPaaS Agent API
  version: v1
servers:
- url: /
  description: default server url
security:
- apiKey: []
tags:
- description: Settings and shared operations for all iPaaS integrations
  name: Agent
paths:
  /ipaas/v1/agent/config:
    get:
      operationId: getConfiguration
      responses:
        '400':
          content:
            '*/*':
              schema:
                type: object
          description: Bad Request
        '404':
          content:
            '*/*':
              schema:
                type: object
          description: Not Found
        '500':
          content:
            '*/*':
              schema:
                type: object
          description: Internal error
      security:
      - apiKey: []
      summary: Retrieves the Agent configuration set in the iPaaS UI
      tags:
      - Agent
  /ipaas/v1/agent/heartbeat:
    get:
      operationId: getHeartbeatStatus
      responses:
        '400':
          content:
            '*/*':
              schema:
                type: object
          description: Bad Request
        '404':
          content:
            '*/*':
              schema:
                type: object
          description: Not Found
        '500':
          content:
            '*/*':
              schema:
                type: object
          description: Internal error
      security:
      - apiKey: []
      summary: Retrieves the status of the agent
      tags:
      - Agent
    post:
      operationId: processHeartbeat
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AgentStatus'
        required: true
      responses:
        '200':
          content:
            '*/*':
              schema:
                type: object
          description: OK
      security:
      - apiKey: []
      summary: Let the system know the status of the agent
      tags:
      - Agent
components:
  schemas:
    AgentStatus:
      type: object
      properties:
        currentState:
          type: string
          enum:
          - RUNNING
          - STOPPED
        dateTime:
          type: integer
          format: int64
        errors:
          type: array
          items:
            $ref: '#/components/schemas/AgentError'
        targetConnectionIsHealthy:
          type: boolean
    AgentError:
      type: object
      properties:
        message:
          type: string
        title:
          type: string
        type:
          type: string
  securitySchemes:
    apiKey:
      description: Api Key access
      in: header
      name: Authentication
      type: apiKey
x-provenance:
  method: harvested
  publisher: Everbridge
  source: https://ipaas-ingestion.everbridge.net/v3/api-docs
  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)