API Documentation

Example Response:

{
  "email": "[email protected]",
  "address": {
    "country": "US",
    "street": "Some Address Suite 2100",
    "state": "NY",
    "city": "New York",
    "postalcode": "10005"
  },
  "phone": "",
  "customerid": 5309,
  "company": "NSONE API Example Account",
  "lastname": "Example",
  "firstname": "API"
}

Example Request:

{
  "lastname": "Smith",
  "firstname": "John"
}

Example Response:

{
  "email": "[email protected]",
  "address": {
    "country": "US",
    "street": "Some Address Suite 2100",
    "state": "NY",
    "city": "New York",
    "postalcode": "10005"
  },
  "phone": "",
  "customerid": 5309,
  "company": "NSONE API Example Account",
  "lastname": "Smith",
  "firstname": "John"
}

Example Response:

{
  "queries": {
    "send_warnings": true,
    "warning_2": 90,
    "warning_1": 80
  },
  "records": {
    "send_warnings": false,
    "warning_2": 80,
    "warning_1": 50
  }
}

Example Request:

{
  "queries": {
    "warning_2": 90
  }
}

Example Response:

{
  "queries": {
    "send_warnings": true,
    "warning_2": 90,
    "warning_1": 60
  },
  "records": {
    "send_warnings": false,
    "warning_2": 80,
    "warning_1": 50
  }
}

Example Response:

[
  {
    "permissions": {
      "dns": {
        "view_zones": true,
        "manage_zones": true,
        "zones_allow_by_default": false,
        "zones_deny": [],
        "zones_allow": [
          "example.com"
        ],
        "records_allow": [],
        "records_deny": [
          {
            "zone": "example.com",
            "domain": "deny.example.com",
            "include_subdomains": false,
            "type": "A"
          }
        ]
      },
      "data": {
        "push_to_datafeeds": false,
        "manage_datasources": false,
        "manage_datafeeds": false
      },
      "account": {
        "manage_payment_methods": false,
        "manage_plan": false,
        "manage_teams": false,
        "manage_apikeys": false,
        "manage_account_settings": false,
        "view_activity_log": false,
        "view_invoices": false,
        "manage_users": false,
        "manage_ip_whitelist": false
      },
      "monitoring": {
        "manage_lists": false,
        "manage_jobs": false,
        "view_jobs": false
      },
      "security": {
        "manage_global_2fa": false
      }
    },
    "teams": [],
    "email": "[email protected]",
    "last_access": 1376325771,
    "notify": {
      "billing": true
    },
    "name": "API Example",
    "username": "apiexample",
    "ip_whitelist_strict": false,
    "ip_whitelist": []
  },
  {
    "permissions": {
      "dns": {
        "view_zones": true,
        "manage_zones": true,
        "zones_allow_by_default": false,
        "zones_deny": [],
        "zones_allow": [
          "example.com"
        ],
        "records_allow": [],
        "records_deny": [
          {
            "zone": "example.com",
            "domain": "deny.example.com",
            "include_subdomains": false,
            "type": "A"
          }
        ]
      },
      "data": {
        "push_to_datafeeds": false,
        "manage_datasources": false,
        "manage_datafeeds": false
      },
      "account": {
        "manage_payment_methods": false,
        "manage_plan": false,
        "manage_teams": false,
        "manage_apikeys": false,
        "manage_account_settings": false,
        "view_activity_log": false,
        "view_invoices": false,
        "manage_users": false,
        "manage_ip_whitelist": false
      },
      "monitoring": {
        "manage_lists": false,
        "manage_jobs": false,
        "view_jobs": false
      },
      "security": {
        "manage_global_2fa": false
      }
    },
    "email": "[email protected]",
    "last_access": null,
    "notify": {
      "billing": true
    },
    "name": "New User",
    "username": "newuser",
    "ip_whitelist_strict": false,
    "ip_whitelist": [],
    "shared_auth": {
      "saml": {
        "sso": false,
        "idp": {
          "use_metadata_url": null,
          "metadata_url": null,
          "metadata_file": null,
          "provider": null
        }
      }
    },
    "2fa_enabled": false
  }
]

Example Response:

{
  "permissions": {
    "dns": {
      "view_zones": true,
      "manage_zones": true,
      "zones_allow_by_default": false,
      "zones_deny": [],
      "zones_allow": [
        "example.com"
      ],
      "records_allow": [],
      "records_deny": [
        {
          "zone": "example.com",
          "domain": "deny.example.com",
          "include_subdomains": false,
          "type": "AAAA"
        }
      ]
    },
    "data": {
      "push_to_datafeeds": false,
      "manage_datasources": false,
      "manage_datafeeds": false
    },
    "account": {
      "manage_payment_methods": false,
      "manage_plan": false,
      "manage_teams": false,
      "manage_apikeys": false,
      "manage_account_settings": false,
      "view_activity_log": false,
      "view_invoices": false,
      "manage_users": false,
      "manage_ip_whitelist": false
    },
    "monitoring": {
      "manage_lists": false,
      "manage_jobs": false,
      "view_jobs": false
    },
    "security": {
      "manage_global_2fa": false
    }
  },
  "teams": [
    "520422919f782d37dffb588a"
  ],
  "email": "[email protected]",
  "last_access": null,
  "notify": {
    "billing": true
  },
  "name": "New User",
  "username": "newuser",
  "ip_whitelist_strict": false,
  "ip_whitelist": []
}

Example Request:

{
  "username": "newuser",
  "email": "[email protected]",
  "name": "New User",
  "teams": [],
  "permissions": {
    "data": {
      "push_to_datafeeds": false,
      "manage_datafeeds": false,
      "manage_datasources": false
    },
    "account": {
      "view_invoices": false,
      "view_activity_log": false,
      "manage_teams": false,
      "manage_apikeys": false,
      "manage_users": false,
      "manage_payment_methods": false,
      "manage_plan": false,
      "manage_account_settings": false,
      "manage_ip_whitelist": false
    },
    "dns": {
      "zones_allow": [
        "example.com"
      ],
      "zones_deny": [],
      "zones_allow_by_default": false,
      "manage_zones": false,
      "view_zones": true,
      "records_allow": [
        {
          "zone": "example.com",
          "domain": "example.com",
          "include_subdomains": false
        },
        {
          "zone": "example.com"
        }
      ],
      "records_deny": [
        {
          "zone": "example.com",
          "domain": "deny.example.com",
          "type": "MX"
        },
        {
          "zone": "foo.bar",
          "domain": "deny.example.com",
          "include_subdomains": true,
          "type": "A"
        },
        {
          "zone": "wha.what",
          "type": "AAAA"
        },
        {
          "zone": "example.com",
          "type": "DNSSEC"
        },
        {
          "zone": "another.example",
          "domain": "noway.example.com"
        }
      ]
    },
    "monitoring": {
      "manage_lists": false,
      "manage_jobs": false,
      "view_jobs": false
    },
    "security": {
      "manage_global_2fa": false
    }
  }
}

Example Response:

{
  "2fa_enabled": true,
  "created": 0,
  "invite_token": "string",
  "last_access": null,
  "username": "some_username69",
  "shared_auth": {
    "saml": {
      "sso": true,
      "idp": {
        "use_metadata_url": null,
        "metadata_url": null,
        "metadata_file": null,
        "provider": null
      }
    }
  },
  "email": "string",
  "ip_whitelist": [
    "strings"
  ],
  "ip_whitelist_strict": true,
  "name": "string",
  "notify": {
    "billing": true
  },
  "permissions": {
    "account": {
      "manage_account_settings": true,
      "manage_teams": true,
      "manage_users": true,
      "manage_apikeys": true,
      "manage_ip_whitelist": true,
      "view_activity_log": true,
      "manage_payment_methods": true,
      "manage_plan": true,
      "view_invoices": true,
      "manage_auth_tags": true,
      "manage_service": true,
      "view_service": true
    },
    "data": {
      "manage_datasources": true,
      "manage_datafeeds": true,
      "push_to_datafeeds": true
    },
    "dhcp": {
      "manage_dhcp": true,
      "view_dhcp": true,
      "tags_allow": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "tags_deny": [
        {
          "name": "string",
          "value": "string"
        }
      ]
    },
    "dns": {
      "manage_zones": true,
      "view_zones": true,
      "zones_allow_by_default": true,
      "zones_allow": [
        "foo.bar.com"
      ],
      "zones_deny": [
        "foo.bar.com"
      ],
      "records_allow": [
        {
          "zone": "foo.bar.com",
          "domain": "*.foo.bar.com",
          "include_subdomains": true,
          "type": "string"
        }
      ],
      "records_deny": [
        {
          "zone": "foo.bar.com",
          "domain": "*.foo.bar.com",
          "include_subdomains": true,
          "type": "string"
        }
      ]
    },
    "ipam": {
      "manage_ipam": true,
      "view_ipam": true,
      "tags_allow": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "tags_deny": [
        {
          "name": "string",
          "value": "string"
        }
      ]
    },
    "monitoring": {
      "manage_lists": true,
      "manage_jobs": true,
      "view_jobs": true
    },
    "security": {
      "manage_global_2fa": true,
      "manage_active_directory": true,
      "manage_kerberos": true,
      "manage_ddns": true
    },
    "service": {
      "view_config": true,
      "manage_config": true
    }
  },
  "teams": [
    "50eb9d77830f784f98b0dd59"
  ]
}

Example Response:

{
  "permissions": {
    "dns": {
      "view_zones": true,
      "manage_zones": true,
      "zones_allow_by_default": false,
      "zones_deny": [],
      "zones_allow": [
        "example.com"
      ],
      "records_allow": [],
      "records_deny": [
        {
          "zone": "example.com",
          "domain": "deny.example.com",
          "include_subdomains": false,
          "type": "A"
        }
      ]
    },
    "data": {
      "push_to_datafeeds": false,
      "manage_datasources": false,
      "manage_datafeeds": false
    },
    "account": {
      "manage_payment_methods": false,
      "manage_plan": false,
      "manage_teams": false,
      "manage_apikeys": false,
      "manage_account_settings": false,
      "view_activity_log": false,
      "view_invoices": false,
      "manage_users": false,
      "manage_ip_whitelist": false
    },
    "monitoring": {
      "manage_lists": false,
      "manage_jobs": false,
      "view_jobs": false
    },
    "security": {
      "manage_global_2fa": false
    }
  },
  "teams": [],
  "email": "[email protected]",
  "last_access": null,
  "notify": {
    "billing": true
  },
  "name": "Jane Smith",
  "username": "newuser",
  "ip_whitelist_strict": false,
  "ip_whitelist": []
}

Example Response:

2FA disabled for user '{userId}'

