Gravitee

Gravitee Application Alerts API

The Application Alerts API from Gravitee — 3 operation(s) for application alerts.

GitHub OpenAPI

Operations 5

GET /organizations/{orgId}/environments/{envId}/applications/{application}/alerts List configured alerts of an application #
POST /organizations/{orgId}/environments/{envId}/applications/{application}/alerts Create an alert for an application #
GET /organizations/{orgId}/environments/{envId}/applications/{application}/alerts/status Get alerting status #
PUT /organizations/{orgId}/environments/{envId}/applications/{application}/alerts/{alert} Update an alert for an application #
DELETE /organizations/{orgId}/environments/{envId}/applications/{application}/alerts/{alert} Delete an alert for an application #

Documentation

📖
Documentation
https://documentation.gravitee.io/apim
📖
GettingStarted
https://documentation.gravitee.io/apim/getting-started
📖
RateLimits
https://artifacts.apis.io/gravitee/rate-limits/gravitee-rate-limits.yml
📖
Documentation
https://documentation.gravitee.io/am

Specifications

⚙
OpenAPI
https://artifacts.apis.io/gravitee/openapi/gravitee-application-alerts-api-openapi.yml

SDKs

📦
GitHubRepository
https://github.com/gravitee-io/gravitee-api-management
📦
GitHubRepository
https://github.com/gravitee-io/gravitee-access-management

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/gravitee/json-schema/gravitee-api-schema.json
📊
JSONSchema
https://artifacts.apis.io/gravitee/json-schema/gravitee-plan-schema.json
📊
JSONSchema
https://artifacts.apis.io/gravitee/json-schema/gravitee-domain-schema.json

Other Resources

🔗
ChangeLog
https://documentation.gravitee.io/apim/release-information/changelog
🔗
License
https://github.com/gravitee-io/gravitee-api-management/blob/master/LICENSE.txt
🔗
SDKs
https://github.com/gravitee-io/gravitee-clients-sdk
🔗
SDKs
https://github.com/gravitee-io/terraform-provider-apim
🔗
CLI
https://github.com/gravitee-io/graviteeio-cli
🔗
KubernetesOperator
https://github.com/gravitee-io/gravitee-kubernetes-operator
🔗
HelmChart
https://github.com/gravitee-io/helm-charts
🔗
DockerImage
https://hub.docker.com/r/graviteeio/apim-gateway
🔗
JSONLDContext
https://artifacts.apis.io/gravitee/json-ld/gravitee-context.jsonld
🔗
KubernetesCRD
https://artifacts.apis.io/gravitee/crd/gravitee.io_apidefinitions.yaml
🔗
KubernetesCRD
https://artifacts.apis.io/gravitee/crd/gravitee.io_apiv4definitions.yaml
🔗
KubernetesCRD
https://artifacts.apis.io/gravitee/crd/gravitee.io_apiresources.yaml
🔗
KubernetesCRD
https://artifacts.apis.io/gravitee/crd/gravitee.io_applications.yaml
🔗
KubernetesCRD
https://artifacts.apis.io/gravitee/crd/gravitee.io_subscriptions.yaml
🔗
KubernetesCRD
https://artifacts.apis.io/gravitee/crd/gravitee.io_managementcontexts.yaml
🔗
KubernetesCRD
https://artifacts.apis.io/gravitee/crd/gravitee.io_sharedpolicygroups.yaml
🔗
KubernetesCRD
https://artifacts.apis.io/gravitee/crd/gravitee.io_groups.yaml
🔗
KubernetesCRD
https://artifacts.apis.io/gravitee/crd/gravitee.io_notifications.yaml
🔗
Plans
https://artifacts.apis.io/gravitee/plans/gravitee-plans-pricing.yml
🔗
FinOps
https://artifacts.apis.io/gravitee/finops/gravitee-finops.yml
🔗
Reference
https://documentation.gravitee.io/am/reference/am-api-reference
🔗
ChangeLog
https://documentation.gravitee.io/am/releases-and-changelog/release-notes
🔗
License
https://github.com/gravitee-io/gravitee-access-management/blob/master/LICENSE
🔗
SDKs
https://github.com/gravitee-io/gravitee-access-management/tree/master/gravitee-am-management-api-sdk-java
🔗
HelmChart
https://github.com/gravitee-io/helm-charts/tree/master/helm/gravitee-am
🔗
DockerImage
https://hub.docker.com/r/graviteeio/am-gateway

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/gravitee:gravitee-application-alerts-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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

gravitee-application-alerts-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Gravitee.io - Management Application Alerts API
  description: Some news resources are in alpha version. This implies that they are likely to be modified or even removed in future versions. They are marked with the 🧪 symbol
  version: 3.20.0
