External DocumentationTo learn more, visit the IBM NS1 Connect documentation.
Basic Parameters
| Parameter | Description |
|---|---|
| Answers | DNS answers by which to filter results. Note: Text can be prefixed and/or suffixed with * for pattern matching. |
| Domain | Domain or subdomain by which to filter results. |
| Expand | Set to true to expand the search results to include record details. |
| Tags | List of one or more tags by which to filter results. Note: You can prepend the key and/or value with an asterisk (e.g., tag=key or tag=*key or tag=key=>value). |
| Type | Record type by which to filter results. |
| Version | The ID associated with the zone version. The response includes zone data corresponding to the specified zone version. If not set, the active zone version is returned. |
Advanced Parameters
| Parameter | Description |
|---|---|
| Limit | Maximum number of results to return in the response. Default is 20. A value of -1 means no limit. |
| Next | If pagination is enabled and the number of results exceeds the defined limit, then the response includes a “next” value which you can apply as a query parameter in a subsequent request to view the next set of results. |
| Pagination | Set to true to enable pagination for the search results. |
Example Output
{
"total_results": 1,
"next": "next",
"limit": 1,
"results": [
{
"domain": "www.example.com",
"type": "A",
"zone_fqdn": "example.com",
"zone_handle": "example.com"
}
]
}