Example Response:

[
  {
    "ip_whitelist_strict": false,
    "name": "MyAPIKey",
    "key": "abcdefghijklmnopqrst",
    "ip_whitelist": [],
    "last_access": null,
    "teams": [],
    "id": "5d727dc9f1e0e100621352a6",
    "permissions": {
      "account": {
        "manage_account_settings": true,
        "manage_apikeys": true,
        "manage_users": true,
        "manage_teams": true,
        "view_activity_log": true,
        "manage_ip_whitelist": true
      },
      "ipam": {
        "view_ipam": true,
        "manage_ipam": true,
        "tags_allow": [
          {
            "name": "auth:allow1"
          },
          {
            "name": "auth:allow2"
          },
          {
            "name": "auth:zip",
            "value": "07030"
          },
          {
            "name": "auth:lat_lon",
            "value": "+12.345-098.765"
          }
        ],
        "tags_deny": [
          {
            "name": "auth:deny1"
          },
          {
            "name": "auth:deny2"
          },
          {
            "name": "auth:zip",
            "value": "90210"
          },
          {
            "name": "auth:lat_lon",
            "value": "+16.345-096.765"
          }
        ]
      },
      "dns": {
        "zones_allow": [
          "example.com"
        ],
        "manage_zones": true,
        "zones_allow_by_default": true,
        "view_zones": true
      },
      "dhcp": {
        "manage_dhcp": true,
        "view_dhcp": true
      },
      "security": {
        "manage_global_2fa": true
      },
      "data": {
        "manage_datafeeds": true,
        "manage_datasources": true,
        "push_to_datafeeds": true
      }
    }
  }
]

Example Response:

{
  "permissions": {
    "dns": {
      "zones_allow_by_default": true,
      "view_zones": true,
      "zones_deny": [],
      "manage_zones": true,
      "zones_allow": []
    },
    "data": {
      "push_to_datafeeds": true,
      "manage_datasources": true,
      "manage_datafeeds": true
    },
    "account": {
      "manage_payment_methods": true,
      "manage_plan": true,
      "manage_teams": true,
      "manage_apikeys": true,
      "manage_account_settings": true,
      "view_activity_log": true,
      "view_invoices": true,
      "manage_users": true
    },
    "monitoring": {
      "manage_lists": false,
      "manage_jobs": false,
      "view_jobs": false
    }
  },
  "teams": ["52276047830f787e2ff88d4c"],
  "id": "520422919f782d37dffb588a",
  "last_access": null,
  "key": "rifGeRNMshCOKwlaYBcu",
  "name": "API Example App",
  "ip_whitelist_strict": false,
  "ip_whitelist": []
}

Example Request:

{
  "ip_whitelist_strict": true,
  "name": "string",
  "key": "stringstringstringst",
  "ip_whitelist": [
    "strings"
  ],
  "last_access": null,
  "teams": [
    "50eb9d77830f784f98b0dd59"
  ],
  "id": "string",
  "permissions": {
    "account": {
      "manage_account_settings": true,
      "manage_teams": true,
      "manage_users": true,
      "manage_apikeys": true,
      "manage_ip_whitelist": true,
      "view_activity_log": true,
      "manage_payment_methods": true,
      "manage_plan": true,
      "view_invoices": true,
      "manage_auth_tags": true,
      "manage_service": true,
      "view_service": true
    },
    "data": {
      "manage_datasources": true,
      "manage_datafeeds": true,
      "push_to_datafeeds": true
    },
    "dhcp": {
      "manage_dhcp": true,
      "view_dhcp": true,
      "tags_allow": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "tags_deny": [
        {
          "name": "string",
          "value": "string"
        }
      ]
    },
    "dns": {
      "manage_zones": true,
      "view_zones": true,
      "zones_allow_by_default": true,
      "zones_allow": [
        "foo.bar.com"
      ],
      "zones_deny": [
        "foo.bar.com"
      ],
      "records_allow": [
        {
          "zone": "foo.bar.com",
          "domain": "*.foo.bar.com",
          "include_subdomains": true,
          "type": "string"
        }
      ],
      "records_deny": [
        {
          "zone": "foo.bar.com",
          "domain": "*.foo.bar.com",
          "include_subdomains": true,
          "type": "string"
        }
      ]
    },
    "ipam": {
      "manage_ipam": true,
      "view_ipam": true,
      "tags_allow": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "tags_deny": [
        {
          "name": "string",
          "value": "string"
        }
      ]
    },
    "monitoring": {
      "manage_lists": true,
      "manage_jobs": true,
      "view_jobs": true
    },
    "security": {
      "manage_global_2fa": true,
      "manage_active_directory": true,
      "manage_kerberos": true,
      "manage_ddns": true
    },
    "service": {
      "view_config": true,
      "manage_config": true
    }
  }
}

Example Response:

{
  "ip_whitelist_strict": true,
  "name": "string",
  "key": "stringstringstringst",
  "ip_whitelist": [
    "strings"
  ],
  "last_access": null,
  "teams": [
    "50eb9d77830f784f98b0dd59"
  ],
  "id": "string",
  "permissions": {
    "account": {
      "manage_account_settings": true,
      "manage_teams": true,
      "manage_users": true,
      "manage_apikeys": true,
      "manage_ip_whitelist": true,
      "view_activity_log": true,
      "manage_payment_methods": true,
      "manage_plan": true,
      "view_invoices": true,
      "manage_auth_tags": true,
      "manage_service": true,
      "view_service": true
    },
    "data": {
      "manage_datasources": true,
      "manage_datafeeds": true,
      "push_to_datafeeds": true
    },
    "dhcp": {
      "manage_dhcp": true,
      "view_dhcp": true,
      "tags_allow": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "tags_deny": [
        {
          "name": "string",
          "value": "string"
        }
      ]
    },
    "dns": {
      "manage_zones": true,
      "view_zones": true,
      "zones_allow_by_default": true,
      "zones_allow": [
        "foo.bar.com"
      ],
      "zones_deny": [
        "foo.bar.com"
      ],
      "records_allow": [
        {
          "zone": "foo.bar.com",
          "domain": "*.foo.bar.com",
          "include_subdomains": true,
          "type": "string"
        }
      ],
      "records_deny": [
        {
          "zone": "foo.bar.com",
          "domain": "*.foo.bar.com",
          "include_subdomains": true,
          "type": "string"
        }
      ]
    },
    "ipam": {
      "manage_ipam": true,
      "view_ipam": true,
      "tags_allow": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "tags_deny": [
        {
          "name": "string",
          "value": "string"
        }
      ]
    },
    "monitoring": {
      "manage_lists": true,
      "manage_jobs": true,
      "view_jobs": true
    },
    "security": {
      "manage_global_2fa": true,
      "manage_active_directory": true,
      "manage_kerberos": true,
      "manage_ddns": true
    },
    "service": {
      "view_config": true,
      "manage_config": true
    }
  }
}

Example Request:

{
  "ip_whitelist_strict": true,
  "name": "string",
  "key": "stringstringstringst",
  "ip_whitelist": [
    "strings"
  ],
  "last_access": null,
  "teams": [
    "50eb9d77830f784f98b0dd59"
  ],
  "id": "string",
  "permissions": {
    "account": {
      "manage_account_settings": true,
      "manage_teams": true,
      "manage_users": true,
      "manage_apikeys": true,
      "manage_ip_whitelist": true,
      "view_activity_log": true,
      "manage_payment_methods": true,
      "manage_plan": true,
      "view_invoices": true,
      "manage_auth_tags": true,
      "manage_service": true,
      "view_service": true
    },
    "data": {
      "manage_datasources": true,
      "manage_datafeeds": true,
      "push_to_datafeeds": true
    },
    "dhcp": {
      "manage_dhcp": true,
      "view_dhcp": true,
      "tags_allow": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "tags_deny": [
        {
          "name": "string",
          "value": "string"
        }
      ]
    },
    "dns": {
      "manage_zones": true,
      "view_zones": true,
      "zones_allow_by_default": true,
      "zones_allow": [
        "foo.bar.com"
      ],
      "zones_deny": [
        "foo.bar.com"
      ],
      "records_allow": [
        {
          "zone": "foo.bar.com",
          "domain": "*.foo.bar.com",
          "include_subdomains": true,
          "type": "string"
        }
      ],
      "records_deny": [
        {
          "zone": "foo.bar.com",
          "domain": "*.foo.bar.com",
          "include_subdomains": true,
          "type": "string"
        }
      ]
    },
    "ipam": {
      "manage_ipam": true,
      "view_ipam": true,
      "tags_allow": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "tags_deny": [
        {
          "name": "string",
          "value": "string"
        }
      ]
    },
    "monitoring": {
      "manage_lists": true,
      "manage_jobs": true,
      "view_jobs": true
    },
    "security": {
      "manage_global_2fa": true,
      "manage_active_directory": true,
      "manage_kerberos": true,
      "manage_ddns": true
    },
    "service": {
      "view_config": true,
      "manage_config": true
    }
  }
}

Example Response:

{
  "ip_whitelist_strict": true,
  "name": "string",
  "key": "stringstringstringst",
  "ip_whitelist": [
    "strings"
  ],
  "last_access": null,
  "teams": [
    "50eb9d77830f784f98b0dd59"
  ],
  "id": "string",
  "permissions": {
    "account": {
      "manage_account_settings": true,
      "manage_teams": true,
      "manage_users": true,
      "manage_apikeys": true,
      "manage_ip_whitelist": true,
      "view_activity_log": true,
      "manage_payment_methods": true,
      "manage_plan": true,
      "view_invoices": true,
      "manage_auth_tags": true,
      "manage_service": true,
      "view_service": true
    },
    "data": {
      "manage_datasources": true,
      "manage_datafeeds": true,
      "push_to_datafeeds": true
    },
    "dhcp": {
      "manage_dhcp": true,
      "view_dhcp": true,
      "tags_allow": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "tags_deny": [
        {
          "name": "string",
          "value": "string"
        }
      ]
    },
    "dns": {
      "manage_zones": true,
      "view_zones": true,
      "zones_allow_by_default": true,
      "zones_allow": [
        "foo.bar.com"
      ],
      "zones_deny": [
        "foo.bar.com"
      ],
      "records_allow": [
        {
          "zone": "foo.bar.com",
          "domain": "*.foo.bar.com",
          "include_subdomains": true,
          "type": "string"
        }
      ],
      "records_deny": [
        {
          "zone": "foo.bar.com",
          "domain": "*.foo.bar.com",
          "include_subdomains": true,
          "type": "string"
        }
      ]
    },
    "ipam": {
      "manage_ipam": true,
      "view_ipam": true,
      "tags_allow": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "tags_deny": [
        {
          "name": "string",
          "value": "string"
        }
      ]
    },
    "monitoring": {
      "manage_lists": true,
      "manage_jobs": true,
      "view_jobs": true
    },
    "security": {
      "manage_global_2fa": true,
      "manage_active_directory": true,
      "manage_kerberos": true,
      "manage_ddns": true
    },
    "service": {
      "view_config": true,
      "manage_config": true
    }
  }
}

