CarbonCopySuspend

Temporarily pauses an active carbon copy rule without permanently removing it, allowing you to resume duplication later with CarbonCopyActivate.

:::caution Established API The SOAP API is in maintenance mode. For new integrations use the REST equivalent. :::

Method Signature

bool CarbonCopySuspend(string SessionID, int CarbonCopyID)

Parameters

Parameter	Type	Required	Description
SessionID	string	Yes	Active session token from Login()
CarbonCopyID	int	Yes	Unique identifier of the active carbon copy rule to suspend

Response

Returns a bool indicating whether the suspension succeeded.

Value	Meaning
true	Rule successfully set to Suspended; traffic duplication has stopped
false	Suspension failed; the rule may already be suspended or terminated

<!-- Example response XML -->
<CarbonCopySuspendResult>true</CarbonCopySuspendResult>

Code Examples

C#

// .NET 10 — dotnet-svcutil generated proxy
// Suspend a carbon copy rule during a planned maintenance window
bool success = await client.CarbonCopySuspendAsync(sessionID, carbonCopyID: 301);

if (success)
    Console.WriteLine("Carbon copy rule suspended. Call CarbonCopyActivate to resume.");
else
    Console.WriteLine("Suspension failed — rule may already be suspended or terminated.");

Java

// JAX-WS generated client
// wsimport -s src https://os.ecgrid.io/v4.1/prod/ECGridOS.asmx?WSDL

ECGridOS service = new ECGridOS();
ECGridOSPortType port = service.getECGridOSPort();

var result = port.CarbonCopySuspend(sessionID /*, additional params */);
System.out.println(result);

Node.js

// npm install soap
import soap from 'soap';

const WSDL = 'https://os.ecgrid.io/v4.1/prod/ECGridOS.asmx?WSDL';
const client = await soap.createClientAsync(WSDL);

const [result] = await client.CarbonCopySuspendAsync({
  SessionID: sessionId,
  // additional params
});
console.log(result);

Python

# pip install zeep
from zeep import Client

WSDL = 'https://os.ecgrid.io/v4.1/prod/ECGridOS.asmx?WSDL'
client = Client(WSDL)

result = client.service.CarbonCopySuspend(
    SessionID=session_id,
    # additional params
)
print(result)

See Also

• CarbonCopyActivate — Resume a suspended rule
• CarbonCopyTerminate — Permanently remove a rule

REST Equivalent

See Update Carbon Copy — PUT /v2/carboncopies/update with status=Suspended.