Gravitee Reporter API

The Reporter API from Gravitee — 7 operation(s) for reporter.

Operations 10

GET /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/reporters List registered reporters for a security domain #
POST /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/reporters Create a reporter for a security domain #
GET /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/reporters/{reporter} Get a reporter #
PUT /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/reporters/{reporter} Update a reporter #
DELETE /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/reporters/{reporter} Delete a reporter #
GET /organizations/{organizationId}/reporters List registered reporters for a security domain #
POST /organizations/{organizationId}/reporters Create a reporter for an organization #
GET /organizations/{organizationId}/reporters/{reporterId} Get a reporter #
PUT /organizations/{organizationId}/reporters/{reporterId} Update a reporter #
DELETE /organizations/{organizationId}/reporters/{reporterId} Delete a reporter #

Documentation

Specifications

SDKs

Schemas & Data

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://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/json-ld/gravitee-context.jsonld
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/crd/gravitee.io_apidefinitions.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/crd/gravitee.io_apiv4definitions.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/crd/gravitee.io_apiresources.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/crd/gravitee.io_applications.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/crd/gravitee.io_subscriptions.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/crd/gravitee.io_managementcontexts.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/crd/gravitee.io_sharedpolicygroups.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/crd/gravitee.io_groups.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/crd/gravitee.io_notifications.yaml
🔗
Plans
https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/plans/gravitee-plans-pricing.yml
🔗
FinOps
https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/finops/gravitee-finops.yml
🔗
GraphQL
https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/graphql/gravitee-graphql.md
🔗
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-reporter-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.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

gravitee-reporter-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Gravitee.io - Access Management Reporter API
  version: 4.12.0-alpha.3
