2
0
mirror of https://github.com/VinylDNS/vinyldns synced 2025-09-05 08:45:11 +00:00
Files
vinyldns/api/list-zones.html
2020-03-09 11:06:36 -04:00

209 lines
23 KiB
HTML

<html><head><title>VinylDNS: List / Search Zones</title><meta charset="utf-8" /><meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" /><meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="author" content="VinylDNS" /><meta name="description" content="DNS Management Platform" /><meta name="og:image" content="/img/poster.png" /><meta name="og:title" content="VinylDNS: List / Search Zones" /><meta name="og:site_name" content="VinylDNS" /><meta name="og:url" content="http://vinyldns.io" /><meta name="og:type" content="website" /><meta name="og:description" content="DNS Management Platform" /><link rel="icon" type="image/png" href="/img/favicon.png" /><meta name="twitter:title" content="VinylDNS: List / Search Zones" /><meta name="twitter:image" content="http://vinyldns.ioimg/poster.png" /><meta name="twitter:description" content="DNS Management Platform" /><meta name="twitter:card" content="summary_large_image" /><link rel="icon" type="image/png" sizes="16x16" href="/img/favicon16x16.png" /><link rel="icon" type="image/png" sizes="24x24" href="/img/favicon24x24.png" /><link rel="icon" type="image/png" sizes="32x32" href="/img/favicon32x32.png" /><link rel="icon" type="image/png" sizes="48x48" href="/img/favicon48x48.png" /><link rel="icon" type="image/png" sizes="57x57" href="/img/favicon57x57.png" /><link rel="icon" type="image/png" sizes="60x60" href="/img/favicon60x60.png" /><link rel="icon" type="image/png" sizes="64x64" href="/img/favicon64x64.png" /><link rel="icon" type="image/png" sizes="70x70" href="/img/favicon70x70.png" /><link rel="icon" type="image/png" sizes="72x72" href="/img/favicon72x72.png" /><link rel="icon" type="image/png" sizes="76x76" href="/img/favicon76x76.png" /><link rel="icon" type="image/png" sizes="96x96" href="/img/favicon96x96.png" /><link rel="icon" type="image/png" sizes="114x114" href="/img/favicon114x114.png" /><link rel="icon" type="image/png" sizes="120x120" href="/img/favicon120x120.png" /><link rel="icon" type="image/png" sizes="128x128" href="/img/favicon128x128.png" /><link rel="icon" type="image/png" sizes="144x144" href="/img/favicon144x144.png" /><link rel="icon" type="image/png" sizes="150x150" href="/img/favicon150x150.png" /><link rel="icon" type="image/png" sizes="152x152" href="/img/favicon152x152.png" /><link rel="icon" type="image/png" sizes="196x196" href="/img/favicon196x196.png" /><link rel="icon" type="image/png" sizes="310x310" href="/img/favicon310x310.png" /><link rel="icon" type="image/png" sizes="310x150" href="/img/favicon310x150.png" /><link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css" /><link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css" /><link rel="stylesheet" href="/highlight/styles/default.css" /><link rel="stylesheet" href="/css/style.css" /><link rel="stylesheet" href="/css/palette.css" /><link rel="stylesheet" href="/css/codemirror.css" /><link rel="stylesheet" href="/css/custom.css" /></head><body class="docs"><div id="wrapper"><div id="sidebar-wrapper"><ul id="sidebar" class="sidebar-nav"><li class="sidebar-brand"><a href="/" class="brand"><div class="brand-wrapper"><span>VinylDNS</span></div></a></li> <li><a href="/api/index" class="">API documentation</a></li> <li><a href="/api/auth-mechanism.html" class="">Authentication</a></li> <li><a href="/api/zone-model.html" class="">Zone</a> <ul class="sub_section"> <li><a href="/api/zone-model.html" class="">Zone Model</a></li> <li><a href="/api/create-zone.html" class="">Create Zone</a></li> <li><a href="/api/update-zone.html" class="">Update Zone</a></li> <li><a href="/api/delete-zone.html" class="">Delete Zone</a></li> <li><a href="/api/get-zone-by-id.html" class="">Get Zone by ID</a></li> <li><a href="/api/get-zone-by-name.html" class="">Get Zone by Name</a></li> <li><a href="/api/list-zones.html" class="">List / Search Zone</a></li> <li><a href="/api/sync-zone.html" class="">Sync Zone</a></li> <li><a href="/api/list-zone-changes.html" class="">List Zone Changes</a></li></ul></li> <li><a href="/api/recordset-model.html" class="">RecordSet</a> <ul class="sub_section"> <li><a href="/api/recordset-model.html" class="">RecordSet Model</a></li> <li><a href="/api/create-recordset.html" class="">Create RecordSet</a></li> <li><a href="/api/update-recordset.html" class="">Update RecordSet</a></li> <li><a href="/api/delete-recordset.html" class="">Delete RecordSet</a></li> <li><a href="/api/get-recordset.html" class="">Get RecordSet</a></li> <li><a href="/api/list-recordsets.html" class="">List / Search RecordSets</a></li> <li><a href="/api/get-recordset-change.html" class="">Get RecordSet Change</a></li> <li><a href="/api/list-recordset-changes.html" class="">List RecordSet Changes</a></li></ul></li> <li><a href="/api/batchchange-model.html" class="">Batch Change</a> <ul class="sub_section"> <li><a href="/api/batchchange-model.html" class="">Batch Change Model</a></li> <li><a href="/api/create-batchchange.html" class="">Create Batch Change</a></li> <li><a href="/api/get-batchchange.html" class="">Get Batch Change</a></li> <li><a href="/api/list-batchchanges.html" class="">List Batch Changes</a></li> <li><a href="/api/batchchange-errors.html" class="">Batch Change Errors</a></li> <li><a href="/api/cancel-batchchange.html" class="">Cancel Batch Change</a></li> <li><a href="/api/approve-batchchange.html" class="">Approve Batch Change</a></li> <li><a href="/api/reject-batchchange.html" class="">Reject Batch Change</a></li></ul></li> <li><a href="/api/membership-model.html" class="">Membership</a> <ul class="sub_section"> <li><a href="/api/membership-model.html" class="">Membership Model</a></li> <li><a href="/api/create-group.html" class="">Create Group</a></li> <li><a href="/api/update-group.html" class="">Update Group</a></li> <li><a href="/api/delete-group.html" class="">Delete Group</a></li> <li><a href="/api/get-group.html" class="">Get Group</a></li> <li><a href="/api/list-groups.html" class="">List Groups</a></li> <li><a href="/api/list-group-admins.html" class="">List Group Admins</a></li> <li><a href="/api/list-group-members.html" class="">List Group Members</a></li> <li><a href="/api/list-group-activity.html" class="">List Group Activity</a></li></ul></li></ul></div><div id="page-content-wrapper"><div class="nav"><div class="container-fluid"><div class="row"><div class="col-lg-12"><div class="action-menu pull-left clearfix"><a href="#menu-toggle" id="menu-toggle"><i class="fa fa-bars" aria-hidden="true"></i></a></div><ul class="pull-right"><li id="gh-eyes-item" class="hidden-xs"><a href="https://github.com/VinylDNS/vinyldns"><i class="fa fa-eye"></i><span>WATCH<span id="eyes" class="label label-default">--</span></span></a></li><li id="gh-stars-item" class="hidden-xs"><a href="https://github.com/VinylDNS/vinyldns"><i class="fa fa-star-o"></i><span>STARS<span id="stars" class="label label-default">--</span></span></a></li></ul></div></div></div></div><div id="content" data-github-owner="VinylDNS" data-github-repo="vinyldns"><div class="content-wrapper"><section><h1 id="list--search-zone">List / Search Zone</h1>
<p>Retrieves the list of zones a user has access to. The zone name is only sorted alphabetically.</p>
<h4 id="http-request">HTTP REQUEST</h4>
<blockquote>
<table>
<tbody>
<tr>
<td>GET /zones?nameFilter={yoursearchhere}&amp;startFrom={response.nextId}&amp;maxItems={1 - 100}&amp;ignoreAccess={true</td>
<td>false}</td>
</tr>
</tbody>
</table>
</blockquote>
<h4 id="http-request-params">HTTP REQUEST PARAMS</h4>
<table>
<thead>
<tr>
<th>name</th>
<th>type</th>
<th>required?</th>
<th style="text-align: left">description</th>
</tr>
</thead>
<tbody>
<tr>
<td>nameFilter</td>
<td>string</td>
<td>no</td>
<td style="text-align: left">Characters that are part of the zone name to search for. The wildcard character <code class="highlighter-rouge">*</code> is supported, for example <code class="highlighter-rouge">www*</code>. Omit the wildcard character when searching for an exact zone name.</td>
</tr>
<tr>
<td>startFrom</td>
<td><em>any</em></td>
<td>no</td>
<td style="text-align: left">In order to advance through pages of results, the startFrom is set to the <code class="highlighter-rouge">nextId</code> that is returned on the previous response. It is up to the client to maintain previous pages if the client wishes to advance forward and backward. If not specified, will return the first page of results</td>
</tr>
<tr>
<td>maxItems</td>
<td>int</td>
<td>no</td>
<td style="text-align: left">The number of items to return in the page. Valid values are 1 - 100. Defaults to 100 if not provided.</td>
</tr>
<tr>
<td>ignoreAccess</td>
<td>boolean</td>
<td>no</td>
<td style="text-align: left">If false, returns only zones the requesting user owns or has ACL access to. If true, returns zones in the system, regardless of ownership. Defaults to false if not provided.</td>
</tr>
</tbody>
</table>
<h4 id="http-response-types">HTTP RESPONSE TYPES</h4>
<table>
<thead>
<tr>
<th>Code</th>
<th style="text-align: left">description</th>
</tr>
</thead>
<tbody>
<tr>
<td>200</td>
<td style="text-align: left"><strong>OK</strong> - The zones and search info are returned in response body</td>
</tr>
<tr>
<td>401</td>
<td style="text-align: left"><strong>Unauthorized</strong> - The authentication information provided is invalid. Typically the request was not signed properly, or the access key and secret used to sign the request are incorrect</td>
</tr>
<tr>
<td>403</td>
<td style="text-align: left"><strong>Forbidden</strong> - The user does not have the access required to perform the action</td>
</tr>
</tbody>
</table>
<h4 id="http-response-attributes">HTTP RESPONSE ATTRIBUTES</h4>
<table>
<thead>
<tr>
<th>name</th>
<th>type</th>
<th style="text-align: left">description</th>
</tr>
</thead>
<tbody>
<tr>
<td>zones</td>
<td>Array of <a href="../api/zone-model#zone-attributes">Zones</a></td>
<td style="text-align: left">An array of the zones found. The zones are sorted alphabetically by zone name.</td>
</tr>
<tr>
<td>startFrom</td>
<td><em>any</em></td>
<td style="text-align: left">(optional) The startFrom parameter that was sent in on the HTTP request. Will not be present if the startFrom parameter was not sent</td>
</tr>
<tr>
<td>nextId</td>
<td><em>any</em></td>
<td style="text-align: left">(optional) The identifier to be passed in as the <em>startFrom</em> parameter to retrieve the next page of results. If there are no results left, this field will not be present.</td>
</tr>
<tr>
<td>maxItems</td>
<td>int</td>
<td style="text-align: left">The maxItems parameter that was sent in the HTTP request. This will be 100 if not sent.</td>
</tr>
<tr>
<td>ignoreAccess</td>
<td>boolean</td>
<td style="text-align: left">The ignoreAccess parameter that was sent in the HTTP request. This will be false if not sent.</td>
</tr>
</tbody>
</table>
<h4 id="example-response">EXAMPLE RESPONSE</h4>
<div class="highlighter-rouge"><pre class="highlight"><code><span class="p">{</span><span class="w">
</span><span class="nt">"zones"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
</span><span class="p">{</span><span class="w">
</span><span class="nt">"status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Active"</span><span class="p">,</span><span class="w">
</span><span class="nt">"account"</span><span class="p">:</span><span class="w"> </span><span class="s2">"a0b5ea74-cc05-4932-a294-9bf935d52744"</span><span class="p">,</span><span class="w">
</span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"list-zones-test-searched-1."</span><span class="p">,</span><span class="w">
</span><span class="nt">"created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-12-16T15:21:47Z"</span><span class="p">,</span><span class="w">
</span><span class="nt">"adminGroupId"</span><span class="p">:</span><span class="w"> </span><span class="s2">"a0b5ea74-cc05-4932-a294-9bf935d52744"</span><span class="p">,</span><span class="w">
</span><span class="nt">"email"</span><span class="p">:</span><span class="w"> </span><span class="s2">"test@test.com"</span><span class="p">,</span><span class="w">
</span><span class="nt">"shared"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
</span><span class="nt">"acl"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
</span><span class="nt">"rules"</span><span class="p">:</span><span class="w"> </span><span class="p">[]</span><span class="w">
</span><span class="p">},</span><span class="w">
</span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"31a3d8a9-bea0-458f-9c24-3d39d4b929d6"</span><span class="p">,</span><span class="w">
</span><span class="nt">"latestSync"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-12-16T15:27:26Z"</span><span class="p">,</span><span class="w">
</span><span class="nt">"accessLevel"</span><span class="p">:</span><span class="w"> </span><span class="s2">"NoAccess"</span><span class="w">
</span><span class="p">},</span><span class="w">
</span><span class="p">{</span><span class="w">
</span><span class="nt">"status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Active"</span><span class="p">,</span><span class="w">
</span><span class="nt">"account"</span><span class="p">:</span><span class="w"> </span><span class="s2">"a0b5ea74-cc05-4932-a294-9bf935d52744"</span><span class="p">,</span><span class="w">
</span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"list-zones-test-searched-2."</span><span class="p">,</span><span class="w">
</span><span class="nt">"created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-12-16T15:21:47Z"</span><span class="p">,</span><span class="w">
</span><span class="nt">"adminGroupId"</span><span class="p">:</span><span class="w"> </span><span class="s2">"a0b5ea74-cc05-4932-a294-9bf935d52744"</span><span class="p">,</span><span class="w">
</span><span class="nt">"email"</span><span class="p">:</span><span class="w"> </span><span class="s2">"test@test.com"</span><span class="p">,</span><span class="w">
</span><span class="nt">"shared"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
</span><span class="nt">"acl"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
</span><span class="nt">"rules"</span><span class="p">:</span><span class="w"> </span><span class="p">[]</span><span class="w">
</span><span class="p">},</span><span class="w">
</span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"f1a376b2-2d8f-41f3-b8c8-9c9fba308f5d"</span><span class="p">,</span><span class="w">
</span><span class="nt">"latestSync"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-12-16T15:27:26Z"</span><span class="p">,</span><span class="w">
</span><span class="nt">"accessLevel"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Delete"</span><span class="w">
</span><span class="p">},</span><span class="w">
</span><span class="p">{</span><span class="w">
</span><span class="nt">"status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Active"</span><span class="p">,</span><span class="w">
</span><span class="nt">"account"</span><span class="p">:</span><span class="w"> </span><span class="s2">"a0b5ea74-cc05-4932-a294-9bf935d52744"</span><span class="p">,</span><span class="w">
</span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"list-zones-test-searched-3."</span><span class="p">,</span><span class="w">
</span><span class="nt">"created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-12-16T15:21:47Z"</span><span class="p">,</span><span class="w">
</span><span class="nt">"adminGroupId"</span><span class="p">:</span><span class="w"> </span><span class="s2">"a0b5ea74-cc05-4932-a294-9bf935d52744"</span><span class="p">,</span><span class="w">
</span><span class="nt">"email"</span><span class="p">:</span><span class="w"> </span><span class="s2">"test@test.com"</span><span class="p">,</span><span class="w">
</span><span class="nt">"shared"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
</span><span class="nt">"acl"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
</span><span class="nt">"rules"</span><span class="p">:</span><span class="w"> </span><span class="p">[]</span><span class="w">
</span><span class="p">},</span><span class="w">
</span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"568de57d-cb34-4f05-a9b5-35f9187490af"</span><span class="p">,</span><span class="w">
</span><span class="nt">"latestSync"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-12-16T15:27:26Z"</span><span class="p">,</span><span class="w">
</span><span class="nt">"accessLevel"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Read"</span><span class="w">
</span><span class="p">},</span><span class="w">
</span><span class="p">{</span><span class="w">
</span><span class="nt">"status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Active"</span><span class="p">,</span><span class="w">
</span><span class="nt">"account"</span><span class="p">:</span><span class="w"> </span><span class="s2">"a0b5ea74-cc05-4932-a294-9bf935d52744"</span><span class="p">,</span><span class="w">
</span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"list-zones-test-unfiltered-1."</span><span class="p">,</span><span class="w">
</span><span class="nt">"created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-12-16T15:21:47Z"</span><span class="p">,</span><span class="w">
</span><span class="nt">"adminGroupId"</span><span class="p">:</span><span class="w"> </span><span class="s2">"a0b5ea74-cc05-4932-a294-9bf935d52744"</span><span class="p">,</span><span class="w">
</span><span class="nt">"email"</span><span class="p">:</span><span class="w"> </span><span class="s2">"test@test.com"</span><span class="p">,</span><span class="w">
</span><span class="nt">"shared"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
</span><span class="nt">"acl"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
</span><span class="nt">"rules"</span><span class="p">:</span><span class="w"> </span><span class="p">[]</span><span class="w">
</span><span class="p">},</span><span class="w">
</span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"98dac90c-236e-4171-8729-c977ad38717e"</span><span class="p">,</span><span class="w">
</span><span class="nt">"latestSync"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-12-16T15:27:26Z"</span><span class="p">,</span><span class="w">
</span><span class="nt">"accessLevel"</span><span class="p">:</span><span class="w"> </span><span class="s2">"NoAccess"</span><span class="w">
</span><span class="p">},</span><span class="w">
</span><span class="p">{</span><span class="w">
</span><span class="nt">"status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Active"</span><span class="p">,</span><span class="w">
</span><span class="nt">"account"</span><span class="p">:</span><span class="w"> </span><span class="s2">"a0b5ea74-cc05-4932-a294-9bf935d52744"</span><span class="p">,</span><span class="w">
</span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"list-zones-test-unfiltered-2."</span><span class="p">,</span><span class="w">
</span><span class="nt">"created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-12-16T15:21:47Z"</span><span class="p">,</span><span class="w">
</span><span class="nt">"adminGroupId"</span><span class="p">:</span><span class="w"> </span><span class="s2">"a0b5ea74-cc05-4932-a294-9bf935d52744"</span><span class="p">,</span><span class="w">
</span><span class="nt">"email"</span><span class="p">:</span><span class="w"> </span><span class="s2">"test@test.com"</span><span class="p">,</span><span class="w">
</span><span class="nt">"shared"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
</span><span class="nt">"acl"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
</span><span class="nt">"rules"</span><span class="p">:</span><span class="w"> </span><span class="p">[]</span><span class="w">
</span><span class="p">},</span><span class="w">
</span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"e4942020-b85a-421f-a8e2-124d8ba79422"</span><span class="p">,</span><span class="w">
</span><span class="nt">"latestSync"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2016-12-16T15:27:26Z"</span><span class="p">,</span><span class="w">
</span><span class="nt">"accessLevel"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Read"</span><span class="w">
</span><span class="p">}</span><span class="w">
</span><span class="p">],</span><span class="w">
</span><span class="nt">"maxItems"</span><span class="p">:</span><span class="w"> </span><span class="mi">100</span><span class="p">,</span><span class="w">
</span><span class="nt">"ignoreAccess"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w">
</span><span class="p">}</span><span class="w">
</span></code></pre>
</div>
</section><div class="edit-button"><a href="https://github.com/VinylDNS/vinyldns/edit/master/modules/docs/src/main/tut/api/list-zones.md" class="btn-sm btn-info">Improve this page</a></div></div></div></div></div><script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/1.11.3/jquery.min.js"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/js/bootstrap.min.js"></script><script src="/highlight/highlight.pack.js"></script><script>hljs.configure({languages:['scala','java','bash']});
hljs.initHighlighting();
</script><script>((window.gitter = {}).chat = {}).options = {
room: 'vinyldns/Lobby'};</script><script src="https://sidecar.gitter.im/dist/sidecar.v1.js"></script><script src="/js/main.js"></script></body></html>