Example Response:

[
  {
    "id": "50eb9d77830f784f98b0dd59",
    "name": "string",
    "permissions": {
      "account": {
        "manage_account_settings": true,
        "manage_teams": true,
        "manage_users": true,
        "manage_apikeys": true,
        "manage_ip_whitelist": true,
        "view_activity_log": true,
        "manage_payment_methods": true,
        "manage_plan": true,
        "view_invoices": true,
        "manage_auth_tags": true,
        "manage_service": true,
        "view_service": true
      },
      "data": {
        "manage_datasources": true,
        "manage_datafeeds": true,
        "push_to_datafeeds": true
      },
      "dhcp": {
        "manage_dhcp": true,
        "view_dhcp": true,
        "tags_allow": [
          {
            "name": "string",
            "value": "string"
          }
        ],
        "tags_deny": [
          {
            "name": "string",
            "value": "string"
          }
        ]
      },
      "dns": {
        "manage_zones": true,
        "view_zones": true,
        "zones_allow_by_default": true,
        "zones_allow": [
          "foo.bar.com"
        ],
        "zones_deny": [
          "foo.bar.com"
        ],
        "records_allow": [
          {
            "zone": "foo.bar.com",
            "domain": "*.foo.bar.com",
            "include_subdomains": true,
            "type": "string"
          }
        ],
        "records_deny": [
          {
            "zone": "foo.bar.com",
            "domain": "*.foo.bar.com",
            "include_subdomains": true,
            "type": "string"
          }
        ]
      },
      "ipam": {
        "manage_ipam": true,
        "view_ipam": true,
        "tags_allow": [
          {
            "name": "string",
            "value": "string"
          }
        ],
        "tags_deny": [
          {
            "name": "string",
            "value": "string"
          }
        ]
      },
      "monitoring": {
        "manage_lists": true,
        "manage_jobs": true,
        "view_jobs": true
      },
      "security": {
        "manage_global_2fa": true,
        "manage_active_directory": true,
        "manage_kerberos": true,
        "manage_ddns": true
      },
      "service": {
        "view_config": true,
        "manage_config": true
      }
    },
    "ip_whitelist": [
      {
        "id": "string",
        "name": "string",
        "values": [
          "string"
        ]
      }
    ]
  }
]

Example Response:

{
  "id": "5d839a45a38fef004eb22f25",
  "ip_whitelist": [],
  "name": "Test team",
  "permissions": {
    "account": {
      "view_invoices": false,
      "view_activity_log": false,
      "manage_teams": false,
      "manage_apikeys": false,
      "manage_users": false,
      "manage_payment_methods": false,
      "manage_plan": false,
      "manage_account_settings": false,
      "manage_ip_whitelist": false
    },
    "data": {
      "manage_datafeeds": false,
      "manage_datasources": false,
      "push_to_datafeeds": false
    },
    "dns": {
      "zones_allow": [
        "example.com"
      ],
      "manage_zones": false,
      "zones_allow_by_default": false,
      "view_zones": true
    },
    "security": {
      "manage_global_2fa": false
    }
  }
}

Example Request:

{
  "name": "Test team",
  "ip_whitelist": [],
  "permissions": {
    "account": {
      "view_invoices": false,
      "view_activity_log": false,
      "manage_teams": false,
      "manage_apikeys": false,
      "manage_users": false,
      "manage_payment_methods": false,
      "manage_plan": false,
      "manage_account_settings": false,
      "manage_ip_whitelist": false
    },
    "data": {
      "push_to_datafeeds": false,
      "manage_datafeeds": false,
      "manage_datasources": false
    },
    "dns": {
      "zones_allow": [
        "example.com"
      ],
      "zones_allow_by_default": false,
      "manage_zones": false,
      "view_zones": true
    },
    "security": {
      "manage_global_2fa": false
    }
  }
}

Example Response:

{
  "id": "5d839a45a38fef004eb22f25",
  "ip_whitelist": [],
  "name": "Test team",
  "permissions": {
    "account": {
      "view_invoices": false,
      "view_activity_log": false,
      "manage_teams": false,
      "manage_apikeys": false,
      "manage_users": false,
      "manage_payment_methods": false,
      "manage_plan": false,
      "manage_account_settings": false,
      "manage_ip_whitelist": false
    },
    "data": {
      "manage_datafeeds": false,
      "manage_datasources": false,
      "push_to_datafeeds": false
    },
    "dns": {
      "zones_allow": [
        "example.com"
      ],
      "manage_zones": false,
      "zones_allow_by_default": false,
      "view_zones": true
    },
    "security": {
      "manage_global_2fa": false
    }
  }
}

Example Request:

{
  "name": "Test team",
  "ip_whitelist": [],
  "permissions": {
    "account": {
      "view_invoices": false,
      "view_activity_log": false,
      "manage_teams": false,
      "manage_apikeys": false,
      "manage_users": false,
      "manage_payment_methods": false,
      "manage_plan": false,
      "manage_account_settings": false,
      "manage_ip_whitelist": false
    },
    "data": {
      "push_to_datafeeds": false,
      "manage_datafeeds": false,
      "manage_datasources": false
    },
    "dns": {
      "zones_allow": [
        "example.com"
      ],
      "zones_allow_by_default": false,
      "manage_zones": false,
      "view_zones": true
    },
    "security": {
      "manage_global_2fa": false
    }
  }
}

Example Response:

{
  "id": "5d839a45a38fef004eb22f25",
  "ip_whitelist": [],
  "name": "Test team",
  "permissions": {
    "account": {
      "view_invoices": false,
      "view_activity_log": false,
      "manage_teams": false,
      "manage_apikeys": false,
      "manage_users": false,
      "manage_payment_methods": false,
      "manage_plan": false,
      "manage_account_settings": false,
      "manage_ip_whitelist": false
    },
    "data": {
      "manage_datafeeds": false,
      "manage_datasources": false,
      "push_to_datafeeds": false
    },
    "dns": {
      "zones_allow": [
        "example.com"
      ],
      "manage_zones": false,
      "zones_allow_by_default": false,
      "view_zones": true
    },
    "security": {
      "manage_global_2fa": false
    }
  }
}

Example Response:

[
  {
    "id":  "7c65ca27-23f0-4c00-8906-ae24f9fe0ae5",
    "name": "New York Office",
    "values": ["192.0.2.0/24"]
  },
  {
    "id":  "ead8e0fb-cd99-4ae2-8643-1c9ab9eca4bc",
    "name": "San Francisco Office",
    "values": ["198.51.100.0/24"]
  },
]

Example Response:

{
  "id":  "7c65ca27-23f0-4c00-8906-ae24f9fe0ae5",
  "name": "New York Office",
  "values": ["192.0.2.0/24"]
}

Example Request:

{
  "name": "San Diego Office",
  "values": ["203.0.113.1", "203.0.113.2"]
}

Example Response:

{
  "id":  "873de209-16ca-4bfb-b53a-e495525cc298",
  "name": "San Diego Office",
  "values": ["203.0.113.1", "203.0.113.2"]
}

Example Request:

{
  "name": "New IP Whitelist Record Name",
  "values": ["203.0.113.1", "203.0.113.2"]
}

Example Response:

{
  "id": "873de209-16ca-4bfb-b53a-e495525cc298",
  "name": "New IP Whitelist Record Name",
  "values": ["203.0.113.1", "203.0.113.2"]
}

Example Response:

[
  {
    "overage_order": "ascending",
    "overages": {
      "static": {
        "queries": "2",
        "records": "1"
      },
      "intelligent": {
        "queries": "6",
        "records": "1"
      },
      "dynamic": {
        "queries": "4",
        "records": "1"
      }
    },
    "monthly_price": "0.00",
    "discount": "0.00",
    "discount_type": "percentage",
    "included": {
      "any": {
        "queries": 1e+07,
        "records": 50
      },
      "static": {
        "queries": 0,
        "records": 0
      },
      "intelligent": {
        "queries": 0,
        "records": 0
      },
      "dynamic": {
        "queries": 0,
        "records": 0
      }
    },
    "recurring_cost": "0.00",
    "access_charges": {
      "static": "0.00",
      "intelligent": "0.00",
      "dynamic": "0.00"
    },
    "monitoring": {
      "jobs": 2,
      "frequency": 60,
      "regions": 1
    },
    "type": "startup",
    "period": "monthly"
  },
  {
    "overage_order": "ascending",
    "overages": {
      "static": {
        "queries": "0.75",
        "records": "0.25"
      },
      "intelligent": {
        "queries": "2",
        "records": "0.25"
      },
      "dynamic": {
        "queries": "1.25",
        "records": "0.25"
      }
    },
    "monthly_price": "50.00",
    "discount": "0.00",
    "discount_type": "percentage",
    "included": {
      "any": {
        "queries": 2.5e+07,
        "records": 250
      },
      "static": {
        "queries": 0,
        "records": 0
      },
      "intelligent": {
        "queries": 0,
        "records": 0
      },
      "dynamic": {
        "queries": 0,
        "records": 0
      }
    },
    "recurring_cost": "50.00",
    "access_charges": {
      "static": "0.00",
      "intelligent": "0.00",
      "dynamic": "0.00"
    },
    "monitoring": {
      "jobs": 25,
      "frequency": 20,
      "regions": 3
    },
    "type": "business",
    "period": "monthly"
  },
  {
    "overage_order": "ascending",
    "overages": {
      "static": {
        "queries": "0.75",
        "records": "0.25"
      },
      "intelligent": {
        "queries": "2",
        "records": "0.25"
      },
      "dynamic": {
        "queries": "1.25",
        "records": "0.25"
      }
    },
    "monthly_price": "47.50",
    "discount": "0.00",
    "discount_type": "percentage",
    "included": {
      "any": {
        "queries": 2.5e+07,
        "records": 250
      },
      "static": {
        "queries": 0,
        "records": 0
      },
      "intelligent": {
        "queries": 0,
        "records": 0
      },
      "dynamic": {
        "queries": 0,
        "records": 0
      }
    },
    "recurring_cost": "47.50",
    "access_charges": {
      "static": "0.00",
      "intelligent": "0.00",
      "dynamic": "0.00"
    },
    "monitoring": {
      "jobs": 25,
      "frequency": 20,
      "regions": 3
    },
    "type": "business",
    "period": "quarterly"
  },
  ...
]