servers:
- url: http://localhost:8083/management
security:
- gravitee-auth: []
tags:
- name: Application Alerts
paths:
  /organizations/{orgId}/environments/{envId}/applications/{application}/alerts:
    get:
      tags:
      - Application Alerts
      summary: List configured alerts of an application
      description: User must have the APPLICATION_ALERT[READ] permission to use this service
      operationId: getApplicationAlerts
      parameters:
      - name: event_counts
        in: query
        schema:
          type: boolean
          default: true
      - name: application
        in: path
        required: true
        schema:
          type: string
      - name: envId
        in: path
        description: The ID of the environment
        required: true
        schema:
          type: string
          default: DEFAULT
      - name: orgId
        in: path
        description: The ID of the Organization
        required: true
        schema:
          type: string
          default: DEFAULT
      responses:
        '200':
          description: List of alerts
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AlertTriggerEntity'
        '500':
          description: Internal server error
    post:
      tags:
      - Application Alerts
      summary: Create an alert for an application
      description: User must have the APPLICATION_ALERT[CREATE] permission to use this service
      operationId: createApplicationAlert
      parameters:
      - name: application
        in: path
        required: true
        schema:
          type: string
      - name: envId
        in: path
        description: The ID of the environment
        required: true
        schema:
          type: string
          default: DEFAULT
      - name: orgId
        in: path
        description: The ID of the Organization
        required: true
        schema:
          type: string
          default: DEFAULT
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NewAlertTriggerEntity'
        required: true
      responses:
        '200':
          description: Alert successfully created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertTriggerEntity'
        '500':
          description: Internal server error
  /organizations/{orgId}/environments/{envId}/applications/{application}/alerts/status:
    get:
      tags:
      - Application Alerts
      summary: Get alerting status
      description: User must have the MANAGEMENT_ALERT[READ] permission to use this service
      operationId: getApplicationAlertsStatus
      parameters:
      - name: application
        in: path
        required: true
        schema:
          type: string
      - name: envId
        in: path
        description: The ID of the environment
        required: true
        schema:
          type: string
          default: DEFAULT
      - name: orgId
        in: path
        description: The ID of the Organization
        required: true
        schema:
          type: string
          default: DEFAULT
      responses:
        '200':
          description: Alerting status
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertStatusEntity'
        '500':
          description: Internal server error
  /organizations/{orgId}/environments/{envId}/applications/{application}/alerts/{alert}:
    put:
      tags:
      - Application Alerts
      summary: Update an alert for an application
      description: User must have the APPLICATION_ALERT[UPDATE] permission to use this service
      operationId: updateApplicationAlert
      parameters:
      - name: alert
        in: path
        required: true
        schema:
          type: string
      - name: application
        in: path
        required: true
        schema:
          type: string
      - name: envId
        in: path
        description: The ID of the environment
        required: true
        schema:
          type: string
          default: DEFAULT
      - name: orgId
        in: path
        description: The ID of the Organization
        required: true
        schema:
          type: string
          default: DEFAULT
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateAlertTriggerEntity'
        required: true
      responses:
        '200':
          description: Alert successfully updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertTriggerEntity'
        '500':
          description: Internal server error
    delete:
      tags:
      - Application Alerts
      summary: Delete an alert for an application
      description: User must have the APPLICATION_ALERT[DELETE] permission to use this service
      operationId: deleteApplicationAlert
      parameters:
      - name: alert
        in: path
        required: true
        schema:
          type: string
      - name: application
        in: path
        required: true
        schema:
          type: string
      - name: envId
        in: path
        description: The ID of the environment
        required: true
        schema:
          type: string
          default: DEFAULT
      - name: orgId
        in: path
        description: The ID of the Organization
        required: true
        schema:
          type: string
          default: DEFAULT
      responses:
        '204':
          description: Alert successfully deleted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertTriggerEntity'
        '500':
          description: Internal server error
