Retrieving a list of Ruleset resources, or the details of the specified Ruleset using the API requires specific syntax depending on whether you are using REST or SOAP. Use this table to find the syntax for your command.

REST Syntax

Click to view all REST Resources

/REST/DSFRuleset/ GET — Retrieves a list of Ruleset resources, or the details of the specified Ruleset.

HTTP Action — GET

URIs:

Get one Ruleset — https://api.dynect.net/REST/DSFRuleset/<service_id>/<dsf_ruleset_id>/

Get a list Ruleset resources — https://api.dynect.net/REST/DSFRuleset/<service_id>/

Arguments:

Get one Ruleset – No Arguments.

Get a list of Ruleset resources:

  • string label — Services with the specified label. Can be wild carded.
    NOTE: The wildcard character is an asterisk ( * ). For example, searching on ( test* ) will return any value with the word test followed by other characters. Some examples are: miketest123, test123, and testcase.
  • string criteria_type — A set of rules describing what traffic is applied to the response pool.
  • string criteria — A comma separated string of entries to search on (Ex: “US,CA”). Can be wild carded.
    NOTE: The wildcard character is an asterisk ( * ). For example, searching on ( test* ) will return any value with the word test followed by other characters. Some examples are: miketest123, test123, and testcase.
  • string ordering — Index of the Ruleset.
  • string detail — A boolean indicating whether or not to return the full details or a list of service resources:
    Valid values:
    Y – The details of each service are specified
    N – The list of service resources is returned ( Default )
  • string pending_changes — Indicates whether pending changes will be returned.
    Valid values:
    Y — Return all published objects plus pending changes along with the change type (add/modify/remove).
    N — Return only published objects.
Response:

Get one Ruleset — Click for More Info

Get a list of Ruleset resources: array — Individual Response Pool resources.

Dyn Logo

SOAP Syntax

Click to view all SOAP Commands

GetOneDSFRuleset — Retrieves information about an existing Ruleset.

GetDSFRulesets — Retrieves all entries from the Traffic Director (DSF) service.

Arguments:

GetOneDSFRuleset — Click for More Info

GetDSFRulesets — Click for More Info

Response:

GetOneDSFRuleset — Click for More Info

GetDSFRulesets — Click for More Info

Example Request (GetOneDSFRuleset) — Click for More Info

Example Request (GetDSFRulesets) — Click for More Info