GRgravitee-io
Subscription Forms

Enable subscription form

Changed on

Enable the subscription form to make it visible to API consumers in the Developer Portal. When enabled, the form will be displayed during the API subscription process.

This operation is idempotent - enabling an already enabled form returns success.

User must have the ENVIRONMENT_SETTINGS[UPDATE] permission.

post/subscription-forms/{subscriptionFormId}/_enable

Request

  • Base URL
    /management/v2/environments/DEFAULT (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /management/v2/environments/DEFAULT/subscription-forms/{subscriptionFormId}/_enable
  • Auth
    • HTTP basic
    • or API key in cookie Auth-Graviteeio-APIM

Path parameters

subscriptionFormIdstring uuid required

The unique ID of the subscription form

Response

Subscription form enabled successfully

idstring uuid required

Unique identifier of the subscription form

gmdContentstring required

Gravitee Markdown (GMD) content defining the form. Supports form components like gmd-input, gmd-textarea, gmd-select, gmd-checkbox, gmd-radio.

enabledboolean required

Whether the form is enabled and visible to API consumers in the Developer Portal

resolvedOptionsobject

Resolved option lists for fields that use EL expressions. Keys are field keys; values are the effective option lists (fallback values when no API context is available). Present only when at least one field has dynamic options.

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "gmdContent": "# Subscription Information\n\n<gmd-input name=\"consumer_company_name\" label=\"Company Name\" required=\"true\"/>\n<gmd-textarea name=\"consumer_use_case\" label=\"Use Case\" required=\"true\"/>\n"
}

Changes