Sign in
Plugins

Create a Datakit plugin

Create a Datakit plugin

post/{workspace}/plugins#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

Created 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 4 of the 11 revisions of this API.9428

  • 28b1f8a59cdc2See 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 201 status

      response-optional-property-added

  • 9555cbb8b259422See the full diff
    • ▲

      the allOf[DatakitPluginConfig]/config/nodes/items/oneOf[subschema #7: static -> subschema #11: 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 optional for the status 201

      response-property-became-optional

    • ▲

      added subschema #6: json_to_xml subschema #7: jwt_decode subschema #8: jwt_sign subschema #9: jwt_verify subschema #12: xml_to_json to the allOf[DatakitPluginConfig]/config/nodes/items/ response property oneOf list for the response status 201

      response-property-one-of-added

    • ▲

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

      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]/outputs/raw_body

      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

    • ○

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

      new-optional-request-property

    • ○

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

      request-property-became-optional

    • ○

      the ssl_verify request property default value changed from false to true

      request-property-default-value-changed

    • ○

      added subschema #6: json_to_xml subschema #7: jwt_decode subschema #8: jwt_sign subschema #9: jwt_verify subschema #12: 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 201 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 201 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 201 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 201 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 201 status

      response-optional-property-added

    • ○

      added the optional property allOf[DatakitPluginConfig]/config/nodes/items/oneOf[subschema #3: call]/outputs/raw_body to the response with the 201 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 201 status

      response-optional-property-added

    • ○

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

      response-optional-property-added

    • ○

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

      response-optional-property-added

    • ○

      the ssl_verify response's property default value changed from false to true for the status 201

      response-property-default-value-changed

  • 65f3141f1662543See the full diff
    • ▲

      the allOf[DatakitPluginConfig]/config/nodes/items/ request property type/format changed from object/ 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 201

      response-property-one-of-added

    • ▲

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

      response-property-type-changed

    • ▲

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

      response-required-property-removed

    • ▲

      removed the required property allOf[DatakitPluginConfig]/config/nodes/items/type from the response with the 201 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

    • ●

      removed the request property name

      request-property-removed

    • ●

      removed the optional property name from the response with the 201 status

      response-optional-property-removed

    • ○

      added the new optional request property allOf[DatakitPluginConfig]/name

      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]/name to the response with the 201 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

  • 740b73588ef41See the full diff
    • ○

      endpoint added

      endpoint-added

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

Of the 11 revisions, 1 has no diff computed.