Gravitee

Gravitee Plans API

Manage plans (Keyless, API Key, OAuth2, JWT, mTLS, Push)

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-plans-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 Plans API
  version: 4.12.0-alpha.3
  description: Manage plans (Keyless, API Key, OAuth2, JWT, mTLS, Push)
servers:
- url: /management
security:
- gravitee-auth: []
tags:
- name: Plans
  description: Manage plans (Keyless, API Key, OAuth2, JWT, mTLS, Push)
paths:
  /environments/{envId}/apis/{apiId}/plans:
    get:
      tags:
      - Plans
      operationId: listApiPlans
      summary: List Plans on an API
      parameters:
      - $ref: '#/components/parameters/EnvId'
      - $ref: '#/components/parameters/ApiId'
      responses:
        '200':
          description: Plans page
    post:
      tags:
      - Plans
      operationId: createApiPlan
      summary: Create a Plan on an API
      parameters:
      - $ref: '#/components/parameters/EnvId'
      - $ref: '#/components/parameters/ApiId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Plan'
      responses:
        '201':
          description: Plan created
  /environments/{envId}/apis/{apiId}/plans/{planId}:
    get:
      tags:
      - Plans
      operationId: getApiPlan
      summary: Get a Plan by Identifier
      parameters:
      - $ref: '#/components/parameters/EnvId'
      - $ref: '#/components/parameters/ApiId'
      - in: path
        name: planId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The plan
    put:
      tags:
      - Plans
      operationId: updateApiPlan
      summary: Update a Plan
      parameters:
      - $ref: '#/components/parameters/EnvId'
      - $ref: '#/components/parameters/ApiId'
      - in: path
        name: planId
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Plan'
      responses:
        '200':
          description: Plan updated
  /environments/{envId}/apis/{apiId}/plans/{planId}/_publish:
    post:
      tags:
      - Plans
      operationId: publishApiPlan
      summary: Publish a Plan
      parameters:
      - $ref: '#/components/parameters/EnvId'
      - $ref: '#/components/parameters/ApiId'
      - in: path
        name: planId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Plan published
  /environments/{envId}/apis/{apiId}/plans/{planId}/_close:
    post:
      tags:
      - Plans
      operationId: closeApiPlan
      summary: Close a Plan
      parameters:
      - $ref: '#/components/parameters/EnvId'
      - $ref: '#/components/parameters/ApiId'
      - in: path
        name: planId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Plan closed
components:
  schemas:
    Plan:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        description:
          type: string
        security:
          type: object
          properties:
            type:
              type: string
              enum:
              - KEY_LESS
              - API_KEY
              - OAUTH2
              - JWT
              - MTLS
              - SUBSCRIPTION
              - PUSH
            configuration:
              type: object
        status:
          type: string
          enum:
          - STAGING
          - PUBLISHED
          - DEPRECATED
          - CLOSED
        validation:
          type: string
          enum:
          - MANUAL
          - AUTO
        order:
          type: integer
        characteristics:
          type: array
          items:
            type: string
  parameters:
    EnvId:
      in: path
      name: envId
      required: true
      schema:
        type: string
      description: The environment identifier
    ApiId:
      in: path
      name: apiId
      required: true
      schema:
        type: string
      description: The API identifier
  securitySchemes:
    gravitee-auth:
      type: http
      scheme: Bearer