Updates a ruleset

PUT /deployments/traffic-filter/rulesets/{ruleset_id}
Basic auth Api key

Updates the ruleset with the definition.

Path parameters

application/json

Body Required

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 array[object] Required

    List of rules

    The container for a traffic filter rule.

    Hide rules attributes Show rules attributes object
    • id string

      The rule ID

    • remote_cluster_org_id string

      The remote cluster organization ID

    • remote_cluster_id string

      The remote cluster ID

    • description string

      Description of the rule

    • source string

      Allowed traffic filter source: IP address, CIDR mask, or VPC endpoint ID

    • azure_endpoint_name string

      Name of the Azure Private Endpoint to allow connections from

    • azure_endpoint_guid string

      Resource GUID of the Azure Private Endpoint to allow connections from

    • egress_rule object

      An egress traffic filter rule

      Hide egress_rule attributes Show egress_rule attributes object
      • target string Required

        Allowed traffic filter egress target: IP address or CIDR mask

      • ports array[integer(int32)]

        A list of target ports for an egress rule

      • protocol string Required

        The target protocol for an egress rule

        Values are all, tcp, or udp.

Responses

  • 200 application/json

    The ruleset definition was valid and the update has started.

    Hide response attribute Show response attribute object
    • id string Required

      The new ruleset ID
  • 404 application/json

    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 application/json

    Error reading 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
PUT /deployments/traffic-filter/rulesets/{ruleset_id} 
curl \
 --request PUT 'https://{{hostname}}/api/v1/deployments/traffic-filter/rulesets/{ruleset_id}' \
 --user "username:password" \
 --header "Content-Type: application/json" \
 --data '{"name":"string","description":"string","type":"string","include_by_default":true,"region":"string","rules":[{"id":"string","remote_cluster_org_id":"string","remote_cluster_id":"string","description":"string","source":"string","azure_endpoint_name":"string","azure_endpoint_guid":"string","egress_rule":{"target":"string","ports":[42],"protocol":"all"}}]}'