Example Response:

{
  "type": "pro",
  "period": "annual"
  "monthly_price": "200.00",
  "discount": "0.00",
  "discount_type": "percentage",
  "recurring_cost": "2400.00",
  "locked": false,
  "included": {
    "any": {
      "queries": 2.5e+08,
      "records": 1500
    },
    "static": {
      "queries": 0,
      "records": 0
    },
    "intelligent": {
      "queries": 0,
      "records": 0
    },
    "dynamic": {
      "queries": 0,
      "records": 0
    }
  },
  "overage_order": "ascending",
  "overages": {
    "static": {
      "queries": "0.50",
      "records": "0.10"
    },
    "intelligent": {
      "queries": "1",
      "records": "0.10"
    },
    "dynamic": {
      "queries": "0.75",
      "records": "0.10"
    }
  },
  "access_charges": {
    "static": "0.00",
    "intelligent": "0.00",
    "dynamic": "0.00"
  },
  "monitoring": {
    "jobs": 250,
    "frequency": 5,
    "regions": 5
  },
  "balance": "0.00"
}

Example Request:

{
  "type": "pro",
  "period": "annual"
}

Example Response:

{
  "overage_order": "ascending",
  "type": "pro",
  "balance": "2,400.00",
  "discount_type": "percentage",
  "monthly_price": "200.00",
  "access_charges": {
    "static": "0.00",
    "intelligent": "0.00",
    "dynamic": "0.00"
  },
  "period": "annual",
  "discount": "0.00",
  "included": {
    "any": {
      "queries": 2.5e+08,
      "records": 1500
    },
    "static": {
      "queries": 0,
      "records": 0
    },
    "intelligent": {
      "queries": 0,
      "records": 0
    },
    "dynamic": {
      "queries": 0,
      "records": 0
    }
  },
  "recurring_cost": "2400.00",
  "overages": {
    "static": {
      "queries": "0.50",
      "records": "0.10"
    },
    "intelligent": {
      "queries": "1",
      "records": "0.10"
    },
    "dynamic": {
      "queries": "0.75",
      "records": "0.10"
    }
  },
  "monitoring": {
    "jobs": 250,
    "frequency": 5,
    "regions": 5
  },
  "locked": true
}

Example Response:

[
  {
    "due": 1377129600,
    "sent": 1375756229,
    "id": 11,
    "amount": "82.02",
    "status": "due"
  },
  {
    "due": 1375315200,
    "sent": 1373985364,
    "id": 10,
    "amount": "29.00",
    "status": "paid"
  },
  {
    "due": 1366588800,
    "sent": 1365215402,
    "id": 2,
    "amount": "0.00",
    "status": "paid"
  },
  {
    "due": 1369180800,
    "sent": 1367807401,
    "id": 4,
    "amount": "0.00",
    "status": "paid"
  }
]

Example Response:

{
  "plan": "startup",
  "period": "monthly",
  "last_invoice": 1377561600,
  "next_invoice": 1379721600,
  "next_base_invoice": 1379721600,
  "recurring_cost": "0.00"
  "recurring_cost_next_invoice": "0.00",
  "any": {
    "overage_order": "ascending",
    "query_credit": 1e+07,
    "record_credit": 50
  },
  "static": {
    "record_rate": "1",
    "access_charge": "0.00",
    "records": 14,
    "query_credit": 0,
    "query_cost": "0.00",
    "query_rate_per_million": "2",
    "queries": 5,
    "record_credit": 0,
    "record_cost": "0.00"
  },
  "dynamic": {
    "record_rate": "1",
    "access_charge": "0.00",
    "records": 2,
    "query_credit": 0,
    "query_cost": "0.00",
    "query_rate_per_million": "4",
    "queries": 10,
    "record_credit": 0,
    "record_cost": "0.00"
  },
  "intelligent": {
    "record_rate": "1",
    "access_charge": "0.00",
    "records": 0,
    "query_credit": 0,
    "query_cost": "0.00",
    "query_rate_per_million": "6",
    "queries": 0,
    "record_credit": 0,
    "record_cost": "0.00"
  },
  "totals": {
    "record_cost": "0.00",
    "record_credit": 16,
    "queries": 15,
    "query_credit": 15,
    "records": 16,
    "access_charge": "0.00",
    "query_cost": "0.00"
  },
  "balance": "0.00",
  "bill": "0.00"
}

Example Response:

[
  {
    "type": "creditcard",
    "default": true,
    "cc_expire_year": 2014,
    "cc_expire_month": 3,
    "firstname": "John",
    "lastname": "Smith",
    "company": "Joe Company",
    "cc_type": "mastercard",
    "phone": "222-555-5555",
    "address": {
      "country": "US",
      "street": "20 Awesome Street Suite 1234",
      "state": "NY",
      "city": "New York",
      "postalcode": "10005"
    },
    "cc_number_last4": "4444",
    "id": 8273
  },
  {
    "type": "creditcard",
    "cc_expire_year": 2016,
    "cc_expire_month": 4,
    "firstname": "Bob",
    "lastname": "Boberton",
    "company": "Joe Company",
    "cc_type": "amex",
    "phone": "212-867-5309",
    "address": {
      "country": "US",
      "street": "20 Awesome Street Suite 1234",
      "state": "NY",
      "city": "New York",
      "postalcode": "10005"
    },
    "cc_number_last4": "1000",
    "id": 6159
  }
]

Example Response:

{
  "type": "creditcard",
  "default": true,
  "cc_expire_year": 2014,
  "cc_expire_month": 3,
  "firstname": "John",
  "lastname": "Smith",
  "company": "Joe Company",
  "cc_type": "mastercard",
  "phone": "222-555-5555",
  "address": {
    "country": "US",
    "street": "20 Awesome Street Suite 1234",
    "state": "NY",
    "city": "New York",
    "postalcode": "10005"
  },
  "cc_number_last4": "4444",
  "id": 8273
}

Example Request:

{
  "address": {
    "country": "US",
    "postalcode": "10005",
    "state": "NY",
    "city": "New York",
    "street": "20 Awesome Street Suite 1234"
  },
  "phone": "222-555-5555",
  "company": "Joe Company",
  "type": "creditcard",
  "default": true,
  "cc_number": "5215888899994444",
  "cc_expire_year": 2014,
  "cc_expire_month": 3,
  "cc_cvv2": "1234",
  "firstname": "John",
  "lastname": "Smith"
}

Example Response:

{
  "type": "creditcard",
  "default": true,
  "cc_expire_year": 2014,
  "cc_expire_month": 3,
  "firstname": "John",
  "lastname": "Smith",
  "company": "Joe Company",
  "cc_type": "mastercard",
  "phone": "222-555-5555",
  "address": {
    "country": "US",
    "street": "20 Awesome Street Suite 1234",
    "state": "NY",
    "city": "New York",
    "postalcode": "10005"
  },
  "cc_number_last4": "4444",
  "id": 8273
}

Example Response:

[
  {
    "resource_type": "zonefile",
    "user_id": "myuser",
    "resource_id": "52276047830f787e2ff88d4c",
    "timestamp": 1378312263,
    "user_type": "user",
    "action": "create",
    "resource": {
      "id": "52276047830f787e2ff88d4c",
      "hostmaster": "[email protected]",
      "meta": {},
      "nx_ttl": 60,
      "retry": 3600,
      "zone": "myzone.net",
      "warnings": [],
      "refresh": 21600,
      "expiry": 1209600,
      "records": [
        {
          "id": "52276047830f787e2ff88d4f",
          "type": "NS",
          "tier": 1,
          "short_answers": [
            "dns1.p03.nsone.net",
            "dns2.p03.nsone.net",
            "dns3.p03.nsone.net",
            "dns4.p03.nsone.net"
          ],
          "domain": "myzone.net"
        },
        {
          "id": "52276047830f787e2ff88d53",
          "type": "A",
          "tier": 1,
          "short_answers": [
            "1.1.1.1",
            "2.2.2.2"
          ],
          "domain": "*.myzone.net"
        }
      ],
      "dns_servers": [
        "dns1.p03.nsone.net",
        "dns2.p03.nsone.net",
        "dns3.p03.nsone.net",
        "dns4.p03.nsone.net"
      ],
      "networks": [0],
      "network_pools": ["p03"]
    },
    "user_name": "My User",
    "id": "52276047830f787e2ff88d59"
  },
  {
    "resource_type": "user",
    "user_id": "myuser",
    "resource_id": "olduser",
    "timestamp": 1378312122,
    "user_type": "user",
    "action": "delete",
    "resource": {
      "permissions": {
        "dns": {
          "zones_allow_by_default": true,
          "view_zones": true,
          "zones_deny": [],
          "manage_zones": true,
          "zones_allow": []
        },
        "data": {
          "manage_datafeeds": true,
          "manage_datasources": true,
          "push_to_datafeeds": true
        },
        "account": {
          "manage_payment_methods": true,
          "manage_teams": true,
          "manage_apikeys": true,
          "manage_account_settings": true,
          "view_activity_log": true,
          "view_invoices": true,
          "manage_users": true,
          "manage_plan": true
        },
        "monitoring": {
          "manage_lists": false,
          "manage_jobs": false,
          "view_jobs": false
        }
      },
      "email": "[email protected]",
      "last_access": null,
      "notify": {
        "billing": true
      },
      "name": "Old User",
      "username": "olduser"
    },
    "user_name": "My User",
    "id": "52275fba830f787e2ff88d42"
  },
  ...
]

Example Response:

[
  {
    "dns_servers": [
      "string"
    ],
    "expiry": 0,
    "primary_master": "string",
    "hostmaster": "string",
    "id": "string",
    "meta": {
      "asn": [
        "string"
      ],
      "ca_province": [
        "string"
      ],
      "connections": 0,
      "country": [
        "string"
      ],
      "georegion": [
        "string"
      ],
      "high_watermark": 0,
      "ip_prefixes": [
        "string"
      ],
      "latitude": 0,
      "loadAvg": 0,
      "longitude": 0,
      "low_watermark": 0,
      "note": "string",
      "priority": 0,
      "pulsar": "string",
      "requests": 0,
      "up": true,
      "us_state": [
        "string"
      ],
      "weight": 0
    },
    "network_pools": [
      "string"
    ],
    "networks": [
      0
    ],
    "nx_ttl": 0,
    "primary": {
      "enabled": true,
      "secondaries": [
        {
          "ip": "string",
          "networks": [
            0
          ],
          "notify": true,
          "port": 0
        }
      ]
    },
    "records": [
      {
        "domain": "string",
        "id": "string",
        "short_answers": [
          "string"
        ],
        "tier": 0,
        "ttl": 0,
        "type": "string"
      }
    ],
    "refresh": 0,
    "retry": 0,
    "ttl": 0,
    "zone": "string",
    "views": [
      "string"
    ],
    "local_tags": [
      "string"
    ],
    "tags": {}
  }
]

