Sign in
Plugins

Create a SolaceUpstream plugin

Create a SolaceUpstream plugin

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

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'solace-upstream' 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 SolaceUpstream 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'solace-upstream' 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 9 of the 52 revisions of this API.24480

  • 36da5cb9a67413See the full diff
    • ●

      added the new CLIENT_CREDENTIALS enum value to the allOf[SolaceUpstreamPluginConfig]/config/session/authentication/scheme response property for the response status 201

      response-property-enum-value-added

    • ○

      added the new optional request property allOf[SolaceUpstreamPluginConfig]/config/session/authentication/client_credentials

      new-optional-request-property

    • ○

      added the new CLIENT_CREDENTIALS enum value to the request property allOf[SolaceUpstreamPluginConfig]/config/session/authentication/scheme

      request-property-enum-value-added

    • ○

      added the optional property allOf[SolaceUpstreamPluginConfig]/config/session/authentication/client_credentials 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

  • 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

  • 7d6a643707d910See the full diff
    • ○

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

      new-optional-request-property

    • ○

      added the new optional request property allOf[SolaceUpstreamPluginConfig]/config/message/content_encoding

      new-optional-request-property

    • ○

      added the new optional request property allOf[SolaceUpstreamPluginConfig]/config/message/content_type

      new-optional-request-property

    • ○

      added the new optional request property allOf[SolaceUpstreamPluginConfig]/config/message/forward_body_raw_only

      new-optional-request-property

    • ○

      added the new optional request property allOf[SolaceUpstreamPluginConfig]/config/message/user_properties

      new-optional-request-property

    • ○

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

      response-optional-property-added

    • ○

      added the optional property allOf[SolaceUpstreamPluginConfig]/config/message/content_encoding to the response with the 201 status

      response-optional-property-added

    • ○

      added the optional property allOf[SolaceUpstreamPluginConfig]/config/message/content_type to the response with the 201 status

      response-optional-property-added

    • ○

      added the optional property allOf[SolaceUpstreamPluginConfig]/config/message/forward_body_raw_only to the response with the 201 status

      response-optional-property-added

    • ○

      added the optional property allOf[SolaceUpstreamPluginConfig]/config/message/user_properties to the response with the 201 status

      response-optional-property-added

  • ad02b4e24eb22See the full diff
    • ○

      added the new optional request property allOf[SolaceUpstreamPluginConfig]/config/session/authentication/basic_auth_header

      new-optional-request-property

    • ○

      added the optional property allOf[SolaceUpstreamPluginConfig]/config/session/authentication/basic_auth_header to the response with the 201 status

      response-optional-property-added

  • 28774c89f2cb11See the full diff
    • ▲

      the response property allOf[SolaceUpstreamPluginConfig]/config/session/properties became nullable for the status 201

      response-property-became-nullable

    • ○

      the request property allOf[SolaceUpstreamPluginConfig]/config/session/properties became nullable

      request-property-became-nullable

  • 19e869275e284313See the full diff
    • ▲

      the request property allOf[SolaceUpstreamPluginConfig]/config/session/properties became not nullable

      request-property-became-not-nullable

    • ▲

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

      request-property-type-changed

    • ▲

      the response property allOf[SolaceUpstreamPluginConfig]/config/message/sender_id became nullable for the status 201

      response-property-became-nullable

    • ▲

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

      response-property-type-changed

    • ●

      the allOf[SolaceUpstreamPluginConfig]/config/session/authentication/password request property's maxLength was set to 128

      request-property-max-length-set

    • ●

      the allOf[SolaceUpstreamPluginConfig]/config/session/authentication/username request property's maxLength was set to 189

      request-property-max-length-set

    • ●

      the allOf[SolaceUpstreamPluginConfig]/config/session/vpn_name request property's maxLength was set to 32

      request-property-max-length-set

    • ○

      added the new optional request property allOf[SolaceUpstreamPluginConfig]/config/session/calculate_message_expiry

      new-optional-request-property

    • ○

      added the new optional request property allOf[SolaceUpstreamPluginConfig]/config/session/generate_rcv_timestamps

      new-optional-request-property

    • ○

      added the new optional request property allOf[SolaceUpstreamPluginConfig]/config/session/generate_send_timestamps

      new-optional-request-property

    • ○

      added the new optional request property allOf[SolaceUpstreamPluginConfig]/config/session/generate_sender_id

      new-optional-request-property

    • ○

      added the new optional request property allOf[SolaceUpstreamPluginConfig]/config/session/generate_sequence_number

      new-optional-request-property

    • ○

      the request property allOf[SolaceUpstreamPluginConfig]/config/message/sender_id became nullable

      request-property-became-nullable

    • ○

      the sender_id request property default value kong was removed

      request-property-default-value-removed

    • ○

      added the optional property allOf[SolaceUpstreamPluginConfig]/config/session/calculate_message_expiry to the response with the 201 status

      response-optional-property-added

    • ○

      added the optional property allOf[SolaceUpstreamPluginConfig]/config/session/generate_rcv_timestamps to the response with the 201 status

      response-optional-property-added

    • ○

      added the optional property allOf[SolaceUpstreamPluginConfig]/config/session/generate_send_timestamps to the response with the 201 status

      response-optional-property-added

    • ○

      added the optional property allOf[SolaceUpstreamPluginConfig]/config/session/generate_sender_id to the response with the 201 status

      response-optional-property-added

    • ○

      added the optional property allOf[SolaceUpstreamPluginConfig]/config/session/generate_sequence_number to the response with the 201 status

      response-optional-property-added

    • ○

      the sender_id response's property default value kong was removed for the status 201

      response-property-default-value-removed

    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

  • 96118a9cd7f41349See 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[SolaceUpstreamPluginConfig]/config/message/default_content became nullable for the status 201

      response-property-became-nullable

    • ▲

      the response property allOf[SolaceUpstreamPluginConfig]/config/message/functions became nullable for the status 201

      response-property-became-nullable

    • ▲

      the response property allOf[SolaceUpstreamPluginConfig]/config/session/authentication became nullable for the status 201

      response-property-became-nullable

    • ▲

      the response property allOf[SolaceUpstreamPluginConfig]/config/session/authentication/access_token became nullable for the status 201

      response-property-became-nullable

    • ▲

      the response property allOf[SolaceUpstreamPluginConfig]/config/session/authentication/access_token_header became nullable for the status 201

      response-property-became-nullable

    • ▲

      the response property allOf[SolaceUpstreamPluginConfig]/config/session/authentication/id_token became nullable for the status 201

      response-property-became-nullable

    • ▲

      the response property allOf[SolaceUpstreamPluginConfig]/config/session/authentication/id_token_header became nullable for the status 201

      response-property-became-nullable

    • ▲

      the response property allOf[SolaceUpstreamPluginConfig]/config/session/authentication/password became nullable for the status 201

      response-property-became-nullable

    • ▲

      the response property allOf[SolaceUpstreamPluginConfig]/config/session/authentication/username became nullable for the status 201

      response-property-became-nullable

    • ▲

      the response property allOf[SolaceUpstreamPluginConfig]/config/session/properties became nullable for the status 201

      response-property-became-nullable

    • ▲

      the response property allOf[SolaceUpstreamPluginConfig]/config/session/vpn_name 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[SolaceUpstreamPluginConfig]/config/message/default_content became nullable

      request-property-became-nullable

    • ○

      the request property allOf[SolaceUpstreamPluginConfig]/config/message/functions became nullable

      request-property-became-nullable

    • ○

      the request property allOf[SolaceUpstreamPluginConfig]/config/session/authentication became nullable

      request-property-became-nullable

    • ○

      the request property allOf[SolaceUpstreamPluginConfig]/config/session/authentication/access_token became nullable

      request-property-became-nullable

    • ○

      the request property allOf[SolaceUpstreamPluginConfig]/config/session/authentication/access_token_header became nullable

      request-property-became-nullable

    • ○

      the request property allOf[SolaceUpstreamPluginConfig]/config/session/authentication/id_token became nullable

      request-property-became-nullable

    • ○

      the request property allOf[SolaceUpstreamPluginConfig]/config/session/authentication/id_token_header became nullable

      request-property-became-nullable

    • ○

      the request property allOf[SolaceUpstreamPluginConfig]/config/session/authentication/password became nullable

      request-property-became-nullable

    • ○

      the request property allOf[SolaceUpstreamPluginConfig]/config/session/authentication/username became nullable

      request-property-became-nullable

    • ○

      the request property allOf[SolaceUpstreamPluginConfig]/config/session/properties became nullable

      request-property-became-nullable

    • ○

      the request property allOf[SolaceUpstreamPluginConfig]/config/session/vpn_name became nullable

      request-property-became-nullable

    • ○

      the ack_timeout request property default value 2000 was added

      request-property-default-value-added

    • ○

      the connect_timeout request property default value 3000 was added

      request-property-default-value-added

    • ○

      the delivery_mode request property default value DIRECT was added

      request-property-default-value-added

    • ○

      the dmq_eligible 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 forward_body request property default value false was added

      request-property-default-value-added

    • ○

      the forward_headers request property default value false was added

      request-property-default-value-added

    • ○

      the forward_method request property default value false was added

      request-property-default-value-added

    • ○

      the forward_uri request property default value false was added

      request-property-default-value-added

    • ○

      the priority request property default value 4 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 scheme request property default value BASIC was added

      request-property-default-value-added

    • ○

      the sender_id request property default value kong was added

      request-property-default-value-added

    • ○

      the ssl_validate_certificate request property default value false was added

      request-property-default-value-added

    • ○

      the tracing request property default value false was added

      request-property-default-value-added

    • ○

      the tracing_sampled request property default value false was added

      request-property-default-value-added

    • ○

      the ttl request property default value 0 was added

      request-property-default-value-added

    • ○

      the type request property default value QUEUE was added

      request-property-default-value-added

    • ○

      the ack_timeout response's property default value 2000 was added for the status 201

      response-property-default-value-added

    • ○

      the connect_timeout response's property default value 3000 was added for the status 201

      response-property-default-value-added

    • ○

      the delivery_mode response's property default value DIRECT was added for the status 201

      response-property-default-value-added

    • ○

      the dmq_eligible response's property default value false 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 forward_body response's property default value false was added for the status 201

      response-property-default-value-added

    • ○

      the forward_headers response's property default value false was added for the status 201

      response-property-default-value-added

    • ○

      the forward_method response's property default value false was added for the status 201

      response-property-default-value-added

    • ○

      the forward_uri response's property default value false was added for the status 201

      response-property-default-value-added

    • ○

      the priority response's property default value 4 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 scheme response's property default value BASIC was added for the status 201

      response-property-default-value-added

    • ○

      the sender_id response's property default value kong was added for the status 201

      response-property-default-value-added

    • ○

      the ssl_validate_certificate response's property default value false was added for the status 201

      response-property-default-value-added

    • ○

      the tracing response's property default value false was added for the status 201

      response-property-default-value-added

    • ○

      the tracing_sampled response's property default value false was added for the status 201

      response-property-default-value-added

    • ○

      the ttl response's property default value 0 was added for the status 201

      response-property-default-value-added

    • ○

      the type response's property default value QUEUE 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

  • 2c77aeaee5fb1See the full diff
    • ○

      endpoint added

      endpoint-added