Delete a ruleset

DELETE /deployments/traffic-filter/rulesets/{ruleset_id}

Deletes the ruleset by ID.

Path parameters

ruleset_id string Required

The mandatory ruleset ID.

Query parameters

ignore_associations boolean

When true, ignores the associations and deletes the ruleset. When false, recognizes the associations, which prevents the deletion of the rule set.

Default value is false.

Responses

200

The traffic filter ruleset was successfully deleted.

Additional properties are allowed.
404

The traffic filter ruleset specified by {ruleset_id} cannot be found. (code: traffic_filter.not_found)
Hide headers attribute Show headers attribute
- x-cloud-error-codes string
  
  The error codes associated with the response
  
  Value is traffic_filter.not_found.
Hide response attribute Show response attribute object
- errors array[object] Required
  
  A list of errors that occurred in the failing request
  
  Hide errors attributes Show errors attributes object
  
  code string Required
  
  A structured code representing the error type that occurred
  
  message string Required
  
  A human readable message describing the error that occurred
  
  fields array[string]
  
  If the error can be tied to a specific field or fields in the user request, this lists those fields
500

Error deleting the traffic filter ruleset. (code: traffic_filter.request_execution_failed)
Hide headers attribute Show headers attribute
- x-cloud-error-codes string
  
  The error codes associated with the response
  
  Value is traffic_filter.request_execution_failed.
Hide response attribute Show response attribute object
- errors array[object] Required
  
  A list of errors that occurred in the failing request
  
  Hide errors attributes Show errors attributes object
  
  code string Required
  
  A structured code representing the error type that occurred
  
  message string Required
  
  A human readable message describing the error that occurred
  
  fields array[string]
  
  If the error can be tied to a specific field or fields in the user request, this lists those fields

DELETE /deployments/traffic-filter/rulesets/{ruleset_id}

curl \
 -X DELETE https://{{hostname}}/api/v1/deployments/traffic-filter/rulesets/{ruleset_id}

Response examples (200)

{}

Response examples (404)

# Headers
x-cloud-error-codes: traffic_filter.not_found

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}

Response examples (500)

# Headers
x-cloud-error-codes: traffic_filter.request_execution_failed

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}