--- updatedAt: 2026-07-28T19:57:20.000Z --- # Create a clone of an existing event broker service

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:

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



Token Permissions: [ services:post ] # OpenAPI definition ```json { "openapi": "3.0.1", "info": { "title": "MISSION CONTROL", "description": "Documentation for Mission Control API", "version": "2.2.1" }, "servers": [ { "url": "https://api.solace.cloud", "description": "Solace Cloud US EAST Region" }, { "url": "https://api.solacecloud.com.au", "description": "Solace Cloud AU Region" }, { "url": "https://api.solacecloud.eu", "description": "Solace Cloud EU Region" }, { "url": "https://api.solacecloud.sg", "description": "Solace Cloud SG Region" } ], "security": [ { "bearerAuth": [] } ], "paths": { "/api/v2/missionControl/eventBrokerServices/{id}/clone": { "post": { "tags": [ "Event Broker Services" ], "summary": "Create a clone of an existing event broker service", "description": "

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:

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



Token Permissions: [ services:post ]", "operationId": "cloneService", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of the event broker service to clone.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The fields to specify to clone an event broker service.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloneServiceRequest" } } }, "required": true }, "responses": { "202": { "description": "Accepted.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationResponse" } } } }, "400": { "description": "Bad request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "message": "An entity of type service was passed in an invalid format.", "errorId": "618e2fb0-a198-4d9d-9219-13e51ef0ecec", "validationDetails": { "serviceClassId": [ "must not be blank" ] } } } } }, "401": { "description": "Unauthorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "message": "An authentication error occurred.", "errorId": "618e2fb0-a198-4d9d-9219-13e51ef0ecec" } } } }, "403": { "description": "Forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "message": "You do not have permissions to perform this operation.", "errorId": "618e2fb0-a198-4d9d-9219-13e51ef0ecec" } } } }, "404": { "description": "Not found.", "content": { "application/json": {} } }, "409": { "description": "Conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "502": { "description": "Bad Gateway - Marketplace integration error.", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "503": { "description": "Service unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "bearerAuth": [] } ] } } }, "components": { "schemas": { "CloneServiceRequest": { "required": [ "datacenterId" ], "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the clone service request.", "readOnly": true }, "type": { "type": "string", "description": "The type of object for informational purposes.", "readOnly": true }, "name": { "type": "string", "description": "The event broker service name.", "example": "my-service-name" }, "datacenterId": { "minLength": 1, "type": "string", "description": "The identifier of the datacenter.", "example": "k8s-us-east-1" }, "serviceConnectionEndpoints": { "type": "array", "description": "The collection of service connection endpoints.", "items": { "$ref": "#/components/schemas/ConnectionEndpoint" } }, "serviceCloneAttributes": { "$ref": "#/components/schemas/ServiceCloneAttributes" }, "customRouterName": { "maxLength": 12, "minLength": 3, "pattern": "^[a-z0-9]*$", "type": "string", "description": "

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.

", "example": "abc123" }, "environmentId": { "type": "string", "description": "The unique identifier of the environment where you want to create the service.\n\nYou 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.\n\nCreating a service in a Public Region without specifying an environment identifier places it in the default environment.\n" } } }, "ConnectionEndpoint": { "required": [ "accessType", "name", "ports" ], "type": "object", "properties": { "id": { "type": "string", "description": "The identifier of the connection endpoint.", "readOnly": true }, "type": { "type": "string", "description": "The type of object for informational purposes.", "readOnly": true }, "name": { "type": "string", "description": "The name of the connection endpoint." }, "description": { "type": "string", "description": "The description for the connection endpoint." }, "accessType": { "$ref": "#/components/schemas/ConnectionEndpointAccessType" }, "k8sServiceType": { "type": "string", "description": "The connectivity configuration that is used in the Kubernetes cluster.", "readOnly": true, "enum": [ "LOADBALANCER", "NODEPORT", "CLUSTERIP" ] }, "k8sServiceId": { "type": "string", "description": "The identifier for the Kubernetes service.", "readOnly": true }, "creationState": { "$ref": "#/components/schemas/CreationState" }, "ports": { "minItems": 1, "type": "array", "description": "

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

\n

Connection specific protocols.

\n