Attachments (API) | Dyn Help Center

REST Methods

VERB	RESOURCE	PARAMETERS (TYPE)	DESCRIPTION
GET	/attachments/policies	None.	Retrieve all attachments for your account.
GET	/attachments/policies/{policy_slug}	policy_slug (path)	Retrieve details for a specified policy.
GET	/attachments/policies/{policy_slug}/{domain_name}	policy_slug (path) domain_name (path)	Retrieve details of an attachment linked to specified policy and domain.
PUT	/attachments/policies/{policy_slug}	policy_slug (path) attachment_list (body)	Replace all the attachments for a policy. This will delete existing attachments and replace them with the new list.
PUT	/attachments/policies/{policy_slug}/{domain_name}	policy_slug (path) domain_name (path) attachment (body)	Create or update an attachment.
DELETE	/attachments/policies/{policy_slug}	policy_slug (path)	Delete all the attachments for a policy.
DELETE	/attachments/policies/{policy_slug}/{domain_name}	policy_slug (path) domain_name (path)	Delete the link between the domain and a policy.

GET /attachments/policies

Retrieve all attachments for your account.

SAMPLE URI: GET https://dns.dynapis.com/policies/rttd?limit={limit}&offset={offset}

Parameters

None

Example Request/Response (JSON)

{
    "_self": "https://dns.dynapis.com:8443/attachments/policies",
    "_items": [
        {
            "_self": "https://dns.dynapis.com:8443/attachments/policies/I%20am%20a%20policy%20name%20with%20spaces/fooooooooo.testrttd3.com",
            "policy": {
                "name": "I am a policy name with spaces",
                "_self": "https://dns.dynapis.com:8443/dynamic_steering/policies/I%20am%20a%20policy%20name%20with%20spaces"
            },
            "zone": {
                "_self": "https://dns.dynect.com/zones/testrttd3.com",
                "name": "testrttd3.com"
            },
            "domain": "fooooooooo.testrttd3.com",
            "rtypes": []
        },
        {
            "_self": "https://dns.dynapis.com:8443/attachments/policies/FooBar/testrttd3.com",
            "policy": {
                "name": "FooBar",
                "_self": "https://dns.dynapis.com:8443/dynamic_steering/policies/FooBar"
            },
            "zone": {
                "_self": "https://dns.dynect.com/zones/testrttd3.com",
                "name": "testrttd3.com"
            },
            "domain": "testrttd3.com",
            "rtypes": []
        },
        {
            "_self": "https://dns.dynapis.com:8443/attachments/policies/FooBar/foo.testrttd3.com",
            "policy": {
                "name": "FooBar",
                "_self": "https://dns.dynapis.com:8443/dynamic_steering/policies/FooBar"
            },
            "zone": {
                "_self": "http://dns.dynect.com/zones/testrttd3.com",
                "name": "testrttd3.com"
            },
            "domain": "foo.testrttd3.com",
            "rtypes": []
        }
    ]
}

GET /attachments/policies/{policy_slug}

Retrieve details for a specified policy.

SAMPLE URI: GET https://dns.dynapis.com/policies/policies/{policy_name}

Parameters

policy_slug – (path) The unique name of the policy requested.

Example Response (JSON)

{
    "_self": "https://dns.dynapis.com:8443/attachments/policies/FooBar",
    "_items": [
        {
            "_self": "https://dns.dynapis.com:8443/attachments/policies/FooBar/foo.testrttd3.com",
            "policy": {
                "name": "FooBar",
                "_self": "https://dns.dynapis.com:8443/dynamic_steering/policies/FooBar"
            },
            "zone": {
                "_self": "http://dns.dynect.com/zones/testrttd3.com",
                "name": "testrttd3.com"
            },
            "domain": "foo.testrttd3.com",
            "rtypes": []
        },
        {
            "_self": "https://dns.dynapis.com:8443/attachments/policies/FooBar/testrttd3.com",
            "policy": {
                "name": "FooBar",
                "_self": "https://dns.dynapis.com:8443/dynamic_steering/policies/FooBar"
            },
            "zone": {
                "_self": "http://dns.dynect.com/zones/testrttd3.com",
                "name": "testrttd3.com"
            },
            "domain": "testrttd3.com",
            "rtypes": []
        }
    ]
}

