Plugins

Get a Datakit plugin

Get a Datakit plugin

get/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#Datakit

Response

Datakit plugin

conditionstring nullable

An expression used for conditional control over plugin execution. If the expression evaluates to true during the request flow, the plugin is executed; otherwise, it is skipped.

created_atinteger nullable

Unix epoch when the resource was created.

enabledboolean nullable

Whether the plugin is applied.

idstring nullable

A string representing a UUID (universally unique identifier).

instance_namestring nullable

A unique string representing a UTF-8 encoded name.

name'datakit' required

The name of the Plugin that's going to be added. Currently, the Plugin must be installed in every Kong instance separately.

tagsstring[] nullable

An optional set of strings associated with the Plugin for grouping and filtering.

updated_atinteger nullable

Unix epoch when the resource was last updated.

protocolsstring[]

A set of strings representing HTTP protocols.

Changes

Changed in 10 of the 52 revisions of this API.1819

    • added the optional property allOf[DatakitPluginConfig]/config/nodes/items/oneOf[subschema #10: property]/non_nil to the response with the 200 status

      response-optional-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 4a39c7f8550911See the full diff
    • the allOf[DatakitPluginConfig]/config/resources/cache/redis/port response's property type/format changed from integer/ to string/ for status 200

      response-property-type-changed

    • the port response's property default value changed from 6379 to 6379 for the status 200

      response-property-default-value-changed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • the response property allOf[PluginBase]/partials/items/path became required for the status 200

      response-property-became-required

  • 7d6a643707d913See the full diff
    • added subschema #7: jwt_decode subschema #8: jwt_sign subschema #9: jwt_verify to the allOf[DatakitPluginConfig]/config/nodes/items/ response property oneOf list for the response status 200

      response-property-one-of-added

    • added the optional property allOf[DatakitPluginConfig]/config/nodes/items/oneOf[subschema #3: call]/outputs/raw_body to the response with the 200 status

      response-optional-property-added

    • added the optional property allOf[PluginBase]/condition to the response with the 200 status

      response-optional-property-added

    • the ssl_verify response's property default value true was added for the status 200

      response-property-default-value-added

    • the response property allOf[DatakitPluginConfig]/config/nodes/items/oneOf[subschema #8: static]/values became required for the status 200

      response-property-became-required

  • ad02b4e24eb267See the full diff
    • the response property allOf[DatakitPluginConfig]/config/nodes/items/oneOf[subschema #3: call]/url became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[DatakitPluginConfig]/config/nodes/items/oneOf[subschema #7: static -> subschema #8: static]/values became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[DatakitPluginConfig]/config/nodes/items/oneOf[subschema #3: call]/url became optional for the status 200

      response-property-became-optional

    • the response property allOf[DatakitPluginConfig]/config/nodes/items/oneOf[subschema #7: static -> subschema #8: static]/values became optional for the status 200

      response-property-became-optional

    • added subschema #6: json_to_xml subschema #9: xml_to_json to the allOf[DatakitPluginConfig]/config/nodes/items/ response property oneOf list for the response status 200

      response-property-one-of-added

    • the allOf[DatakitPluginConfig]/config/nodes/items/oneOf[subschema #7: static -> subschema #8: static]/values response's property type/format changed from string/ to object/ for status 200

      response-property-type-changed

    • added the optional property allOf[DatakitPluginConfig]/config/nodes/items/oneOf[subschema #3: call]/inputs/http_proxy to the response with the 200 status

      response-optional-property-added

    • added the optional property allOf[DatakitPluginConfig]/config/nodes/items/oneOf[subschema #3: call]/inputs/https_proxy to the response with the 200 status

      response-optional-property-added

    • added the optional property allOf[DatakitPluginConfig]/config/nodes/items/oneOf[subschema #3: call]/inputs/proxy_auth_password to the response with the 200 status

      response-optional-property-added

    • added the optional property allOf[DatakitPluginConfig]/config/nodes/items/oneOf[subschema #3: call]/inputs/proxy_auth_username to the response with the 200 status

      response-optional-property-added

    • added the optional property allOf[DatakitPluginConfig]/config/nodes/items/oneOf[subschema #3: call]/inputs/url to the response with the 200 status

      response-optional-property-added

    • added the optional property allOf[DatakitPluginConfig]/config/nodes/items/oneOf[subschema #3: call]/ssl_verify to the response with the 200 status

      response-optional-property-added

    • added the optional property allOf[DatakitPluginConfig]/config/resources/cache/redis/cloud_authentication to the response with the 200 status

      response-optional-property-added

    • the response property allOf[DatakitPluginConfig]/config/nodes/items/oneOf[subschema #5: jq]/inputs became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[DatakitPluginConfig]/config/nodes/items/oneOf[subschema #7: static]/outputs became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[DatakitPluginConfig]/config/resources/vault became nullable for the status 200

      response-property-became-nullable

  • 19e869275e2851See the full diff
    • added subschema #1: branch subschema #2: cache subschema #3: call subschema #4: exit subschema #5: jq subschema #6: property subschema #7: static to the allOf[DatakitPluginConfig]/config/nodes/items/ response property oneOf list for the response status 200

      response-property-one-of-added

    • the allOf[DatakitPluginConfig]/config/nodes/items/ response's property type/format changed from object/ to / for status 200

      response-property-type-changed

    • the allOf[DatakitPluginConfig]/name response's property type/format changed from string/ to / for status 200

      response-property-type-changed

    • removed the required property allOf[DatakitPluginConfig]/config/nodes/items/name from the response with the 200 status

      response-required-property-removed

    • removed the required property allOf[DatakitPluginConfig]/config/nodes/items/type from the response with the 200 status

      response-required-property-removed

    • added the optional property allOf[DatakitPluginConfig]/config/resources to the response with the 200 status

      response-optional-property-added

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 96118a9cd7f423See the full diff
    • the response property allOf[PluginBase]/partials/items/name became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[PluginBase]/partials/items/path became nullable for the status 200

      response-property-became-nullable

    • the debug response's property default value false was added for the status 200

      response-property-default-value-added

    • the enabled response's property default value true was added for the status 200

      response-property-default-value-added

    • the protocols response's property default value grpc grpcs http https was added for the status 200

      response-property-default-value-added

    This revision also has 7 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • endpoint added

      endpoint-added