Example Response:

{
  "dns_servers": [
    "string"
  ],
  "expiry": 0,
  "primary_master": "string",
  "hostmaster": "string",
  "id": "string",
  "meta": {
    "asn": [
      "string"
    ],
    "ca_province": [
      "string"
    ],
    "connections": 0,
    "country": [
      "string"
    ],
    "georegion": [
      "string"
    ],
    "high_watermark": 0,
    "ip_prefixes": [
      "string"
    ],
    "latitude": 0,
    "loadAvg": 0,
    "longitude": 0,
    "low_watermark": 0,
    "note": "string",
    "priority": 0,
    "pulsar": "string",
    "requests": 0,
    "up": true,
    "us_state": [
      "string"
    ],
    "weight": 0
  },
  "network_pools": [
    "string"
  ],
  "networks": [
    0
  ],
  "nx_ttl": 0,
  "primary": {
    "enabled": true,
    "secondaries": [
      {
        "ip": "string",
        "networks": [
          0
        ],
        "notify": true,
        "port": 0
      }
    ]
  },
  "records": [
    {
      "domain": "string",
      "id": "string",
      "short_answers": [
        "string"
      ],
      "tier": 0,
      "ttl": 0,
      "type": "string"
    }
  ],
  "refresh": 0,
  "retry": 0,
  "ttl": 0,
  "zone": "string",
  "views": [
    "string"
  ],
  "local_tags": [
    "string"
  ],
  "tags": {}
}

Example Request:

{
  "zone": "newzone.com",
  "ttl&tuot;: 3600,
  "nx_ttl": 60
}

Example Response:

{
  "id": "52051b2c9f782d58bb4df41b",
  "hostmaster": "[email protected]",
  "ttl": 3600,
  "nx_ttl": 60,
  "retry": 7200,
  "zone": "newzone.com",
  "refresh": 43200,
  "expiry": 1209600,
  "dns_servers": [
    "dns1.p06.nsone.net",z
    "dns2.p06.nsone.net",
    "dns3.p06.nsone.net",
    "dns4.p06.nsone.net"
  ],
  "networks": [0],
  "network_pools": ["p06"],
  "primary": {
    "enabled": false,
    "secondaries": []
  },
  "records": [
    {
      "id": "52051b2c9f782d58bb4df420",
      "type": "NS",
      "tier": 1,
      "ttl": 3600,
      "short_answers": [
        "dns1.p06.nsone.net",
        "dns2.p06.nsone.net",
        "dns3.p06.nsone.net",
        "dns4.p06.nsone.net"
      ],
      "domain": "newzone.com"
    }
  ],
  "meta": {}
}

Example Request:

{
  "expiry": 0,
  "hostmaster": "string",
  "nx_ttl": 0,
  "primary": {
    "enabled": true,
    "secondaries": [
      {
        "ip": "string",
        "networks": [
          0
        ],
        "notify": true,
        "port": 0
      }
    ]
  },
  "refresh": 0,
  "retry": 0,
  "ttl": 0,
  "zone": "string",
  "local_tags": [
    "string"
  ],
  "tags": {}
}

Example Response:

{
  "dns_servers": [
    "string"
  ],
  "expiry": 0,
  "name": "string",
  "link": "string",
  "primary_master": "string",
  "hostmaster": "string",
  "id": "string",
  "meta": {
    "asn": [
      "string"
    ],
    "ca_province": [
      "string"
    ],
    "connections": 0,
    "country": [
      "string"
    ],
    "georegion": [
      "string"
    ],
    "high_watermark": 0,
    "ip_prefixes": [
      "string"
    ],
    "latitude": 0,
    "loadAvg": 0,
    "longitude": 0,
    "low_watermark": 0,
    "note": "string",
    "priority": 0,
    "pulsar": "string",
    "requests": 0,
    "up": true,
    "us_state": [
      "string"
    ],
    "weight": 0
  },
  "network_pools": [
    "string"
  ],
  "networks": [
    0
  ],
  "nx_ttl": 0,
  "serial": 0,
  "primary": {
    "enabled": true,
    "secondaries": [
      {
        "ip": "string",
        "networks": [
          0
        ],
        "notify": true,
        "port": 0
      }
    ]
  },
  "records": [
    {
      "domain": "string",
      "zone": "string",
      "tags": {
        "property1": "string",
        "property2": "string"
      },
      "link": "string",
      "use_client_subnet": true,
      "regions": {
        "property1": "string",
        "property2": "string"
      },
      "meta": {
        "property1": "string",
        "property2": "string"
      },
      "zone_name": "string",
      "networks": [
        0
      ],
      "id": "string",
      "short_answers": [
        "string"
      ],
      "tier": 0,
      "ttl": 0,
      "type": "string"
    }
  ],
  "refresh": 0,
  "retry": 0,
  "secondary": {
    "status": "string",
    "last_xfr": 0,
    "primary_ip": "string",
    "primary_port": 0,
    "enabled": true,
    "tsig": {
      "enabled": true,
      "hash": "string",
      "name": "string",
      "key": "string"
    },
    "other_ports": [
      0
    ],
    "other_ips": [
      "string"
    ],
    "expired": true
  },
  "ttl": 0,
  "zone": "string",
  "views": [
    "string"
  ],
  "local_tags": [
    "string"
  ],
  "tags": {
    "property1": "string",
    "property2": "string"
  }
}

Example Request:

{
  "refresh": 10800
}

Example Response:

{
  "dns_servers": [
    "string"
  ],
  "expiry": 0,
  "primary_master": "string",
  "hostmaster": "string",
  "id": "string",
  "meta": {
    "asn": [
      "string"
    ],
    "ca_province": [
      "string"
    ],
    "connections": 0,
    "country": [
      "string"
    ],
    "georegion": [
      "string"
    ],
    "high_watermark": 0,
    "ip_prefixes": [
      "string"
    ],
    "latitude": 0,
    "loadAvg": 0,
    "longitude": 0,
    "low_watermark": 0,
    "note": "string",
    "priority": 0,
    "pulsar": "string",
    "requests": 0,
    "up": true,
    "us_state": [
      "string"
    ],
    "weight": 0
  },
  "network_pools": [
    "string"
  ],
  "networks": [
    0
  ],
  "nx_ttl": 0,
  "primary": {
    "enabled": true,
    "secondaries": [
      {
        "ip": "string",
        "networks": [
          0
        ],
        "notify": true,
        "port": 0
      }
    ]
  },
  "records": [
    {
      "domain": "string",
      "id": "string",
      "short_answers": [
        "string"
      ],
      "tier": 0,
      "ttl": 0,
      "type": "string"
    }
  ],
  "refresh": 10800,
  "retry": 0,
  "ttl": 0,
  "zone": "string",
  "views": [
    "string"
  ],
  "local_tags": [
    "string"
  ],
  "tags": {}
}

Example Request:

(Other headers)
Content-Type: multipart/form-data; boundary=----------------------------a5d22159c43c

------------------------------a5d22159c43c
Content-Disposition: form-data; name="zonefile"; filename="newzone.com.db"
Content-Type: application/octet-stream

$ORIGIN newzone.com.
$TTL 300
@	SOA	ns1.newzone.com. hostmaster.newzone.com. 201303202324 43200 7200 1209600 3600
@	NS	ns1
@	NS	ns2
@	A	1.2.3.4
www	A	1.2.3.4

------------------------------a5d22159c43c--

Example Response:

{
  "id": "52052aa99f782d5b1a10a831",
  "hostmaster": "[email protected]",
  "meta": {},
  "ttl": 3600,
  "nx_ttl": 300,
  "retry": 7200,
  "zone": "newzone.com",
  "warnings": [],
  "refresh": 43200,
  "expiry": 1209600,
  "dns_servers": [
    "dns1.p06.nsone.net",
    "dns2.p06.nsone.net",
    "dns3.p06.nsone.net",
    "dns4.p06.nsone.net"
  ],
  "networks": [0],
  "network_pools": ["p06"],
  "records": [
    {
      "id": "52052aa99f782d5b1a10a836",
      "type": "NS",
      "tier": 1,
      "short_answers": [
        "dns1.p06.nsone.net",
        "dns2.p06.nsone.net",
        "dns3.p06.nsone.net",
        "dns4.p06.nsone.net"
      ],
      "domain": "newzone.com"
    },
    {
      "id": "52052aa99f782d5bcc10a847",
      "type": "A",
      "tier": 1,
      "domain": "newzone.com",
      "zone": "newzone.com",
      "short_answers": [
        "1.2.3.4"
      ]
    },
    {
      "id": "52052aa99f78375bcc10a666",
      "type": "A",
      "tier": 1,
      "domain": "www.newzone.com",
      "zone": "newzone.com",
      "short_answers": [
        "1.2.3.4"
      ]
    }
  ]
}

Example Response:

{
  "sent": 1376070394,
  "id": "zIbC9VfrnVtubXfJbM6a",
  "type": "importzonefile",
  "percent": 20,
  "status": "Creating zone"
}

Example Response:

{
  "sent": 1376070394,
  "id": "zIbC9VfrnVtubXfJbM6a",
  "type": "importzonefile",
  "result": {
    "id": "52052afa9f782d5b1a10a83f",
    "hostmaster": "[email protected]",
    "meta": {},
    "ttl": 3600,
    "nx_ttl": 300,
    "retry": 7200,
    "zone": "newzone.com",
    "warnings": [],
    "refresh": 43200,
    "expiry": 1209600,
    "records": [
      {
        "id": "52052afa9f782d5b1a10a844",
        "type": "NS",
        "tier": 1,
        "short_answers": [
          "dns1.p01.nsone.net",
          "dns2.p01.nsone.net",
          "dns3.p01.nsone.net",
          "dns4.p01.nsone.net"
        ],
        "domain": "newzone.com"
      },
      {
        "type": "A",
        "feeds": [],
        "tier": 1,
        "domain": "newzone.com",
        "zone": "newzone.com",
        "answers": [
          {
            "id": "52052afa9f782d5b1a10a846",
            "answer": [
              "1.2.3.4"
            ]
          }
        ],
        "regions": {},
        "meta": {},
        "filters": [],
        "ttl": 300
      },
      {
        "type": "A",
        "feeds": [],
        "tier": 1,
        "domain": "www.newzone.com",
        "zone": "newzone.com",
        "answers": [
          {
            "id": "52052afa9f782d5b1a10a848",
            "answer": [
              "1.2.3.4"
            ]
          }
        ],
        "regions": {},
        "meta": {},
        "filters": [],
        "ttl": 300
      }
    ],
    "dns_servers": [
      "dns1.p01.nsone.net",
      "dns2.p01.nsone.net",
      "dns3.p01.nsone.net",
      "dns4.p01.nsone.net"
    ],
    "networks": [0],
    "network_pools": ["p01"]
  },
  "percent": 100,
  "status": "Created zone and 3 records",
}

