Solace DocsDeveloper HubSolace Community
API Reference

Create a clone of an existing event broker service

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

Create a clone of an existing event broker service.

You must specify the unique identifiers of the event broker service in the URL and the datacenter in the request body. By default, the name of the new service is the name of the specified event broker service with " - Clone" appended to the name. When the event broker service that you clone has deletion protection enabled ('locked' is ‘true’), the new event broker service also has deletion protection enabled. If service creation fails during the clone process, deletion protection is disabled ('locked' is 'false') and allows you to delete the failed service.

Cloning copies the Rest Delivery Endpoints, but disables them. You must re-enable the endpoints after creating the cloned service.

This endpoint does not clone:

  • The custom hostname (or custom domain hostnames)
  • Bridge configuration
  • Event mesh configuration (Dynamic Message Routing (DMR) configuration)
  • Distributed tracing configuration
  • Event Broker Service Single Sign-on (SSO) configuration (OAuth profiles)
  • The router name for the event broker service
  • Server certificates

Optionally, you can set the service connection endpoint settings as they are not cloned from the specified service.



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

The unique identifier of the event broker service to clone.

Body Params

The fields to specify to clone an event broker service.

string

The event broker service name.

string
required
length ≥ 1

The identifier of the datacenter.

serviceConnectionEndpoints
array of objects

The collection of service connection endpoints.

serviceConnectionEndpoints
serviceCloneAttributes
object

The event broker service settings that you can specify to clone. The cluster name, client authentication (client user names), and management users are always cloned to the new service. You can specify one or more of the following attributes to clone to the new event broker service:

  • 'SERVICE_CONFIGURATION'-The LDAP authentication profiles, LDAP management, SEMP over message bus enabled setting, and SYSLOG configuration settings.
  • 'BROKER_CONFIGURATION'-Message VPN settings, such as topics, topic endpoints, queues, ACL profiles, client profiles, REST Delivery Points (including any configured client certificates).
  • 'CERTIFICATE_AUTHORITIES'-Domain and Client Certificate Authorities (CAs).

If you don't specify an attribute (default), all the supported settings except for the 'CERTIFICATE_AUTHORITIES' settings are cloned to the new service.

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 is added as a prefix to the event broker service node role, and "cn" (custom name) is appended to the end to create the custom router name, for example, "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 greater.

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