Solace DocsDeveloper HubSolace Community
API Reference

(Beta) Create a connection endpoint

post
https://api.solace.cloud/api/v2/missionControl/eventBrokerServices//connectionEndpoints

Create a connection endpoint for a given event broker service.

An event broker service can have a maximum of one public and one private connection endpoint, and must have at least one connection endpoint. The serviceManagementTlsListenPort and serviceSmfTlsListenPort protocols must be enabled on at least one connection endpoint.



Token Permissions: [ mission_control:access or service_connection_endpoint:post ]

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params

A collection of networking protocol and port configurations that permit applications to connect to the event broker service.

string
required

The name of the connection endpoint.

string

The description for the connection endpoint.

string
enum
required

The connectivity for the connection endpoint. This can be through private IP addresses (PRIVATE) or public internet (PUBLIC).
For event brokers deployed to self-managed containers, only PRIVATE is supported: public ingress is not provided, so reaching the event broker from the internet must be arranged on your own network. PUBLIC is rejected for those services.

Allowed:
ports
array of objects
required
length ≥ 1

The protocols and port numbers of the connection endpoint. The serviceManagementTlsListenPort and serviceSmfTlsListenPort protocols along with the port numbers must be specified in the request.

Connection specific protocols.

  • Solace Messaging
    • 'serviceSmfPlainTextListenPort'-Use SMF Host (plain-text) over TCP to connect and exchange messages with the event broker service.
    • 'serviceSmfCompressedListenPort'-Use SMF (plain-text) in a compressed format over TCP to connect and exchange messages with the event broker service.
    • 'serviceSmfTlsListenPort'-Use secure SMF using TLS over TCP.

  • Solace Web Messaging
    • 'serviceWebPlainTextListenPort'-Use WebSocket over HTTP (plain-text).
    • 'serviceWebTlsListenPort'-Use WebSocket over secured HTTP.

  • AMQP
    • 'serviceAmqpPlainTextListenPort'-Use AMQP (plain-text).
    • 'serviceAmqpTlsListenPort'-Use AMQP over a secure TCP connection.

  • MQTT
    • 'serviceMqttPlainTextListenPort'-Use MQTT (plain-text).
    • 'serviceMqttWebSocketListenPort'-Use MQTT WebSocket (plain-text).
    • 'serviceMqttTlsListenPort'-Use secure MQTT.
    • 'serviceMqttTlsWebSocketListenPort'-Use WebSocket secured MQTT.

  • REST
    • 'serviceRestIncomingPlainTextListenPort'-Use REST messaging (plain-text).
    • 'serviceRestIncomingTlsListenPort'-Use secure REST messaging.

  • Management
    • 'serviceManagementTlsListenPort'-Use the secured management connection, which uses SEMP to manage the event broker. This port must be enabled on at least one of the service connection endpoints on the event broker service.
    • 'managementSshTlsListenPort'-Use a secure port to connect to the event broker service to issue Solace Command Line Interface (CLI). This port provides you with scope-restricted access to the event broker service.
    ports*

    The protocols and port numbers of the connection endpoint. The serviceManagementTlsListenPort and serviceSmfTlsListenPort protocols along with the port numbers must be specified in the request.

    Connection specific protocols.

    • Solace Messaging
      • 'serviceSmfPlainTextListenPort'-Use SMF Host (plain-text) over TCP to connect and exchange messages with the event broker service.
      • 'serviceSmfCompressedListenPort'-Use SMF (plain-text) in a compressed format over TCP to connect and exchange messages with the event broker service.
      • 'serviceSmfTlsListenPort'-Use secure SMF using TLS over TCP.

    • Solace Web Messaging
      • 'serviceWebPlainTextListenPort'-Use WebSocket over HTTP (plain-text).
      • 'serviceWebTlsListenPort'-Use WebSocket over secured HTTP.

    • AMQP
      • 'serviceAmqpPlainTextListenPort'-Use AMQP (plain-text).
      • 'serviceAmqpTlsListenPort'-Use AMQP over a secure TCP connection.

    • MQTT
      • 'serviceMqttPlainTextListenPort'-Use MQTT (plain-text).
      • 'serviceMqttWebSocketListenPort'-Use MQTT WebSocket (plain-text).
      • 'serviceMqttTlsListenPort'-Use secure MQTT.
      • 'serviceMqttTlsWebSocketListenPort'-Use WebSocket secured MQTT.

    • REST
      • 'serviceRestIncomingPlainTextListenPort'-Use REST messaging (plain-text).
      • 'serviceRestIncomingTlsListenPort'-Use secure REST messaging.

    • Management
      • 'serviceManagementTlsListenPort'-Use the secured management connection, which uses SEMP to manage the event broker. This port must be enabled on at least one of the service connection endpoints on the event broker service.
      • 'managementSshTlsListenPort'-Use a secure port to connect to the event broker service to issue Solace Command Line Interface (CLI). This port provides you with scope-restricted access to the event broker service.

      string
      enum
      required

      Messaging or management protocol.

      int32
      0 to 65535

      Port number. Use '0' to disable the port.

      annotations
      object

      Annotations to apply to this connection endpoint's Kubernetes Service.

      annotationsRemoved
      array of strings

      Annotation keys to remove from this connection endpoint's Kubernetes Service.

      annotationsRemoved
      Headers
      string
      enum
      Defaults to application/json

      Generated from available response content types

      Allowed:
      Responses

      Updated 3 months ago

      Did this page help you?
      Language
      Credentials
      Bearer
      JWT
      URL
      LoadingLoading…
      Response
      Click Try It! to start a request and see the response here! Or choose an example:
      application/json
      */*

      Updated 3 months ago

      Did this page help you?