Gravitee

Gravitee Subscriptions API

Manage subscriptions between applications and plans

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-subscriptions-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 Subscriptions API
  version: 4.12.0-alpha.3
  description: Manage subscriptions between applications and plans
servers:
- url: /management
security:
- gravitee-auth: []
tags:
- name: Subscriptions
  description: Manage subscriptions between applications and plans
paths:
  /environments/{envId}/apis/{apiId}/subscriptions:
    get:
      tags:
      - Subscriptions
      operationId: listApiSubscriptions
      summary: List Subscriptions for an API
      parameters:
      - $ref: '#/components/parameters/EnvId'
      - $ref: '#/components/parameters/ApiId'
      responses:
        '200':
          description: Subscriptions page
  /environments/{envId}/subscriptions:
    get:
      tags:
      - Subscriptions
      operationId: listSubscriptions
      summary: List Subscriptions
      parameters:
      - $ref: '#/components/parameters/EnvId'
      responses:
        '200':
          description: Subscriptions page
    post:
      tags:
      - Subscriptions
      operationId: createSubscription
      summary: Create a Subscription
      parameters:
      - $ref: '#/components/parameters/EnvId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Subscription'
      responses:
        '201':
          description: Subscription created
  /environments/{envId}/subscriptions/{subscriptionId}:
    get:
      tags:
      - Subscriptions
      operationId: getSubscription
      summary: Get a Subscription
      parameters:
      - $ref: '#/components/parameters/EnvId'
      - in: path
        name: subscriptionId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The subscription
  /environments/{envId}/subscriptions/{subscriptionId}/_accept:
    post:
      tags:
      - Subscriptions
      operationId: acceptSubscription
      summary: Accept a Subscription
      parameters:
      - $ref: '#/components/parameters/EnvId'
      - in: path
        name: subscriptionId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Subscription accepted
  /environments/{envId}/subscriptions/{subscriptionId}/_reject:
    post:
      tags:
      - Subscriptions
      operationId: rejectSubscription
      summary: Reject a Subscription
      parameters:
      - $ref: '#/components/parameters/EnvId'
      - in: path
        name: subscriptionId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Subscription rejected
components:
  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
  schemas:
    Subscription:
      type: object
      properties:
        id:
          type: string
        api:
          type: string
        plan:
          type: string
        application:
          type: string
        status:
          type: string
          enum:
          - PENDING
          - ACCEPTED
          - REJECTED
          - CLOSED
          - PAUSED
          - RESUMED
        createdAt:
          type: string
          format: date-time
        startingAt:
          type: string
          format: date-time
        endingAt:
          type: string
          format: date-time
  securitySchemes:
    gravitee-auth:
      type: http
      scheme: Bearer