Gravitee

Gravitee Notifier API

The Notifier API from Gravitee — 3 operation(s) for notifier.

Documentation GitHub OpenAPI

Documentation

https://documentation.gravitee.io/apim

https://documentation.gravitee.io/apim/getting-started

https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/rate-limits/gravitee-rate-limits.yml

https://documentation.gravitee.io/am

Specifications

https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/openapi/gravitee-notifier-api-openapi.yml

SDKs

GitHubRepository

https://github.com/gravitee-io/gravitee-api-management

GitHubRepository

https://github.com/gravitee-io/gravitee-access-management

Schemas & Data

https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/json-schema/gravitee-api-schema.json

https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/json-schema/gravitee-plan-schema.json

https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/json-schema/gravitee-domain-schema.json

Other Resources

https://documentation.gravitee.io/apim/release-information/changelog

https://github.com/gravitee-io/gravitee-api-management/blob/master/LICENSE.txt

https://github.com/gravitee-io/gravitee-clients-sdk

https://github.com/gravitee-io/terraform-provider-apim

https://github.com/gravitee-io/graviteeio-cli

KubernetesOperator

https://github.com/gravitee-io/gravitee-kubernetes-operator

https://github.com/gravitee-io/helm-charts

https://hub.docker.com/r/graviteeio/apim-gateway

https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/json-ld/gravitee-context.jsonld

https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/crd/gravitee.io_apidefinitions.yaml

https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/crd/gravitee.io_apiv4definitions.yaml

https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/crd/gravitee.io_apiresources.yaml

https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/crd/gravitee.io_applications.yaml

https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/crd/gravitee.io_subscriptions.yaml

https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/crd/gravitee.io_managementcontexts.yaml

https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/crd/gravitee.io_sharedpolicygroups.yaml

https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/crd/gravitee.io_groups.yaml

https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/crd/gravitee.io_notifications.yaml

https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/plans/gravitee-plans-pricing.yml

https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/finops/gravitee-finops.yml

https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/capabilities/api-gateway-operations.yaml

https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/capabilities/traffic-observability.yaml

https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/graphql/gravitee-graphql.md

https://documentation.gravitee.io/am/reference/am-api-reference

https://documentation.gravitee.io/am/releases-and-changelog/release-notes

https://github.com/gravitee-io/gravitee-access-management/blob/master/LICENSE

https://github.com/gravitee-io/gravitee-access-management/tree/master/gravitee-am-management-api-sdk-java

https://github.com/gravitee-io/helm-charts/tree/master/helm/gravitee-am

https://hub.docker.com/r/graviteeio/am-gateway

https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/capabilities/access-management.yaml

OpenAPI Specification

openapi: 3.0.1
info:
  title: Gravitee.io - Access Management alerts Notifier API
  version: 4.12.0-alpha.3
servers:
- url: /management
security:
- gravitee-auth: []
tags:
- name: Notifier
paths:
  /platform/plugins/notifiers:
    get:
      tags:
      - Notifier
      summary: List all available notifier plugins
      description: There is no particular permission needed. User must be authenticated.
      operationId: listNotifiers
      parameters:
      - name: expand
        in: query
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: Notifier plugin list
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/NotifierPlugin'
        '500':
          description: Internal server error
  /platform/plugins/notifiers/{notifierId}:
    get:
      tags:
      - Notifier
      summary: Get a notifier
      description: There is no particular permission needed. User must be authenticated.
      operationId: getNotifier
      parameters:
      - name: notifierId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Notifier plugin
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotifierPlugin'
        '404':
          description: Notifier plugin not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEntity'
        '500':
          description: Internal server error
  /platform/plugins/notifiers/{notifierId}/schema:
    get:
      tags:
      - Notifier
      summary: Get a notifier plugin's schema
      description: There is no particular permission needed. User must be authenticated.
      operationId: getNotifierSchema
      parameters:
      - name: notifierId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Notifier plugin schema
          content:
            application/json:
              schema:
                type: string
        '404':
          description: Notifier plugin schema not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEntity'
        '500':
          description: Internal server error
components:
  schemas:
    ErrorEntity:
      type: object
      properties:
        http_status:
          type: integer
          format: int32
        message:
          type: string
    NotifierPlugin:
      type: object
      properties:
        deployed:
          type: boolean
        description:
          type: string
        displayName:
          type: string
        feature:
          type: string
        icon:
          type: string
        id:
          type: string
        name:
          type: string
        version:
          type: string
  securitySchemes:
    gravitee-auth:
      type: http
      scheme: Bearer