Forms

List option presets

GET/option-presets
forms:readlist_option_presetsRead-only

Lists the reusable option lists, newest first, and returns one page. A dropdown field links to one with option_preset_id. Filter by filter[q] on the name. Use GET /option-presets/{id} for one preset. It changes nothing.

Query parameters

  • limitinteger#

    Page size (1–100). Defaults to 25; values are clamped to the range.

    Default: 25
  • cursorstring#

    Opaque pagination cursor taken from a prior response's meta.next_cursor.

  • fieldsstring#

    Comma-separated top-level fields to return. id is always returned.

  • sortstring#

    Comma-separated fields to sort by: created_at, updated_at or name. Prefix a field with - for descending. Defaults to -created_at. The preset id is always the final tiebreak.

  • filter[q]string#

    Presets whose name contains this text, ignoring case.

Responses

200

One page of option presets.

OptionPreset[]
{
  "data": [
    {
      "id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
      "name": "string",
      "description": "string",
      "items": [
        "string"
      ],
      "created_at": "2026-06-12T10:00:00+00:00",
      "updated_at": "2026-06-12T10:00:00+00:00"
    }
  ],
  "meta": {
    "limit": 1,
    "next_cursor": "string",
    "prev_cursor": "string"
  }
}
401

Authentication failed. error.code is one of invalid_token, expired, revoked.

Error
403

Authorization failed. error.code is one of org_disabled, ip_blocked, missing_scope, scope_disabled, user_disabled.

Error
422

The request can't be processed (HTTP 422): validation_failed with one ErrorDetail per problem, or a code documented on the operation.

Error
429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl https://your-org-domain/kong/core/api/v2/option-presets\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"