IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

› › › ›

Get a ruleset

edit

Get a ruleset

edit

DEPRECATED: Retrieves the ruleset by ID. Deprecated in favor of traffic-filter endpoints.

Request

edit

GET /api/v1/deployments/ip-filtering/rulesets/{ruleset_id}

Path parameters

edit

Name	Type	Required	Description
`ruleset_id`	`string`	Y	The mandatory ruleset ID

Query parameters

edit

Name	Type	Required	Description
`include_associations`	`boolean`; default: `false`	N	Retrieves a list of resources that are associated to the specified ruleset.

Responses

edit

200

(IpFilterRuleset)

The IP filter ruleset was successfully returned

Headers

x-cloud-resource-created (string): The date-time when the resource was created (ISO format relative to UTC)
x-cloud-resource-last-modified (string): The date-time when the resource was last modified (ISO format relative to UTC)
x-cloud-resource-version (string): The resource version, which is used to avoid update conflicts with concurrent operations

404

(BasicFailedReply)

The IP filter ruleset specified by {ruleset_id} cannot be found (code: 'ip_filtering.ruleset_not_found')

500

(BasicFailedReply)

The request execution failed (code: 'ip_filtering.request_execution_failed')

Request example

edit

curl -XGET https://{{hostname}}/api/v1/deployments/ip-filtering/rulesets/{ruleset_id} \
-H "Authorization: ApiKey $ECE_API_KEY"

« Delete a ruleset Updates a ruleset »