GET /attachments/policies/{policy_slug}/{domain_name}

Retrieve details of an attachment linked to specified policy and domain.

SAMPLE URI: GET https://dns.dynapis.com/attachments/policies/{policy_name}/{domain_name}

Parameters

policy_slug – (path) The unique name of the policy requested.
.
domain_name – (path) The domain name linked to policy.

Example Request/Response (JSON)

{
    "_self": "https://dns.dynapis.com:8443/attachments/policies/FooBar/foo.testrttd3.com",
    "policy": {
        "name": "FooBar",
        "_self": "https://dns.dynapis.com:8443/dynamic_steering/policies/FooBar"
    },
    "zone": {
        "_self": "http://dns.dynect.com/zones/testrttd3.com",
        "name": "testrttd3.com"
    },
    "domain": "foo.testrttd3.com",
    "rtypes": []
}

PUT /attachments/policies/{policy_slug}

Replace all the attachments for the named policy. This will delete existing attachments and replace them with the new list.

SAMPLE URI: PUT https://dns.dynapis.com/attachments/policies/{policy_name}

Parameters

policy_slug – (path) The unique name of the policy requested.
attachment_list – (body) New list of policy attachments to save.

Attachment List Properties

policy – Name of policy.
zone – Name of zone.
domain – A name within a zone.
rtypes – Record types allowed.

Example Request/Response (JSON)

{
    "_self": "https://dns.dynapis.com:8443/attachments/policies/FooBar",
    "_items": [
        {
            "_self": "https://dns.dynapis.com:8443/attachments/policies/FooBar/foo.testrttd3.com",
            "policy": {
                "name": "FooBar",
                "_self": "https://dns.dynapis.com:8443/dynamic_steering/policies/FooBar"
            },
            "zone": {
                "_self": "https://dns.dynect.com/zones/testrttd3.com",
                "name": "testrttd3.com"
            },
            "domain": "foo.testrttd3.com",
            "rtypes": []
        },
        {
            "_self": "https://dns.dynapis.com:8443/attachments/policies/FooBar/testrttd3.com",
            "policy": {
                "name": "FooBar",
                "_self": "https://dns.dynapis.com:8443/dynamic_steering/policies/FooBar"
            },
            "zone": {
                "_self": "https://dns.dynect.com/zones/testrttd3.com",
                "name": "testrttd3.com"
            },
            "domain": "testrttd3.com",
            "rtypes": []
        }
    ]
}

PUT /attachments/policies/{policy_slug}/{domain_name}

Create or update an attachment.

SAMPLE URI: PUT PUT https://dns.dynapis.com/attachments/policies/{policy_name}/{domain_name}

Parameters

policy_slug – (path) The unique name of the policy requested.
domain_name – (path) The domain name linked to policy.
attachment – (body) New list of policy attachments to save.

Attachment Properties

policy – Name of policy.
zone – Name of zone.
domain – A name within a zone.
rtypes – Record types allowed.

Example Request/Response (JSON)

{
    "_self": "https://dns.dynapis.com:8443/attachments/policies/FooBar/foo.testrttd3.com",
    "policy": {
        "name": "FooBar",
        "_self": "https://dns.dynapis.com:8443/dynamic_steering/policies/FooBar"
    },
    "zone": {
        "_self": "http://dns.dynect.com/zones/testrttd3.com",
        "name": "testrttd3.com"
    },
    "domain": "foo.testrttd3.com",
    "rtypes": []
}

DELETE /attachments/policies/{policy_slug}

Delete all attachments for a specified policy.

SAMPLE URI: DELETE https://dns.dynapis.com/attachments/rttd/{policy_name}/span>

Parameters

policy_slug – (path) Unique name identifying the policy requested.

DELETE /attachments/policies/{policy_slug}/{domain_name}

Delete the link between the domain and a policy.

SAMPLE URI: DELETE https://dns.dynapis.com/attachments/policies/{policy_name}/{domain_name}

Parameters

policy_slug – (path) The unique name of the policy requested.
domain_name – (path) The domain name linked to policy.

Useful Traffic Steering Links		Rules
Answers		Policies
Getting Started Guide