Sign in
Plugins

Update a Datakit plugin

Update a Datakit plugin

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

Request body

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.

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 11 of the 52 revisions of this API.31247

  • 36da5cb9a6742See the full diff
    • ○

      added the new optional request property allOf[DatakitPluginConfig]/config/nodes/items/oneOf[subschema #10: property]/non_nil

      new-optional-request-property

    • ○

      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

  • 4a39c7f8550922See the full diff
    • ▲

      the allOf[DatakitPluginConfig]/config/resources/cache/redis/port request property type/format changed from integer/ to string/

      request-property-type-changed

    • ▲

      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 request property default value changed from 6379 to 6379

      request-property-default-value-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

  • 62c54f1094bb11See the full diff
    • ▲

      the request property allOf[PluginBase]/partials/items/path became required

      request-property-became-required

    • ○

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

      response-property-became-required

  • 7d6a643707d927See the full diff
    • ▲

      the request property allOf[DatakitPluginConfig]/config/nodes/items/oneOf[subschema #3: call]/ssl_verify became not nullable

      request-property-became-not-nullable

    • ▲

      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 new optional request property allOf[DatakitPluginConfig]/config/nodes/items/oneOf[subschema #3: call]/outputs/raw_body

      new-optional-request-property

    • ○

      added the new optional request property allOf[PluginBase]/condition

      new-optional-request-property

    • ○

      the ssl_verify request property default value true was added

      request-property-default-value-added

    • ○

      added subschema #7: jwt_decode subschema #8: jwt_sign subschema #9: jwt_verify to the allOf[DatakitPluginConfig]/config/nodes/items/ request property oneOf list

      request-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

  • 2eb528e691a221See the full diff
    • ▲

      the request property allOf[DatakitPluginConfig]/config/nodes/items/oneOf[subschema #8: static]/values became not nullable

      request-property-became-not-nullable

    • ▲

      the request property allOf[DatakitPluginConfig]/config/nodes/items/oneOf[subschema #8: static]/values became required

      request-property-became-required

    • ○

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

      response-property-became-required

  • ad02b4e24eb2719See the full diff
    • ▲

      the allOf[DatakitPluginConfig]/config/nodes/items/oneOf[subschema #7: static -> subschema #8: static]/values request property type/format changed from string/ to object/

      request-property-type-changed

    • ▲

      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 new optional request property allOf[DatakitPluginConfig]/config/nodes/items/oneOf[subschema #3: call]/inputs/http_proxy

      new-optional-request-property

    • ○

      added the new optional request property allOf[DatakitPluginConfig]/config/nodes/items/oneOf[subschema #3: call]/inputs/https_proxy

      new-optional-request-property

    • ○

      added the new optional request property allOf[DatakitPluginConfig]/config/nodes/items/oneOf[subschema #3: call]/inputs/proxy_auth_password

      new-optional-request-property

    • ○

      added the new optional request property allOf[DatakitPluginConfig]/config/nodes/items/oneOf[subschema #3: call]/inputs/proxy_auth_username

      new-optional-request-property

    • ○

      added the new optional request property allOf[DatakitPluginConfig]/config/nodes/items/oneOf[subschema #3: call]/inputs/url

      new-optional-request-property

    • ○

      added the new optional request property allOf[DatakitPluginConfig]/config/nodes/items/oneOf[subschema #3: call]/ssl_verify

      new-optional-request-property

    • ○

      added the new optional request property allOf[DatakitPluginConfig]/config/resources/cache/redis/cloud_authentication

      new-optional-request-property

    • ○

      the request property allOf[DatakitPluginConfig]/config/nodes/items/oneOf[subschema #3: call]/url became nullable

      request-property-became-nullable

    • ○

      the request property allOf[DatakitPluginConfig]/config/nodes/items/oneOf[subschema #7: static -> subschema #8: static]/values became nullable

      request-property-became-nullable

    • ○

      the request property allOf[DatakitPluginConfig]/config/nodes/items/oneOf[subschema #3: call]/url became optional

      request-property-became-optional

    • ○

      the request property allOf[DatakitPluginConfig]/config/nodes/items/oneOf[subschema #7: static -> subschema #8: static]/values became optional

      request-property-became-optional

    • ○

      added subschema #6: json_to_xml subschema #9: xml_to_json to the allOf[DatakitPluginConfig]/config/nodes/items/ request property oneOf list

      request-property-one-of-added

    • ○

      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

  • 28774c89f2cb33See the full diff
    • ▲

      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

    • ○

      the request property allOf[DatakitPluginConfig]/config/nodes/items/oneOf[subschema #5: jq]/inputs became nullable

      request-property-became-nullable

    • ○

      the request property allOf[DatakitPluginConfig]/config/nodes/items/oneOf[subschema #7: static]/outputs became nullable

      request-property-became-nullable

    • ○

      the request property allOf[DatakitPluginConfig]/config/resources/vault became nullable

      request-property-became-nullable

  • 19e869275e28723See the full diff
    • ▲

      the allOf[DatakitPluginConfig]/config/nodes/items/ request property type/format changed from object/ to /

      request-property-type-changed

    • ▲

      the allOf[DatakitPluginConfig]/name request property type/format changed from string/ to /

      request-property-type-changed

    • ▲

      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

    • ●

      removed the request property allOf[DatakitPluginConfig]/config/nodes/items/name

      request-property-removed

    • ●

      removed the request property allOf[DatakitPluginConfig]/config/nodes/items/type

      request-property-removed

    • ○

      added the new optional request property allOf[DatakitPluginConfig]/config/resources

      new-optional-request-property

    • ○

      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/ request property oneOf list

      request-property-one-of-added

    • ○

      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

  • f030590166225See the full diff
    • ▲

      the request property allOf[PluginBase]/partials/items/name became not nullable

      request-property-became-not-nullable

    • ▲

      the request property allOf[PluginBase]/partials/items/path became not nullable

      request-property-became-not-nullable

    • ▲

      the allOf[PluginBase]/id request property's minLength was increased from 0 to 1

      request-property-min-length-increased

    • ▲

      the allOf[PluginBase]/name request property's minLength was increased from 0 to 1

      request-property-min-length-increased

    • ▲

      the allOf[PluginBase]/partials/items/id request property's minLength was increased from 0 to 1

      request-property-min-length-increased

  • 96118a9cd7f428See 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 request property allOf[PluginBase]/partials/items/name became nullable

      request-property-became-nullable

    • ○

      the request property allOf[PluginBase]/partials/items/path became nullable

      request-property-became-nullable

    • ○

      the debug request property default value false was added

      request-property-default-value-added

    • ○

      the enabled request property default value true was added

      request-property-default-value-added

    • ○

      the protocols request property default value grpc grpcs http https was added

      request-property-default-value-added

    • ○

      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