Unsupported content

 

This version of the documentation is no longer supported. However, the documentation is available for your convenience. You will not be able to leave comments.

LogicalPerimeterFirewallInterface replaceOutboundRules request

Description

This API replaces the existing set of outbound firewall rules on the interface with the newly provided set of LogicalFirewallRule objects.
The replaceOutboundRules API may only be used within the context of a LogicalHostingEnvironment lock. Locking the LogicalHostingEnvironment object prevents concurrent updates to the same firewalls or rules. The API usage pattern should be as follows :
Acquire a lock ID using the LogicalHostingEnvironment acquireLock API.
Use the lock ID to make the replaceOutboundRules API call.
Release the LogicalHostingEnvironment lock.

API stability classification

Unassigned

API overview

HTTP
method

URI

Return
type

Return type
multiplicity

POST

csm/LogicalPerimeterFirewallInterface/guid/replaceOutboundRules

void

Not applicable

HTTP request message

Query string parameters

This API does not use query string parameters.

Request message headers

This API uses only common headers listed in HTTP request and response headers.

Request message body

This API uses the following objects in the request message body JSON.

Top-level objects

Name

Type

Multi-
plicity

Description

callbackURL

String

0..1

URL to call when the operation finishes

postCallout

String

0..1

Identifier of a callout to run after the operation executes

preCallout

String

0..1

Identifier of a callout to run before the operation executes

timeout

Integer

0..1

Timeout setting. For more information about using the timeout, see Synchronous and asynchronous operations. Timeout values:

  • 0: Immediate timeout
  • -1: Uses the system default timeout value
  • 1..*: Times out in the specified number of seconds

operationParams

OperationParameter

1

Array of input parameters. The following table contains the list of input parameters. For information about setting up the input parameters, see Passing input parameters with an API request.


Input parameters to include in operationParams

Name

Type

Multi-
plicity

Description

ipAddress

String

0..1

If an IPAddress is provided, only outbound rules pertaining to the IP provided will be replaced. If no IPAddress is provided, all the outbound rules on the interface will be replaced

lockId

String

1

Lock ID acquired from a LogicalHostingEnvironment acquireLock call performed prior to the replaceOutboundRules call.

logicalFirewallRules

LogicalFirewallRule

0..*

List of new outbound LogicalFirewallRule objects which will replace the existing set of outbound {{LogicalFirewallRule}}s

void

void

HTTP response message

Response message headers

This API uses only common headers listed in HTTP request and response headers.

Response message body

The response message body contains a Task object.

This version of the documentation is no longer supported. However, the documentation is available for your convenience. You will not be able to leave comments.

Comments