Gravitee Logs API

openapi: 3.2.0
info:
  title: Gravitee.io APIM Management Logs API
  description: 'The Gravitee API Management (APIM) Management API is the administrative

    control plane for the Gravitee platform. It exposes endpoints to create

    and deploy APIs (both v2 "Gravitee definition v2" and v4 message-oriented

    APIs), manage plans, applications, subscriptions, API products,

    analytics, logs, users, plugins, UI customization, environments, and

    organization-level installation.


    This consolidated specification is synthesized from the upstream v2

    OpenAPI fragments in `gravitee-apim-rest-api-management-v2-rest`

    (`openapi-apis.yaml`, `openapi-environments.yaml`,

    `openapi-analytics.yaml`, `openapi-api-products.yaml`,

    `openapi-installation.yaml`, `openapi-plugins.yaml`,

    `openapi-users.yaml`, `openapi-logs.yaml`, `openapi-ui.yaml`).'
  contact:
    name: GraviteeSource Team
    url: https://gravitee.io
    email: team-apim@graviteesource.com
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  version: 2.0.0
servers:
- url: https://{host}/management/v2
  description: APIM Management API v2 - default base URL
  variables:
    host:
      default: apim.example.com
      description: Hostname of the Gravitee APIM Management API
- url: https://{host}/management/v2/organizations/{orgId}
  description: APIM Management API v2 - per-organization base URL
  variables:
    host:
      default: apim.example.com
    orgId:
      default: DEFAULT
security:
- BasicAuth: []
- CookieAuth: []
- BearerAuth: []
tags:
- name: Logs
  description: Search request and error logs
paths:
  /environments/{envId}/logs/search:
    post:
      tags:
      - Logs
      operationId: searchLogs
      summary: Search Request Logs
      parameters:
      - $ref: '#/components/parameters/EnvId'
      responses:
        '200':
          description: Logs page
  /environments/{envId}/logs/error-keys:
    get:
      tags:
      - Logs
      operationId: listErrorKeys
      summary: List Error Keys for Logs
      parameters:
      - $ref: '#/components/parameters/EnvId'
      responses:
        '200':
          description: Error keys
components:
  parameters:
    EnvId:
      in: path
      name: envId
      required: true
      schema:
        type: string
      description: The environment identifier
  securitySchemes:
    BasicAuth:
      type: http
      scheme: basic
    CookieAuth:
      type: apiKey
      in: cookie
      name: Auth-Graviteeio-APIM
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT