Updates a ruleset

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

Auth

Updates the ruleset with the definition.

Path parameters

ruleset_id string required: The mandatory ruleset ID.

Request body

The specification for traffic filter ruleset.

name string required: Name of the ruleset
description string: Description of the ruleset
type string required: Type of the ruleset
include_by_default boolean required: Should the ruleset be automatically included in the new deployments
region string required: The ruleset can be attached only to deployments in the specific region
rules object[] required: List of rules

Responses

The ruleset definition was valid and the update has started.

application/json

id string required: The new ruleset ID

The traffic filter ruleset specified by {ruleset_id} cannot be found. (code: traffic_filter.not_found)

application/json

Error reading the traffic filter ruleset. (code: traffic_filter.request_execution_failed)

application/json

View as Markdown

Examples

Request curl 1 / 1 language

curl Shell

curl -X PUT "${API_URL}/deployments/traffic-filter/rulesets/${RULESET_ID}" \
  -u "${USERNAME}:${PASSWORD}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "type": "string",
    "include_by_default": false,
    "region": "string",
    "rules": [
      {}
    ]
  }'

Generated from the API spec

Response

{
  "id": "string"
}

Generated from the API spec

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

Generated from the API spec

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

Generated from the API spec