components:
  schemas:
    Notification:
      type: object
      properties:
        configuration:
          type: string
        periods:
          type: array
          items:
            $ref: '#/components/schemas/Period'
        type:
          type: string
    Dampening:
      required:
      - mode
      type: object
      properties:
        duration:
          type: integer
          format: int64
        mode:
          type: string
          enum:
          - STRICT_COUNT
          - RELAXED_COUNT
          - RELAXED_TIME
          - STRICT_TIME
        timeUnit:
          type: string
          enum:
          - NANOSECONDS
          - MICROSECONDS
          - MILLISECONDS
          - SECONDS
          - MINUTES
          - HOURS
          - DAYS
        totalEvaluations:
          type: integer
          format: int32
        trueEvaluations:
          type: integer
          format: int32
    Filter:
      type: object
      properties:
        projections:
          type: array
          items:
            $ref: '#/components/schemas/Projection'
        type:
          type: string
          enum:
          - STRING
          - THRESHOLD
          - THRESHOLD_RANGE
          - RATE
          - FREQUENCY
          - AGGREGATION
          - COMPARE
          - STRING_COMPARE
          - MISSING_DATA
    Period:
      required:
      - beginHour
      - endHour
      - zoneId
      type: object
      properties:
        beginHour:
          type: integer
          format: int32
        days:
          type: array
          items:
            type: integer
            format: int32
        endHour:
          type: integer
          format: int32
        zoneId:
          type: string
    AlertEventRuleEntity:
      type: object
      properties:
        event:
          type: string
    AlertStatusEntity:
      type: object
      properties:
        available_plugins:
          type: integer
          format: int32
        enabled:
          type: boolean
    Projection:
      type: object
      properties:
        type:
          type: string
          enum:
          - PROPERTY
      discriminator:
        propertyName: type
    Condition:
      type: object
      properties:
        projections:
          type: array
          items:
            $ref: '#/components/schemas/Projection'
        type:
          type: string
          enum:
          - STRING
          - THRESHOLD
          - THRESHOLD_RANGE
          - RATE
          - FREQUENCY
          - AGGREGATION
          - COMPARE
          - STRING_COMPARE
          - MISSING_DATA
      discriminator:
        propertyName: type
    AlertReferenceType:
      type: string
      enum:
      - API
      - APPLICATION
      - ENVIRONMENT
    AlertTriggerEntity:
      type: object
      properties:
        conditions:
          type: array
          items:
            $ref: '#/components/schemas/Condition'
        counters:
          type: object
          additionalProperties:
            type: integer
            format: int32
        created_at:
          type: string
          format: date-time
        dampening:
          $ref: '#/components/schemas/Dampening'
        description:
          type: string
        enabled:
          type: boolean
        environment_id:
          type: string
        event_rules:
          type: array
          items:
            $ref: '#/components/schemas/AlertEventRuleEntity'
        filters:
          type: array
          items:
            $ref: '#/components/schemas/Filter'
        id:
          type: string
        last_alert_at:
          type: string
          format: date-time
        last_alert_message:
          type: string
        metadata:
          type: object
          additionalProperties:
            type: object
            additionalProperties:
              type: string
        name:
          type: string
        notificationPeriods:
          type: array
          items:
            $ref: '#/components/schemas/Period'
        notifications:
          type: array
          items:
            $ref: '#/components/schemas/Notification'
        parent_id:
          type: string
        reference_id:
          type: string
        reference_type:
          $ref: '#/components/schemas/AlertReferenceType'
        severity:
          type: string
          enum:
          - INFO
          - WARNING
          - CRITICAL
        source:
          type: string
        template:
          type: boolean
        type:
          type: string
        updated_at:
          type: string
          format: date-time
    NewAlertTriggerEntity:
      required:
      - name
      - type
      type: object
      properties:
        conditions:
          type: array
          items:
            $ref: '#/components/schemas/Condition'
        dampening:
          $ref: '#/components/schemas/Dampening'
        description:
          maxLength: 256
          minLength: 0
          type: string
        enabled:
          type: boolean
        event_rules:
          type: array
          items:
            $ref: '#/components/schemas/AlertEventRuleEntity'
        filters:
          type: array
          items:
            $ref: '#/components/schemas/Filter'
        id:
          type: string
        metadata:
          type: object
          additionalProperties:
            type: object
            additionalProperties:
              type: string
        name:
          type: string
        notificationPeriods:
          type: array
          items:
            $ref: '#/components/schemas/Period'
        notifications:
          type: array
          items:
            $ref: '#/components/schemas/Notification'
        reference_id:
          type: string
        reference_type:
          $ref: '#/components/schemas/AlertReferenceType'
        severity:
          type: string
          enum:
          - INFO
          - WARNING
          - CRITICAL
        source:
          type: string
        template:
          type: boolean
        type:
          type: string
    UpdateAlertTriggerEntity:
      required:
      - name
      - severity
      type: object
      properties:
        conditions:
          type: array
          items:
            $ref: '#/components/schemas/Condition'
        dampening:
          $ref: '#/components/schemas/Dampening'
        description:
          maxLength: 256
          minLength: 0
          type: string
        enabled:
          type: boolean
        event_rules:
          type: array
          items:
            $ref: '#/components/schemas/AlertEventRuleEntity'
        filters:
          type: array
          items:
            $ref: '#/components/schemas/Filter'
        id:
          type: string
        metadata:
          type: object
          additionalProperties:
            type: object
            additionalProperties:
              type: string
        name:
          type: string
        notificationPeriods:
          type: array
          items:
            $ref: '#/components/schemas/Period'
        notifications:
          type: array
          items:
            $ref: '#/components/schemas/Notification'
        reference_id:
          type: string
        reference_type:
          $ref: '#/components/schemas/AlertReferenceType'
        severity:
          type: string
          enum:
          - INFO
          - WARNING
          - CRITICAL
        source:
          type: string
  securitySchemes:
    gravitee-auth:
      type: http
      scheme: basic