Plugins

Create a Syslog plugin

Create a Syslog plugin

post/v2/control-planes/{controlPlaneId}/core-entities/plugins#Syslog

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'syslog' 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 protocols.

Response

Created Syslog 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'syslog' 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 protocols.

Changes

Changed in 15 of the 52 revisions of this API.27269

  • 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 201

      response-property-became-required

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

      new-optional-request-property

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

      response-optional-property-added

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

      request-property-type-changed

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

      response-property-type-changed

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

    • 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

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

      response-property-became-nullable

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

      response-property-became-nullable

    • the response property allOf[SyslogPluginConfig]/config became nullable for the status 201

      response-property-became-nullable

    • the response property allOf[SyslogPluginConfig]/config/custom_fields_by_lua became nullable for the status 201

      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 request property allOf[SyslogPluginConfig]/config became nullable

      request-property-became-nullable

    • the request property allOf[SyslogPluginConfig]/config/custom_fields_by_lua became nullable

      request-property-became-nullable

    • the client_errors_severity request property default value info was added

      request-property-default-value-added

    • the enabled request property default value true was added

      request-property-default-value-added

    • the facility request property default value user was added

      request-property-default-value-added

    • the log_level request property default value info 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 server_errors_severity request property default value info was added

      request-property-default-value-added

    • the successful_severity request property default value info was added

      request-property-default-value-added

    • the client_errors_severity response's property default value info was added for the status 201

      response-property-default-value-added

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

      response-property-default-value-added

    • the facility response's property default value user was added for the status 201

      response-property-default-value-added

    • the log_level response's property default value info was added for the status 201

      response-property-default-value-added

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

      response-property-default-value-added

    • the server_errors_severity response's property default value info was added for the status 201

      response-property-default-value-added

    • the successful_severity response's property default value info was added for the status 201

      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

  • 2c77aeaee5fb11See the full diff
    • the response property allOf[PluginBase]/tags became nullable for the status 201

      response-property-became-nullable

    • the request property allOf[PluginBase]/tags became nullable

      request-property-became-nullable

    • the allOf[SyslogPluginConfig]/protocols request property type/format changed from array/ to array/set

      request-property-type-changed

    • the allOf[SyslogPluginConfig]/protocols response's property type/format changed from array/ to array/set for status 201

      response-property-type-changed

    • added the new optional request property allOf[PluginBase]/partials

      new-optional-request-property

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

      response-optional-property-added

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

  • fc6abbc537f326See the full diff
    • the response property allOf[PluginBase]/created_at became nullable for the status 201

      response-property-became-nullable

    • the response property allOf[PluginBase]/updated_at became nullable for the status 201

      response-property-became-nullable

    • the request optional property allOf[PluginBase]/created_at became not read-only

      request-optional-property-became-not-read-only

    • the request optional property allOf[PluginBase]/updated_at became not read-only

      request-optional-property-became-not-read-only

    • the request property allOf[PluginBase]/created_at became nullable

      request-property-became-nullable

    • the request property allOf[PluginBase]/updated_at became nullable

      request-property-became-nullable

    • the response optional property allOf[PluginBase]/created_at became not read-only for the status 201

      response-optional-property-became-not-read-only

    • the response optional property allOf[PluginBase]/updated_at became not read-only for the status 201

      response-optional-property-became-not-read-only

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

    • the response property allOf[SyslogPluginConfig]/consumer became nullable for the status 201

      response-property-became-nullable

    • the response property allOf[SyslogPluginConfig]/route became nullable for the status 201

      response-property-became-nullable

    • the response property allOf[SyslogPluginConfig]/service became nullable for the status 201

      response-property-became-nullable

    • the request property allOf[SyslogPluginConfig]/consumer became nullable

      request-property-became-nullable

    • the request property allOf[SyslogPluginConfig]/route became nullable

      request-property-became-nullable

    • the request property allOf[SyslogPluginConfig]/service became nullable

      request-property-became-nullable

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