Retrieving one or more instances of the Traffic Director service 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/DSF/ GET — Retrieve a list of Traffic Director service resources or the details of the specified service.

HTTP Action — GET

URIs:

Get One Traffic Director (DSF) instance — https://api.dynect.net/REST/DSF/<service_id>/

Get all Traffic Director (DSF) instances — https://api.dynect.net/REST/DSF/

Arguments:

Get One Traffic Director (DSF) instance:

  • 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.
  • string detail — A boolean indicating whether or not to return a list of service resources. Service resources returned are: pending changesets, whether or not the service is active, the service TTL, the service ID, and the service label.
    Valid values:
    Y – Return the service resources for each DSF service.
    N – Do not return a list of service resources. (Default)

Get all Traffic Director (DSF) instances:

  • 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.
Response:

Get One Traffic Director (DSF) Instance — Click for More Info

  • array nodes — A list of zone and FQDN pairs to identify nodes that are attached to the Traffic Director service.
    • string zone — Name of the zone.
    • string fqdn — Fully qualified domain name of a node in the zone.
  • string pending_change — Indicates whether or not the service has any changes pending.
    Valid values:
    Y – There are changes pending for this service.
    N – There are no changes pending for this service.

Get all Traffic Director (DSF) instances:
array — Individual Traffic Director service resources.

Dyn Logo

SOAP Syntax

Click to view all SOAP Commands
GetOneDSF — Retrieves the specified Traffic Director service.

GetDSFs — Retrieves the specified Traffic Director service.

Arguments:

GetOneDSF:

  • string service_idRequired. ID of the Traffic Director (DSF) Service.
  • string tokenRequired. The session identifier.

GetDSFs:

  • string label — Label used to describe the Traffic Director (DSF) service. 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 tokenRequired. The session identifier.
Response:

GetOneDSF — Click for More Info

GetDSFs — Click for More Info

Example Request (GetOneDSF) — Click for More Info

Example Request (GetDSFs) — Click for More Info