Tyk · JSON Structure

Tyk Gateway Custom Plugin Structure

Type: object Properties: 5
API GatewayAPI ManagementGraphQLOpen Source

CustomPlugin is a JSON Structure definition published by Tyk, describing 5 properties. It conforms to the https://json-structure.org/draft/2020-12/schema meta-schema.

Properties

enabled functionName path rawBodyOnly requireSession

Meta-schema: https://json-structure.org/draft/2020-12/schema

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/draft/2020-12/schema",
  "name": "CustomPlugin",
  "type": "object",
  "properties": {
    "enabled": {
      "type": "boolean"
    },
    "functionName": {
      "type": "string"
    },
    "path": {
      "type": "string"
    },
    "rawBodyOnly": {
      "type": "boolean"
    },
    "requireSession": {
      "type": "boolean"
    }
  }
}