Kong Service Virtualization Configuration

Configuration

This plugin is compatible with DB-less mode.

Parameters

Here's a list of all the parameters which can be used in this plugin's configuration:

• name

  string required

  The name of the plugin, in this case kong-service-virtualization.

• instance_name

  string

  An optional custom name to identify an instance of the plugin, for example kong-service-virtualization_my-service. Useful when running the same plugin in multiple contexts, for example, on multiple services.

• service.name or service.id

  string

  The name or ID of the service the plugin targets. Set one of these parameters if adding the plugin to a service through the top-level /plugins endpoint. Not required if using /services/SERVICE_NAME|ID/plugins.

• route.name or route.id

  string

  The name or ID of the route the plugin targets. Set one of these parameters if adding the plugin to a route through the top-level /plugins endpoint. Not required if using /routes/ROUTE_NAME|ID/plugins.

• enabled

  boolean default: true

  Whether this plugin will be applied.

• api_id

  string

  The ID of the API the plugin targets.
  
  Note: The API Entity is deprecated in favor of Services since CE 0.13.0 and EE 0.32.

• config

  record required
  • virtual_tests

    array of type record required

    A JSON array as string representation of the plugin’s configurable fields.

    • name

      string required

      Represents a human readable test case name.

    • requestHttpMethod

      string required

      Represents the HTTP method associated to the virtual request.

    • requestHash

      string required

      Represents the Sha256 of the HTTP Body or QUERY Parameters of your request.

    • responseHttpStatus

      number required

      Represents the HTTP response to send consumers after successful virtual match.

    • responseContentType

      string required

      Represents the Content-Type of the HTTP response after successful virtual request match.

    • response

      string required

      Represents the Base64 encoded virtual response to send after successful virtual request match.