Gravitee

Gravitee preview API

The preview API from Gravitee — 1 operation(s) for preview.

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-preview-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 preview API
  version: 4.12.0-alpha.3
servers:
- url: /management
security:
- gravitee-auth: []
tags:
- name: preview
paths:
  /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/forms/preview:
    post:
      tags:
      - preview
      summary: Render the provided template
      description: User must have the DOMAIN_THEME[READ] permission on the specified domain or DOMAIN_THEME[READ] permission on the specified environment or DOMAIN_THEME[READ] permission on the specified organization
      operationId: renderDomainTemplate
      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/PreviewRequest'
        required: true
      responses:
        '200':
          description: Template successfully rendered
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PreviewResponse'
        '500':
          description: Internal server error
components:
  schemas:
    PreviewRequest:
      required:
      - template
      - type
      type: object
      properties:
        content:
          type: string
        template:
          type: string
        theme:
          $ref: '#/components/schemas/Theme'
        type:
          type: string
          enum:
          - EMAIL
          - FORM
    Theme:
      type: object
      properties:
        createdAt:
          type: string
          format: date-time
        css:
          type: string
        faviconUrl:
          type: string
        id:
          type: string
        logoUrl:
          type: string
        logoWidth:
          type: integer
          format: int32
        primaryButtonColorHex:
          type: string
        primaryTextColorHex:
          type: string
        referenceId:
          type: string
        referenceType:
          type: string
          enum:
          - PLATFORM
          - DOMAIN
          - APPLICATION
          - ORGANIZATION
          - ENVIRONMENT
          - PROTECTED_RESOURCE
        secondaryButtonColorHex:
          type: string
        secondaryTextColorHex:
          type: string
        updatedAt:
          type: string
          format: date-time
    PreviewResponse:
      type: object
      properties:
        content:
          type: string
        template:
          type: string
        type:
          type: string
          enum:
          - EMAIL
          - FORM
  securitySchemes:
    gravitee-auth:
      type: http
      scheme: Bearer