Solace DocsDeveloper HubSolace Community
API Reference

Create an event broker service

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

Create an event broker service. You must provide a unique name and select a service class and datacenter. You can optionally define other properties for the event broker service.

Your token must have one of the permissions listed in the Token Permissions.



Token Permissions: [ services:post ]
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

The new service specification.

string
required
length ≥ 1

The event broker service name.

string

The event broker version. A default version is provided when this is not specified.

string

The message VPN name. A default message VPN name is provided when this is not specified.

int32
10 to 6000

The message spool size, in gigabytes (GB). A default message spool size is provided if this is not specified.

string
enum
required

Supported service classes.

string
required
length ≥ 1

The identifier of the datacenter.

string

The name of the DMR cluster.

boolean
Defaults to false

Indicates if you can delete the event broker service after creating it. The default value is false, and the valid values are:

  • 'true' - you cannot delete this service
  • 'false' - you can delete this service

boolean
Defaults to false

Enable or disable SSL for the redundancy group (for mate-link encryption). The default value is false and the valid values are:

  • 'true' - enabled
  • 'false' - disabled

serviceConnectionEndpoints
array of objects

The collection of service connection endpoints. If you do not provide parameters for the service connection endpoint, a private endpoint (for Dedicated Regions and Customer-Controlled Regions) or a public endpoint (for Public Regions) is created.

serviceConnectionEndpoints
string
length between 3 and 12

The unique prefix for the name of the router for the event broker service. The prefix must be constructed using only lower-case, alphanumeric characters.

When the customRouterName value is defined, it’s value is added as a prefix to the high-availability role ("primary", "backup", or "monitoring"), and "cn" (custom name) is appended to the end to create the custom router name. For example, if you specified a value of "custom", the router name is "customprimarycn".

If the customRouterName value is left blank, the prefix defaults to the service id of the event broker service. This is prefixed to the event broker service node role to create the router name, for example, "bd37t1d5h4kprimary".

Note: customRouterName is only supported on event broker versions 10.4 or later.

string

The unique identifier of the environment where you want to create the service.

You can only specify an environment identifier when creating services in a Public Region. You cannot specify an environment identifier when creating a service in a Dedicated Region.

Creating a service in a Public Region without specifying an environment identifier places it in the default environment.

Responses

Updated 10 months ago

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 10 months ago