servers:
- url: /management
security:
- gravitee-auth: []
tags:
- name: reporter
paths:
  /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/reporters:
    get:
      tags:
      - reporter
      summary: List registered reporters for a security domain
      description: User must have the DOMAIN_REPORTER[LIST] permission on the specified domain or DOMAIN_REPORTER[LIST] permission on the specified environment or DOMAIN_REPORTER[LIST] permission on the specified organization. Except if user has DOMAIN_REPORTER[READ] permission on the domain, environment or organization, each returned reporter is filtered and contains only basic information such as id and name and type.
      operationId: listDomainReporters
      parameters:
      - name: organizationId
        in: path
        required: true
        schema:
          type: string
      - name: environmentId
        in: path
        required: true
        schema:
          type: string
      - name: domain
        in: path
        required: true
        schema:
          type: string
      - name: userProvider
        in: query
        schema:
          type: boolean
      responses:
        '200':
          description: List registered reporters for a security domain
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Reporter'
        '500':
          description: Internal server error
    post:
      tags:
      - reporter
      summary: Create a reporter for a security domain
      description: User must have the DOMAIN_REPORTER[CREATE] permission on the specified domain or DOMAIN_REPORTER[CREATE] permission on the specified environment or DOMAIN_REPORTER[CREATE] permission on the specified organization.
      operationId: createDomainReporter
      parameters:
      - name: organizationId
        in: path
        required: true
        schema:
          type: string
      - name: environmentId
        in: path
        required: true
        schema:
          type: string
      - name: domain
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NewReporter'
      responses:
        '201':
          description: Reporter created for a security domain
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Reporter'
        '500':
          description: Internal server error
  /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/reporters/{reporter}:
    get:
      tags:
      - reporter
      summary: Get a reporter
      description: User must have the DOMAIN_REPORTER[READ] permission on the specified domain or DOMAIN_REPORTER[READ] permission on the specified environment or DOMAIN_REPORTER[READ] permission on the specified organization
      operationId: getDomainReporter
      parameters:
      - name: organizationId
        in: path
        required: true
        schema:
          type: string
      - name: environmentId
        in: path
        required: true
        schema:
          type: string
      - name: domain
        in: path
        required: true
        schema:
          type: string
      - name: reporter
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Reporter successfully fetched
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Reporter'
        '500':
          description: Internal server error
    put:
      tags:
      - reporter
      summary: Update a reporter
      description: User must have the DOMAIN_REPORTER[UPDATE] permission on the specified domain or DOMAIN_REPORTER[UPDATE] permission on the specified environment or DOMAIN_REPORTER[UPDATE] permission on the specified organization
      operationId: updateDomainReporter
      parameters:
      - name: organizationId
        in: path
        required: true
        schema:
          type: string
      - name: environmentId
        in: path
        required: true
        schema:
          type: string
      - name: domain
        in: path
        required: true
        schema:
          type: string
      - name: reporter
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateReporter'
        required: true
      responses:
        '201':
          description: Reporter successfully updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Reporter'
        '500':
          description: Internal server error
    delete:
      tags:
      - reporter
      summary: Delete a reporter
      description: User must have the DOMAIN_REPORTER[DELETE] permission on the specified domain or DOMAIN_REPORTER[DELETE] permission on the specified environment or DOMAIN_REPORTER[DELETE] permission on the specified organization
      operationId: deleteDomainReporter
      parameters:
      - name: organizationId
        in: path
        required: true
        schema:
          type: string
      - name: environmentId
        in: path
        required: true
        schema:
          type: string
      - name: domain
        in: path
        required: true
        schema:
          type: string
      - name: reporter
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Reporter successfully removed
          content:
            application/json: {}
        '500':
          description: Internal server error
  /organizations/{organizationId}/reporters:
    get:
      tags:
      - reporter
      summary: List registered reporters for a security domain
      description: User must have the ORGANIZATION_REPORTER[LIST] permission on the specified organization. Except if user has ORGANIZATION_REPORTER[READ] permission on the organization, each returned reporter is filtered and contains only basic information such as id and name and type.
      operationId: getOrgReporters
      parameters:
      - name: organizationId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: List registered reporters for an organization
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Reporter'
        '500':
          description: Internal server error
    post:
      tags:
      - reporter
      summary: Create a reporter for an organization
      description: User must have the ORGANIZATION_REPORTER[CREATE] permission on the specified organization
      operationId: createOrgReporter
      parameters:
      - name: organizationId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NewReporter'
      responses:
        '201':
          description: Reporter created for a security domain
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Reporter'
        '500':
          description: Internal server error
  /organizations/{organizationId}/reporters/{reporterId}:
    get:
      tags:
      - reporter
      summary: Get a reporter
      description: User must have the ORGANIZATION_REPORTER[READ] permission on the organization
      operationId: getOrgReporter
      parameters:
      - name: organizationId
        in: path
        required: true
        schema:
          type: string
      - name: reporterId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Reporter successfully fetched
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Reporter'
        '500':
          description: Internal server error
    put:
      tags:
      - reporter
      summary: Update a reporter
      description: User must have the ORGANIZATION_REPORTER[UPDATE] permission on the specified organization
      operationId: updateOrgReporter
      parameters:
      - name: organizationId
        in: path
        required: true
        schema:
          type: string
      - name: reporterId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateReporter'
        required: true
      responses:
        '201':
          description: Reporter successfully updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Reporter'
        '500':
          description: Internal server error
    delete:
      tags:
      - reporter
      summary: Delete a reporter
      description: User must have the ORGANIZATION_REPORTER[DELETE] permission on the specified organization
      operationId: deleteOrgReporter
      parameters:
      - name: organizationId
        in: path
        required: true
        schema:
          type: string
      - name: reporterId
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Reporter successfully removed
          content:
            application/json: {}
        '500':
          description: Internal server error
components:
  schemas:
    Reporter:
      type: object
      properties:
        configuration:
          type: string
        createdAt:
          type: string
          format: date-time
        dataType:
          type: string
        enabled:
          type: boolean
        id:
          type: string
        inherited:
          type: boolean
        name:
          type: string
        reference:
          $ref: '#/components/schemas/Reference'
        system:
          type: boolean
        type:
          type: string
        updatedAt:
          type: string
          format: date-time
    UpdateReporter:
      required:
      - configuration
      - name
      - type
      type: object
      properties:
        configuration:
          type: string
        enabled:
          type: boolean
        inherited:
          type: boolean
        name:
          type: string
        type:
          minLength: 1
          type: string
    NewReporter:
      required:
      - configuration
      - name
      - type
      type: object
      properties:
        configuration:
          type: string
        enabled:
          type: boolean
        id:
          type: string
        inherited:
          type: boolean
        name:
          type: string
        type:
          type: string
    Reference:
      type: object
      properties:
        id:
          type: string
        type:
          type: string
          enum:
          - PLATFORM
          - DOMAIN
          - APPLICATION
          - ORGANIZATION
          - ENVIRONMENT
          - PROTECTED_RESOURCE
  securitySchemes:
    gravitee-auth:
      type: http
      scheme: Bearer