Example Response:

[
  {
    "zone": "example.com"
  },
  {
    "zone": "example.com",
    "type": "NS",
    "domain": "example.com"
  },
  {
    "zone": "example.com",
    "type": "MX",
    "domain": "mail.example.com"
  },
  {
    "zone": "example.com",
    "type": "A",
    "domain": "www.example.com"
  }
]

Example Response:

{
  "total_results": 1,
  "next": "next",
  "limit": 1,
  "results": [
    {
      "fqdn": "example.com",
      "handle": "example.com"
    }
  ]
}

Example Response:

{
  "total_results": 1,
  "next": "next",
  "limit": 1,
  "results": [
    {
      "fqdn": "example.com",
      "handle": "example.com",
      "network_pools": [
        "p00"
      ],
      "networks": [
        1
      ],
      "primary": {
        "enabled": true,
        "secondaries": [
          {
            "ip": "127.0.0.1",
            "notify": true,
            "port": 53
          }
        ]
      },
      "record": [
        "dns1.p00.nsone.net",
        "hostmaster.example.net.",
        6,
        43200,
        7200,
        1209600,
        3600
      ],
      "secondary": {
        "enabled": false,
        "expired": false,
        "last_try": 1616692983,
        "last_xfr": 1616692983,
        "other_ips": [],
        "other_ports": [],
        "primary_ip": "127.0.0.1",
        "primary_port": 53,
        "status": "ok"
      },
      "ttl": 3600,
      "views": []
    }
  ]
}

Example Response:

{
  "total_results": 1,
  "next": "next",
  "limit": 1,
  "results": [
    {
      "domain": "www.example.com",
      "type": "A",
      "zone_fqdn": "example.com",
      "zone_handle": "example.com"
    }
  ]
}

Example Response:

{
  "total_results": 1,
  "next": "next",
  "limit": 1,
  "results": [
    {
      "answers": [
        {
          "answer": [
            "192.0.2.1"
          ],
          "id": "605cc6f6b407da12cd986c9f"
        }
      ],
      "domain": "www.example.com",
      "id": "605cc6f6b407da12cd986ca0",
      "meta": {},
      "networks": [
        1
      ],
      "regions": {},
      "tags": {
        "tag0": "value0",
        "tag1": "value1",
        "tag2": "value2",
        "tag3": "value3",
        "tag4": "value4"
      },
      "tier": 1,
      "ttl": 3600,
      "type": "A",
      "zone_fqdn": "example.com",
      "zone_handle": "example.com",
      "use_client_subnet": false
    }
  ]
}

Example Response:

[
  {
    "network_id": 0,
    "label": "NSONE",
    "name": "NSONE Global Network"
  },
  {
    "network_id": 82,
    "label": "myprivate",
    "name": "My Private Network"
  }
]

Example Request:

{"dnssec":true}

Example Response:

{
    "nx_ttl": 3600,
    "retry": 7200,
    "dnssec": true,
    "zone": "mydnssec.test",
    "network_pools": [
        "p05"
    ],
    "primary": {
        "enabled": false,
        "secondaries": []
    },
    "refresh": 43200,
    "expiry": 1209600,
    "dns_servers": [
        "dns1.p05.nsone.net",
        "dns2.p05.nsone.net",
        "dns3.p05.nsone.net",
        "dns4.p05.nsone.net"
    ],
    "records": [
        {
            "domain": "mydnssec.test",
            "short_answers": [
                "dns1.p05.nsone.net",
                "dns2.p05.nsone.net",
                "dns3.p05.nsone.net",
                "dns4.p05.nsone.net"
            ],
            "ttl": 3600,
            "tier": 1,
            "type": "NS",
            "id": "5d4994bec94a900001134b77"
        }
    ],
    "meta": {},
    "link": null,
    "serial": 1565103372,
    "ttl": 3600,
    "id": "5d4994bec94a900001134b72",
    "hostmaster": "[email protected]",
    "networks": [
        0
    ],
    "pool": "p05"
}

Example Response:

{
    "keys": {
        "dnskey": [
            [
                "257",
                "3",
                "13",
                "t+4DPP+MFZ0Cr7gasdghasdhasdfhasdfhsdfa5xBXKIsjsj5baV1HzhBNo2F7mbsevsEo0/6UEL8+JBmA=="
            ],
            [
                "256",
                "3",
                "13",
                "pxEUulkf8UZtE9fy2+4wJwasdghashasdfhhasdfhadsfahd/QL9AmwFCgyFeC4uRNxoqxK0xOg=="
            ]
        ],
        "ttl": 3600
    },
    "delegation": {
        "dnskey": [
            [
                "257",
                "3",
                "13",
                "t+4DPP+MFZ0Cr7gAXiDYv6HTasdghashasdhasdfhahshasdfjsj5baV1HzhBNo2F7mbsevsEo0/6UEL8+JBmA=="
            ]
        ],
        "ds": [
            [
                "48553",
                "13",
                "2",
                "02f7cf1f6c24ccasdfasdgasdgasghd91e702287d74453b1aa3f495"
            ]
        ],
        "ttl": 3600
    },
    "zone": "mydnssec.test."
}

Example Request:

curl -X PUT -H 'X-NSONE-Key: qACMD09OJXBxT7XOuRs8' -d'{"zone":"newzone.com","secondary":{"enabled":true,"primary_ip":"1.2.3.4","tsig":{"enabled":true,"hash":"hmac-md5","name":"ns1-transfer-key","key":"mwmF7XOq/cB0TSF6kJX+sNW2jkZU/s0V/KPfXtOa6tTk3wU3RuZBFjM9 H0ATD+qbCdC7n64L9QqkAvk3sh89xw=="}}}'

Example Response:

{"dns_servers":["dns1.p06.nsone.net","dns2.p06.nsone.net","dns3.p06.nsone.net","dns4.p06.nsone.net"],"dnssec":false,"network_pools":["p06"],"primary":{"enabled":false,"secondaries":[]},"disabled":false,"meta":{},"ttl":3600,"serial":1578928419,"id":"5e1c8923bbccf90001c16162","retry":7200,"zone":"newzone.com","networks":[0],"hostmaster":"[email protected]","nx_ttl":3600,"expiry":1209600,"records":[],"link":null,"pool":"p06","secondary":{"status":"pending","last_xfr":0,"other_ips":[],"primary_port":53,"enabled":true,"tsig":{"enabled":true,"hash":"hmac-md5","name":"tsigname","key":"+Cdjlkef9ZTSeixERZ433Q=="},"error":null,"other_ports":[],"primary_ip":"1.2.3.4","expired":false},"refresh":43200,"primary_master":"dns1.p06.nsone.net"}

Example Response:

{
  "answers": [
    {
      "answer": [
        "string"
      ],
      "id": "string",
      "meta": {
        "asn": [
          "string"
        ],
        "ca_province": [
          "string"
        ],
        "connections": 0,
        "country": [
          "string"
        ],
        "georegion": [
          "string"
        ],
        "high_watermark": 0,
        "ip_prefixes": [
          "string"
        ],
        "latitude": 0,
        "loadAvg": 0,
        "longitude": 0,
        "low_watermark": 0,
        "note": "string",
        "priority": 0,
        "pulsar": "string",
        "requests": 0,
        "up": true,
        "us_state": [
          "string"
        ],
        "weight": 0
      },
      "region": "string"
    }
  ],
  "domain": "string",
  "filters": [
    {
      "disabled": true,
      "filter": "string",
      "config": {
        "eliminate": false
      }
    }
  ],
  "id": "50eb9d77830f784f98b0dd59",
  "link": "string",
  "meta": {
    "asn": [
      "string"
    ],
    "ca_province": [
      "string"
    ],
    "connections": 0,
    "country": [
      "string"
    ],
    "georegion": [
      "string"
    ],
    "high_watermark": 0,
    "ip_prefixes": [
      "string"
    ],
    "latitude": 0,
    "loadAvg": 0,
    "longitude": 0,
    "low_watermark": 0,
    "note": "string",
    "priority": 0,
    "pulsar": "string",
    "requests": 0,
    "up": true,
    "us_state": [
      "string"
    ],
    "weight": 0
  },
  "networks": [
    0
  ],
  "regions": {
    "meta": {
      "asn": [
        "string"
      ],
      "ca_province": [
        "string"
      ],
      "connections": 0,
      "country": [
        "string"
      ],
      "georegion": [
        "string"
      ],
      "high_watermark": 0,
      "ip_prefixes": [
        "string"
      ],
      "latitude": 0,
      "loadAvg": 0,
      "longitude": 0,
      "low_watermark": 0,
      "note": "string",
      "priority": 0,
      "pulsar": "string",
      "requests": 0,
      "up": true,
      "us_state": [
        "string"
      ],
      "weight": 0
    }
  },
  "tier": 0,
  "ttl": 0,
  "type": "string",
  "use_client_subnet": true,
  "zone": "string",
  "blocked_tags": [
    "string"
  ],
  "local_tags": [
    "string"
  ],
  "tags": {}
}

Example Request:

{
  "answers": [
    {
      "answer": [
        10,
        "1.2.3.4"
      ],
      "meta": {
        "up": { feed: "520533b89f782d5b1a10a854" }
      }
    }
  ],
  "type": "MX",
  "domain": "mail.example.com",
  "zone": "example.com"
}

Example Response:

{
  "id": "52053b569f782d5b1a10a85a",
  "networks": [0],
  "type": "MX",
  "feeds": [],
  "customer": 1004,
  "domain": "mail.example.com",
  "zone": "example.com",
  "answers": [
    {
      "id": "52053b569f782d5b1a10a859",
      "feeds": [
        {
          "source": "a53252f9e583c6708331a1daeb172e12",
          "feed": "520533b89f782d5b1a10a854"
        }
      ],
      "answer": [
        10,
        "1.2.3.4"
      ],
      "meta": {
        "up": { feed: "520533b89f782d5b1a10a854" }
      }
    }
  ],
  "regions": {},
  "meta": {},
  "filters": [],
  "ttl": 3600,
  "use_client_subnet": true
}

