Delete Remote Endpoint entries for a Service Provider

delete

http://127.0.0.1:8080/thirdPartyServices/serviceOrchestration/remoteEndpoints

Removes specified remote endpoint configurations from a service provider. This operation deletes the remote endpoints, their appliance associations, and related service orchestration configurations. Requires READ_WRITE permission.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

serviceId

string

required

The unique identifier of the service provider. Must reference an existing service provider configuration.

Body Params

Object containing an array of remote endpoint entries to delete. Only the remoteEndpointId field is required for each entry.

Request body for deleting remote endpoints. Contains an array of endpoints to remove.

remoteEndpoints

array of objects

required

length ≥ 1

List of remote endpoints to delete. Each entry must include the remoteEndpointId.

remoteEndpoints*

Represents a remote endpoint configuration for service orchestration tunnels.

remoteEndpointId

integer

Unique identifier for the remote endpoint. Required for DELETE operations.

serviceId

integer

ID of the service provider this endpoint belongs to.

remoteEndpointName

string

required

Display name for the remote endpoint. Must be unique within the service.

ipAddress

string

IP address or hostname of the remote endpoint for tunnel establishment.

labelId

string

Interface label ID(s) for WAN binding. Use pipe (|) separator for multiple interfaces.

preSharedKey

string

Pre-shared key for IPsec tunnel authentication. Leave empty to use default.

probeIpAddress

string

Probe IP address(es) for endpoint health monitoring. Use pipe (|) separator for multiple IPs.

backupEndpointId

string

ID of backup endpoint for failover configuration.

timestamp

int64

Last modification timestamp in milliseconds since epoch.

Responses

200

Remote endpoints deleted successfully. Associated endpoint associations and service configurations are also removed.

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

400Bad Request - Invalid input parameters

500Internal Server Error - Unexpected error during deletion