{"openapi":"3.1.0","info":{"version":"1.0.0","title":"The No-IP API","description":"The No-IP API\n"},"servers":[{"url":"https://api.noip.com","description":"Production environment. Data at this URL is published to production DNS network."}],"tags":[{"name":"clients","description":"Dynamic Update Client resources.","x-displayName":"clients"},{"name":"DDNS Keys","description":"Dynamic DNS authentication keys.","x-displayName":"DDNS Keys"},{"name":"zones","description":"Manage zones and their settings.","x-displayName":"zones"},{"name":"zone_authorities","description":"Manage zones authorities and their settings.","x-displayName":"zone_authorities"},{"name":"records","description":"Manage data related to the DNS name as a whole, or to its enclosed RRSets, not individual rdata.","x-displayName":"records"},{"name":"meta","description":"Get information about this API.","x-displayName":"meta"}],"paths":{"/v1/account/ddns-keys/{ddns_key_username}":{"get":{"tags":["DDNS Keys"],"summary":"Get a DDNS key.","description":"Get data associated with a DDNS key.","operationId":"v1/accountGetDDNSKey","parameters":[{"$ref":"#/components/parameters/ddns_key_username"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/AccountDDNSKeyTargets"},{"properties":{"warnings":{"type":"array","items":{"$ref":"#/components/schemas/AccountWarning"}}},"type":"object"}]}}}},"401":{"description":"Unauthenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountErrorResponse"}}}}},"security":[{"Basic":[]},{"Bearer":[]}]},"put":{"tags":["DDNS Keys"],"summary":"Edit a DDNS key.","description":"Edit the data and hostnames attached to a DDNS key.","operationId":"v1/accountUpdateDDNSKey","parameters":[{"$ref":"#/components/parameters/ddns_key_username"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountDDNSKeyRequestEditAPI"}}}},"responses":{"202":{"description":"Updated","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/AccountVoidHttpResource"},{"properties":{"warnings":{"type":"array","items":{"$ref":"#/components/schemas/AccountWarning"}}},"type":"object"}]}}}},"401":{"description":"Unauthenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountErrorResponse"}}}}},"security":[{"Basic":[]},{"Bearer":[]}]},"delete":{"tags":["DDNS Keys"],"summary":"Delete a DDNS key.","description":"Delete an existing DDNS key.","operationId":"v1/accountDeleteDDNSKey","parameters":[{"$ref":"#/components/parameters/ddns_key_username"}],"responses":{"200":{"description":"Deleted","content":{"application/json":{"schema":{"properties":{"warnings":{"type":"array","items":{"$ref":"#/components/schemas/AccountWarning"}}},"type":"object"}}}},"401":{"description":"Unauthenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountErrorResponse"}}}}},"security":[{"Basic":[]},{"Bearer":[]}]}},"/v1/account/ddns-keys":{"get":{"tags":["DDNS Keys"],"summary":"List DDNS keys.","description":"Get a paginated collection of DDNS Keys.","operationId":"v1/accountListDDNSKeys","parameters":[{"name":"offset","in":"query","description":"Offset from beginning of list","required":false,"deprecated":false,"schema":{"type":"integer"},"example":3},{"name":"limit","in":"query","description":"Maximum number of results to return","required":false,"deprecated":false,"schema":{"type":"integer"},"example":25},{"name":"sort","in":"query","description":"Sort options; allowed fields: created_at","required":false,"deprecated":false,"style":"deepObject","schema":{"properties":{"created_at":{"type":"string","enum":["asc","desc"]}},"type":"object"},"example":{"created_at":"asc"}},{"name":"filter","in":"query","description":"Filter options; allowed fields: description","required":false,"deprecated":false,"style":"deepObject","schema":{"properties":{"description":{"type":"string"}},"type":"object"},"example":{"description":"asc"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/AccountDDNSKeyCollection"},{"properties":{"warnings":{"type":"array","items":{"$ref":"#/components/schemas/AccountWarning"}}},"type":"object"}]}}}},"401":{"description":"Unauthenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountErrorResponse"}}}}},"security":[{"Basic":[]},{"Bearer":[]}]},"post":{"tags":["DDNS Keys"],"summary":"Create a DDNS key.","description":"Create a new DDNS key.","operationId":"v1/accountCreateDDNSKey","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountDDNSKeyRequestPost"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/AccountDDNSKeyCreated"},{"properties":{"warnings":{"type":"array","items":{"$ref":"#/components/schemas/AccountWarning"}}},"type":"object"}]}}}},"401":{"description":"Unauthenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountErrorResponse"}}}},"402":{"description":"Payment required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountErrorResponse"}}}}},"security":[{"Basic":[]},{"Bearer":[]}]}},"/v1/dns/about":{"get":{"tags":["meta"],"summary":"Get information about API","description":"Get information about the API, including name and version.","operationId":"v1/dnsAbout","responses":{"200":{"description":"About DNS API","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerInfo"}}}}},"security":[{"bearer":[]},{"basic":[]}]}},"/v1/dns/records":{"get":{"tags":["records"],"summary":"List DNS names","description":"Lists the dns names of the user.\nThe type of the results can be selected using the `view` parameter.\nResults can be filtered and sorted using the `filter` and `sort` parameters,\nand filtered by `zone`, `name` and `rrset` metadata using metadata filter expressions.","operationId":"v1/dnsListNames","parameters":[{"name":"view","in":"query","description":"Record format (defaults to summary)","required":false,"schema":{"$ref":"#/components/schemas/DnsNameViewType"},"style":"form","example":"summary"},{"name":"offset","in":"query","description":"Offset from beginning of list","required":false,"schema":{"type":"integer","format":"int64","minimum":0},"style":"form","example":0},{"name":"limit","in":"query","description":"Maximum number of results to return","required":false,"schema":{"type":"integer","format":"int64","minimum":0},"style":"form","example":20},{"name":"sort","in":"query","description":"Sort options: (allowed fields: zone_name, name, name_labels_reversed, dns_type, rdata, label, zone_is_shared, created_at; allowed sorting: asc, desc).","required":false,"schema":{"type":"object","properties":{"zone_name":{"type":"string","enum":["asc","desc"],"example":"asc"},"name":{"type":"string","enum":["asc","desc"],"example":"asc"},"name_labels_reversed":{"type":"string","enum":["asc","desc"],"example":"asc"},"dns_type":{"type":"string","enum":["asc","desc"],"example":"asc"},"rdata":{"type":"string","enum":["asc","desc"],"example":"asc"},"label":{"type":"string","enum":["asc","desc"],"example":"asc"},"zone_is_shared":{"type":"string","enum":["asc","desc"],"example":"asc"},"created_at":{"type":"string","enum":["asc","desc"],"example":"asc"}},"examples":[{"zone_name":"asc","name":"asc","name_labels_reversed":"asc","dns_type":"asc","rdata":"asc","label":"asc","zone_is_shared":"asc","created_at":"asc"}]},"style":"deepObject","example":{"zone_name":"asc","name":"asc","name_labels_reversed":"asc","dns_type":"asc","rdata":"asc","label":"asc","zone_is_shared":"asc","created_at":"asc"}},{"name":"filter","in":"query","description":"Filter options: (allowed fields: name, zone_name, dns_type, zone_is_shared, dynupdate)","required":false,"schema":{"$ref":"#/components/schemas/FilterDnsNameList","description":"Filter options: (allowed fields: name, zone_name, dns_type, zone_is_shared, dynupdate)"},"style":"deepObject","example":{"dns_name":["www"],"zone_name":["example-zone-a.com","example-zone-b.com"],"dns_type":["A"],"zone_is_shared":true,"update_group":["dns-group-1"],"dynupdate":true,"label":["rdata-label"],"rdata":["192.0.2.1"]}},{"name":"expand[]","in":"query","description":"Sub-resource expansion options. (allowed resources: offline_settings)","required":false,"schema":{"type":"array","items":{"type":"string","enum":["offline_settings"]},"examples":[["offline_settings"]]},"style":"form","example":["offline_settings"]},{"name":"zone_metadata","in":"query","description":"Filter results by zone metadata.\nSee [metadata filters](metadata-filter-expressions) for an in-depth description of the expression syntax.","required":false,"schema":{"$ref":"#/components/schemas/MetadataFilterExpression"},"style":"form","example":"{\"or\":[{\"and\":[{\"op\":\"contains\",\"key\":\"key1\",\"value\":\"value1\"},{\"op\":\"exact\",\"key\":\"key2\",\"value\":\"value2\"}]},{\"op\":\"exact\",\"key\":\"key3\",\"value\":\"value3\"}]}"},{"name":"metadata","in":"query","description":"Filter results by DNS name metadata.\nSee [metadata filters](metadata-filter-expressions) for an in-depth description of the expression syntax.","required":false,"schema":{"$ref":"#/components/schemas/MetadataFilterExpression"},"style":"form","example":"{\"or\":[{\"and\":[{\"op\":\"contains\",\"key\":\"key1\",\"value\":\"value1\"},{\"op\":\"exact\",\"key\":\"key2\",\"value\":\"value2\"}]},{\"op\":\"exact\",\"key\":\"key3\",\"value\":\"value3\"}]}"},{"name":"rrset_metadata","in":"query","description":"Filter results by RRSet metadata.\nSee [metadata filters](metadata-filter-expressions) for an in-depth description of the expression syntax.","required":false,"schema":{"$ref":"#/components/schemas/MetadataFilterExpression"},"style":"form","example":"{\"or\":[{\"and\":[{\"op\":\"contains\",\"key\":\"key1\",\"value\":\"value1\"},{\"op\":\"exact\",\"key\":\"key2\",\"value\":\"value2\"}]},{\"op\":\"exact\",\"key\":\"key3\",\"value\":\"value3\"}]}"}],"responses":{"200":{"description":"DNS name data","content":{"application/json":{"schema":{"type":"object","description":"DNS name data","required":["data","page"],"properties":{"data":{"$ref":"#/components/schemas/DnsNameData","description":"DNS name data"},"page":{"$ref":"#/components/schemas/PageInfo"},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/Warning"}}}}}}},"400":{"description":"invalid sort key (code: 4251)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"unauthorized (code: 2465)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearer":[]},{"basic":[]}]}},"/v1/dns/records/{zone_name}":{"get":{"tags":["records"],"summary":"List DNS names in a zone","description":"Lists the dns names of the user in a given zone.\nResults can be sorted using the `sort` parameter,\nand filtered by `name` metadata using metadata filter expressions.","operationId":"v1/dnsListNamesZone","parameters":[{"name":"zone_name","in":"path","description":"The name of the zone.","required":true,"schema":{"$ref":"#/components/schemas/ZoneName"},"example":"example.com"},{"name":"offset","in":"query","description":"Offset from beginning of list","required":false,"schema":{"type":"integer","format":"int64","minimum":0},"style":"form","example":0},{"name":"limit","in":"query","description":"Maximum number of results to return","required":false,"schema":{"type":"integer","format":"int64","minimum":0},"style":"form","example":20},{"name":"sort","in":"query","description":"Sort options: (allowed fields: name, name_labels_reversed, created_at; allowed sorting: asc, desc).","required":false,"schema":{"type":"object","properties":{"name":{"type":"string","enum":["asc","desc"],"example":"asc"},"name_labels_reversed":{"type":"string","enum":["asc","desc"],"example":"asc"},"created_at":{"type":"string","enum":["asc","desc"],"example":"asc"}},"examples":[{"name":"asc","name_labels_reversed":"asc","created_at":"asc"}]},"style":"deepObject","example":{"name":"asc","name_labels_reversed":"asc","created_at":"asc"}},{"name":"expand[]","in":"query","description":"Sub-resource expansion options. (allowed resources: offline_settings)","required":false,"schema":{"type":"array","items":{"type":"string","enum":["offline_settings"]},"examples":[["offline_settings"]]},"style":"form","example":["offline_settings"]},{"name":"metadata","in":"query","description":"Filter results by metadata.\nSee [metadata filters](metadata-filter-expressions) for an in-depth description of the expression syntax.","required":false,"schema":{"$ref":"#/components/schemas/MetadataFilterExpression"},"style":"form","example":"{\"or\":[{\"and\":[{\"op\":\"contains\",\"key\":\"key1\",\"value\":\"value1\"},{\"op\":\"exact\",\"key\":\"key2\",\"value\":\"value2\"}]},{\"op\":\"exact\",\"key\":\"key3\",\"value\":\"value3\"}]}"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object","required":["data","page"],"properties":{"data":{"$ref":"#/components/schemas/DnsNameList"},"page":{"$ref":"#/components/schemas/PageInfo"},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/Warning"}}}}}}},"401":{"description":"unauthorized (code: 2465)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"operation only available via the website (code: 4786)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"zone not found (codes: 2510, 2728)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearer":[]},{"basic":[]}]},"post":{"tags":["records"],"description":"\n\nCreate a new name\n\nCreate a new name, with records and metadata.","operationId":"v1/dnsCreateName","parameters":[{"name":"zone_name","in":"path","description":"The name of the zone.","required":true,"schema":{"$ref":"#/components/schemas/ZoneName"},"example":"example.com"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewDnsName"},"examples":{"autogenerated":{"value":{"name":"dns-name","rrsets":[{"dns_type":"A","rdata":[{"value":"192.0.2.1","label":"optional-label-1"},{"value":"192.0.2.2"}],"ttl":60,"metadata":{"key":"value"}},{"dns_type":"AAAA","rdata":[{"value":"2001:db8::1","label":"optional-label-2"}],"ttl":60}],"metadata":{"property":"value"}}}}}},"required":true},"responses":{"201":{"description":"resource created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommandSuccess"}}}},"400":{"description":"Multiple error variants are possible:\n- DNS hostname contains too many labels (code: 2324)\n- Rdata labels must be unique in an RRset (code: 2008)\n- a label contains characters not in the allowed character set (code: 3284)\n- a wildcard label must be the terminal label in a name (code: 3893)\n- duplicated update groups for rrset (code: 4344)\n- expected valid offline settings for offline name (code: 2212)\n- invalid ALIAS record (code: 4159)\n- invalid CNAME record (code: 4659)\n- invalid DNS update group (code: 3315)\n- invalid NS record (code: 3111)\n- invalid PTR record (code: 4619)\n- invalid Rdata label (code: 4819)\n- invalid TTL (code: 3295)\n- invalid email address (code: 3588)\n- invalid format for Rdata (code: 2839)\n- invalid format for URL redirect (code: 3564)\n- invalid logo url (code: 3562)\n- invalid name (code: 3607)\n- invalid offline IP address (code: 2711)\n- invalid redirect URL (code: 2788)\n- label is required for rdata update group targets (code: 4945)\n- operation violates DNS rules (code: 3363)\n- required field missing for offline action (code: 2714)\n- the parent of a wildcard cannot be an empty nonterminal node (code: 3624)\n- unsupported DNS record type (code: 3252)\n- update group target dns type must be either A, AAAA or _URL (code: 3325)\n- update group target on both name and rdata (code: 3731)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"unauthorized (code: 2465)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"402":{"description":"Multiple error variants are possible:\n- DNS names are over limit; please contact support (code: 3354)\n- RRset metadata over limit; please contact support (code: 4556)\n- Rdata count is over limit; please contact support (code: 4428)\n- dns name metadata over limit; please contact support (code: 2218)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Multiple error variants are possible:\n- DNS types disallowed (code: 2051)\n- RRset TTL cannot be changed (code: 4535)\n- changing this zone is prohibited; please contact support (code: 3903)\n- creating a DNS name in this zone is forbidden (code: 3331)\n- new names cannot be created in this zone (code: 2784)\n- not allowed (code: 4748)\n- only auto-generated Rdata labels may start with an underscore (code: 4555)\n- only the zone owner may create this record (code: 4365)\n- operation only available via the website (code: 4786)\n- requested RRset TTL is too low (code: 3655)\n- updating this DNS update group is forbidden (code: 4127)\n- wildcards in labels are restricted (code: 4072)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"zone not found (codes: 2510, 2728)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Multiple error variants are possible:\n- DNS name already exists (code: 4285)\n- DNS name is already owned (code: 3424)\n- Rdata value already exists (code: 2722)\n- conflicting target already exists in a group (code: 3311)\n- target already exists (code: 3676)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"alias points to name outside the zone (code: 4145)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearer":[]},{"basic":[]}]}},"/v1/dns/records/{zone_name}/{name}":{"get":{"tags":["records"],"summary":"Get a DNS Name","description":"Get detailed information about a DNS name.","operationId":"v1/dnsGetDnsName","parameters":[{"name":"zone_name","in":"path","description":"The name of the zone.","required":true,"schema":{"$ref":"#/components/schemas/ZoneName"},"example":"example.com"},{"name":"name","in":"path","description":"The DNS name, not including the zone portion.","required":true,"schema":{"$ref":"#/components/schemas/Name"},"example":"dns-name"},{"name":"expand[]","in":"query","description":"Sub-resource expansion options. (allowed resources: offline_settings)","required":false,"schema":{"type":"array","items":{"type":"string","enum":["offline_settings"]},"examples":[["offline_settings"]]},"style":"form","example":["offline_settings"]}],"responses":{"200":{"description":"DNS name, not fully-qualified","content":{"application/json":{"schema":{"type":"object","description":"DNS name, not fully-qualified","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/DnsName","description":"DNS name, not fully-qualified"},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/Warning"}}}}}}},"401":{"description":"unauthorized (code: 2465)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"operation only available via the website (code: 4786)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Multiple error variants are possible:\n- DNS name not found (code: 4809)\n- zone not found (codes: 2510, 2728)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearer":[]},{"basic":[]}]},"delete":{"tags":["records"],"summary":"Delete name","description":"Delete name, along with associated records and metadata.","operationId":"v1/dnsDeleteName","parameters":[{"name":"zone_name","in":"path","description":"The name of the zone.","required":true,"schema":{"$ref":"#/components/schemas/ZoneName"},"example":"example.com"},{"name":"name","in":"path","description":"The DNS name, not including the zone portion.","required":true,"schema":{"$ref":"#/components/schemas/Name"},"example":"dns-name"}],"responses":{"200":{"description":"resource deleted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommandSuccess"}}}},"401":{"description":"unauthorized (code: 2465)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Multiple error variants are possible:\n- changing this DNS name is forbidden (code: 3998)\n- changing this DNS name is prohibited; please contact support (code: 4821)\n- changing this zone is prohibited; please contact support (code: 3903)\n- operation only available via the website (code: 4786)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Multiple error variants are possible:\n- DNS name not found (code: 4809)\n- zone not found (codes: 2510, 2728)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearer":[]},{"basic":[]}]}},"/v1/dns/records/{zone_name}/{name}/metadata":{"get":{"tags":["records"],"summary":"Get name metadata","description":"Get metadata associated to a DNS name.\nSee [metadata filters](metadata-filter-expressions) for an in-depth explanation about metadata filters.","operationId":"v1/dnsGetNameMetadata","parameters":[{"name":"zone_name","in":"path","description":"The name of the zone.","required":true,"schema":{"$ref":"#/components/schemas/ZoneName"},"example":"example.com"},{"name":"name","in":"path","description":"The DNS name, not including the zone portion.","required":true,"schema":{"$ref":"#/components/schemas/Name"},"example":"dns-name"}],"responses":{"200":{"description":"Response for get metadata queries","content":{"application/json":{"schema":{"type":"object","description":"Response for get metadata queries","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/GetMetadata","description":"Response for get metadata queries"},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/Warning"}}}}}}},"401":{"description":"unauthorized (code: 2465)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"operation only available via the website (code: 4786)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Multiple error variants are possible:\n- DNS name not found (code: 4809)\n- zone not found (codes: 2510, 2728)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearer":[]},{"basic":[]}]},"post":{"tags":["records"],"summary":"Set metadata for a name","description":"Set metadata associated to a name.\nName metadata is stored until the name gets deleted.\nNew keys are added, existing keys are updated. To remove a key, set its value to an empty string.\n\nSee [metadata filters](metadata-filter-expressions) for an in-depth explanation about metadata filters.","operationId":"v1/dnsSetNameMetadata","parameters":[{"name":"zone_name","in":"path","description":"The name of the zone.","required":true,"schema":{"$ref":"#/components/schemas/ZoneName"},"example":"example.com"},{"name":"name","in":"path","description":"The DNS name, not including the zone portion.","required":true,"schema":{"$ref":"#/components/schemas/Name"},"example":"dns-name"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetMetadata"},"examples":{"autogenerated":{"value":{"metadata":{"public property":"public value"}}}}}},"required":true},"responses":{"202":{"description":"resource updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommandSuccess"}}}},"401":{"description":"unauthorized (code: 2465)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"402":{"description":"dns name metadata over limit; please contact support (code: 2218)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Multiple error variants are possible:\n- changing this DNS name is forbidden (code: 3998)\n- changing this DNS name is prohibited; please contact support (code: 4821)\n- changing this zone is prohibited; please contact support (code: 3903)\n- operation only available via the website (code: 4786)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Multiple error variants are possible:\n- DNS name not found (code: 4809)\n- zone not found (codes: 2510, 2728)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearer":[]},{"basic":[]}]}},"/v1/dns/records/{zone_name}/{name}/offline-settings":{"get":{"tags":["records"],"summary":"Get offline settings.","description":"Get offline settings.","operationId":"v1/dnsGetOfflineSettings","parameters":[{"name":"zone_name","in":"path","description":"The name of the zone.","required":true,"schema":{"$ref":"#/components/schemas/ZoneName"},"example":"example.com"},{"name":"name","in":"path","description":"The DNS name, not including the zone portion.","required":true,"schema":{"$ref":"#/components/schemas/Name"},"example":"dns-name"}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/OfflineSettings"},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/Warning"}}}}}}},"401":{"description":"unauthorized (code: 2465)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Multiple error variants are possible:\n- DNS name not found (code: 4809)\n- zone not found (code: 2510)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearer":[]},{"basic":[]}]},"put":{"tags":["records"],"summary":"Set offline settings.","description":"Set offline settings.","operationId":"v1/dnsSetOfflineSettings","parameters":[{"name":"zone_name","in":"path","description":"The name of the zone.","required":true,"schema":{"$ref":"#/components/schemas/ZoneName"},"example":"example.com"},{"name":"name","in":"path","description":"The DNS name, not including the zone portion.","required":true,"schema":{"$ref":"#/components/schemas/Name"},"example":"dns-name"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfflineSettings"}}},"required":true},"responses":{"202":{"description":"resource updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommandSuccess"}}}},"400":{"description":"Multiple error variants are possible:\n- dns type or rdata is missing (code: 2128)\n- invalid email address (code: 3588)\n- invalid logo url (code: 3562)\n- invalid offline IP address (code: 2711)\n- invalid redirect URL (code: 2788)\n- required field missing for offline action (code: 2714)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"unauthorized (code: 2465)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Multiple error variants are possible:\n- changing this DNS name is forbidden (code: 3998)\n- changing this DNS name is prohibited; please contact support (code: 4821)\n- changing this zone is prohibited; please contact support (code: 3903)\n- not allowed (code: 4748)\n- operation only available via the website (code: 4786)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Multiple error variants are possible:\n- DNS name not found (code: 4809)\n- zone not found (codes: 2510, 2728)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearer":[]},{"basic":[]}]},"delete":{"tags":["records"],"summary":"Remove offline settings.","description":"Remove offline settings.","operationId":"v1/dnsDeleteOfflineSettings","parameters":[{"name":"zone_name","in":"path","description":"The name of the zone.","required":true,"schema":{"$ref":"#/components/schemas/ZoneName"},"example":"example.com"},{"name":"name","in":"path","description":"The DNS name, not including the zone portion.","required":true,"schema":{"$ref":"#/components/schemas/Name"},"example":"dns-name"}],"responses":{"200":{"description":"resource deleted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommandSuccess"}}}},"401":{"description":"unauthorized (code: 2465)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Multiple error variants are possible:\n- changing this DNS name is forbidden (code: 3998)\n- changing this DNS name is prohibited; please contact support (code: 4821)\n- changing this zone is prohibited; please contact support (code: 3903)\n- operation only available via the website (code: 4786)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Multiple error variants are possible:\n- DNS name not found (code: 4809)\n- zone not found (codes: 2510, 2728)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearer":[]},{"basic":[]}]}},"/v1/dns/records/{zone_name}/{name}/publish":{"post":{"tags":["records"],"summary":"Publish DNS name","description":"Request publication of the DNS name.\nWhen the name becomes published, it will be resolvable on the primary nameservers.","operationId":"v1/dnsPublishName","parameters":[{"name":"zone_name","in":"path","description":"The name of the zone.","required":true,"schema":{"$ref":"#/components/schemas/ZoneName"},"example":"example.com"},{"name":"name","in":"path","description":"The DNS name, not including the zone portion.","required":true,"schema":{"$ref":"#/components/schemas/Name"},"example":"dns-name"}],"responses":{"202":{"description":"resource updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommandSuccess"}}}},"401":{"description":"unauthorized (code: 2465)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"402":{"description":"Multiple error variants are possible:\n- DNS names are over limit; please contact support (code: 3354)\n- RRset metadata over limit; please contact support (code: 4556)\n- Rdata count is over limit; please contact support (code: 4428)\n- dns name metadata over limit; please contact support (code: 2218)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Multiple error variants are possible:\n- changing this DNS name is forbidden (code: 3998)\n- changing this DNS name is prohibited; please contact support (code: 4821)\n- changing this zone is prohibited; please contact support (code: 3903)\n- operation only available via the website (code: 4786)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Multiple error variants are possible:\n- DNS name not found (code: 4809)\n- zone not found (codes: 2510, 2728)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearer":[]},{"basic":[]}]}},"/v1/dns/records/{zone_name}/{name}/rrsets":{"get":{"tags":["records"],"summary":"List RRSets for a name","description":"Lists the rrsets for a name.\nResults can be filtered and sorted using the `filter` and `sort` parameters,\nand filtered by `rrset` metadata using metadata filter expressions.","operationId":"v1/dnsListRRSets","parameters":[{"name":"zone_name","in":"path","description":"The name of the zone.","required":true,"schema":{"$ref":"#/components/schemas/ZoneName"},"example":"example.com"},{"name":"name","in":"path","description":"The DNS name, not including the zone portion.","required":true,"schema":{"$ref":"#/components/schemas/Name"},"example":"dns-name"},{"name":"offset","in":"query","description":"Offset from beginning of list","required":false,"schema":{"type":"integer","format":"int64","minimum":0},"style":"form","example":0},{"name":"limit","in":"query","description":"Maximum number of results to return","required":false,"schema":{"type":"integer","format":"int64","minimum":0},"style":"form","example":20},{"name":"sort","in":"query","description":"Sort options: (allowed fields: dns_type; allowed sorting: asc, desc).","required":false,"schema":{"type":"object","properties":{"dns_type":{"type":"string","enum":["asc","desc"],"example":"asc"}},"examples":[{"dns_type":"asc"}]},"style":"deepObject","example":{"dns_type":"asc"}},{"name":"metadata","in":"query","description":"Filter results by metadata.\nSee [metadata filters](metadata-filter-expressions) for an in-depth description of the expression syntax.","required":false,"schema":{"$ref":"#/components/schemas/MetadataFilterExpression"},"style":"form","example":"{\"or\":[{\"and\":[{\"op\":\"contains\",\"key\":\"key1\",\"value\":\"value1\"},{\"op\":\"exact\",\"key\":\"key2\",\"value\":\"value2\"}]},{\"op\":\"exact\",\"key\":\"key3\",\"value\":\"value3\"}]}"}],"responses":{"200":{"description":"A list of Resource Record Sets","content":{"application/json":{"schema":{"type":"object","description":"A list of Resource Record Sets","required":["data","page"],"properties":{"data":{"$ref":"#/components/schemas/RRSetList","description":"A list of Resource Record Sets"},"page":{"$ref":"#/components/schemas/PageInfo"},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/Warning"}}}}}}},"401":{"description":"unauthorized (code: 2465)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"operation only available via the website (code: 4786)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Multiple error variants are possible:\n- DNS name not found (code: 4809)\n- zone not found (codes: 2510, 2728)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearer":[]},{"basic":[]}]},"post":{"tags":["records"],"summary":"Create RRSets","description":"Create RRSets for a name, along with records, rrset options and metadata.","operationId":"v1/dnsCreateRRSets","parameters":[{"name":"zone_name","in":"path","description":"The name of the zone.","required":true,"schema":{"$ref":"#/components/schemas/ZoneName"},"example":"example.com"},{"name":"name","in":"path","description":"The DNS name, not including the zone portion.","required":true,"schema":{"$ref":"#/components/schemas/Name"},"example":"dns-name"}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NewRRSet"}},"examples":{"autogenerated":{"value":[{"dns_type":"A","rdata":[{"value":"192.0.2.1","label":"optional-label-1"},{"value":"192.0.2.1"}],"ttl":60,"metadata":{"property":"value"}}]}}}},"required":true},"responses":{"201":{"description":"resource created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommandSuccess"}}}},"400":{"description":"Multiple error variants are possible:\n- Rdata labels must be unique in an RRset (code: 2008)\n- duplicated update groups for rrset (code: 4344)\n- invalid ALIAS record (code: 4159)\n- invalid CNAME record (code: 4659)\n- invalid DNS update group (code: 3315)\n- invalid NS record (code: 3111)\n- invalid PTR record (code: 4619)\n- invalid Rdata label (code: 4819)\n- invalid TTL (code: 3295)\n- invalid format for Rdata (code: 2839)\n- invalid format for URL redirect (code: 3564)\n- label is required for rdata update group targets (code: 4945)\n- operation violates DNS rules (code: 3363)\n- unsupported DNS record type (code: 3252)\n- update group target dns type must be either A, AAAA or _URL (code: 3325)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"unauthorized (code: 2465)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"402":{"description":"Multiple error variants are possible:\n- RRset metadata over limit; please contact support (code: 4556)\n- Rdata count is over limit; please contact support (code: 4428)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Multiple error variants are possible:\n- DNS types disallowed (code: 2051)\n- RRset TTL cannot be changed (code: 4535)\n- changing this DNS name is prohibited; please contact support (code: 4821)\n- changing this zone is prohibited; please contact support (code: 3903)\n- creating this RRset is forbidden (code: 4403)\n- not allowed (code: 4748)\n- only auto-generated Rdata labels may start with an underscore (code: 4555)\n- operation only available via the website (code: 4786)\n- requested RRset TTL is too low (code: 3655)\n- updating this DNS update group is forbidden (code: 4127)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Multiple error variants are possible:\n- DNS name not found (code: 4809)\n- zone not found (codes: 2510, 2728)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Multiple error variants are possible:\n- RRset already exists (code: 2204)\n- Rdata value already exists (code: 2722)\n- conflicting target already exists in a group (code: 3311)\n- target already exists (code: 3676)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"alias points to name outside the zone (code: 4145)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearer":[]},{"basic":[]}]}},"/v1/dns/records/{zone_name}/{name}/rrsets/{dns_type}":{"get":{"tags":["records"],"summary":"Get an RRSet","description":"Get detailed information about an RRSet.","operationId":"v1/dnsGetRRSet","parameters":[{"name":"zone_name","in":"path","description":"The name of the zone.","required":true,"schema":{"$ref":"#/components/schemas/ZoneName"},"example":"example.com"},{"name":"name","in":"path","description":"The DNS name, not including the zone portion.","required":true,"schema":{"$ref":"#/components/schemas/Name"},"example":"dns-name"},{"name":"dns_type","in":"path","description":"DNS name type supported by API","required":true,"schema":{"$ref":"#/components/schemas/DnsRecType"},"example":"A"}],"responses":{"200":{"description":"Resource Record Set (resources with a common name, class and type)","content":{"application/json":{"schema":{"type":"object","description":"Resource Record Set (resources with a common name, class and type)","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/RRSet","description":"Resource Record Set (resources with a common name, class and type)"},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/Warning"}}}}}}},"401":{"description":"unauthorized (code: 2465)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"operation only available via the website (code: 4786)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Multiple error variants are possible:\n- DNS name not found (code: 4809)\n- RRset not found (code: 2373)\n- zone not found (codes: 2510, 2728)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearer":[]},{"basic":[]}]},"delete":{"tags":["records"],"summary":"Delete an RRSet","description":"Delete an RRSet, remove all records of a given type from a name,\nand its associated metadata.","operationId":"v1/dnsDeleteRRSet","parameters":[{"name":"zone_name","in":"path","description":"The name of the zone.","required":true,"schema":{"$ref":"#/components/schemas/ZoneName"},"example":"example.com"},{"name":"name","in":"path","description":"The DNS name, not including the zone portion.","required":true,"schema":{"$ref":"#/components/schemas/Name"},"example":"dns-name"},{"name":"dns_type","in":"path","description":"DNS name type supported by API","required":true,"schema":{"$ref":"#/components/schemas/DnsRecType"},"example":"A"}],"responses":{"200":{"description":"resource deleted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommandSuccess"}}}},"401":{"description":"unauthorized (code: 2465)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Multiple error variants are possible:\n- changing this DNS name is prohibited; please contact support (code: 4821)\n- changing this RRset is forbidden (code: 2710)\n- changing this zone is prohibited; please contact support (code: 3903)\n- operation only available via the website (code: 4786)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Multiple error variants are possible:\n- DNS name not found (code: 4809)\n- RRset not found (code: 2373)\n- zone not found (codes: 2510, 2728)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearer":[]},{"basic":[]}]}},"/v1/dns/records/{zone_name}/{name}/rrsets/{dns_type}/metadata":{"get":{"tags":["records"],"summary":"Get RRSet metadata","description":"Get metadata associated to the RRSet.\nSee [metadata filters](metadata-filter-expressions) for an in-depth explanation about metadata filters.","operationId":"v1/dnsGetRRSetMetadata","parameters":[{"name":"zone_name","in":"path","description":"The name of the zone.","required":true,"schema":{"$ref":"#/components/schemas/ZoneName"},"example":"example.com"},{"name":"name","in":"path","description":"The DNS name, not including the zone portion.","required":true,"schema":{"$ref":"#/components/schemas/Name"},"example":"dns-name"},{"name":"dns_type","in":"path","description":"DNS name type supported by API","required":true,"schema":{"$ref":"#/components/schemas/DnsRecType"},"example":"A"}],"responses":{"200":{"description":"Response for get metadata queries","content":{"application/json":{"schema":{"type":"object","description":"Response for get metadata queries","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/GetMetadata","description":"Response for get metadata queries"},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/Warning"}}}}}}},"401":{"description":"unauthorized (code: 2465)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"operation only available via the website (code: 4786)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Multiple error variants are possible:\n- RRset not found (code: 2373)\n- zone not found (codes: 2510, 2728)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearer":[]},{"basic":[]}]},"post":{"tags":["records"],"summary":"Set metadata for an RRSet","description":"Set metadata associated to an RRSet.\nRRSet metadata is stored until the rrset gets deleted.\nNew keys are added, existing keys are updated. To remove a key, set its value to an empty string.\n\nSee [metadata filters](metadata-filter-expressions) for an in-depth explanation about metadata filters.","operationId":"v1/dnsSetRRSetMetadata","parameters":[{"name":"zone_name","in":"path","description":"The name of the zone.","required":true,"schema":{"$ref":"#/components/schemas/ZoneName"},"example":"example.com"},{"name":"name","in":"path","description":"The DNS name, not including the zone portion.","required":true,"schema":{"$ref":"#/components/schemas/Name"},"example":"dns-name"},{"name":"dns_type","in":"path","description":"DNS name type supported by API","required":true,"schema":{"$ref":"#/components/schemas/DnsRecType"},"example":"A"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetMetadata"},"examples":{"autogenerated":{"value":{"metadata":{"public property":"public value"}}}}}},"required":true},"responses":{"202":{"description":"resource updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommandSuccess"}}}},"401":{"description":"unauthorized (code: 2465)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"402":{"description":"RRset metadata over limit; please contact support (code: 4556)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Multiple error variants are possible:\n- changing this DNS name is prohibited; please contact support (code: 4821)\n- changing this RRset is forbidden (code: 2710)\n- changing this zone is prohibited; please contact support (code: 3903)\n- operation only available via the website (code: 4786)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Multiple error variants are possible:\n- DNS name not found (code: 4809)\n- RRset not found (code: 2373)\n- zone not found (codes: 2510, 2728)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearer":[]},{"basic":[]}]}},"/v1/dns/records/{zone_name}/{name}/rrsets/{dns_type}/rdata":{"put":{"tags":["records"],"summary":"Replace rdata","description":"Replace the records of a given type in a pre-existing name,\nremoving the previous records of that type.","operationId":"v1/dnsSetRdata","parameters":[{"name":"zone_name","in":"path","description":"The name of the zone.","required":true,"schema":{"$ref":"#/components/schemas/ZoneName"},"example":"example.com"},{"name":"name","in":"path","description":"The DNS name, not including the zone portion.","required":true,"schema":{"$ref":"#/components/schemas/Name"},"example":"dns-name"},{"name":"dns_type","in":"path","description":"DNS name type supported by API","required":true,"schema":{"$ref":"#/components/schemas/DnsRecType"},"example":"A"}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NewRdata"}},"examples":{"autogenerated":{"value":[{"value":"192.0.2.1","label":"a-label-123"}]}}}},"required":true},"responses":{"202":{"description":"resource updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommandSuccess"}}}},"400":{"description":"Multiple error variants are possible:\n- Rdata labels must be unique in an RRset (code: 2008)\n- duplicated update groups for rrset (code: 4344)\n- invalid ALIAS record (code: 4159)\n- invalid CNAME record (code: 4659)\n- invalid DNS update group (code: 3315)\n- invalid NS record (code: 3111)\n- invalid PTR record (code: 4619)\n- invalid Rdata label (code: 4819)\n- invalid format for Rdata (code: 2839)\n- invalid format for URL redirect (code: 3564)\n- label is required for rdata update group targets (code: 4945)\n- operation violates DNS rules (code: 3363)\n- unsupported DNS record type (code: 3252)\n- update group target dns type must be either A, AAAA or _URL (code: 3325)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"unauthorized (code: 2465)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"402":{"description":"Multiple error variants are possible:\n- RRset metadata over limit; please contact support (code: 4556)\n- Rdata count is over limit; please contact support (code: 4428)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Multiple error variants are possible:\n- DNS types disallowed (code: 2051)\n- changing this DNS name is prohibited; please contact support (code: 4821)\n- changing this RRset is forbidden (code: 2710)\n- changing this zone is prohibited; please contact support (code: 3903)\n- creating Rdata in this zone is forbidden (code: 4635)\n- creating this RRset is forbidden (code: 4403)\n- not allowed (code: 4748)\n- only auto-generated Rdata labels may start with an underscore (code: 4555)\n- operation only available via the website (code: 4786)\n- updating this DNS update group is forbidden (code: 4127)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Multiple error variants are possible:\n- DNS name not found (code: 4809)\n- zone not found (codes: 2510, 2728)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Multiple error variants are possible:\n- Rdata value already exists (code: 2722)\n- conflicting target already exists in a group (code: 3311)\n- target already exists (code: 3676)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"alias points to name outside the zone (code: 4145)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearer":[]},{"basic":[]}]},"post":{"tags":["records"],"summary":"Create Rdata","description":"Create records of a given type in a name.\nIf the name did not exist, the name will also be created,","operationId":"v1/dnsCreateRdata","parameters":[{"name":"zone_name","in":"path","description":"The name of the zone.","required":true,"schema":{"$ref":"#/components/schemas/ZoneName"},"example":"example.com"},{"name":"name","in":"path","description":"The DNS name, not including the zone portion.","required":true,"schema":{"$ref":"#/components/schemas/Name"},"example":"dns-name"},{"name":"dns_type","in":"path","description":"DNS name type supported by API","required":true,"schema":{"$ref":"#/components/schemas/DnsRecType"},"example":"A"}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NewRdata"}},"examples":{"autogenerated":{"value":[{"value":"192.0.2.1","label":"a-label-123"}]}}}},"required":true},"responses":{"201":{"description":"resource created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommandSuccess"}}}},"400":{"description":"Multiple error variants are possible:\n- DNS hostname contains too many labels (code: 2324)\n- Rdata labels must be unique in an RRset (code: 2008)\n- a label contains characters not in the allowed character set (code: 3284)\n- a wildcard label must be the terminal label in a name (code: 3893)\n- duplicated update groups for rrset (code: 4344)\n- invalid ALIAS record (code: 4159)\n- invalid CNAME record (code: 4659)\n- invalid DNS update group (code: 3315)\n- invalid NS record (code: 3111)\n- invalid PTR record (code: 4619)\n- invalid Rdata label (code: 4819)\n- invalid format for Rdata (code: 2839)\n- invalid format for URL redirect (code: 3564)\n- label is required for rdata update group targets (code: 4945)\n- operation violates DNS rules (code: 3363)\n- the parent of a wildcard cannot be an empty nonterminal node (code: 3624)\n- unsupported DNS record type (code: 3252)\n- update group target dns type must be either A, AAAA or _URL (code: 3325)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"unauthorized (code: 2465)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"402":{"description":"Multiple error variants are possible:\n- DNS names are over limit; please contact support (code: 3354)\n- RRset metadata over limit; please contact support (code: 4556)\n- Rdata count is over limit; please contact support (code: 4428)\n- dns name metadata over limit; please contact support (code: 2218)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Multiple error variants are possible:\n- DNS types disallowed (code: 2051)\n- changing this zone is prohibited; please contact support (code: 3903)\n- creating Rdata in this zone is forbidden (code: 4635)\n- creating a DNS name in this zone is forbidden (code: 3331)\n- creating this RRset is forbidden (code: 4403)\n- new names cannot be created in this zone (code: 2784)\n- not allowed (code: 4748)\n- only auto-generated Rdata labels may start with an underscore (code: 4555)\n- only the zone owner may create this record (code: 4365)\n- operation only available via the website (code: 4786)\n- updating this DNS update group is forbidden (code: 4127)\n- wildcards in labels are restricted (code: 4072)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"zone not found (codes: 2510, 2728)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Multiple error variants are possible:\n- DNS name already exists (code: 4285)\n- DNS name is already owned (code: 3424)\n- Rdata value already exists (code: 2722)\n- conflicting target already exists in a group (code: 3311)\n- target already exists (code: 3676)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"alias points to name outside the zone (code: 4145)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearer":[]},{"basic":[]}]}},"/v1/dns/records/{zone_name}/{name}/rrsets/{dns_type}/rdata/{label}":{"put":{"tags":["records"],"summary":"Set rdata by label","description":"Creates or updates a record in a dns name, with an specified label.","operationId":"v1/dnsSetRdataByLabel","parameters":[{"name":"zone_name","in":"path","description":"The name of the zone.","required":true,"schema":{"$ref":"#/components/schemas/ZoneName"},"example":"example.com"},{"name":"name","in":"path","description":"The DNS name, not including the zone portion.","required":true,"schema":{"$ref":"#/components/schemas/Name"},"example":"dns-name"},{"name":"dns_type","in":"path","description":"DNS name type supported by API","required":true,"schema":{"$ref":"#/components/schemas/DnsRecType"},"example":"A"},{"name":"label","in":"path","description":"A label for this Rdata that uniquely identifies it within its RRSet","required":true,"schema":{"$ref":"#/components/schemas/Label"},"example":"a-label-123"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetRdata"},"examples":{"autogenerated":{"value":{"value":"192.0.2.1"}}}}},"required":true},"responses":{"200":{"description":"resource not changed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommandSuccess"}}}},"201":{"description":"resource created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommandSuccess"}}}},"202":{"description":"resource updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommandSuccess"}}}},"400":{"description":"Multiple error variants are possible:\n- Rdata labels must be unique in an RRset (code: 2008)\n- duplicated update groups for rrset (code: 4344)\n- invalid ALIAS record (code: 4159)\n- invalid CNAME record (code: 4659)\n- invalid DNS update group (code: 3315)\n- invalid NS record (code: 3111)\n- invalid PTR record (code: 4619)\n- invalid Rdata label (code: 4819)\n- invalid format for Rdata (code: 2839)\n- invalid format for URL redirect (code: 3564)\n- label is required for rdata update group targets (code: 4945)\n- operation violates DNS rules (code: 3363)\n- unsupported DNS record type (code: 3252)\n- update group target dns type must be either A, AAAA or _URL (code: 3325)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"unauthorized (code: 2465)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"402":{"description":"Multiple error variants are possible:\n- RRset metadata over limit; please contact support (code: 4556)\n- Rdata count is over limit; please contact support (code: 4428)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Multiple error variants are possible:\n- DNS types disallowed (code: 2051)\n- changing this DNS name is prohibited; please contact support (code: 4821)\n- changing this Rdata is forbidden (code: 2730)\n- changing this zone is prohibited; please contact support (code: 3903)\n- creating Rdata in this zone is forbidden (code: 4635)\n- creating this RRset is forbidden (code: 4403)\n- not allowed (code: 4748)\n- only auto-generated Rdata labels may start with an underscore (code: 4555)\n- operation only available via the website (code: 4786)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Multiple error variants are possible:\n- DNS name not found (code: 4809)\n- zone not found (codes: 2510, 2728)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Rdata value already exists (code: 2722)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"alias points to name outside the zone (code: 4145)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearer":[]},{"basic":[]}]},"delete":{"tags":["records"],"summary":"Delete rdata by label","description":"Delete the record with the specified label.","operationId":"v1/dnsDeleteRdataByLabel","parameters":[{"name":"zone_name","in":"path","description":"The name of the zone.","required":true,"schema":{"$ref":"#/components/schemas/ZoneName"},"example":"example.com"},{"name":"name","in":"path","description":"The DNS name, not including the zone portion.","required":true,"schema":{"$ref":"#/components/schemas/Name"},"example":"dns-name"},{"name":"dns_type","in":"path","description":"DNS name type supported by API","required":true,"schema":{"$ref":"#/components/schemas/DnsRecType"},"example":"A"},{"name":"label","in":"path","description":"A label for this Rdata that uniquely identifies it within its RRSet","required":true,"schema":{"$ref":"#/components/schemas/Label"},"example":"a-label-123"}],"responses":{"200":{"description":"resource deleted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommandSuccess"}}}},"400":{"description":"invalid Rdata label (code: 4819)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"unauthorized (code: 2465)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Multiple error variants are possible:\n- changing this DNS name is prohibited; please contact support (code: 4821)\n- changing this Rdata is forbidden (code: 2730)\n- changing this zone is prohibited; please contact support (code: 3903)\n- operation only available via the website (code: 4786)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Multiple error variants are possible:\n- DNS name not found (code: 4809)\n- RRset not found (code: 2373)\n- Rdata not found (code: 3335)\n- zone not found (codes: 2510, 2728)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearer":[]},{"basic":[]}]}},"/v1/dns/records/{zone_name}/{name}/rrsets/{dns_type}/ttl":{"put":{"tags":["records"],"summary":"Set RRSet TTL","description":"Set TTL for an RRSet.","operationId":"v1/dnsSetRRSetTtl","parameters":[{"name":"zone_name","in":"path","description":"The name of the zone.","required":true,"schema":{"$ref":"#/components/schemas/ZoneName"},"example":"example.com"},{"name":"name","in":"path","description":"The DNS name, not including the zone portion.","required":true,"schema":{"$ref":"#/components/schemas/Name"},"example":"dns-name"},{"name":"dns_type","in":"path","description":"DNS name type supported by API","required":true,"schema":{"$ref":"#/components/schemas/DnsRecType"},"example":"A"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetRRSetTtl"},"examples":{"autogenerated":{"value":{"ttl":60}}}}},"required":true},"responses":{"202":{"description":"resource updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommandSuccess"}}}},"400":{"description":"invalid TTL (code: 3295)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"unauthorized (code: 2465)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Multiple error variants are possible:\n- RRset TTL cannot be changed (code: 4535)\n- changing this DNS name is prohibited; please contact support (code: 4821)\n- changing this RRset is forbidden (code: 2710)\n- changing this zone is prohibited; please contact support (code: 3903)\n- operation only available via the website (code: 4786)\n- requested RRset TTL is too low (code: 3655)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Multiple error variants are possible:\n- DNS name not found (code: 4809)\n- RRset not found (code: 2373)\n- zone not found (codes: 2510, 2728)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearer":[]},{"basic":[]}]}},"/v1/dns/records/{zone_name}/{name}/set-offline":{"post":{"tags":["records"],"summary":"Set name offline.","description":"Set name offline.","operationId":"v1/dnsSetNameOffline","parameters":[{"name":"zone_name","in":"path","description":"The name of the zone.","required":true,"schema":{"$ref":"#/components/schemas/ZoneName"},"example":"example.com"},{"name":"name","in":"path","description":"The DNS name, not including the zone portion.","required":true,"schema":{"$ref":"#/components/schemas/Name"},"example":"dns-name"}],"responses":{"202":{"description":"resource updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommandSuccess"}}}},"401":{"description":"unauthorized (code: 2465)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Multiple error variants are possible:\n- changing this DNS name is forbidden (code: 3998)\n- changing this DNS name is prohibited; please contact support (code: 4821)\n- changing this zone is prohibited; please contact support (code: 3903)\n- operation only available via the website (code: 4786)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Multiple error variants are possible:\n- DNS name not found (code: 4809)\n- zone not found (codes: 2510, 2728)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearer":[]},{"basic":[]}]}},"/v1/dns/records/{zone_name}/{name}/set-online":{"post":{"tags":["records"],"summary":"Set name online.","description":"Set name online.","operationId":"v1/dnsSetNameOnline","parameters":[{"name":"zone_name","in":"path","description":"The name of the zone.","required":true,"schema":{"$ref":"#/components/schemas/ZoneName"},"example":"example.com"},{"name":"name","in":"path","description":"The DNS name, not including the zone portion.","required":true,"schema":{"$ref":"#/components/schemas/Name"},"example":"dns-name"}],"responses":{"202":{"description":"resource updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommandSuccess"}}}},"401":{"description":"unauthorized (code: 2465)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Multiple error variants are possible:\n- changing this DNS name is forbidden (code: 3998)\n- changing this DNS name is prohibited; please contact support (code: 4821)\n- changing this zone is prohibited; please contact support (code: 3903)\n- operation only available via the website (code: 4786)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Multiple error variants are possible:\n- DNS name not found (code: 4809)\n- zone not found (codes: 2510, 2728)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearer":[]},{"basic":[]}]}},"/v1/dns/records/{zone_name}/{name}/unpublish":{"post":{"tags":["records"],"summary":"Unpublish DNS name","description":"Request reverting the publication of the DNS name.\nWhen the name becomes unpublished, it will not be resolvable on the primary nameservers.","operationId":"v1/dnsUnpublishName","parameters":[{"name":"zone_name","in":"path","description":"The name of the zone.","required":true,"schema":{"$ref":"#/components/schemas/ZoneName"},"example":"example.com"},{"name":"name","in":"path","description":"The DNS name, not including the zone portion.","required":true,"schema":{"$ref":"#/components/schemas/Name"},"example":"dns-name"}],"responses":{"202":{"description":"resource updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommandSuccess"}}}},"401":{"description":"unauthorized (code: 2465)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Multiple error variants are possible:\n- changing this DNS name is forbidden (code: 3998)\n- changing this DNS name is prohibited; please contact support (code: 4821)\n- changing this zone is prohibited; please contact support (code: 3903)\n- operation only available via the website (code: 4786)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Multiple error variants are possible:\n- DNS name not found (code: 4809)\n- zone not found (codes: 2510, 2728)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearer":[]},{"basic":[]}]}},"/v1/dns/zone-authorities":{"get":{"tags":["zone_authorities"],"summary":"List zone authorities","description":"List zone authorities","operationId":"v1/dnsListZoneAuthorities","parameters":[{"name":"offset","in":"query","description":"Offset from beginning of list","required":false,"schema":{"type":"integer","format":"int64","minimum":0},"style":"form","example":0},{"name":"limit","in":"query","description":"Maximum number of results to return","required":false,"schema":{"type":"integer","format":"int64","minimum":0},"style":"form","example":20},{"name":"sort","in":"query","description":"Sort options: (allowed fields: name; allowed sorting: asc, desc).","required":false,"schema":{"type":"object","properties":{"name":{"type":"string","enum":["asc","desc"],"example":"asc"}},"examples":[{"name":"asc"}]},"style":"deepObject","example":{"name":"asc"}}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"type":"object","required":["data","page"],"properties":{"data":{"$ref":"#/components/schemas/ZoneAuthorityList"},"page":{"$ref":"#/components/schemas/PageInfo"},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/Warning"}}}}}}},"401":{"description":"unauthorized (code: 2465)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearer":[]},{"basic":[]}]},"post":{"tags":["zone_authorities"],"summary":"Create a zone authority","description":"Create an authority for use in zones.","operationId":"v1/dnsCreateZoneAuthority","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ZoneAuthority"}}},"required":true},"responses":{"201":{"description":"resource created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommandSuccess"}}}},"400":{"description":"Multiple error variants are possible:\n- at least one of mname, rname or nameservers must be specified (code: 2708)\n- invalid fqdn (code: 4931)\n- nameservers must be non-empty if extend is false (code: 2358)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"unauthorized (code: 2465)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"no more zone authorities may be created (code: 4620)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"zone authority already exists (code: 4576)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearer":[]},{"basic":[]}]}},"/v1/dns/zone-authorities/{zone_authority_name}":{"delete":{"tags":["zone_authorities"],"summary":"Delete zone authority","description":"Delete zone authority.","operationId":"v1/dnsDeleteZoneAuthority","parameters":[{"name":"zone_authority_name","in":"path","description":"Name of zone authority","required":true,"schema":{"$ref":"#/components/schemas/Identifier"},"example":"zone-authority-name"}],"responses":{"200":{"description":"resource deleted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommandSuccess"}}}},"401":{"description":"unauthorized (code: 2465)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"operation only available via the website (code: 4786)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Multiple error variants are possible:\n- zone authority not found (code: 3792)\n- zone not found (code: 2728)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"zone authority still in use (code: 2677)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearer":[]},{"basic":[]}]}},"/v1/dns/zones":{"get":{"tags":["zones"],"summary":"List zones","description":"List a user's zones.\nThe type of the results can be selected using the `view` parameter.\nResults can be filtered and sorted using the `filter` and `sort` parameters,\nand filtered by `zone` metadata using metadata filter expressions.","operationId":"v1/dnsListZones","parameters":[{"name":"view","in":"query","description":"Zone format (defaults to summary)","required":false,"schema":{"$ref":"#/components/schemas/ZoneViewType"},"style":"form","example":"detail"},{"name":"offset","in":"query","description":"Offset from beginning of list","required":false,"schema":{"type":"integer","format":"int64","minimum":0},"style":"form","example":0},{"name":"limit","in":"query","description":"Maximum number of results to return","required":false,"schema":{"type":"integer","format":"int64","minimum":0},"style":"form","example":20},{"name":"sort","in":"query","description":"Sort options: (allowed fields: zone_name, publication_state; allowed sorting: asc, desc).","required":false,"schema":{"type":"object","properties":{"zone_name":{"type":"string","enum":["asc","desc"],"example":"asc"},"publication_state":{"type":"string","enum":["asc","desc"],"example":"asc"}},"examples":[{"zone_name":"asc","publication_state":"asc"}]},"style":"deepObject","example":{"zone_name":"asc","publication_state":"asc"}},{"name":"filter","in":"query","description":"Filter options: (allowed fields: publication_state, is_shared, name, zone_type)","required":false,"schema":{"$ref":"#/components/schemas/FilterZoneSummaryList","description":"Filter options: (allowed fields: publication_state, is_shared, name, zone_type)"},"style":"deepObject","example":{"publication_state":"published","is_shared":true,"zone_type":"primary","zone_name":["example-zone-a.com","example-zone-b.com"],"dns_name":["www"],"dns_type":["A"],"label":["rdata-label"],"rdata":["192.0.2.1"]}},{"name":"expand[]","in":"query","description":"Sub-resource expansion options. (allowed resources: dns_name_count, rdata_count)","required":false,"schema":{"type":"array","items":{"type":"string","enum":["dns_name_count","rdata_count"]},"examples":[["dns_name_count","rdata_count"]]},"style":"form","example":["dns_name_count","rdata_count"]},{"name":"metadata","in":"query","description":"Filter results by metadata.\nSee [metadata filters](metadata-filter-expressions) for an in-depth description of the expression syntax.","required":false,"schema":{"$ref":"#/components/schemas/MetadataFilterExpression"},"style":"form","example":"{\"or\":[{\"and\":[{\"op\":\"contains\",\"key\":\"key1\",\"value\":\"value1\"},{\"op\":\"exact\",\"key\":\"key2\",\"value\":\"value2\"}]},{\"op\":\"exact\",\"key\":\"key3\",\"value\":\"value3\"}]}"}],"responses":{"200":{"description":"zone data","content":{"application/json":{"schema":{"type":"object","description":"zone data","required":["data","page"],"properties":{"data":{"$ref":"#/components/schemas/ZoneData","description":"zone data"},"page":{"$ref":"#/components/schemas/PageInfo"},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/Warning"}}}}}}},"401":{"description":"unauthorized (code: 2465)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearer":[]},{"basic":[]}]},"post":{"tags":["zones"],"summary":"Create a zone","description":"Create a zone and request its publication.\nWhen the zone gets published, it becomes resolvable on the primary nameservers.","operationId":"v1/dnsCreateZone","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewZone"},"examples":{"autogenerated":{"value":{"name":"example.com","request_publication":true,"serial_epoch":42,"nx_ttl":60,"metadata":{"property":"value"}}}}}},"required":true},"responses":{"201":{"description":"resource created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommandSuccess"}}}},"400":{"description":"Multiple error variants are possible:\n- invalid identifier (code: 3913)\n- invalid zone name (code: 4637)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"unauthorized (code: 2465)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"402":{"description":"Multiple error variants are possible:\n- owned zones are over limit; please contact support (code: 4085)\n- zone metadata over limit; please contact support (code: 4228)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Multiple error variants are possible:\n- not allowed (code: 4748)\n- operation only available via the website (code: 4786)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Multiple error variants are possible:\n- zone authority not found (code: 3792)\n- zone primary not found (code: 3124)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Multiple error variants are possible:\n- zone already exists (code: 3901)\n- zone containing this name already exists. (code: 3728)\n- zone is within an existing zone (code: 4032)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearer":[]},{"basic":[]}]}},"/v1/dns/zones/{zone_name}":{"get":{"tags":["zones"],"summary":"Get a zone","description":"Get detailed information about a zone.","operationId":"v1/dnsGetZone","parameters":[{"name":"zone_name","in":"path","description":"The name of the zone.","required":true,"schema":{"$ref":"#/components/schemas/ZoneName"},"example":"example.com"},{"name":"expand[]","in":"query","description":"Sub-resource expansion options. (allowed resources: dns_name_count, rdata_count)","required":false,"schema":{"type":"array","items":{"type":"string","enum":["dns_name_count","rdata_count"]},"examples":[["dns_name_count","rdata_count"]]},"style":"form","example":["dns_name_count","rdata_count"]}],"responses":{"200":{"description":"DNS zone of authority","content":{"application/json":{"schema":{"type":"object","description":"DNS zone of authority","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/ZoneDetail","description":"DNS zone of authority"},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/Warning"}}}}}}},"401":{"description":"unauthorized (code: 2465)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"operation only available via the website (code: 4786)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"zone not found (codes: 2510, 2728)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearer":[]},{"basic":[]}]},"delete":{"tags":["zones"],"summary":"Delete zone","description":"Delete zone, associated records and metadata.","operationId":"v1/dnsDeleteZone","parameters":[{"name":"zone_name","in":"path","description":"The name of the zone.","required":true,"schema":{"$ref":"#/components/schemas/ZoneName"},"example":"example.com"}],"responses":{"200":{"description":"resource deleted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommandSuccess"}}}},"401":{"description":"unauthorized (code: 2465)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Multiple error variants are possible:\n- changing this zone is forbidden (code: 4238)\n- changing this zone is prohibited; please contact support (code: 3903)\n- operation only available via the website (code: 4786)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"zone not found (codes: 2510, 2728)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearer":[]},{"basic":[]}]}},"/v1/dns/zones/{zone_name}/authority":{"post":{"tags":["zones"],"summary":"Set authority for zone","description":"Specify an authority for a zone","operationId":"v1/dnsSetAuthorityForZone","parameters":[{"name":"zone_name","in":"path","description":"The name of the zone.","required":true,"schema":{"$ref":"#/components/schemas/ZoneName"},"example":"example.com"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ZoneAuthority"}}},"required":true},"responses":{"202":{"description":"resource updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommandSuccess"}}}},"401":{"description":"unauthorized (code: 2465)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"changing this zone is prohibited; please contact support (code: 3903)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Multiple error variants are possible:\n- zone authority not found (code: 3792)\n- zone not found (code: 2510)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearer":[]},{"basic":[]}]},"delete":{"tags":["zones"],"summary":"Delete authority for zone","description":"Delete the authority for a zone, restoring use of the default.","operationId":"v1/dnsDeleteAuthorityForZone","parameters":[{"name":"zone_name","in":"path","description":"The name of the zone.","required":true,"schema":{"$ref":"#/components/schemas/ZoneName"},"example":"example.com"}],"responses":{"202":{"description":"resource updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommandSuccess"}}}},"401":{"description":"unauthorized (code: 2465)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"changing this zone is prohibited; please contact support (code: 3903)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"zone not found (code: 2510)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearer":[]},{"basic":[]}]}},"/v1/dns/zones/{zone_name}/export":{"get":{"tags":["zones"],"summary":"Export zone file data","description":"Export the zone file data as plain text.","operationId":"v1/dnsExportZone","parameters":[{"name":"zone_name","in":"path","description":"The name of the zone.","required":true,"schema":{"$ref":"#/components/schemas/ZoneName"},"example":"example.com"},{"name":"serial","in":"query","description":"What serial number should appear in the SOA record of the exported zone","required":false,"schema":{"type":"integer","format":"int32","minimum":0},"example":42}],"responses":{"200":{"description":"Zone data in master file format","content":{"text/plain":{"schema":{"type":"string","description":"Zone data in master file format"}}}},"401":{"description":"unauthorized (code: 2465)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"operation only available via the website (code: 4786)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Multiple error variants are possible:\n- zone authority not found (code: 3792)\n- zone not found (codes: 2510, 2728)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearer":[]},{"basic":[]}]}},"/v1/dns/zones/{zone_name}/import":{"post":{"tags":["zones"],"summary":"Import zone file data","description":"Takes a zone file and creates the zone with all its records.","operationId":"v1/dnsImportZone","parameters":[{"name":"zone_name","in":"path","description":"The name of the zone.","required":true,"schema":{"$ref":"#/components/schemas/ZoneName"},"example":"example.com"}],"requestBody":{"description":"zone data in master zone file format","content":{"text/plain":{"schema":{"type":"string"}}},"required":true},"responses":{"201":{"description":"resource created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommandSuccess"}}}},"400":{"description":"Multiple error variants are possible:\n- DNS hostname contains too many labels (code: 2324)\n- Rdata labels must be unique in an RRset (code: 2008)\n- a label contains characters not in the allowed character set (code: 3284)\n- a wildcard label must be the terminal label in a name (code: 3893)\n- duplicated update groups for rrset (code: 4344)\n- expected valid offline settings for offline name (code: 2212)\n- invalid ALIAS record (code: 4159)\n- invalid CNAME record (code: 4659)\n- invalid DNS name (code: 4625)\n- invalid DNS update group (code: 3315)\n- invalid NS record (code: 3111)\n- invalid PTR record (code: 4619)\n- invalid Rdata label (code: 4819)\n- invalid TTL (code: 3295)\n- invalid email address (code: 3588)\n- invalid format for Rdata (code: 2839)\n- invalid format for URL redirect (code: 3564)\n- invalid logo url (code: 3562)\n- invalid name (code: 3607)\n- invalid offline IP address (code: 2711)\n- invalid origin name (code: 4355)\n- invalid redirect URL (code: 2788)\n- label is required for rdata update group targets (code: 4945)\n- operation violates DNS rules (code: 3363)\n- required field missing for offline action (code: 2714)\n- the parent of a wildcard cannot be an empty nonterminal node (code: 3624)\n- unsupported DNS record type (code: 3252)\n- update group target dns type must be either A, AAAA or _URL (code: 3325)\n- update group target on both name and rdata (code: 3731)\n- zone parse failed (code: 3937)\n- zone parse failed: invalid SOA data (code: 4286)\n- zone parse failed: invalid format (code: 2930)\n- zone parse failed: serial not found (code: 4236)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"unauthorized (code: 2465)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"402":{"description":"Multiple error variants are possible:\n- DNS names are over limit; please contact support (code: 3354)\n- RRset metadata over limit; please contact support (code: 4556)\n- Rdata count is over limit; please contact support (code: 4428)\n- dns name metadata over limit; please contact support (code: 2218)\n- owned zones are over limit; please contact support (code: 4085)\n- zone metadata over limit; please contact support (code: 4228)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Multiple error variants are possible:\n- DNS types disallowed (code: 2051)\n- RRset TTL cannot be changed (code: 4535)\n- new names cannot be created in this zone (code: 2784)\n- not allowed (code: 4748)\n- only auto-generated Rdata labels may start with an underscore (code: 4555)\n- only the zone owner may create this record (code: 4365)\n- operation only available via the website (code: 4786)\n- requested RRset TTL is too low (code: 3655)\n- updating this DNS update group is forbidden (code: 4127)\n- wildcards in labels are restricted (code: 4072)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"zone authority not found (code: 3792)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Multiple error variants are possible:\n- DNS name already exists (code: 4285)\n- DNS name is already owned (code: 3424)\n- Rdata value already exists (code: 2722)\n- conflicting target already exists in a group (code: 3311)\n- target already exists (code: 3676)\n- zone already exists (code: 3901)\n- zone containing this name already exists. (code: 3728)\n- zone is within an existing zone (code: 4032)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"alias points to name outside the zone (code: 4145)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearer":[]},{"basic":[]}]}},"/v1/dns/zones/{zone_name}/metadata":{"get":{"tags":["zones"],"summary":"Get metadata for a zone","description":"Get metadata associated to the zone.\nSee [metadata filters](metadata-filter-expressions) for an in-depth explanation about metadata filters.","operationId":"v1/dnsGetZoneMetadata","parameters":[{"name":"zone_name","in":"path","description":"The name of the zone.","required":true,"schema":{"$ref":"#/components/schemas/ZoneName"},"example":"example.com"}],"responses":{"200":{"description":"Response for get metadata queries","content":{"application/json":{"schema":{"type":"object","description":"Response for get metadata queries","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/GetMetadata","description":"Response for get metadata queries"},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/Warning"}}}}}}},"401":{"description":"unauthorized (code: 2465)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"operation only available via the website (code: 4786)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"zone not found (codes: 2510, 2728)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearer":[]},{"basic":[]}]},"post":{"tags":["zones"],"summary":"Set zone metadata","description":"Set metadata associated to a zone.\nZone metadata is stored until the zone gets deleted.\nNew keys are added, existing keys are updated. To remove a key, set its value to an empty string.\n\nSee [metadata filters](metadata-filter-expressions) for an in-depth explanation about metadata filters.","operationId":"v1/dnsSetZoneMetadata","parameters":[{"name":"zone_name","in":"path","description":"The name of the zone.","required":true,"schema":{"$ref":"#/components/schemas/ZoneName"},"example":"example.com"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetMetadata"},"examples":{"autogenerated":{"value":{"metadata":{"public property":"public value"}}}}}},"required":true},"responses":{"202":{"description":"resource updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommandSuccess"}}}},"401":{"description":"unauthorized (code: 2465)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"402":{"description":"zone metadata over limit; please contact support (code: 4228)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Multiple error variants are possible:\n- changing this zone is forbidden (code: 4238)\n- changing this zone is prohibited; please contact support (code: 3903)\n- operation only available via the website (code: 4786)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"zone not found (codes: 2510, 2728)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearer":[]},{"basic":[]}]}},"/v1/dns/zones/{zone_name}/nx-ttl":{"post":{"tags":["zones"],"summary":"Set zone NXTTL","description":"Set the NXTTL for a zone.","operationId":"v1/dnsSetZoneNxTtl","parameters":[{"name":"zone_name","in":"path","description":"The name of the zone.","required":true,"schema":{"$ref":"#/components/schemas/ZoneName"},"example":"example.com"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SerialEpoch"},"examples":{"autogenerated":{"value":{"serial_epoch":42}}}}},"required":true},"responses":{"202":{"description":"resource updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommandSuccess"}}}},"401":{"description":"unauthorized (code: 2465)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Multiple error variants are possible:\n- changing this zone is prohibited; please contact support (code: 3903)\n- operation only available via the website (code: 4786)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"zone not found (codes: 2510, 2728)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"zone must be unpublished to change NXTTL (code: 3361)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearer":[]},{"basic":[]}]}},"/v1/dns/zones/{zone_name}/publish":{"post":{"tags":["zones"],"summary":"Publish zone","description":"Request publication of the zone.\nWhen the zone gets published, it becomes resolvable on the primary nameservers.","operationId":"v1/dnsPublishZone","parameters":[{"name":"zone_name","in":"path","description":"The name of the zone.","required":true,"schema":{"$ref":"#/components/schemas/ZoneName"},"example":"example.com"}],"responses":{"202":{"description":"resource updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommandSuccess"}}}},"401":{"description":"unauthorized (code: 2465)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"402":{"description":"Multiple error variants are possible:\n- DNS names are over limit; please contact support (code: 3354)\n- RRset metadata over limit; please contact support (code: 4556)\n- Rdata count is over limit; please contact support (code: 4428)\n- dns name metadata over limit; please contact support (code: 2218)\n- owned zones are over limit; please contact support (code: 4085)\n- zone metadata over limit; please contact support (code: 4228)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Multiple error variants are possible:\n- changing this zone is forbidden (code: 4238)\n- changing this zone is prohibited; please contact support (code: 3903)\n- force publication of the zone is disallowed (code: 4605)\n- operation only available via the website (code: 4786)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"zone not found (codes: 2510, 2728)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Multiple error variants are possible:\n- zone already published (code: 3805)\n- zone containing this name already exists. (code: 3728)\n- zone is within an existing zone (code: 4032)\n- zone publication already requested (code: 4738)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearer":[]},{"basic":[]}]}},"/v1/dns/zones/{zone_name}/unpublish":{"post":{"tags":["zones"],"summary":"Unpublish zone","description":"Request reverting the publication of the zone.\nWhen the zone becomes unpublished, it will not be resolvable on the primary nameservers.","operationId":"v1/dnsUnpublishZone","parameters":[{"name":"zone_name","in":"path","description":"The name of the zone.","required":true,"schema":{"$ref":"#/components/schemas/ZoneName"},"example":"example.com"}],"responses":{"202":{"description":"resource updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommandSuccess"}}}},"401":{"description":"unauthorized (code: 2465)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Multiple error variants are possible:\n- changing this zone is forbidden (code: 4238)\n- changing this zone is prohibited; please contact support (code: 3903)\n- operation only available via the website (code: 4786)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"zone not found (codes: 2510, 2728)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Multiple error variants are possible:\n- zone is already unpublished (code: 3810)\n- zone unpublication already requested (code: 4644)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearer":[]},{"basic":[]}]}}},"components":{"securitySchemes":{"Basic":{"type":"http","description":"Open [https://my.noip.com/auth/api-keys](https://my.noip.com/auth/api-keys) to start using the No-IP API","scheme":"basic","x-visibility":"public"},"Bearer":{"type":"http","description":"Open [https://my.noip.com/auth/api-keys](https://my.noip.com/auth/api-keys) to start using the No-IP API","scheme":"bearer","x-visibility":"public"},"basic":{"type":"http","scheme":"basic","description":"Put your API key in the password field and leave the username field blank. If your client requires a username, enter 'user'."},"bearer":{"type":"http","scheme":"bearer"}},"parameters":{"ddns_key_username":{"name":"ddns_key_username","in":"path","description":"The username identifier of a DDNS key.","required":true,"deprecated":false,"schema":{"type":"string"},"example":"kgp25ha"}},"schemas":{"AccountDDNSKeyTargets":{"properties":{"description":{"type":["string","null"]},"created_at":{"type":"string","format":"date-time"},"targets":{"type":"array","items":{"properties":{"name":{"description":"The DNS name, not including the zone portion.","type":"string","example":"dns-name"},"zone_name":{"description":"The name of the zone.","type":"string","example":"example.com"}},"type":"object"}},"credentials":{"required":["username"],"properties":{"username":{"type":"string"}},"type":"object"}},"type":"object"},"AccountWarning":{"properties":{"title":{"description":"A title for this warning.","type":["string","null"]},"detail":{"description":"Contextual information about this warning.","type":["string","null"]},"code":{"description":"A code for this warning.","type":["string","null"]}},"type":"object"},"AccountErrorResponse":{"properties":{"warnings":{"type":"array","items":{"$ref":"#/components/schemas/AccountWarning"}},"errors":{"type":"array","items":{"$ref":"#/components/schemas/AccountError"}}},"type":"object"},"AccountDDNSKeyRequestEditAPI":{"required":["targets"],"properties":{"description":{"type":"string"},"targets":{"type":"array","items":{"properties":{"name":{"description":"The DNS name, not including the zone portion.","type":"string","example":"dns-name"},"zone_name":{"description":"The name of the zone.","type":"string","example":"example.com"}},"type":"object"}}},"type":"object"},"AccountVoidHttpResource":{},"AccountDDNSKeyCollection":{"properties":{"page":{"oneOf":[{"$ref":"#/components/schemas/AccountPage"},{"type":"null"}]},"data":{"type":"array","items":{"$ref":"#/components/schemas/AccountDDNSKey"}}},"type":"object"},"AccountDDNSKeyRequestPost":{"required":["targets"],"properties":{"description":{"description":"A friendly title.","type":"string","example":"group-name_1"},"targets":{"type":"array","items":{"properties":{"name":{"description":"The DNS name, not including the zone portion.","type":"string","example":"dns-name"},"zone_name":{"description":"The name of the zone.","type":"string","example":"example.com"}},"type":"object"}}},"type":"object"},"AccountDDNSKeyCreated":{"type":"object","allOf":[{"$ref":"#/components/schemas/AccountDDNSKey"},{"properties":{"credentials":{"required":["username"],"properties":{"username":{"type":"string"},"password":{"type":"string"}},"type":"object"}},"type":"object"}]},"AccountError":{"properties":{"location":{"description":"Specific information about where this code was emitted.","type":["string","null"]},"detail":{"description":"Specific information about why this code was emitted.","type":["string","null"]},"title":{"description":"an application-specific text describing the code.","type":["string","null"]},"pointer":{"description":"Detailed information about where this code was emitted.","type":["string","null"]},"code":{"description":"an application-specific error code","type":["string","null"]},"id":{"description":"a unique code to identify this error instance","type":["string","null"]}},"type":"object"},"AccountPage":{"properties":{"offset":{"type":"integer"},"limit":{"type":"integer"},"total":{"type":"integer"}},"type":"object"},"AccountDDNSKey":{"properties":{"created_at":{"type":"string","format":"date-time"},"description":{"type":["string","null"]},"credentials":{"required":["username"],"properties":{"username":{"type":"string"}},"type":"object"}},"type":"object"},"CommandSuccess":{"type":"object","properties":{"warnings":{"type":"array","items":{"$ref":"#/components/schemas/Warning"}}}},"DnsName":{"allOf":[{"$ref":"#/components/schemas/GetMetadata"},{"type":"object","required":["name","is_published","is_offline","is_write_prohibited","created_at","name_labels_reversed"],"properties":{"name":{"$ref":"#/components/schemas/Name","description":"Name"},"update_group":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/GroupName","description":"The DNS update update group"}]},"is_published":{"type":"boolean","description":"Is the name published?"},"is_offline":{"type":"boolean","description":"Is the name offline?"},"is_write_prohibited":{"type":"boolean","description":"Name is write prohibited"},"created_at":{"type":"string","format":"date-time","description":"Created at"},"name_labels_reversed":{"type":"string","description":"Name with the labels in reverse order"},"offline_settings":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/OfflineSettings","description":"Offline settings"}]}}}],"description":"DNS name, not fully-qualified","type":"object"},"DnsNameData":{"oneOf":[{"type":"array","items":{"$ref":"#/components/schemas/DnsNameSummary"}},{"type":"array","items":{"$ref":"#/components/schemas/DnsNameRecord"}}],"description":"DNS name data","example":[{"fqdn":"one.free.example.com"},{"fqdn":"other.free.example.com"}],"type":"array"},"DnsNameList":{"type":"array","items":{"$ref":"#/components/schemas/DnsName"}},"DnsNameRecord":{"allOf":[{"$ref":"#/components/schemas/DnsNameRecordMetadata"},{"type":"object","required":["name","zone_name","is_write_prohibited","zone_is_shared","name_labels_reversed","created_at"],"properties":{"name":{"$ref":"#/components/schemas/Name","description":"Name"},"update_group":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/GroupName","description":"The DNS update update group"}]},"record":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/Record","description":"DNS name"}]},"zone_name":{"$ref":"#/components/schemas/ZoneName","description":"Zone"},"is_write_prohibited":{"type":"boolean","description":"Name is write prohibited"},"zone_is_shared":{"type":"boolean","description":"Is the zone shared?"},"shared_in_group":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/Identifier","description":"Zone group where the zone is shared"}]},"name_labels_reversed":{"type":"string","description":"Name with the labels in reverse order"},"created_at":{"type":"string","format":"date-time","description":"Created at"}}}],"description":"A detailed name","type":"object"},"DnsNameRecordMetadata":{"type":"object","properties":{"metadata":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/Metadata","description":"Dns Name metadata"}]},"rrset_metadata":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/MetadataField","description":"RRSet Metadata"}]},"zone_metadata":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/MetadataField","description":"Zone Metadata"}]}},"example":{"metadata":{"DNS name property":"DNS name value"},"rrset_metadata":{"metadata":{"rrset property":"rrset value"}},"zone_metadata":{"metadata":{"zone property":"zone value"}}}},"DnsNameSummary":{"type":"object","description":"A summary of name information.","required":["fqdn"],"properties":{"fqdn":{"type":"string","description":"The FQDN that results from this name and its zone","example":"h.free.example.com"}}},"DnsNameViewType":{"type":"string","description":"Record format (defaults to summary)","enum":["summary","record"],"example":"summary"},"DnsRecType":{"type":"string","description":"DNS name type supported by API","enum":["A","AAAA","CAA","CNAME","MX","NS","SRV","TXT","PTR","_URL","ALIAS"],"example":"A"},"Error":{"type":"object","required":["id","code","title"],"properties":{"id":{"type":"string","description":"a unique code to identify this error instance"},"code":{"type":"string","description":"an application-specific error code"},"title":{"type":"string","description":"an application-specific text describing the code."},"detail":{"type":["string","null"],"description":"Specific information about why this code was emitted."},"location":{"type":["string","null"],"description":"Specific information about where this code was emitted."},"pointer":{"type":["string","null"],"description":"Detailed information about where this code was emitted."}}},"ErrorResponse":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/Warning"}}}},"FilterDnsNameList":{"type":"object","description":"Filter options: (allowed fields: name, zone_name, dns_type, zone_is_shared, dynupdate)","properties":{"dns_name":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"zone_name":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"dns_type":{"oneOf":[{"$ref":"#/components/schemas/DnsRecType","description":"DNS name type supported by API"},{"type":"array","items":{"$ref":"#/components/schemas/DnsRecType","description":"DNS name type supported by API"}},{"$ref":"#/components/schemas/Sentinel"}],"description":"DNS name type supported by API"},"zone_is_shared":{"type":["boolean","null"]},"update_group":{"oneOf":[{"$ref":"#/components/schemas/GroupName","description":"Name of the update group"},{"type":"array","items":{"$ref":"#/components/schemas/GroupName","description":"Name of the update group"}},{"$ref":"#/components/schemas/Sentinel"}],"description":"Name of the update group"},"dynupdate":{"type":["boolean","null"]},"label":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"rdata":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}},{"$ref":"#/components/schemas/Sentinel"}]}},"example":{"dns_name":["www"],"zone_name":["example-zone-a.com","example-zone-b.com"],"dns_type":["A"],"zone_is_shared":true,"update_group":["dns-group-1"],"dynupdate":true,"label":["rdata-label"],"rdata":["192.0.2.1"]}},"FilterZoneSummaryList":{"type":"object","description":"Filter options: (allowed fields: publication_state, is_shared, name, zone_type)","properties":{"publication_state":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/PublicationState"}]},"is_shared":{"type":["boolean","null"]},"zone_type":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/ZoneType"}]},"zone_name":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"dns_name":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}},{"$ref":"#/components/schemas/Sentinel"}]},"dns_type":{"oneOf":[{"$ref":"#/components/schemas/DnsRecType","description":"DNS name type supported by API"},{"type":"array","items":{"$ref":"#/components/schemas/DnsRecType","description":"DNS name type supported by API"}},{"$ref":"#/components/schemas/Sentinel"}],"description":"DNS name type supported by API"},"label":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"rdata":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}},{"$ref":"#/components/schemas/Sentinel"}]}},"example":{"publication_state":"published","is_shared":true,"zone_type":"primary","zone_name":["example-zone-a.com","example-zone-b.com"],"dns_name":["www"],"dns_type":["A"],"label":["rdata-label"],"rdata":["192.0.2.1"]}},"GetMetadata":{"allOf":[{"$ref":"#/components/schemas/MetadataField"}],"description":"Response for get metadata queries","example":{"metadata":{"public property":"public value"}},"type":"object"},"GroupName":{"type":"string","description":"Name of the update group","example":"grp_1-2"},"Identifier":{"type":"string","description":"## Identifier\n\nA string type that has a limited character set, which makes it useful\nas an easy to type identifier for use in things like URL paths. The\nrestrictions are alphanumeric characters (Unicode is permitted),\nplus dashes and underscore except for the initial character.\n"},"Label":{"type":"string","description":"Label for an Rdata that uniquely identifies it within its RRSet\nLabels are case-insensitive and may contain alphanumeric characters and dashes.\nIf a label is not set manually, it will be autogenerated, prefixed with an underscore _.","example":"a-label-123"},"Metadata":{"type":"object","description":"A collection of string key/value pairs that provide additional information or classification for an object.","additionalProperties":{"type":"string"},"propertyNames":{"type":"string"},"example":{"property":"value"}},"MetadataField":{"type":"object","description":"A metadata field.","properties":{"metadata":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/Metadata"}]}},"example":{"metadata":{"public property":"public value"}}},"MetadataFilterExpression":{"type":"string","description":"A metadata filter expression\nSee [metadata filters](metadata-filter-expressions) for an in-depth description of the expression syntax.","example":"{\"or\":[{\"and\":[{\"op\":\"contains\",\"key\":\"key1\",\"value\":\"value1\"},{\"op\":\"exact\",\"key\":\"key2\",\"value\":\"value2\"}]},{\"op\":\"exact\",\"key\":\"key3\",\"value\":\"value3\"}]}"},"Name":{"type":"string","description":"The DNS name, not including the zone portion.","example":"dns-name"},"NewDnsName":{"type":"object","description":"A new name to be created.","required":["name"],"properties":{"name":{"$ref":"#/components/schemas/Name","description":"The name, not including the zone portion"},"rrsets":{"type":"array","items":{"$ref":"#/components/schemas/NewRRSet"},"description":"List of RRSets to create with the name","example":[{"dns_type":"A","rdata":[{"value":"192.0.2.1","label":"optional-label-1"},{"value":"192.0.2.2"}],"ttl":60,"metadata":{"key":"value"}},{"dns_type":"AAAA","rdata":[{"value":"2001:db8::1","label":"optional-label-2"}],"ttl":60}]},"offline_settings":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/OfflineSettings","description":"Offline settings for the DNS name"}]},"is_offline":{"type":["boolean","null"],"description":"Is the DNS name offline?"},"metadata":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/Metadata","description":"Metadata for the DNS name\n\nSee [metadata filters](metadata-filter-expressions) for an in-depth explanation about metadata filters."}]}}},"NewRRSet":{"type":"object","description":"RRSet to create.","required":["dns_type"],"properties":{"dns_type":{"$ref":"#/components/schemas/DnsRecType","description":"DNS type"},"rdata":{"type":"array","items":{"$ref":"#/components/schemas/NewRdata"},"description":"List of Rdata for this RRset","example":[{"value":"192.0.2.1","label":"optional-label-1"},{"value":"192.0.2.1"}]},"ttl":{"type":["integer","null"],"format":"int32","description":"Time to live (seconds)","example":60,"minimum":0},"metadata":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/Metadata","description":"Metadata for the RRSet\n\nSee [metadata filters](metadata-filter-expressions) for an in-depth explanation about metadata filters."}]}}},"NewRdata":{"type":"object","description":"Rdata value, with an optional label.","required":["value"],"properties":{"value":{"type":"string","description":"Rdata value","example":"192.0.2.1"},"label":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/Label","description":"API-specific label for Rdata. If unspecified, random label will be generated."}]}}},"NewZone":{"type":"object","description":"New DNS zone to create.","required":["name"],"properties":{"name":{"$ref":"#/components/schemas/ZoneName","description":"Domain name for zone"},"request_publication":{"type":["boolean","null"],"description":"Zone is to published (resolvable on Internet) upon creation","example":true},"serial_epoch":{"type":["integer","null"],"format":"int32","description":"Initial serial number to use in published zone data (default: 1)","example":42,"minimum":0},"zone_authority":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/Identifier","description":"Zone authority (MNAME, RNAME, nameservers) for the zone"}]},"nx_ttl":{"type":["integer","null"],"format":"int32","example":60,"minimum":0},"metadata":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/Metadata","description":"Metadata for zone\n\nSee [metadata filters](metadata-filter-expressions) for an in-depth explanation about metadata filters."}]}}},"OfflineAction":{"type":"string","enum":["no_action","ip","web_redirect","page"]},"OfflineSettings":{"type":"object","required":["action"],"properties":{"action":{"$ref":"#/components/schemas/OfflineAction","description":"Action when offline"},"ip":{"type":["string","null"],"description":"Ip address used when action is `ip`"},"web_redirect":{"type":["string","null"],"description":"Url to redirect used when action is `url`"},"page_title":{"type":["string","null"],"description":"Page title when action is `page`"},"page_text":{"type":["string","null"],"description":"Page text when action is `page`"},"page_email":{"type":["string","null"],"description":"Page contact email when action is `page`"},"page_logo_url":{"type":["string","null"],"description":"Page logo when action is `page`"}}},"PageInfo":{"type":"object","required":["offset","limit","total"],"properties":{"offset":{"type":"integer","format":"int64","minimum":0},"limit":{"type":"integer","format":"int64","minimum":0},"total":{"type":"integer","format":"int64","example":10,"minimum":0}}},"PublicationState":{"type":"string","description":"Publication state for zone","enum":["publish_requested","published","publish_failed","unpublish_requested","unpublished"]},"RRSet":{"allOf":[{"$ref":"#/components/schemas/GetMetadata","description":"Metadata for RRSet"},{"type":"object","required":["name","dns_type","rdata","ttl","updated_at"],"properties":{"name":{"$ref":"#/components/schemas/Name","description":"DNS name"},"dns_type":{"$ref":"#/components/schemas/DnsRecType","description":"DNS type"},"rdata":{"type":"array","items":{"$ref":"#/components/schemas/Rdata"},"description":"List of Rdata for this RRset"},"ttl":{"type":"integer","format":"int32","minimum":0},"updated_at":{"type":"string","format":"date-time","description":"Updated at"}}}],"description":"Resource Record Set (resources with a common name, class and type)","type":"object"},"RRSetList":{"type":"array","items":{"$ref":"#/components/schemas/RRSet"},"description":"A list of Resource Record Sets"},"Rdata":{"type":"object","description":"Resource Record data","required":["value","label","updated_at"],"properties":{"value":{"type":"string","description":"Rdata value"},"label":{"$ref":"#/components/schemas/Label","description":"API-specific label for Rdata"},"update_group":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/GroupName","description":"The DNS update update group that contains this rdata"}]},"updated_at":{"type":"string","format":"date-time","description":"Updated at"}}},"Record":{"type":"object","description":"DNS resource name","required":["dns_type","rdata","label","ttl","updated_at"],"properties":{"dns_type":{"$ref":"#/components/schemas/DnsRecType","description":"DNS name type"},"rdata":{"type":"string","description":"Rdata value"},"label":{"type":"string","description":"Rdata label"},"update_group":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/GroupName","description":"The DNS update update group that contains this rdata"}]},"ttl":{"type":"integer","format":"int32","minimum":0},"updated_at":{"type":"string","format":"date-time","description":"Updated at"}}},"Sentinel":{"type":"string","enum":["*","!*"]},"SerialEpoch":{"type":"object","required":["serial_epoch"],"properties":{"serial_epoch":{"type":"integer","format":"int32","example":42,"minimum":0}}},"ServerInfo":{"type":"object","description":"API server version information","required":["name","version","commit_sha"],"properties":{"name":{"type":"string","description":"Package name"},"version":{"type":"string","description":"Package version"},"commit_sha":{"type":"string","description":"Git commit hash"}}},"SetMetadata":{"allOf":[{"$ref":"#/components/schemas/MetadataField"}],"description":"Parameters used to set the metadata.","example":{"metadata":{"public property":"public value"}},"type":"object"},"SetRRSetTtl":{"type":"object","description":"Sets the TTL value for an RRSet","required":["ttl"],"properties":{"ttl":{"type":"integer","format":"int32","description":"Time to live (seconds)","example":60,"minimum":0}}},"SetRdata":{"type":"object","description":"Rdata value","required":["value"],"properties":{"value":{"type":"string","description":"Rdata value","example":"192.0.2.1"}}},"Warning":{"type":"object","description":"The Warning error type","required":["code","title"],"properties":{"code":{"type":"string","description":"A code for this warning."},"title":{"type":"string","description":"A title for this warning."},"detail":{"type":["string","null"],"description":"Contextual information about this warning."}}},"ZoneAuthority":{"type":"object","required":["name"],"properties":{"name":{"$ref":"#/components/schemas/Identifier"},"mname":{"type":["string","null"]},"rname":{"type":["string","null"]},"nameservers":{"type":["array","null"],"items":{"type":"string"}},"extend":{"type":["boolean","null"]}}},"ZoneAuthorityList":{"type":"array","items":{"$ref":"#/components/schemas/ZoneAuthority"}},"ZoneData":{"oneOf":[{"type":"array","items":{"$ref":"#/components/schemas/ZoneDetail"}},{"type":"array","items":{"$ref":"#/components/schemas/ZoneSummary"}}],"description":"zone data","example":[{"name":"example.com","zone_type":"primary","is_owner":true,"zone_authority":"zone-authority","nx_ttl":1800,"publication_state":"published","is_write_prohibited":false,"shared_in_group":"zone-group-name","dns_name_count":10,"rdata_count":100,"metadata":{"zone metadata key":"zone metadata value"},"created_at":"1970-01-01T00:01:01Z","updated_at":"1970-01-01T00:01:01Z"},{"name":"example.com","zone_type":"primary","is_owner":false,"dns_name_count":10,"rdata_count":100}],"type":"array"},"ZoneDetail":{"oneOf":[{"$ref":"#/components/schemas/ZoneDetailForOwner"},{"$ref":"#/components/schemas/ZoneDetailForNonOwner"}],"description":"DNS zone of authority","type":"object"},"ZoneDetailForNonOwner":{"type":"object","description":"DNS zone of authority","required":["name","zone_type","is_owner"],"properties":{"name":{"$ref":"#/components/schemas/ZoneName","description":"Zone name"},"zone_type":{"$ref":"#/components/schemas/ZoneType","description":"Zone type"},"is_owner":{"type":"boolean","description":"Is the zone owned by the user?"},"dns_name_count":{"type":["integer","null"],"format":"int32","description":"Count of dns names in the zone.","minimum":0},"rdata_count":{"type":["integer","null"],"format":"int32","description":"Count of rdata in the zone.","minimum":0}}},"ZoneDetailForOwner":{"type":"object","description":"Zone summary, including group options.","required":["name","zone_type","is_owner","nx_ttl","publication_state","is_write_prohibited","created_at","updated_at"],"properties":{"name":{"$ref":"#/components/schemas/ZoneName","description":"Zone name"},"zone_type":{"$ref":"#/components/schemas/ZoneType","description":"Zone type"},"is_owner":{"type":"boolean","description":"Is the zone owned by the user?"},"zone_authority":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/Identifier","description":"Zone authority (MNAME, RNAME, nameservers)"}]},"nx_ttl":{"type":"integer","format":"int32","description":"Negative caching (NXDOMAIN, etc) time-to-live (seconds)","minimum":0},"publication_state":{"$ref":"#/components/schemas/PublicationState","description":"Zone is published (resolvable on Internet)"},"publication_failure":{"type":["string","null"],"description":"Publication failure reason"},"is_write_prohibited":{"type":"boolean","description":"Zone is write prohibited"},"shared_in_group":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/Identifier","description":"Name of the zone group where the zone is shared"}]},"dns_name_count":{"type":["integer","null"],"format":"int32","description":"Count of dns names in the zone.","minimum":0},"rdata_count":{"type":["integer","null"],"format":"int32","description":"Count of rdata in the zone.","minimum":0},"metadata":{"$ref":"#/components/schemas/Metadata","description":"Metadata for zone"},"created_at":{"type":"string","format":"date-time","description":"Created at"},"updated_at":{"type":"string","format":"date-time","description":"Updated at"}}},"ZoneName":{"type":"string","description":"The name of the zone.","example":"example.com"},"ZoneSummary":{"$ref":"#/components/schemas/ZoneName","description":"Zone summary."},"ZoneType":{"type":"string","description":"Zone type","enum":["primary","secondary"],"example":"primary"},"ZoneViewType":{"type":"string","description":"Zone format (defaults to summary)","enum":["detail","name_only"],"example":"detail"}}},"x-tagGroups":[{"name":"Eureka API","tags":["clients","DDNS Keys"]},{"name":"No-IP DNS API","tags":["zones","zone_authorities","records","meta"]}]}