Example Request:

{
  "answers": [
    {
      "answer": [
        10,
        "1.2.3.4"
      ]
    },
    {
      "answer": [
        20,
        "5.6.7.8"
      ]
    }
  ]
}

Example Response:

{
  "id": "52053b569f782d5b1a10a85a",
  "networks": [0],
  "type": "MX",
  "feeds": [],
  "tier": 1,
  "customer": 1004,
  "domain": "mail.example.com",
  "zone": "example.com",
  "answers": [
    {
      "id": "52053c239f782d5b1a10a85e",
      "answer": [
        10,
        "1.2.3.4"
      ]
    },
    {
      "id": "52053c239f782d5b1a10a85f",
      "answer": [
        20,
        "5.6.7.8"
      ]
    }
  ],
  "regions": {},
  "meta": {},
  "filters": [],
  "ttl": 3600,
  "use_client_subnet": true
}

Example Response:

{
  "georegion": {
    "desc": "Geographic region(s) associated with the answer or\n    region, e.g., the rough geographic location of the datacenter\n    where your server resides.  Each region must be a string, one of\n    'US-EAST', 'US-CENTRAL', 'US-WEST', 'EUROPE', 'ASIAPAC',\n    'SOUTH-AMERICA', 'AFRICA'.  The \"georegion\" value may be a single\n    region string, or a list of several such strings to associate an\n    answer/region with multiple geographic regions.",
    "category": "geographical",
    "shortdesc": "Geographic region"
  },
  "up": {
    "desc": "This boolean value indicates \"upness\" of answers or\n    regions.  If true (or 1), the answer/region is \"up\".  If false (or\n    0) it is \"down\".",
    "category": "status",
    "shortdesc": "Up/down"
  },
  ...
}

Example Response:

{
  "up": {
    "desc": "This filter eliminates all answers where the <code>up</code> metadata field is not <code>\"1\"</code>.",
    "config": {},
    "inputs": ["up"],
    "tier": 2,
    "shortdesc": "Removes \"down\" answers"
  },
  "sticky_region": {
    "desc": "This filter first sorts regions uniquely depending on\n        the IP address of the requester, and then groups all answers\n        together by region.  The same requester always gets the same\n        ordering of regions, but answers within each region may be in\n        any order.  You can use this filter with another one like\n        <span class=\"filtername-2\">SELECT_FIRST_REGION</span> to always\n        give a user answers from the same region.  Note that this\n        filter does <i>not</i> do any geotargeting or GSLB: it sorts\n        regions randomly but consistently for each user.  Answers with\n        no region defined are considered to be in the same (empty)\n        region.",
    "config": {},
    "inputs": [],
    "tier": 2,
    "shortdesc": "Make regions \"sticky\""
  },
  "select_first_n": {
    "desc": "This filter eliminates all but the first <code>N</code>\n        answers from the list.  Use this with filters like <span\n        class=\"filtername-2\">SHUFFLE</span> or <span\n        class=\"filtername-2\">SHUFFLE_WEIGHTED</span> to implement round\n        robin or weighted round robin.",
    "config": {
      "N": {
        "desc": "Number of answers to keep",
        "type": "number",
        "shortdesc": "Number of answers",
        "validator": "number",
        "required": false,
        "default": "1"
      }
    },
    "inputs": [],
    "tier": 2,
    "shortdesc": "Return the first \"N\" answers"
  },
  ...
}

Example Response:

{
    "subdivisions": {
	    ...
        "CA": [
            "MB",
            "NB",
            "NL",
            ...
            "YT",
            "ON",
            "BC"
        ],
        "RU": [
            "KOS",
            "SE",
            "IN",
            ...
            "LEN",
            "NGR",
            "SA"
        ],
		...
        "US": [
            "NM",
            "ND",
            "LA",
            ...
            "GU",
            "NY",
            "NV"
        ],
		...
	},
	 "countries": [
        "AD",
        "AE",
        "AF",
        ...
        "ZA",
        "ZM",
        "ZW"
    ]
}

Example Response:

[
  {
    "name": "string",
    "created_at": 0,
    "updated_at": 0,
    "read_acls": [
      "string"
    ],
    "update_acls": [
      "string"
    ],
    "zones": [
      "string"
    ],
    "networks": [
      1
    ],
    "preference": 0
  }
]

Example Response:

[
  {
    "name": "string",
    "created_at": 0,
    "updated_at": 0,
    "read_acls": [
      "string"
    ],
    "update_acls": [
      "string"
    ],
    "zones": [
      "string"
    ],
    "networks": [
      1
    ],
    "preference": 0
  }
]

Example Request:

curl -X PUT -H "X-NSONE-Key: $API_KEY" -d '{"filters":{},"read_acls":["private_net","staging_net"],"update_acls":[],"zones":["mycompany.local","mycompany.net"],"networks":[1],"preference":0}' https://api.nsone.net/v1/views/internal_view

Example Response:

{"name":"internal_view","networks":[1],"preference":0,"read_acls":["private_net","staging_net"],"update_acls":[],"zones":["mycompany.local","mycompany.net"]}

Example Request:

{
  "read_acls": [
    "SF_office",
    "LA_office"
  ],
  "zones": [
    "example.com"
  ],
  "networks": [
    1,
    2
  ]
}

Example Request:

curl -X POST -H "X-NSONE-Key: $API_KEY" -d '{"filters":{},"read_acls":["private_net","staging_net"],"update_acls":["trusted_ips"],"zones":["mycompany.local","mycompany.net"],"networks":[1],"preference":0}' https://api.nsone.net/v1/views/internal_view

Example Response:

{"name":"internal_view","networks":[1],"preference":0,"read_acls":["private_net","staging_net"],"update_acls":["trusted_ips"],"zones":["mycompany.local","mycompany.net"]}

Example Request:

curl -X DELETE -H "X-NSONE-Key: $API_KEY" 
https://api.nsone.net/v1/views/internal_view

Example Response:

{
  "property1": 0,
  "property2": 0
}

Example Request:

curl -X POST -H "X-NSONE-Key: $API_KEY" -d  '{
  "internalview": 1,
  "externalview": 2
}' https://api.nsone.net/v1/config/views/preference

Example Response:

[{"name":"docker.acl","gss_tsig_identities":[],"src_prefixes":["172.18.11.0/24","127.0.0.1/32"],"tsig_keys":[]},{"name":"private_net","gss_tsig_identities":["test/[email protected]"],"src_prefixes":["172.18.11.0/24","192.168.0.11-192.168.0.56"],"tsig_keys":["my.test.key."]}]

Example Request:

curl -X GET -H "X-NSONE-Key: $API_KEY" 
 https://api.mycompany.net/v1/acls/private_net 

Example Response:

{
  "name": "string",
  "src_prefixes": [
    "string"
  ],
  "tsig_keys": [
    "string"
  ],
  "gss_tsig_identities": [
    "string"
  ]
}

Example Request:

{
  "src_prefixes": [
    "172.18.0.0/16",
    "!172.18.12.0/24"
  ],
  "tsig_keys": [
    "tsig3",
    "tsig4"
  ],
  "gss_tsig_identities": [
    "[email protected]",
    "[email protected]"
  ]
}

Example Response:

{
  "name": "string",
  "src_prefixes": [
    "string"
  ],
  "tsig_keys": [
    "string"
  ],
  "gss_tsig_identities": [
    "string"
  ]
}

Example Request:

{
  "src_prefixes": [
    "172.18.0.0/16",
    "!172.18.12.0/24"
  ],
  "tsig_keys": [
    "tsig3",
    "tsig4"
  ],
  "gss_tsig_identities": [
    "[email protected]",
    "[email protected]"
  ]
}

Example Response:

{
  "name": "string",
  "src_prefixes": [
    "string"
  ],
  "tsig_keys": [
    "string"
  ],
  "gss_tsig_identities": [
    "string"
  ]
}

Example Request:

curl -X DELETE -H "X-NSONE-Key: $API_KEY" 
 https://api.mycompany.net/v1/acls/private_net 

Example Response:

[
  {
    "name": "string",
    "algorithm": "hmac-sha1",
    "secret": "string"
  }
]

Example Response:

{
  "name": "string",
  "algorithm": "hmac-sha1",
  "secret": "string"
}

Example Request:

{
  "algorithm": "hmac-sha512",
  "secret": "Ok1qR5IW1ajVka5cHPEJQIXfLyx5V3PSkFBROAzOn21JumDq6nIpoj6H8rfj5Uo+Ok55ZWQ0Wgrf302fDscHLw=="
}

Example Response:

{
  "name": "string",
  "algorithm": "hmac-sha1",
  "secret": "string"
}

Example Request:

{
  "algorithm": "hmac-sha1",
  "secret": "string"
}

Example Response:

{
  "name": "string",
  "algorithm": "hmac-sha1",
  "secret": "string"
}

Example Response:

{
  "monitis": {
    "desc": "Monitis is a monitoring solution.  To use this data source,\n    first create a new \"URL\" contact in your Monitis account with the NSONE\n    Feed URL.  When creating data feeds, set the \"Test Name\" field to\n    the name of the test in Monitis.  Make sure you set the \"Notify when\n    back up\" rule in Monitis for all your connected tests.  Data feeds from\n    this source update the <code>up</code> metadata field.",
    "config": {
      "api_key": {
        "desc": "Your Monitis API Key (in your Monitis dashboard, click Account, API Key)",
        "type": "text",
        "shortdesc": "Monitis API Key",
        "validator": "text",
        "required": true,
        "default": null
      },
      "secret_key": {
        "desc": "Your Monitis Secret Key (in your Monitis dashboard, click Account, API Key)",
        "type": "text",
        "shortdesc": "Monitis Secret Key",
        "validator": "text",
        "required": true,
        "default": null
      }
    },
    "feed_config": {
      "test_name": {
        "desc": "The name of the test in Monitis that corresponds to this feed",
        "type": "text",
        "shortdesc": "Test Name",
        "validator": "text",
        "required": true,
        "default": null
      }
    },
    "shortdesc": "Monitis Alert Notification"
  },
  "cloudwatch": {
    "desc": "Amazon Cloudwatch is a monitoring solution for Amazon\n    Web Services.  You must configure your Cloudwatch alarms to\n    publish messages to a Simple Notification Service (SNS) topic for\n    your NSONE Feed.  First, in the SNS console, create a topic for\n    your alarms; then create an HTTPS subscription for the topic with\n    your NSONE Feed URL.  Do not associate your Data Source with more\n    than one topic in SNS (you can always create another Data Source).\n    Ensure your Cloudwatch alarms send notifications to this SNS topic\n    and specify the Alarm Name of a Cloudwatch alarm when creating a\n    new Data Feed.  Data feeds from this source update the\n    <code>up</code> metadata field.",
    "config": {},
    "feed_config": {
      "alarm_name": {
        "desc": "The name of the Cloudwatch Alarm that corresponds to this feed",
        "type": "text",
        "shortdesc": "Alarm Name",
        "validator": "text",
        "required": true,
        "default": null
      }
    },
    "shortdesc": "Cloudwatch Alarm Notification"
  },
  "nsone_v1": {
    "desc": "The native NSONE data source, our own API.  Requires\n    normal NSONE API authentication via the <code>X-NSONE-Key</code>\n    header when sending requests to the Feed URL.  The body of your\n    data feed request must be a JSON object containing <b>either</b>\n    simple key/value pairs as in any normal record/region/answer\n    metadata table, e.g. <code>{\"up\": true}</code>, in which case the\n    updated values will be applied to <b>all</b> data feeds associated\n    with this data source; <b>or</b>, an object where keys match the\n    <code>label</code> for data feeds from this source, and values are\n    metadata update tables.  Data feeds from this source may update\n    any metadata field.",
    "config": {},
    "feed_config": {
      "label": {
        "desc": "Short/simple label for the service this feed is\n              for, like a server name, facility name, etc.",
        "type": "text",
        "shortdesc": "Label",
        "validator": "text",
        "required": true,
        "default": null
      }
    },
    "shortdesc": "NSONE Data Feed API v1"
  },
  ...
}

