It is time to say goodbye: This version of Elastic Cloud Enterprise has reached end-of-life (EOL) and is no longer supported.
The documentation for this version is no longer being maintained. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.
Get a ruleset
editGet a ruleset
editDEPRECATED: Retrieves the ruleset by ID. Deprecated in favor of traffic-filter endpoints.
Request
editGET /api/v1/deployments/ip-filtering/rulesets/{ruleset_id}
Path parameters
edit| Name | Type | Required | Description |
|---|---|---|---|
|
|
Y |
The mandatory ruleset ID |
Query parameters
edit| Name | Type | Required | Description |
|---|---|---|---|
|
|
N |
Retrieves a list of resources that are associated to the specified ruleset. |
Responses
edit-
200 -
(
IpFilterRuleset) The IP filter ruleset was successfully returnedHeaders
-
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')
To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.
Request example
editcurl -XGET https://{{hostname}}/api/v1/deployments/ip-filtering/rulesets/{ruleset_id} \
-H "Authorization: ApiKey $ECE_API_KEY"