Example Request:

[
  {
    "name": "string",
    "sourcetype": "string",
    "config": {
      "property1": "string",
      "property2": "string"
    },
    "feeds": [],
    "id": "abfa2a71776ae5246724dce7b53c4371"
  }
]

Example Response:

{
  "sourcetype": "rackspace",
  "id": "f443e609c9a9182b3dab56b7abd74546",
  "config": {
    "webhook_token": "none"
  },
  "feeds": [
    {
      "destinations": [],
      "id": "520849a99f782d5b1a10a86d",
      "data": {
        "up": "false"
      },
      "config": {
        "entity_id": "enAAAAA",
        "alarm_id": "alAAAA"
      },
      "name": "server.example.com alert"
    }
  ],
  "name": "My Rackspace Source",
  "status": "ok"
}

Example Response:

{
  "name": "string",
  "sourcetype": "string",
  "config": {
    "property1": "string",
    "property2": "string"
  },
  "feeds": [],
  "id": "abfa2a71776ae5246724dce7b53c4371"
}

Example Request:

{
  "name": "Monitor.us New Name"
}

Example Response:

{
  "sourcetype": "monitor_us",
  "id": "0e308ec0266d9127d166e0cbd7ceffda",
  "config": {
    "api_key": "15PSVFCXA377TGUY0FJA7T9VZY",
    "secret_key": "47AOG8ATA1QNUC3H3UH2DRBXYZ"
  },
  "feeds": [],
  "name": "Monitor.us New Name",
  "status": "ok"
}

Example Response:

[
  {
    "destinations": [
      {
        "destid": "520519509f782d58bb4df418",
        "desttype": "answer",
        "record": "520519509f782d58bb4df419"
      }
    ],
    "id": "520533b89f782d5b1a10a851",
    "data": {
      "up": "true"
    },
    "config": {
      "label": "server-1"
    },
    "name": "Server 1 Feed"
  },
  {
    "destinations": [
      {
        "destid": "5205338e9f782d5b1a10a84e",
        "desttype": "answer",
        "record": "520519509f782d58bb4df419"
      }
    ],
    "id": "520533c09f782d5b1a10a852",
    "data": {
      "up": "true"
    },
    "config": {
      "label": "server-2"
    },
    "name": "Server 2 Feed"
  },
  {
    "destinations": [
      {
        "destid": "5205338e9f782d5b1a10a84f",
        "desttype": "answer",
        "record": "520519509f782d58bb4df419"
      }
    ],
    "id": "520533dc9f782d5b1a10a854",
    "data": {
      "up": "false"
    },
    "config": {
      "label": "server-8"
    },
    "name": "Server 8 Feed"
  },
  {
    "destinations": [
      {
        "destid": "5205338e9f782d5b1a10a850",
        "desttype": "answer",
        "record": "520519509f782d58bb4df419"
      }
    ],
    "id": "520533e49f782d5b1a10a855",
    "data": {
      "up": "true"
    },
    "config": {
      "label": "server-9"
    },
    "name": "Server 9 Feed"
  }
]

Example Response:

{
  "destinations": [
    {
      "destid": "5205338e9f782d5b1a10a84e",
      "desttype": "answer",
      "record": "520519509f782d58bb4df419"
    }
  ],
  "id": "520533c09f782d5b1a10a852",
  "data": {
    "up": "true"
  },
  "config": {
    "label": "server-2"
  },
  "name": "Server 2 Feed"
}

Example Request:

{
  "config": {
    "alarm_id": "a1AAAAA",
    "entity_id": "enAAAAA"
  },
  "name": "server.example.com alert"
}

Example Response:

{
  "destinations": [ ],
  "id": "5208fd909f782d3d253d62ae",
  "data": { },
  "config": {
    "entity_id": "enAAAAA",
    "alarm_id": "a1AAAAA"
  },
  "name": "server.example.com alert"
}

Example Request:

{
  "name": "new name"
}

Example Response:

{
  "destinations": [
    {
      "destid": "us-east",
      "desttype": "region",
      "record": "520519509f782d58bb4df419"
    },
    {
      "destid": "520519509f782d58bb4df418",
      "desttype": "answer",
      "record": "520519509f782d58bb4df419"
    }
  ],
  "id": "5208fd909f782d3d253d62ae",
  "config": {
    "entity_id": "enAAAAA",
    "alarm_id": "a1AAAAA"
  },
  "name": "new name"
}

Example Request:

{
  "server-1": {
    "up": false
  },
  "server-2": {
    "up": true
  }
}

Example Response:

[
  {
    "id": "52a27d4397d5f07003fdbe7b",
    "config": {
      "host": "1.2.3.4"
    },
    "status": {
      "lga": {
        "since": 1389407609,
        "status": "up"
      },
      "global": {
        "since": 1389407609,
        "status": "up"
      },
      "sjc": {
        "since": 1389404014,
        "status": "up"
      }
    },
    "rules": [
      {
        "key": "rtt",
        "value": 100,
        "comparison": "<"
      }
    ],
    "job_type": "ping",
    "regions": [
      "lga",
      "sjc"
    ],
    "active": true,
    "frequency": 60,
    "policy": "quorum",
    "region_scope": "fixed"
  }
]

Example Response:

{
  "notes": null,
  "name": "example.com:80",
  "notify_repeat": 0,
  "id": "52cae678830f7809ec5c9f6b",
  "region_scope": "fixed",
  "rapid_recheck": false,
  "frequency": 30,
  "job_type": "tcp",
  "notify_delay": 0,
  "notify_list": null,
  "notify_regional": false,
  "regions": [
    "ams"
  ],
  "policy": "quorum",
  "config": {
    "send": "HEAD / HTTP/1.0\r\n\r\n",
    "port": 80,
    "host": "1.2.3.4",
    "ssl": "0",
    "ipv6": false
  },
  "status": {
    "ams": {
      "since": 1389052665,
      "status": "down"
    },
    "global": {
      "since": 1389052665,
      "status": "down"
    }
  },
  "notify_failback": true,
  "rules": [
    {
      "value": "200 OK",
      "key": "output",
      "comparison": "contains"
    }
  ],
  "active": true
}

Example Request:

{
  "notify_list": "52cc775a2db1561b55135327",
  "notify_regional": false,
  "notify_failback": true,
  "notify_repeat": 0,
  "notify_delay": 65,
  "rules": [
    {
      "value": "200 OK",
      "comparison": "contains",
      "key": "output"
    },
    {
      "value": 200,
      "comparison": "<=",
      "key": "connect"
    }
  ],
  "config": {
    "ssl": "1",
    "send": "HEAD / HTTP/1.0\r\n\r\n",
    "port": 443,
    "host": "1.2.3.4"
  },
  "job_type": "tcp",
  "name": "myhost.com:443 monitor",
  "active": true,
  "rapid_recheck": true,
  "region_scope": "fixed",
  "regions": [
    "lga",
    "sjc"
  ],
  "frequency": 30,
  "policy": "quorum",
  "notes": "If this monitor is down then the webserver on myhost.com:443 is down or too slow!"
}

Example Response:

{
  "status": {
    "global": {
      "since": 1389458558,
      "status": "pending"
    }
  },
  "notes": "If this monitor is down then the webserver on myhost.com:443 is down or too slow!",
  "policy": "quorum",
  "frequency": 30,
  "regions": [
    "lga",
    "sjc"
  ],
  "region_scope": "fixed",
  "active": true,
  "rapid_recheck": true,
  "name": "myhost.com:443 monitor",
  "job_type": "tcp",
  "config": {
    "ssl": "1",
    "send": "HEAD / HTTP/1.0\r\n\r\n",
    "port": 443,
    "host": "1.2.3.4"
  },
  "rules": [
    {
      "value": "200 OK",
      "comparison": "contains",
      "key": "output"
    },
    {
      "value": 200,
      "comparison": "<=",
      "key": "connect"
    }
  ],
  "notify_delay": 65,
  "notify_repeat": 0,
  "notify_failback": true,
  "notify_regional": false,
  "notify_list": "52cc775a2db1561b55135327",
  "id": "52cc79123db8711b6713554a"
}

Example Request:

{
  "notes": "Some new notes for this job",
  "policy": "all",
  "frequency": 40
}

Example Response:

{
  "status": {
    "global": {
      "since": 1389458558,
      "status": "pending"
    }
  },
  "notes": "Some new notes for this job",
  "policy": "all",
  "frequency": 40,
  "regions": [
    "lga",
    "sjc"
  ],
  "region_scope": "fixed",
  "active": true,
  "rapid_recheck": false,
  "name": "myhost.com:443 monitor",
  "job_type": "tcp",
  "config": {
    "ssl": "1",
    "send": "HEAD / HTTP/1.0\r\n\r\n",
    "port": 443,
    "host": "1.2.3.4"
  },
  "rules": [
    {
      "value": "200 OK",
      "comparison": "contains",
      "key": "output"
    },
    {
      "value": 200,
      "comparison": "<=",
      "key": "connect"
    }
  ],
  "notify_delay": 65,
  "notify_repeat": 0,
  "notify_failback": true,
  "notify_regional": false,
  "notify_list": "52cc775a2db1561b55135327",
  "id": "52cc79123db8711b6713554a"
}