> For the complete documentation index, see [llms.txt](https://docs.ionos.com/cloud/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ionos.com/cloud/api-reference/network-services/cloud-dns/models.md). # Models ## The ZoneTransferPrimaryIpsStatus object ```json {"openapi":"3.0.3","info":{"title":"IONOS CLOUD - DNS API","version":"1.18.2"},"components":{"schemas":{"ZoneTransferPrimaryIpsStatus":{"type":"object","description":"Indicates, for secondary zones, the transfer status for each one single IP defined on primaryIps field\n","required":["type","items"],"properties":{"type":{"type":"string","enum":["collection"]},"items":{"type":"array","items":{"$ref":"#/components/schemas/ZoneTransferPrimaryIpStatus"}}}},"ZoneTransferPrimaryIpStatus":{"type":"object","required":["primaryIp","status"],"properties":{"primaryIp":{"type":"string","anyOf":[{"format":"ipv4"},{"format":"ipv6"}],"description":"one single IP from the primaryIps field for secondary zones"},"status":{"type":"string","description":"Human readable status of the zone transfer status for the IP"},"errorMessage":{"type":"string","description":"Human readable explanation of the error when status is not ok"}}}}}} ``` ## The ZoneTransferPrimaryIpStatus object ```json {"openapi":"3.0.3","info":{"title":"IONOS CLOUD - DNS API","version":"1.18.2"},"components":{"schemas":{"ZoneTransferPrimaryIpStatus":{"type":"object","required":["primaryIp","status"],"properties":{"primaryIp":{"type":"string","anyOf":[{"format":"ipv4"},{"format":"ipv6"}],"description":"one single IP from the primaryIps field for secondary zones"},"status":{"type":"string","description":"Human readable status of the zone transfer status for the IP"},"errorMessage":{"type":"string","description":"Human readable explanation of the error when status is not ok"}}}}}} ``` ## The Quota object ```json {"openapi":"3.0.3","info":{"title":"IONOS CLOUD - DNS API","version":"1.18.2"},"components":{"schemas":{"Quota":{"type":"object","required":["quotaUsage","quotaLimits"],"properties":{"quotaUsage":{"$ref":"#/components/schemas/QuotaDetail"},"quotaLimits":{"$ref":"#/components/schemas/QuotaDetail"}}},"QuotaDetail":{"type":"object","description":"Count of zones and records. This schema is used to show both usage and defined limits (quota)","required":["zones","records","secondaryZones","reverseRecords"],"properties":{"zones":{"type":"integer","default":0,"description":"count of the number of zones"},"secondaryZones":{"type":"integer","default":0,"description":"count of the number of secondary zones"},"records":{"type":"integer","default":0,"description":"count of the number of records"},"reverseRecords":{"type":"integer","default":0,"description":"count of the number of reverse DNS records"}}}}}} ``` ## The QuotaDetail object ```json {"openapi":"3.0.3","info":{"title":"IONOS CLOUD - DNS API","version":"1.18.2"},"components":{"schemas":{"QuotaDetail":{"type":"object","description":"Count of zones and records. This schema is used to show both usage and defined limits (quota)","required":["zones","records","secondaryZones","reverseRecords"],"properties":{"zones":{"type":"integer","default":0,"description":"count of the number of zones"},"secondaryZones":{"type":"integer","default":0,"description":"count of the number of secondary zones"},"records":{"type":"integer","default":0,"description":"count of the number of records"},"reverseRecords":{"type":"integer","default":0,"description":"count of the number of reverse DNS records"}}}}}} ``` ## The ReverseRecordsReadList object ```json {"openapi":"3.0.3","info":{"title":"IONOS CLOUD - DNS API","version":"1.18.2"},"components":{"schemas":{"ReverseRecordsReadList":{"type":"object","required":["id","type","items","href","limit","_links"],"properties":{"id":{"type":"string","format":"uuid","description":"ID (UUID) created to identify this action."},"type":{"type":"string","enum":["collection"]},"href":{"type":"string","format":"uri","readOnly":true},"items":{"type":"array","items":{"$ref":"#/components/schemas/ReverseRecordRead"}},"offset":{"$ref":"#/components/schemas/Offset"},"limit":{"$ref":"#/components/schemas/Limit"},"_links":{"$ref":"#/components/schemas/Links"}}},"ReverseRecordRead":{"type":"object","required":["id","type","href","metadata","properties"],"properties":{"id":{"type":"string","format":"uuid","description":"The reverse DNS record ID (UUID)."},"type":{"type":"string","enum":["reverserecord"]},"href":{"type":"string","format":"uri","readOnly":true},"metadata":{"$ref":"#/components/schemas/Metadata"},"properties":{"$ref":"#/components/schemas/ReverseRecord"}}},"Metadata":{"type":"object","description":"Metadata of the resource.","properties":{"createdDate":{"type":"string","readOnly":true,"format":"date-time","description":"The creation date formatted as yyyy-MM-dd'T'HH:mm:ss.SSS'Z'."},"createdBy":{"type":"string","description":"Unique name of the identity that created the resource.","readOnly":true},"createdByUserId":{"type":"string","description":"The unique ID of the user who created the resource.","readOnly":true},"lastModifiedDate":{"type":"string","readOnly":true,"format":"date-time","description":"The date of the last change formatted as yyyy-MM-dd'T'HH:mm:ss.SSS'Z'."},"lastModifiedBy":{"type":"string","description":"Unique name of the identity that created the resource.","readOnly":true},"lastModifiedByUserId":{"type":"string","description":"The unique ID of the user who last modified the resource.","readOnly":true},"resourceURN":{"type":"string","description":"Unique name of the resource.","readOnly":true}}},"ReverseRecord":{"type":"object","description":"The reverse DNS record.","required":["name","ip"],"properties":{"name":{"type":"string","description":"The reverse DNS record name"},"description":{"type":"string","description":"Description stored along with the reverse DNS record to describe its usage."},"ip":{"type":"string","anyOf":[{"format":"ipv4"},{"format":"ipv6"}],"description":"Specifies for which IP address the reverse record should be created. The IP addresses needs to be owned by the contract. Accepts IPv4 and IPv6 addresses."}}},"Offset":{"type":"number","description":"Pagination offset.","readOnly":true},"Limit":{"type":"number","description":"Pagination limit.","readOnly":true},"Links":{"description":"URLs to navigate the different pages of results.\n","type":"object","properties":{"prev":{"description":"URL of the previous page; only present if offset is greater than\n0. Contains `offset` and `limit`; not returned when paging via\n`pagination.token`, which is forward-only.\n","type":"string","format":"uri","readOnly":true},"self":{"description":"URL of the current page. Contains `limit` plus either `offset` or\n`pagination.token`, depending on which pagination strategy the\nendpoint supports and the request used.\n","type":"string","format":"uri","readOnly":true},"next":{"description":"URL of the next page; only present if there are more elements to\nreturn. Contains `limit` plus either `offset` or\n`pagination.token`, depending on which pagination strategy the\nendpoint supports and the request used.\n","type":"string","format":"uri","readOnly":true}}}}}} ``` ## The ReverseRecordRead object ```json {"openapi":"3.0.3","info":{"title":"IONOS CLOUD - DNS API","version":"1.18.2"},"components":{"schemas":{"ReverseRecordRead":{"type":"object","required":["id","type","href","metadata","properties"],"properties":{"id":{"type":"string","format":"uuid","description":"The reverse DNS record ID (UUID)."},"type":{"type":"string","enum":["reverserecord"]},"href":{"type":"string","format":"uri","readOnly":true},"metadata":{"$ref":"#/components/schemas/Metadata"},"properties":{"$ref":"#/components/schemas/ReverseRecord"}}},"Metadata":{"type":"object","description":"Metadata of the resource.","properties":{"createdDate":{"type":"string","readOnly":true,"format":"date-time","description":"The creation date formatted as yyyy-MM-dd'T'HH:mm:ss.SSS'Z'."},"createdBy":{"type":"string","description":"Unique name of the identity that created the resource.","readOnly":true},"createdByUserId":{"type":"string","description":"The unique ID of the user who created the resource.","readOnly":true},"lastModifiedDate":{"type":"string","readOnly":true,"format":"date-time","description":"The date of the last change formatted as yyyy-MM-dd'T'HH:mm:ss.SSS'Z'."},"lastModifiedBy":{"type":"string","description":"Unique name of the identity that created the resource.","readOnly":true},"lastModifiedByUserId":{"type":"string","description":"The unique ID of the user who last modified the resource.","readOnly":true},"resourceURN":{"type":"string","description":"Unique name of the resource.","readOnly":true}}},"ReverseRecord":{"type":"object","description":"The reverse DNS record.","required":["name","ip"],"properties":{"name":{"type":"string","description":"The reverse DNS record name"},"description":{"type":"string","description":"Description stored along with the reverse DNS record to describe its usage."},"ip":{"type":"string","anyOf":[{"format":"ipv4"},{"format":"ipv6"}],"description":"Specifies for which IP address the reverse record should be created. The IP addresses needs to be owned by the contract. Accepts IPv4 and IPv6 addresses."}}}}}} ``` ## The ReverseRecord object ```json {"openapi":"3.0.3","info":{"title":"IONOS CLOUD - DNS API","version":"1.18.2"},"components":{"schemas":{"ReverseRecord":{"type":"object","description":"The reverse DNS record.","required":["name","ip"],"properties":{"name":{"type":"string","description":"The reverse DNS record name"},"description":{"type":"string","description":"Description stored along with the reverse DNS record to describe its usage."},"ip":{"type":"string","anyOf":[{"format":"ipv4"},{"format":"ipv6"}],"description":"Specifies for which IP address the reverse record should be created. The IP addresses needs to be owned by the contract. Accepts IPv4 and IPv6 addresses."}}}}}} ``` ## The ReverseRecordCreate object ```json {"openapi":"3.0.3","info":{"title":"IONOS CLOUD - DNS API","version":"1.18.2"},"components":{"schemas":{"ReverseRecordCreate":{"type":"object","required":["properties"],"properties":{"properties":{"$ref":"#/components/schemas/ReverseRecord"}}},"ReverseRecord":{"type":"object","description":"The reverse DNS record.","required":["name","ip"],"properties":{"name":{"type":"string","description":"The reverse DNS record name"},"description":{"type":"string","description":"Description stored along with the reverse DNS record to describe its usage."},"ip":{"type":"string","anyOf":[{"format":"ipv4"},{"format":"ipv6"}],"description":"Specifies for which IP address the reverse record should be created. The IP addresses needs to be owned by the contract. Accepts IPv4 and IPv6 addresses."}}}}}} ``` ## The ReverseRecordEnsure object ```json {"openapi":"3.0.3","info":{"title":"IONOS CLOUD - DNS API","version":"1.18.2"},"components":{"schemas":{"ReverseRecordEnsure":{"type":"object","required":["properties"],"properties":{"properties":{"$ref":"#/components/schemas/ReverseRecord"}}},"ReverseRecord":{"type":"object","description":"The reverse DNS record.","required":["name","ip"],"properties":{"name":{"type":"string","description":"The reverse DNS record name"},"description":{"type":"string","description":"Description stored along with the reverse DNS record to describe its usage."},"ip":{"type":"string","anyOf":[{"format":"ipv4"},{"format":"ipv6"}],"description":"Specifies for which IP address the reverse record should be created. The IP addresses needs to be owned by the contract. Accepts IPv4 and IPv6 addresses."}}}}}} ``` ## The CommonZoneReadList object ```json {"openapi":"3.0.3","info":{"title":"IONOS CLOUD - DNS API","version":"1.18.2"},"components":{"schemas":{"CommonZoneReadList":{"type":"object","required":["id","type","href","limit","_links"],"properties":{"id":{"type":"string","format":"uuid","description":"ID (UUID) created to identify this action."},"type":{"type":"string","enum":["collection"]},"href":{"type":"string","format":"uri","readOnly":true},"offset":{"$ref":"#/components/schemas/Offset"},"limit":{"$ref":"#/components/schemas/Limit"},"_links":{"$ref":"#/components/schemas/Links"}}},"Offset":{"type":"number","description":"Pagination offset.","readOnly":true},"Limit":{"type":"number","description":"Pagination limit.","readOnly":true},"Links":{"description":"URLs to navigate the different pages of results.\n","type":"object","properties":{"prev":{"description":"URL of the previous page; only present if offset is greater than\n0. Contains `offset` and `limit`; not returned when paging via\n`pagination.token`, which is forward-only.\n","type":"string","format":"uri","readOnly":true},"self":{"description":"URL of the current page. Contains `limit` plus either `offset` or\n`pagination.token`, depending on which pagination strategy the\nendpoint supports and the request used.\n","type":"string","format":"uri","readOnly":true},"next":{"description":"URL of the next page; only present if there are more elements to\nreturn. Contains `limit` plus either `offset` or\n`pagination.token`, depending on which pagination strategy the\nendpoint supports and the request used.\n","type":"string","format":"uri","readOnly":true}}}}}} ``` ## The ZoneReadList object ```json {"openapi":"3.0.3","info":{"title":"IONOS CLOUD - DNS API","version":"1.18.2"},"components":{"schemas":{"ZoneReadList":{"allOf":[{"$ref":"#/components/schemas/CommonZoneReadList"},{"type":"object","description":"List of primary zones","required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ZoneRead"}}}}]},"CommonZoneReadList":{"type":"object","required":["id","type","href","limit","_links"],"properties":{"id":{"type":"string","format":"uuid","description":"ID (UUID) created to identify this action."},"type":{"type":"string","enum":["collection"]},"href":{"type":"string","format":"uri","readOnly":true},"offset":{"$ref":"#/components/schemas/Offset"},"limit":{"$ref":"#/components/schemas/Limit"},"_links":{"$ref":"#/components/schemas/Links"}}},"Offset":{"type":"number","description":"Pagination offset.","readOnly":true},"Limit":{"type":"number","description":"Pagination limit.","readOnly":true},"Links":{"description":"URLs to navigate the different pages of results.\n","type":"object","properties":{"prev":{"description":"URL of the previous page; only present if offset is greater than\n0. Contains `offset` and `limit`; not returned when paging via\n`pagination.token`, which is forward-only.\n","type":"string","format":"uri","readOnly":true},"self":{"description":"URL of the current page. Contains `limit` plus either `offset` or\n`pagination.token`, depending on which pagination strategy the\nendpoint supports and the request used.\n","type":"string","format":"uri","readOnly":true},"next":{"description":"URL of the next page; only present if there are more elements to\nreturn. Contains `limit` plus either `offset` or\n`pagination.token`, depending on which pagination strategy the\nendpoint supports and the request used.\n","type":"string","format":"uri","readOnly":true}}},"ZoneRead":{"allOf":[{"$ref":"#/components/schemas/CommonZoneRead"},{"type":"object","required":["properties"],"properties":{"properties":{"$ref":"#/components/schemas/Zone"}}}]},"CommonZoneRead":{"type":"object","required":["id","type","href","metadata"],"properties":{"id":{"type":"string","format":"uuid","description":"The zone ID (UUID)."},"type":{"type":"string","enum":["zone","secondaryzone"]},"href":{"type":"string","format":"uri","readOnly":true},"metadata":{"$ref":"#/components/schemas/MetadataWithStateNameservers"}}},"MetadataWithStateNameservers":{"allOf":[{"$ref":"#/components/schemas/Metadata"},{"type":"object","required":["state","nameservers"],"properties":{"state":{"$ref":"#/components/schemas/ProvisioningState"},"nameservers":{"type":"array","description":"The list of nameservers associated to the zone. \nNameservers are different for primary and secondary zones.\nFor primary zones it would be:\n- ns-ic.ui-dns.com\n- ns-ic.ui-dns.de\n- ns-ic.ui-dns.org\n- ns-ic.ui-dns.biz\n\nAnd for secondary zones:\n- nscs.ui-dns.com\n- nscs.ui-dns.de\n- nscs.ui-dns.org\n- nscs.ui-dns.biz\n","items":{"type":"string"}}}}]},"Metadata":{"type":"object","description":"Metadata of the resource.","properties":{"createdDate":{"type":"string","readOnly":true,"format":"date-time","description":"The creation date formatted as yyyy-MM-dd'T'HH:mm:ss.SSS'Z'."},"createdBy":{"type":"string","description":"Unique name of the identity that created the resource.","readOnly":true},"createdByUserId":{"type":"string","description":"The unique ID of the user who created the resource.","readOnly":true},"lastModifiedDate":{"type":"string","readOnly":true,"format":"date-time","description":"The date of the last change formatted as yyyy-MM-dd'T'HH:mm:ss.SSS'Z'."},"lastModifiedBy":{"type":"string","description":"Unique name of the identity that created the resource.","readOnly":true},"lastModifiedByUserId":{"type":"string","description":"The unique ID of the user who last modified the resource.","readOnly":true},"resourceURN":{"type":"string","description":"Unique name of the resource.","readOnly":true}}},"ProvisioningState":{"type":"string","description":"The list of possible provisioning states in which DNS resource could be at the specific time.\n* AVAILABLE - resource exists and is healthy.\n* PROVISIONING - resource is being created or updated.\n* DESTROYING - delete command was issued, the resource is being deleted.\n* FAILED - creation of the resource failed.\n","enum":["PROVISIONING","DESTROYING","AVAILABLE","FAILED"]},"Zone":{"allOf":[{"$ref":"#/components/schemas/CommonZone"},{"type":"object","description":"Indicates the specific fields for a primary zone. This type of zone is the default one.","properties":{"enabled":{"description":"Users can activate and deactivate zones.","type":"boolean","default":true}}}]},"CommonZone":{"type":"object","description":"Indicates the fields for a zone to be created","required":["zoneName"],"properties":{"zoneName":{"type":"string","description":"The zone name"},"description":{"type":"string","description":"The hosted zone is used for..."}}}}}} ``` ## The SecondaryZoneReadList object ```json {"openapi":"3.0.3","info":{"title":"IONOS CLOUD - DNS API","version":"1.18.2"},"components":{"schemas":{"SecondaryZoneReadList":{"allOf":[{"$ref":"#/components/schemas/CommonZoneReadList"},{"type":"object","description":"List of secondary zones","required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/SecondaryZoneRead"}}}}]},"CommonZoneReadList":{"type":"object","required":["id","type","href","limit","_links"],"properties":{"id":{"type":"string","format":"uuid","description":"ID (UUID) created to identify this action."},"type":{"type":"string","enum":["collection"]},"href":{"type":"string","format":"uri","readOnly":true},"offset":{"$ref":"#/components/schemas/Offset"},"limit":{"$ref":"#/components/schemas/Limit"},"_links":{"$ref":"#/components/schemas/Links"}}},"Offset":{"type":"number","description":"Pagination offset.","readOnly":true},"Limit":{"type":"number","description":"Pagination limit.","readOnly":true},"Links":{"description":"URLs to navigate the different pages of results.\n","type":"object","properties":{"prev":{"description":"URL of the previous page; only present if offset is greater than\n0. Contains `offset` and `limit`; not returned when paging via\n`pagination.token`, which is forward-only.\n","type":"string","format":"uri","readOnly":true},"self":{"description":"URL of the current page. Contains `limit` plus either `offset` or\n`pagination.token`, depending on which pagination strategy the\nendpoint supports and the request used.\n","type":"string","format":"uri","readOnly":true},"next":{"description":"URL of the next page; only present if there are more elements to\nreturn. Contains `limit` plus either `offset` or\n`pagination.token`, depending on which pagination strategy the\nendpoint supports and the request used.\n","type":"string","format":"uri","readOnly":true}}},"SecondaryZoneRead":{"allOf":[{"$ref":"#/components/schemas/CommonZoneRead"},{"type":"object","required":["properties"],"properties":{"properties":{"$ref":"#/components/schemas/SecondaryZone"}}}]},"CommonZoneRead":{"type":"object","required":["id","type","href","metadata"],"properties":{"id":{"type":"string","format":"uuid","description":"The zone ID (UUID)."},"type":{"type":"string","enum":["zone","secondaryzone"]},"href":{"type":"string","format":"uri","readOnly":true},"metadata":{"$ref":"#/components/schemas/MetadataWithStateNameservers"}}},"MetadataWithStateNameservers":{"allOf":[{"$ref":"#/components/schemas/Metadata"},{"type":"object","required":["state","nameservers"],"properties":{"state":{"$ref":"#/components/schemas/ProvisioningState"},"nameservers":{"type":"array","description":"The list of nameservers associated to the zone. \nNameservers are different for primary and secondary zones.\nFor primary zones it would be:\n- ns-ic.ui-dns.com\n- ns-ic.ui-dns.de\n- ns-ic.ui-dns.org\n- ns-ic.ui-dns.biz\n\nAnd for secondary zones:\n- nscs.ui-dns.com\n- nscs.ui-dns.de\n- nscs.ui-dns.org\n- nscs.ui-dns.biz\n","items":{"type":"string"}}}}]},"Metadata":{"type":"object","description":"Metadata of the resource.","properties":{"createdDate":{"type":"string","readOnly":true,"format":"date-time","description":"The creation date formatted as yyyy-MM-dd'T'HH:mm:ss.SSS'Z'."},"createdBy":{"type":"string","description":"Unique name of the identity that created the resource.","readOnly":true},"createdByUserId":{"type":"string","description":"The unique ID of the user who created the resource.","readOnly":true},"lastModifiedDate":{"type":"string","readOnly":true,"format":"date-time","description":"The date of the last change formatted as yyyy-MM-dd'T'HH:mm:ss.SSS'Z'."},"lastModifiedBy":{"type":"string","description":"Unique name of the identity that created the resource.","readOnly":true},"lastModifiedByUserId":{"type":"string","description":"The unique ID of the user who last modified the resource.","readOnly":true},"resourceURN":{"type":"string","description":"Unique name of the resource.","readOnly":true}}},"ProvisioningState":{"type":"string","description":"The list of possible provisioning states in which DNS resource could be at the specific time.\n* AVAILABLE - resource exists and is healthy.\n* PROVISIONING - resource is being created or updated.\n* DESTROYING - delete command was issued, the resource is being deleted.\n* FAILED - creation of the resource failed.\n","enum":["PROVISIONING","DESTROYING","AVAILABLE","FAILED"]},"SecondaryZone":{"allOf":[{"$ref":"#/components/schemas/CommonZone"},{"type":"object","description":"Indicates the fields for a secondary zone to be created","required":["primaryIps"],"properties":{"primaryIps":{"type":"array","items":{"type":"string","anyOf":[{"format":"ipv4"},{"format":"ipv6"}]},"minItems":1,"uniqueItems":true,"description":"Indicates IP addresses of primary nameservers for a secondary zone. Accepts IPv4 and IPv6 addresses"}}}]},"CommonZone":{"type":"object","description":"Indicates the fields for a zone to be created","required":["zoneName"],"properties":{"zoneName":{"type":"string","description":"The zone name"},"description":{"type":"string","description":"The hosted zone is used for..."}}}}}} ``` ## The CommonZoneRead object ```json {"openapi":"3.0.3","info":{"title":"IONOS CLOUD - DNS API","version":"1.18.2"},"components":{"schemas":{"CommonZoneRead":{"type":"object","required":["id","type","href","metadata"],"properties":{"id":{"type":"string","format":"uuid","description":"The zone ID (UUID)."},"type":{"type":"string","enum":["zone","secondaryzone"]},"href":{"type":"string","format":"uri","readOnly":true},"metadata":{"$ref":"#/components/schemas/MetadataWithStateNameservers"}}},"MetadataWithStateNameservers":{"allOf":[{"$ref":"#/components/schemas/Metadata"},{"type":"object","required":["state","nameservers"],"properties":{"state":{"$ref":"#/components/schemas/ProvisioningState"},"nameservers":{"type":"array","description":"The list of nameservers associated to the zone. \nNameservers are different for primary and secondary zones.\nFor primary zones it would be:\n- ns-ic.ui-dns.com\n- ns-ic.ui-dns.de\n- ns-ic.ui-dns.org\n- ns-ic.ui-dns.biz\n\nAnd for secondary zones:\n- nscs.ui-dns.com\n- nscs.ui-dns.de\n- nscs.ui-dns.org\n- nscs.ui-dns.biz\n","items":{"type":"string"}}}}]},"Metadata":{"type":"object","description":"Metadata of the resource.","properties":{"createdDate":{"type":"string","readOnly":true,"format":"date-time","description":"The creation date formatted as yyyy-MM-dd'T'HH:mm:ss.SSS'Z'."},"createdBy":{"type":"string","description":"Unique name of the identity that created the resource.","readOnly":true},"createdByUserId":{"type":"string","description":"The unique ID of the user who created the resource.","readOnly":true},"lastModifiedDate":{"type":"string","readOnly":true,"format":"date-time","description":"The date of the last change formatted as yyyy-MM-dd'T'HH:mm:ss.SSS'Z'."},"lastModifiedBy":{"type":"string","description":"Unique name of the identity that created the resource.","readOnly":true},"lastModifiedByUserId":{"type":"string","description":"The unique ID of the user who last modified the resource.","readOnly":true},"resourceURN":{"type":"string","description":"Unique name of the resource.","readOnly":true}}},"ProvisioningState":{"type":"string","description":"The list of possible provisioning states in which DNS resource could be at the specific time.\n* AVAILABLE - resource exists and is healthy.\n* PROVISIONING - resource is being created or updated.\n* DESTROYING - delete command was issued, the resource is being deleted.\n* FAILED - creation of the resource failed.\n","enum":["PROVISIONING","DESTROYING","AVAILABLE","FAILED"]}}}} ``` ## The ZoneRead object ```json {"openapi":"3.0.3","info":{"title":"IONOS CLOUD - DNS API","version":"1.18.2"},"components":{"schemas":{"ZoneRead":{"allOf":[{"$ref":"#/components/schemas/CommonZoneRead"},{"type":"object","required":["properties"],"properties":{"properties":{"$ref":"#/components/schemas/Zone"}}}]},"CommonZoneRead":{"type":"object","required":["id","type","href","metadata"],"properties":{"id":{"type":"string","format":"uuid","description":"The zone ID (UUID)."},"type":{"type":"string","enum":["zone","secondaryzone"]},"href":{"type":"string","format":"uri","readOnly":true},"metadata":{"$ref":"#/components/schemas/MetadataWithStateNameservers"}}},"MetadataWithStateNameservers":{"allOf":[{"$ref":"#/components/schemas/Metadata"},{"type":"object","required":["state","nameservers"],"properties":{"state":{"$ref":"#/components/schemas/ProvisioningState"},"nameservers":{"type":"array","description":"The list of nameservers associated to the zone. \nNameservers are different for primary and secondary zones.\nFor primary zones it would be:\n- ns-ic.ui-dns.com\n- ns-ic.ui-dns.de\n- ns-ic.ui-dns.org\n- ns-ic.ui-dns.biz\n\nAnd for secondary zones:\n- nscs.ui-dns.com\n- nscs.ui-dns.de\n- nscs.ui-dns.org\n- nscs.ui-dns.biz\n","items":{"type":"string"}}}}]},"Metadata":{"type":"object","description":"Metadata of the resource.","properties":{"createdDate":{"type":"string","readOnly":true,"format":"date-time","description":"The creation date formatted as yyyy-MM-dd'T'HH:mm:ss.SSS'Z'."},"createdBy":{"type":"string","description":"Unique name of the identity that created the resource.","readOnly":true},"createdByUserId":{"type":"string","description":"The unique ID of the user who created the resource.","readOnly":true},"lastModifiedDate":{"type":"string","readOnly":true,"format":"date-time","description":"The date of the last change formatted as yyyy-MM-dd'T'HH:mm:ss.SSS'Z'."},"lastModifiedBy":{"type":"string","description":"Unique name of the identity that created the resource.","readOnly":true},"lastModifiedByUserId":{"type":"string","description":"The unique ID of the user who last modified the resource.","readOnly":true},"resourceURN":{"type":"string","description":"Unique name of the resource.","readOnly":true}}},"ProvisioningState":{"type":"string","description":"The list of possible provisioning states in which DNS resource could be at the specific time.\n* AVAILABLE - resource exists and is healthy.\n* PROVISIONING - resource is being created or updated.\n* DESTROYING - delete command was issued, the resource is being deleted.\n* FAILED - creation of the resource failed.\n","enum":["PROVISIONING","DESTROYING","AVAILABLE","FAILED"]},"Zone":{"allOf":[{"$ref":"#/components/schemas/CommonZone"},{"type":"object","description":"Indicates the specific fields for a primary zone. This type of zone is the default one.","properties":{"enabled":{"description":"Users can activate and deactivate zones.","type":"boolean","default":true}}}]},"CommonZone":{"type":"object","description":"Indicates the fields for a zone to be created","required":["zoneName"],"properties":{"zoneName":{"type":"string","description":"The zone name"},"description":{"type":"string","description":"The hosted zone is used for..."}}}}}} ``` ## The SecondaryZoneRead object ```json {"openapi":"3.0.3","info":{"title":"IONOS CLOUD - DNS API","version":"1.18.2"},"components":{"schemas":{"SecondaryZoneRead":{"allOf":[{"$ref":"#/components/schemas/CommonZoneRead"},{"type":"object","required":["properties"],"properties":{"properties":{"$ref":"#/components/schemas/SecondaryZone"}}}]},"CommonZoneRead":{"type":"object","required":["id","type","href","metadata"],"properties":{"id":{"type":"string","format":"uuid","description":"The zone ID (UUID)."},"type":{"type":"string","enum":["zone","secondaryzone"]},"href":{"type":"string","format":"uri","readOnly":true},"metadata":{"$ref":"#/components/schemas/MetadataWithStateNameservers"}}},"MetadataWithStateNameservers":{"allOf":[{"$ref":"#/components/schemas/Metadata"},{"type":"object","required":["state","nameservers"],"properties":{"state":{"$ref":"#/components/schemas/ProvisioningState"},"nameservers":{"type":"array","description":"The list of nameservers associated to the zone. \nNameservers are different for primary and secondary zones.\nFor primary zones it would be:\n- ns-ic.ui-dns.com\n- ns-ic.ui-dns.de\n- ns-ic.ui-dns.org\n- ns-ic.ui-dns.biz\n\nAnd for secondary zones:\n- nscs.ui-dns.com\n- nscs.ui-dns.de\n- nscs.ui-dns.org\n- nscs.ui-dns.biz\n","items":{"type":"string"}}}}]},"Metadata":{"type":"object","description":"Metadata of the resource.","properties":{"createdDate":{"type":"string","readOnly":true,"format":"date-time","description":"The creation date formatted as yyyy-MM-dd'T'HH:mm:ss.SSS'Z'."},"createdBy":{"type":"string","description":"Unique name of the identity that created the resource.","readOnly":true},"createdByUserId":{"type":"string","description":"The unique ID of the user who created the resource.","readOnly":true},"lastModifiedDate":{"type":"string","readOnly":true,"format":"date-time","description":"The date of the last change formatted as yyyy-MM-dd'T'HH:mm:ss.SSS'Z'."},"lastModifiedBy":{"type":"string","description":"Unique name of the identity that created the resource.","readOnly":true},"lastModifiedByUserId":{"type":"string","description":"The unique ID of the user who last modified the resource.","readOnly":true},"resourceURN":{"type":"string","description":"Unique name of the resource.","readOnly":true}}},"ProvisioningState":{"type":"string","description":"The list of possible provisioning states in which DNS resource could be at the specific time.\n* AVAILABLE - resource exists and is healthy.\n* PROVISIONING - resource is being created or updated.\n* DESTROYING - delete command was issued, the resource is being deleted.\n* FAILED - creation of the resource failed.\n","enum":["PROVISIONING","DESTROYING","AVAILABLE","FAILED"]},"SecondaryZone":{"allOf":[{"$ref":"#/components/schemas/CommonZone"},{"type":"object","description":"Indicates the fields for a secondary zone to be created","required":["primaryIps"],"properties":{"primaryIps":{"type":"array","items":{"type":"string","anyOf":[{"format":"ipv4"},{"format":"ipv6"}]},"minItems":1,"uniqueItems":true,"description":"Indicates IP addresses of primary nameservers for a secondary zone. Accepts IPv4 and IPv6 addresses"}}}]},"CommonZone":{"type":"object","description":"Indicates the fields for a zone to be created","required":["zoneName"],"properties":{"zoneName":{"type":"string","description":"The zone name"},"description":{"type":"string","description":"The hosted zone is used for..."}}}}}} ``` ## The ZoneCreate object ```json {"openapi":"3.0.3","info":{"title":"IONOS CLOUD - DNS API","version":"1.18.2"},"components":{"schemas":{"ZoneCreate":{"type":"object","required":["properties"],"properties":{"properties":{"$ref":"#/components/schemas/Zone"}}},"Zone":{"allOf":[{"$ref":"#/components/schemas/CommonZone"},{"type":"object","description":"Indicates the specific fields for a primary zone. This type of zone is the default one.","properties":{"enabled":{"description":"Users can activate and deactivate zones.","type":"boolean","default":true}}}]},"CommonZone":{"type":"object","description":"Indicates the fields for a zone to be created","required":["zoneName"],"properties":{"zoneName":{"type":"string","description":"The zone name"},"description":{"type":"string","description":"The hosted zone is used for..."}}}}}} ``` ## The ZoneEnsure object ```json {"openapi":"3.0.3","info":{"title":"IONOS CLOUD - DNS API","version":"1.18.2"},"components":{"schemas":{"ZoneEnsure":{"type":"object","required":["properties"],"properties":{"properties":{"$ref":"#/components/schemas/Zone"}}},"Zone":{"allOf":[{"$ref":"#/components/schemas/CommonZone"},{"type":"object","description":"Indicates the specific fields for a primary zone. This type of zone is the default one.","properties":{"enabled":{"description":"Users can activate and deactivate zones.","type":"boolean","default":true}}}]},"CommonZone":{"type":"object","description":"Indicates the fields for a zone to be created","required":["zoneName"],"properties":{"zoneName":{"type":"string","description":"The zone name"},"description":{"type":"string","description":"The hosted zone is used for..."}}}}}} ``` ## The EmptyBodyResponse object ```json {"openapi":"3.0.3","info":{"title":"IONOS CLOUD - DNS API","version":"1.18.2"},"components":{"schemas":{"EmptyBodyResponse":{"type":"object","properties":{}}}}} ``` ## The CommonZone object ```json {"openapi":"3.0.3","info":{"title":"IONOS CLOUD - DNS API","version":"1.18.2"},"components":{"schemas":{"CommonZone":{"type":"object","description":"Indicates the fields for a zone to be created","required":["zoneName"],"properties":{"zoneName":{"type":"string","description":"The zone name"},"description":{"type":"string","description":"The hosted zone is used for..."}}}}}} ``` ## The Zone object ```json {"openapi":"3.0.3","info":{"title":"IONOS CLOUD - DNS API","version":"1.18.2"},"components":{"schemas":{"Zone":{"allOf":[{"$ref":"#/components/schemas/CommonZone"},{"type":"object","description":"Indicates the specific fields for a primary zone. This type of zone is the default one.","properties":{"enabled":{"description":"Users can activate and deactivate zones.","type":"boolean","default":true}}}]},"CommonZone":{"type":"object","description":"Indicates the fields for a zone to be created","required":["zoneName"],"properties":{"zoneName":{"type":"string","description":"The zone name"},"description":{"type":"string","description":"The hosted zone is used for..."}}}}}} ``` ## The SecondaryZone object ```json {"openapi":"3.0.3","info":{"title":"IONOS CLOUD - DNS API","version":"1.18.2"},"components":{"schemas":{"SecondaryZone":{"allOf":[{"$ref":"#/components/schemas/CommonZone"},{"type":"object","description":"Indicates the fields for a secondary zone to be created","required":["primaryIps"],"properties":{"primaryIps":{"type":"array","items":{"type":"string","anyOf":[{"format":"ipv4"},{"format":"ipv6"}]},"minItems":1,"uniqueItems":true,"description":"Indicates IP addresses of primary nameservers for a secondary zone. Accepts IPv4 and IPv6 addresses"}}}]},"CommonZone":{"type":"object","description":"Indicates the fields for a zone to be created","required":["zoneName"],"properties":{"zoneName":{"type":"string","description":"The zone name"},"description":{"type":"string","description":"The hosted zone is used for..."}}}}}} ``` ## The SecondaryZoneCreate object ```json {"openapi":"3.0.3","info":{"title":"IONOS CLOUD - DNS API","version":"1.18.2"},"components":{"schemas":{"SecondaryZoneCreate":{"type":"object","required":["properties"],"properties":{"properties":{"$ref":"#/components/schemas/SecondaryZone"}}},"SecondaryZone":{"allOf":[{"$ref":"#/components/schemas/CommonZone"},{"type":"object","description":"Indicates the fields for a secondary zone to be created","required":["primaryIps"],"properties":{"primaryIps":{"type":"array","items":{"type":"string","anyOf":[{"format":"ipv4"},{"format":"ipv6"}]},"minItems":1,"uniqueItems":true,"description":"Indicates IP addresses of primary nameservers for a secondary zone. Accepts IPv4 and IPv6 addresses"}}}]},"CommonZone":{"type":"object","description":"Indicates the fields for a zone to be created","required":["zoneName"],"properties":{"zoneName":{"type":"string","description":"The zone name"},"description":{"type":"string","description":"The hosted zone is used for..."}}}}}} ``` ## The SecondaryZoneEnsure object ```json {"openapi":"3.0.3","info":{"title":"IONOS CLOUD - DNS API","version":"1.18.2"},"components":{"schemas":{"SecondaryZoneEnsure":{"type":"object","required":["properties"],"properties":{"properties":{"$ref":"#/components/schemas/SecondaryZone"}}},"SecondaryZone":{"allOf":[{"$ref":"#/components/schemas/CommonZone"},{"type":"object","description":"Indicates the fields for a secondary zone to be created","required":["primaryIps"],"properties":{"primaryIps":{"type":"array","items":{"type":"string","anyOf":[{"format":"ipv4"},{"format":"ipv6"}]},"minItems":1,"uniqueItems":true,"description":"Indicates IP addresses of primary nameservers for a secondary zone. Accepts IPv4 and IPv6 addresses"}}}]},"CommonZone":{"type":"object","description":"Indicates the fields for a zone to be created","required":["zoneName"],"properties":{"zoneName":{"type":"string","description":"The zone name"},"description":{"type":"string","description":"The hosted zone is used for..."}}}}}} ``` ## The RecordReadList object ```json {"openapi":"3.0.3","info":{"title":"IONOS CLOUD - DNS API","version":"1.18.2"},"components":{"schemas":{"RecordReadList":{"type":"object","required":["id","type","href","items","limit","_links"],"properties":{"id":{"type":"string","format":"uuid","description":"The resource's unique identifier.","readOnly":true},"type":{"type":"string","enum":["collection"]},"href":{"type":"string","format":"uri","readOnly":true},"items":{"type":"array","items":{"$ref":"#/components/schemas/RecordRead"}},"offset":{"$ref":"#/components/schemas/Offset"},"limit":{"$ref":"#/components/schemas/Limit"},"_links":{"$ref":"#/components/schemas/Links"}}},"RecordRead":{"type":"object","required":["id","type","href","metadata","properties"],"properties":{"id":{"type":"string","format":"uuid","description":"The record ID (UUID).","readOnly":true},"type":{"type":"string","enum":["record"]},"href":{"type":"string","format":"uri","readOnly":true},"metadata":{"$ref":"#/components/schemas/MetadataWithStateFqdnZoneId"},"properties":{"$ref":"#/components/schemas/Record"}}},"MetadataWithStateFqdnZoneId":{"allOf":[{"$ref":"#/components/schemas/Metadata"},{"type":"object","required":["state","fqdn","zoneId"],"properties":{"state":{"$ref":"#/components/schemas/ProvisioningState"},"fqdn":{"type":"string","readOnly":true,"description":"A fully qualified domain name. FQDN consists of two parts - the hostname and the domain name."},"zoneId":{"$ref":"#/components/schemas/zoneId"}}}]},"Metadata":{"type":"object","description":"Metadata of the resource.","properties":{"createdDate":{"type":"string","readOnly":true,"format":"date-time","description":"The creation date formatted as yyyy-MM-dd'T'HH:mm:ss.SSS'Z'."},"createdBy":{"type":"string","description":"Unique name of the identity that created the resource.","readOnly":true},"createdByUserId":{"type":"string","description":"The unique ID of the user who created the resource.","readOnly":true},"lastModifiedDate":{"type":"string","readOnly":true,"format":"date-time","description":"The date of the last change formatted as yyyy-MM-dd'T'HH:mm:ss.SSS'Z'."},"lastModifiedBy":{"type":"string","description":"Unique name of the identity that created the resource.","readOnly":true},"lastModifiedByUserId":{"type":"string","description":"The unique ID of the user who last modified the resource.","readOnly":true},"resourceURN":{"type":"string","description":"Unique name of the resource.","readOnly":true}}},"ProvisioningState":{"type":"string","description":"The list of possible provisioning states in which DNS resource could be at the specific time.\n* AVAILABLE - resource exists and is healthy.\n* PROVISIONING - resource is being created or updated.\n* DESTROYING - delete command was issued, the resource is being deleted.\n* FAILED - creation of the resource failed.\n","enum":["PROVISIONING","DESTROYING","AVAILABLE","FAILED"]},"zoneId":{"type":"string","readOnly":true,"format":"uuid","description":"The ID (UUID) of the DNS zone of which record belongs to."},"Record":{"type":"object","required":["name","type","content"],"properties":{"name":{"type":"string"},"type":{"$ref":"#/components/schemas/RecordType"},"content":{"type":"string"},"ttl":{"type":"integer","default":3600,"minimum":60,"maximum":604800,"description":"Time to live for the record, recommended 3600."},"priority":{"type":"integer","default":3600,"minimum":0,"maximum":65535,"description":"Priority value is between 0 and 65535. Priority is mandatory for MX, SRV and URI record types and ignored for all other types."},"enabled":{"type":"boolean","default":true,"description":"When true - the record is visible for lookup."}}},"RecordType":{"type":"string","description":"Holds supported DNS resource record types. In the DNS context a record is a DNS resource record.","enum":["A","AAAA","CNAME","ALIAS","MX","NS","SRV","TXT","CAA","SSHFP","TLSA","SMIMEA","DS","HTTPS","SVCB","OPENPGPKEY","CERT","URI","RP","LOC"]},"Offset":{"type":"number","description":"Pagination offset.","readOnly":true},"Limit":{"type":"number","description":"Pagination limit.","readOnly":true},"Links":{"description":"URLs to navigate the different pages of results.\n","type":"object","properties":{"prev":{"description":"URL of the previous page; only present if offset is greater than\n0. Contains `offset` and `limit`; not returned when paging via\n`pagination.token`, which is forward-only.\n","type":"string","format":"uri","readOnly":true},"self":{"description":"URL of the current page. Contains `limit` plus either `offset` or\n`pagination.token`, depending on which pagination strategy the\nendpoint supports and the request used.\n","type":"string","format":"uri","readOnly":true},"next":{"description":"URL of the next page; only present if there are more elements to\nreturn. Contains `limit` plus either `offset` or\n`pagination.token`, depending on which pagination strategy the\nendpoint supports and the request used.\n","type":"string","format":"uri","readOnly":true}}}}}} ``` ## The SecondaryZoneRecordReadList object ```json {"openapi":"3.0.3","info":{"title":"IONOS CLOUD - DNS API","version":"1.18.2"},"components":{"schemas":{"SecondaryZoneRecordReadList":{"type":"object","required":["id","type","href","metadata","items","limit","_links"],"properties":{"id":{"type":"string","format":"uuid","description":"The resource's unique identifier.","readOnly":true},"type":{"type":"string","enum":["collection"]},"href":{"type":"string","format":"uri","readOnly":true},"metadata":{"type":"object","required":["primaryIps"],"description":"Shows the specific properties for secondary zones","properties":{"primaryIps":{"type":"array","items":{"type":"string","anyOf":[{"format":"ipv4"},{"format":"ipv6"}]},"minItems":1,"uniqueItems":true,"description":"Indicates IP addresses of primary nameservers for a secondary zone. Accepts IPv4 and IPv6 addresses"}}},"items":{"type":"array","items":{"$ref":"#/components/schemas/SecondaryZoneRecordRead"}},"offset":{"$ref":"#/components/schemas/Offset"},"limit":{"$ref":"#/components/schemas/Limit"},"_links":{"$ref":"#/components/schemas/Links"}}},"SecondaryZoneRecordRead":{"type":"object","required":["type","metadata","properties"],"properties":{"type":{"type":"string","enum":["record"]},"metadata":{"$ref":"#/components/schemas/MetadataForSecondaryZoneRecords"},"properties":{"$ref":"#/components/schemas/Record"}}},"MetadataForSecondaryZoneRecords":{"type":"object","description":"Metadata for records of secondary zones.","required":["fqdn","zoneId","rootName"],"properties":{"fqdn":{"type":"string","readOnly":true,"description":"A fully qualified domain name. FQDN consists of two parts - the hostname and the domain name."},"zoneId":{"$ref":"#/components/schemas/zoneId"},"rootName":{"type":"string","description":"Indicates the root name (from the primary zone) for the record"}}},"zoneId":{"type":"string","readOnly":true,"format":"uuid","description":"The ID (UUID) of the DNS zone of which record belongs to."},"Record":{"type":"object","required":["name","type","content"],"properties":{"name":{"type":"string"},"type":{"$ref":"#/components/schemas/RecordType"},"content":{"type":"string"},"ttl":{"type":"integer","default":3600,"minimum":60,"maximum":604800,"description":"Time to live for the record, recommended 3600."},"priority":{"type":"integer","default":3600,"minimum":0,"maximum":65535,"description":"Priority value is between 0 and 65535. Priority is mandatory for MX, SRV and URI record types and ignored for all other types."},"enabled":{"type":"boolean","default":true,"description":"When true - the record is visible for lookup."}}},"RecordType":{"type":"string","description":"Holds supported DNS resource record types. In the DNS context a record is a DNS resource record.","enum":["A","AAAA","CNAME","ALIAS","MX","NS","SRV","TXT","CAA","SSHFP","TLSA","SMIMEA","DS","HTTPS","SVCB","OPENPGPKEY","CERT","URI","RP","LOC"]},"Offset":{"type":"number","description":"Pagination offset.","readOnly":true},"Limit":{"type":"number","description":"Pagination limit.","readOnly":true},"Links":{"description":"URLs to navigate the different pages of results.\n","type":"object","properties":{"prev":{"description":"URL of the previous page; only present if offset is greater than\n0. Contains `offset` and `limit`; not returned when paging via\n`pagination.token`, which is forward-only.\n","type":"string","format":"uri","readOnly":true},"self":{"description":"URL of the current page. Contains `limit` plus either `offset` or\n`pagination.token`, depending on which pagination strategy the\nendpoint supports and the request used.\n","type":"string","format":"uri","readOnly":true},"next":{"description":"URL of the next page; only present if there are more elements to\nreturn. Contains `limit` plus either `offset` or\n`pagination.token`, depending on which pagination strategy the\nendpoint supports and the request used.\n","type":"string","format":"uri","readOnly":true}}}}}} ``` ## The SecondaryZoneRecordRead object ```json {"openapi":"3.0.3","info":{"title":"IONOS CLOUD - DNS API","version":"1.18.2"},"components":{"schemas":{"SecondaryZoneRecordRead":{"type":"object","required":["type","metadata","properties"],"properties":{"type":{"type":"string","enum":["record"]},"metadata":{"$ref":"#/components/schemas/MetadataForSecondaryZoneRecords"},"properties":{"$ref":"#/components/schemas/Record"}}},"MetadataForSecondaryZoneRecords":{"type":"object","description":"Metadata for records of secondary zones.","required":["fqdn","zoneId","rootName"],"properties":{"fqdn":{"type":"string","readOnly":true,"description":"A fully qualified domain name. FQDN consists of two parts - the hostname and the domain name."},"zoneId":{"$ref":"#/components/schemas/zoneId"},"rootName":{"type":"string","description":"Indicates the root name (from the primary zone) for the record"}}},"zoneId":{"type":"string","readOnly":true,"format":"uuid","description":"The ID (UUID) of the DNS zone of which record belongs to."},"Record":{"type":"object","required":["name","type","content"],"properties":{"name":{"type":"string"},"type":{"$ref":"#/components/schemas/RecordType"},"content":{"type":"string"},"ttl":{"type":"integer","default":3600,"minimum":60,"maximum":604800,"description":"Time to live for the record, recommended 3600."},"priority":{"type":"integer","default":3600,"minimum":0,"maximum":65535,"description":"Priority value is between 0 and 65535. Priority is mandatory for MX, SRV and URI record types and ignored for all other types."},"enabled":{"type":"boolean","default":true,"description":"When true - the record is visible for lookup."}}},"RecordType":{"type":"string","description":"Holds supported DNS resource record types. In the DNS context a record is a DNS resource record.","enum":["A","AAAA","CNAME","ALIAS","MX","NS","SRV","TXT","CAA","SSHFP","TLSA","SMIMEA","DS","HTTPS","SVCB","OPENPGPKEY","CERT","URI","RP","LOC"]}}}} ``` ## The RecordRead object ```json {"openapi":"3.0.3","info":{"title":"IONOS CLOUD - DNS API","version":"1.18.2"},"components":{"schemas":{"RecordRead":{"type":"object","required":["id","type","href","metadata","properties"],"properties":{"id":{"type":"string","format":"uuid","description":"The record ID (UUID).","readOnly":true},"type":{"type":"string","enum":["record"]},"href":{"type":"string","format":"uri","readOnly":true},"metadata":{"$ref":"#/components/schemas/MetadataWithStateFqdnZoneId"},"properties":{"$ref":"#/components/schemas/Record"}}},"MetadataWithStateFqdnZoneId":{"allOf":[{"$ref":"#/components/schemas/Metadata"},{"type":"object","required":["state","fqdn","zoneId"],"properties":{"state":{"$ref":"#/components/schemas/ProvisioningState"},"fqdn":{"type":"string","readOnly":true,"description":"A fully qualified domain name. FQDN consists of two parts - the hostname and the domain name."},"zoneId":{"$ref":"#/components/schemas/zoneId"}}}]},"Metadata":{"type":"object","description":"Metadata of the resource.","properties":{"createdDate":{"type":"string","readOnly":true,"format":"date-time","description":"The creation date formatted as yyyy-MM-dd'T'HH:mm:ss.SSS'Z'."},"createdBy":{"type":"string","description":"Unique name of the identity that created the resource.","readOnly":true},"createdByUserId":{"type":"string","description":"The unique ID of the user who created the resource.","readOnly":true},"lastModifiedDate":{"type":"string","readOnly":true,"format":"date-time","description":"The date of the last change formatted as yyyy-MM-dd'T'HH:mm:ss.SSS'Z'."},"lastModifiedBy":{"type":"string","description":"Unique name of the identity that created the resource.","readOnly":true},"lastModifiedByUserId":{"type":"string","description":"The unique ID of the user who last modified the resource.","readOnly":true},"resourceURN":{"type":"string","description":"Unique name of the resource.","readOnly":true}}},"ProvisioningState":{"type":"string","description":"The list of possible provisioning states in which DNS resource could be at the specific time.\n* AVAILABLE - resource exists and is healthy.\n* PROVISIONING - resource is being created or updated.\n* DESTROYING - delete command was issued, the resource is being deleted.\n* FAILED - creation of the resource failed.\n","enum":["PROVISIONING","DESTROYING","AVAILABLE","FAILED"]},"zoneId":{"type":"string","readOnly":true,"format":"uuid","description":"The ID (UUID) of the DNS zone of which record belongs to."},"Record":{"type":"object","required":["name","type","content"],"properties":{"name":{"type":"string"},"type":{"$ref":"#/components/schemas/RecordType"},"content":{"type":"string"},"ttl":{"type":"integer","default":3600,"minimum":60,"maximum":604800,"description":"Time to live for the record, recommended 3600."},"priority":{"type":"integer","default":3600,"minimum":0,"maximum":65535,"description":"Priority value is between 0 and 65535. Priority is mandatory for MX, SRV and URI record types and ignored for all other types."},"enabled":{"type":"boolean","default":true,"description":"When true - the record is visible for lookup."}}},"RecordType":{"type":"string","description":"Holds supported DNS resource record types. In the DNS context a record is a DNS resource record.","enum":["A","AAAA","CNAME","ALIAS","MX","NS","SRV","TXT","CAA","SSHFP","TLSA","SMIMEA","DS","HTTPS","SVCB","OPENPGPKEY","CERT","URI","RP","LOC"]}}}} ``` ## The RecordCreate object ```json {"openapi":"3.0.3","info":{"title":"IONOS CLOUD - DNS API","version":"1.18.2"},"components":{"schemas":{"RecordCreate":{"type":"object","required":["properties"],"properties":{"properties":{"$ref":"#/components/schemas/Record"}}},"Record":{"type":"object","required":["name","type","content"],"properties":{"name":{"type":"string"},"type":{"$ref":"#/components/schemas/RecordType"},"content":{"type":"string"},"ttl":{"type":"integer","default":3600,"minimum":60,"maximum":604800,"description":"Time to live for the record, recommended 3600."},"priority":{"type":"integer","default":3600,"minimum":0,"maximum":65535,"description":"Priority value is between 0 and 65535. Priority is mandatory for MX, SRV and URI record types and ignored for all other types."},"enabled":{"type":"boolean","default":true,"description":"When true - the record is visible for lookup."}}},"RecordType":{"type":"string","description":"Holds supported DNS resource record types. In the DNS context a record is a DNS resource record.","enum":["A","AAAA","CNAME","ALIAS","MX","NS","SRV","TXT","CAA","SSHFP","TLSA","SMIMEA","DS","HTTPS","SVCB","OPENPGPKEY","CERT","URI","RP","LOC"]}}}} ``` ## The RecordEnsure object ```json {"openapi":"3.0.3","info":{"title":"IONOS CLOUD - DNS API","version":"1.18.2"},"components":{"schemas":{"RecordEnsure":{"type":"object","required":["properties"],"properties":{"properties":{"$ref":"#/components/schemas/Record"}}},"Record":{"type":"object","required":["name","type","content"],"properties":{"name":{"type":"string"},"type":{"$ref":"#/components/schemas/RecordType"},"content":{"type":"string"},"ttl":{"type":"integer","default":3600,"minimum":60,"maximum":604800,"description":"Time to live for the record, recommended 3600."},"priority":{"type":"integer","default":3600,"minimum":0,"maximum":65535,"description":"Priority value is between 0 and 65535. Priority is mandatory for MX, SRV and URI record types and ignored for all other types."},"enabled":{"type":"boolean","default":true,"description":"When true - the record is visible for lookup."}}},"RecordType":{"type":"string","description":"Holds supported DNS resource record types. In the DNS context a record is a DNS resource record.","enum":["A","AAAA","CNAME","ALIAS","MX","NS","SRV","TXT","CAA","SSHFP","TLSA","SMIMEA","DS","HTTPS","SVCB","OPENPGPKEY","CERT","URI","RP","LOC"]}}}} ``` ## The Record object ```json {"openapi":"3.0.3","info":{"title":"IONOS CLOUD - DNS API","version":"1.18.2"},"components":{"schemas":{"Record":{"type":"object","required":["name","type","content"],"properties":{"name":{"type":"string"},"type":{"$ref":"#/components/schemas/RecordType"},"content":{"type":"string"},"ttl":{"type":"integer","default":3600,"minimum":60,"maximum":604800,"description":"Time to live for the record, recommended 3600."},"priority":{"type":"integer","default":3600,"minimum":0,"maximum":65535,"description":"Priority value is between 0 and 65535. Priority is mandatory for MX, SRV and URI record types and ignored for all other types."},"enabled":{"type":"boolean","default":true,"description":"When true - the record is visible for lookup."}}},"RecordType":{"type":"string","description":"Holds supported DNS resource record types. In the DNS context a record is a DNS resource record.","enum":["A","AAAA","CNAME","ALIAS","MX","NS","SRV","TXT","CAA","SSHFP","TLSA","SMIMEA","DS","HTTPS","SVCB","OPENPGPKEY","CERT","URI","RP","LOC"]}}}} ``` ## The ProvisioningState object ```json {"openapi":"3.0.3","info":{"title":"IONOS CLOUD - DNS API","version":"1.18.2"},"components":{"schemas":{"ProvisioningState":{"type":"string","description":"The list of possible provisioning states in which DNS resource could be at the specific time.\n* AVAILABLE - resource exists and is healthy.\n* PROVISIONING - resource is being created or updated.\n* DESTROYING - delete command was issued, the resource is being deleted.\n* FAILED - creation of the resource failed.\n","enum":["PROVISIONING","DESTROYING","AVAILABLE","FAILED"]}}}} ``` ## The RecordType object ```json {"openapi":"3.0.3","info":{"title":"IONOS CLOUD - DNS API","version":"1.18.2"},"components":{"schemas":{"RecordType":{"type":"string","description":"Holds supported DNS resource record types. In the DNS context a record is a DNS resource record.","enum":["A","AAAA","CNAME","ALIAS","MX","NS","SRV","TXT","CAA","SSHFP","TLSA","SMIMEA","DS","HTTPS","SVCB","OPENPGPKEY","CERT","URI","RP","LOC"]}}}} ``` ## The Metadata object ```json {"openapi":"3.0.3","info":{"title":"IONOS CLOUD - DNS API","version":"1.18.2"},"components":{"schemas":{"Metadata":{"type":"object","description":"Metadata of the resource.","properties":{"createdDate":{"type":"string","readOnly":true,"format":"date-time","description":"The creation date formatted as yyyy-MM-dd'T'HH:mm:ss.SSS'Z'."},"createdBy":{"type":"string","description":"Unique name of the identity that created the resource.","readOnly":true},"createdByUserId":{"type":"string","description":"The unique ID of the user who created the resource.","readOnly":true},"lastModifiedDate":{"type":"string","readOnly":true,"format":"date-time","description":"The date of the last change formatted as yyyy-MM-dd'T'HH:mm:ss.SSS'Z'."},"lastModifiedBy":{"type":"string","description":"Unique name of the identity that created the resource.","readOnly":true},"lastModifiedByUserId":{"type":"string","description":"The unique ID of the user who last modified the resource.","readOnly":true},"resourceURN":{"type":"string","description":"Unique name of the resource.","readOnly":true}}}}}} ``` ## The MetadataWithStateNameservers object ```json {"openapi":"3.0.3","info":{"title":"IONOS CLOUD - DNS API","version":"1.18.2"},"components":{"schemas":{"MetadataWithStateNameservers":{"allOf":[{"$ref":"#/components/schemas/Metadata"},{"type":"object","required":["state","nameservers"],"properties":{"state":{"$ref":"#/components/schemas/ProvisioningState"},"nameservers":{"type":"array","description":"The list of nameservers associated to the zone. \nNameservers are different for primary and secondary zones.\nFor primary zones it would be:\n- ns-ic.ui-dns.com\n- ns-ic.ui-dns.de\n- ns-ic.ui-dns.org\n- ns-ic.ui-dns.biz\n\nAnd for secondary zones:\n- nscs.ui-dns.com\n- nscs.ui-dns.de\n- nscs.ui-dns.org\n- nscs.ui-dns.biz\n","items":{"type":"string"}}}}]},"Metadata":{"type":"object","description":"Metadata of the resource.","properties":{"createdDate":{"type":"string","readOnly":true,"format":"date-time","description":"The creation date formatted as yyyy-MM-dd'T'HH:mm:ss.SSS'Z'."},"createdBy":{"type":"string","description":"Unique name of the identity that created the resource.","readOnly":true},"createdByUserId":{"type":"string","description":"The unique ID of the user who created the resource.","readOnly":true},"lastModifiedDate":{"type":"string","readOnly":true,"format":"date-time","description":"The date of the last change formatted as yyyy-MM-dd'T'HH:mm:ss.SSS'Z'."},"lastModifiedBy":{"type":"string","description":"Unique name of the identity that created the resource.","readOnly":true},"lastModifiedByUserId":{"type":"string","description":"The unique ID of the user who last modified the resource.","readOnly":true},"resourceURN":{"type":"string","description":"Unique name of the resource.","readOnly":true}}},"ProvisioningState":{"type":"string","description":"The list of possible provisioning states in which DNS resource could be at the specific time.\n* AVAILABLE - resource exists and is healthy.\n* PROVISIONING - resource is being created or updated.\n* DESTROYING - delete command was issued, the resource is being deleted.\n* FAILED - creation of the resource failed.\n","enum":["PROVISIONING","DESTROYING","AVAILABLE","FAILED"]}}}} ``` ## The MetadataWithStateFqdnZoneId object ```json {"openapi":"3.0.3","info":{"title":"IONOS CLOUD - DNS API","version":"1.18.2"},"components":{"schemas":{"MetadataWithStateFqdnZoneId":{"allOf":[{"$ref":"#/components/schemas/Metadata"},{"type":"object","required":["state","fqdn","zoneId"],"properties":{"state":{"$ref":"#/components/schemas/ProvisioningState"},"fqdn":{"type":"string","readOnly":true,"description":"A fully qualified domain name. FQDN consists of two parts - the hostname and the domain name."},"zoneId":{"$ref":"#/components/schemas/zoneId"}}}]},"Metadata":{"type":"object","description":"Metadata of the resource.","properties":{"createdDate":{"type":"string","readOnly":true,"format":"date-time","description":"The creation date formatted as yyyy-MM-dd'T'HH:mm:ss.SSS'Z'."},"createdBy":{"type":"string","description":"Unique name of the identity that created the resource.","readOnly":true},"createdByUserId":{"type":"string","description":"The unique ID of the user who created the resource.","readOnly":true},"lastModifiedDate":{"type":"string","readOnly":true,"format":"date-time","description":"The date of the last change formatted as yyyy-MM-dd'T'HH:mm:ss.SSS'Z'."},"lastModifiedBy":{"type":"string","description":"Unique name of the identity that created the resource.","readOnly":true},"lastModifiedByUserId":{"type":"string","description":"The unique ID of the user who last modified the resource.","readOnly":true},"resourceURN":{"type":"string","description":"Unique name of the resource.","readOnly":true}}},"ProvisioningState":{"type":"string","description":"The list of possible provisioning states in which DNS resource could be at the specific time.\n* AVAILABLE - resource exists and is healthy.\n* PROVISIONING - resource is being created or updated.\n* DESTROYING - delete command was issued, the resource is being deleted.\n* FAILED - creation of the resource failed.\n","enum":["PROVISIONING","DESTROYING","AVAILABLE","FAILED"]},"zoneId":{"type":"string","readOnly":true,"format":"uuid","description":"The ID (UUID) of the DNS zone of which record belongs to."}}}} ``` ## The MetadataForSecondaryZoneRecords object ```json {"openapi":"3.0.3","info":{"title":"IONOS CLOUD - DNS API","version":"1.18.2"},"components":{"schemas":{"MetadataForSecondaryZoneRecords":{"type":"object","description":"Metadata for records of secondary zones.","required":["fqdn","zoneId","rootName"],"properties":{"fqdn":{"type":"string","readOnly":true,"description":"A fully qualified domain name. FQDN consists of two parts - the hostname and the domain name."},"zoneId":{"$ref":"#/components/schemas/zoneId"},"rootName":{"type":"string","description":"Indicates the root name (from the primary zone) for the record"}}},"zoneId":{"type":"string","readOnly":true,"format":"uuid","description":"The ID (UUID) of the DNS zone of which record belongs to."}}}} ``` ## The zoneId object ```json {"openapi":"3.0.3","info":{"title":"IONOS CLOUD - DNS API","version":"1.18.2"},"components":{"schemas":{"zoneId":{"type":"string","readOnly":true,"format":"uuid","description":"The ID (UUID) of the DNS zone of which record belongs to."}}}} ``` ## The Offset object ```json {"openapi":"3.0.3","info":{"title":"IONOS CLOUD - DNS API","version":"1.18.2"},"components":{"schemas":{"Offset":{"type":"number","description":"Pagination offset.","readOnly":true}}}} ``` ## The Limit object ```json {"openapi":"3.0.3","info":{"title":"IONOS CLOUD - DNS API","version":"1.18.2"},"components":{"schemas":{"Limit":{"type":"number","description":"Pagination limit.","readOnly":true}}}} ``` ## The PaginationToken object ```json {"openapi":"3.0.3","info":{"title":"IONOS CLOUD - DNS API","version":"1.18.2"},"components":{"schemas":{"PaginationToken":{"type":"string","pattern":"^[A-Za-z0-9_-]+$","description":"Opaque cursor token identifying a page of results. Returned in the\n`pagination.token` field (and the `_links.next` URL) of a response\nwhen more results remain, and accepted back via the\n`pagination.token` query parameter to fetch that page. The token uses\na URL-safe encoding limited to the characters `A-Z`, `a-z`, `0-9`,\n`-` and `_`, so it can be round-tripped in a query string without\nescaping.\n"}}}} ``` ## The Pagination object ```json {"openapi":"3.0.3","info":{"title":"IONOS CLOUD - DNS API","version":"1.18.2"},"components":{"schemas":{"Pagination":{"type":"object","readOnly":true,"description":"Cursor pagination details. Only present when there are more results\nto return. Pass the `token` back via the `pagination.token` query\nparameter to fetch the next page.\n","required":["token"],"properties":{"token":{"$ref":"#/components/schemas/PaginationToken"}}},"PaginationToken":{"type":"string","pattern":"^[A-Za-z0-9_-]+$","description":"Opaque cursor token identifying a page of results. Returned in the\n`pagination.token` field (and the `_links.next` URL) of a response\nwhen more results remain, and accepted back via the\n`pagination.token` query parameter to fetch that page. The token uses\na URL-safe encoding limited to the characters `A-Z`, `a-z`, `0-9`,\n`-` and `_`, so it can be round-tripped in a query string without\nescaping.\n"}}}} ``` ## The Links object ```json {"openapi":"3.0.3","info":{"title":"IONOS CLOUD - DNS API","version":"1.18.2"},"components":{"schemas":{"Links":{"description":"URLs to navigate the different pages of results.\n","type":"object","properties":{"prev":{"description":"URL of the previous page; only present if offset is greater than\n0. Contains `offset` and `limit`; not returned when paging via\n`pagination.token`, which is forward-only.\n","type":"string","format":"uri","readOnly":true},"self":{"description":"URL of the current page. Contains `limit` plus either `offset` or\n`pagination.token`, depending on which pagination strategy the\nendpoint supports and the request used.\n","type":"string","format":"uri","readOnly":true},"next":{"description":"URL of the next page; only present if there are more elements to\nreturn. Contains `limit` plus either `offset` or\n`pagination.token`, depending on which pagination strategy the\nendpoint supports and the request used.\n","type":"string","format":"uri","readOnly":true}}}}}} ``` ## The keyData object ```json {"openapi":"3.0.3","info":{"title":"IONOS CLOUD - DNS API","version":"1.18.2"},"components":{"schemas":{"keyData":{"type":"object","description":"Represents the separate components of the RDATA for a DNSKEY.\nThe values must conform to the guidelines in [RFC-4034 Section 2.1](https://www.rfc-editor.org/rfc/rfc4034#section-2.1).\n","properties":{"flags":{"description":"Represents the key's metadata and usage information.","type":"integer"},"pubKey":{"description":"Represents the public key data in Base64 encoding.","type":"string"}}}}}} ``` ## The dnssecKey object ```json {"openapi":"3.0.3","info":{"title":"IONOS CLOUD - DNS API","version":"1.18.2"},"components":{"schemas":{"dnssecKey":{"type":"object","properties":{"keyTag":{"type":"integer"},"digestAlgorithmMnemonic":{"type":"string","description":"A string that denotes the digest algorithm.\nThis value must conform to the guidelines in [RFC-8624 Section 3.3](https://datatracker.ietf.org/doc/html/rfc8624#section-3.3).\n"},"digest":{"type":"string"},"keyData":{"$ref":"#/components/schemas/keyData"},"composedKeyData":{"description":"Represents the composed value of the The RDATA for a DNSKEY.\nThe format should be the following: Flags | Protocol | Algorithm | Public Key\nThe values must conform to the guidelines in [RFC-4034 Section 2.1](https://www.rfc-editor.org/rfc/rfc4034#section-2.1).\n","type":"string"}}},"keyData":{"type":"object","description":"Represents the separate components of the RDATA for a DNSKEY.\nThe values must conform to the guidelines in [RFC-4034 Section 2.1](https://www.rfc-editor.org/rfc/rfc4034#section-2.1).\n","properties":{"flags":{"description":"Represents the key's metadata and usage information.","type":"integer"},"pubKey":{"description":"Represents the public key data in Base64 encoding.","type":"string"}}}}}} ``` ## The algorithm object ```json {"openapi":"3.0.3","info":{"title":"IONOS CLOUD - DNS API","version":"1.18.2"},"components":{"schemas":{"algorithm":{"type":"string","description":"Algorithm used to generate signing keys (both Key Signing Keys and Zone Signing Keys).","enum":["RSASHA256"]}}}} ``` ## The kskBits object ```json {"openapi":"3.0.3","info":{"title":"IONOS CLOUD - DNS API","version":"1.18.2"},"components":{"schemas":{"kskBits":{"type":"integer","description":"Key signing key length in bits.\nkskBits >= zskBits\n","enum":[1024,2048,4096]}}}} ``` ## The zskBits object ```json {"openapi":"3.0.3","info":{"title":"IONOS CLOUD - DNS API","version":"1.18.2"},"components":{"schemas":{"zskBits":{"type":"integer","description":"Zone signing key length in bits.\n","enum":[1024,2048,4096]}}}} ``` ## The keyParameters object ```json {"openapi":"3.0.3","info":{"title":"IONOS CLOUD - DNS API","version":"1.18.2"},"components":{"schemas":{"keyParameters":{"type":"object","required":["algorithm","kskBits","zskBits"],"description":"Key parameters used to sign the zone.\n","properties":{"algorithm":{"$ref":"#/components/schemas/algorithm"},"kskBits":{"$ref":"#/components/schemas/kskBits"},"zskBits":{"$ref":"#/components/schemas/zskBits"}}},"algorithm":{"type":"string","description":"Algorithm used to generate signing keys (both Key Signing Keys and Zone Signing Keys).","enum":["RSASHA256"]},"kskBits":{"type":"integer","description":"Key signing key length in bits.\nkskBits >= zskBits\n","enum":[1024,2048,4096]},"zskBits":{"type":"integer","description":"Zone signing key length in bits.\n","enum":[1024,2048,4096]}}}} ``` ## The nsecParameters object ```json {"openapi":"3.0.3","info":{"title":"IONOS CLOUD - DNS API","version":"1.18.2"},"components":{"schemas":{"nsecParameters":{"type":"object","required":["nsecMode","nsec3Iterations","nsec3SaltBits"],"description":"Nsec parameters.\n","properties":{"nsecMode":{"$ref":"#/components/schemas/nsecMode"},"nsec3Iterations":{"$ref":"#/components/schemas/nsec3Iterations"},"nsec3SaltBits":{"$ref":"#/components/schemas/nsec3SaltBits"}}},"nsecMode":{"type":"string","description":"NSEC mode.\n","enum":["NSEC","NSEC3"]},"nsec3Iterations":{"type":"integer","description":"Number of iterations for NSEC3. (between 0 and 50)\n","minimum":0,"maximum":50},"nsec3SaltBits":{"type":"integer","description":"Salt length in bits for NSEC3. (between 64 and 128, multiples of 8)\n","minimum":64,"maximum":128}}}} ``` ## The nsecMode object ```json {"openapi":"3.0.3","info":{"title":"IONOS CLOUD - DNS API","version":"1.18.2"},"components":{"schemas":{"nsecMode":{"type":"string","description":"NSEC mode.\n","enum":["NSEC","NSEC3"]}}}} ``` ## The nsec3Iterations object ```json {"openapi":"3.0.3","info":{"title":"IONOS CLOUD - DNS API","version":"1.18.2"},"components":{"schemas":{"nsec3Iterations":{"type":"integer","description":"Number of iterations for NSEC3. (between 0 and 50)\n","minimum":0,"maximum":50}}}} ``` ## The nsec3SaltBits object ```json {"openapi":"3.0.3","info":{"title":"IONOS CLOUD - DNS API","version":"1.18.2"},"components":{"schemas":{"nsec3SaltBits":{"type":"integer","description":"Salt length in bits for NSEC3. (between 64 and 128, multiples of 8)\n","minimum":64,"maximum":128}}}} ``` ## The validity object ```json {"openapi":"3.0.3","info":{"title":"IONOS CLOUD - DNS API","version":"1.18.2"},"components":{"schemas":{"validity":{"type":"integer","description":"Signature validity in days\n","minimum":90,"maximum":365}}}} ``` ## The dnssecKeyParameters object ```json {"openapi":"3.0.3","info":{"title":"IONOS CLOUD - DNS API","version":"1.18.2"},"components":{"schemas":{"dnssecKeyParameters":{"type":"object","description":"Parameters used to sign zone.\n","properties":{"keyParameters":{"$ref":"#/components/schemas/keyParameters"},"nsecParameters":{"$ref":"#/components/schemas/nsecParameters"},"validity":{"$ref":"#/components/schemas/validity"}},"required":["keyParameters","nsecParameters","validity"]},"keyParameters":{"type":"object","required":["algorithm","kskBits","zskBits"],"description":"Key parameters used to sign the zone.\n","properties":{"algorithm":{"$ref":"#/components/schemas/algorithm"},"kskBits":{"$ref":"#/components/schemas/kskBits"},"zskBits":{"$ref":"#/components/schemas/zskBits"}}},"algorithm":{"type":"string","description":"Algorithm used to generate signing keys (both Key Signing Keys and Zone Signing Keys).","enum":["RSASHA256"]},"kskBits":{"type":"integer","description":"Key signing key length in bits.\nkskBits >= zskBits\n","enum":[1024,2048,4096]},"zskBits":{"type":"integer","description":"Zone signing key length in bits.\n","enum":[1024,2048,4096]},"nsecParameters":{"type":"object","required":["nsecMode","nsec3Iterations","nsec3SaltBits"],"description":"Nsec parameters.\n","properties":{"nsecMode":{"$ref":"#/components/schemas/nsecMode"},"nsec3Iterations":{"$ref":"#/components/schemas/nsec3Iterations"},"nsec3SaltBits":{"$ref":"#/components/schemas/nsec3SaltBits"}}},"nsecMode":{"type":"string","description":"NSEC mode.\n","enum":["NSEC","NSEC3"]},"nsec3Iterations":{"type":"integer","description":"Number of iterations for NSEC3. (between 0 and 50)\n","minimum":0,"maximum":50},"nsec3SaltBits":{"type":"integer","description":"Salt length in bits for NSEC3. (between 64 and 128, multiples of 8)\n","minimum":64,"maximum":128},"validity":{"type":"integer","description":"Signature validity in days\n","minimum":90,"maximum":365}}}} ``` ## The dnssecKeyCreate object ```json {"openapi":"3.0.3","info":{"title":"IONOS CLOUD - DNS API","version":"1.18.2"},"components":{"schemas":{"dnssecKeyCreate":{"type":"object","required":["properties"],"properties":{"properties":{"$ref":"#/components/schemas/dnssecKeyParameters"}}},"dnssecKeyParameters":{"type":"object","description":"Parameters used to sign zone.\n","properties":{"keyParameters":{"$ref":"#/components/schemas/keyParameters"},"nsecParameters":{"$ref":"#/components/schemas/nsecParameters"},"validity":{"$ref":"#/components/schemas/validity"}},"required":["keyParameters","nsecParameters","validity"]},"keyParameters":{"type":"object","required":["algorithm","kskBits","zskBits"],"description":"Key parameters used to sign the zone.\n","properties":{"algorithm":{"$ref":"#/components/schemas/algorithm"},"kskBits":{"$ref":"#/components/schemas/kskBits"},"zskBits":{"$ref":"#/components/schemas/zskBits"}}},"algorithm":{"type":"string","description":"Algorithm used to generate signing keys (both Key Signing Keys and Zone Signing Keys).","enum":["RSASHA256"]},"kskBits":{"type":"integer","description":"Key signing key length in bits.\nkskBits >= zskBits\n","enum":[1024,2048,4096]},"zskBits":{"type":"integer","description":"Zone signing key length in bits.\n","enum":[1024,2048,4096]},"nsecParameters":{"type":"object","required":["nsecMode","nsec3Iterations","nsec3SaltBits"],"description":"Nsec parameters.\n","properties":{"nsecMode":{"$ref":"#/components/schemas/nsecMode"},"nsec3Iterations":{"$ref":"#/components/schemas/nsec3Iterations"},"nsec3SaltBits":{"$ref":"#/components/schemas/nsec3SaltBits"}}},"nsecMode":{"type":"string","description":"NSEC mode.\n","enum":["NSEC","NSEC3"]},"nsec3Iterations":{"type":"integer","description":"Number of iterations for NSEC3. (between 0 and 50)\n","minimum":0,"maximum":50},"nsec3SaltBits":{"type":"integer","description":"Salt length in bits for NSEC3. (between 64 and 128, multiples of 8)\n","minimum":64,"maximum":128},"validity":{"type":"integer","description":"Signature validity in days\n","minimum":90,"maximum":365}}}} ``` ## The dnssecKeyReadCreation object ```json {"openapi":"3.0.3","info":{"title":"IONOS CLOUD - DNS API","version":"1.18.2"},"components":{"schemas":{"dnssecKeyReadCreation":{"type":"object","required":["id","type","href","properties"],"properties":{"properties":{"$ref":"#/components/schemas/dnssecKeyParameters"},"id":{"type":"string"},"type":{"type":"string","enum":["dnsseckeys"]},"href":{"type":"string","format":"uri","readOnly":true}}},"dnssecKeyParameters":{"type":"object","description":"Parameters used to sign zone.\n","properties":{"keyParameters":{"$ref":"#/components/schemas/keyParameters"},"nsecParameters":{"$ref":"#/components/schemas/nsecParameters"},"validity":{"$ref":"#/components/schemas/validity"}},"required":["keyParameters","nsecParameters","validity"]},"keyParameters":{"type":"object","required":["algorithm","kskBits","zskBits"],"description":"Key parameters used to sign the zone.\n","properties":{"algorithm":{"$ref":"#/components/schemas/algorithm"},"kskBits":{"$ref":"#/components/schemas/kskBits"},"zskBits":{"$ref":"#/components/schemas/zskBits"}}},"algorithm":{"type":"string","description":"Algorithm used to generate signing keys (both Key Signing Keys and Zone Signing Keys).","enum":["RSASHA256"]},"kskBits":{"type":"integer","description":"Key signing key length in bits.\nkskBits >= zskBits\n","enum":[1024,2048,4096]},"zskBits":{"type":"integer","description":"Zone signing key length in bits.\n","enum":[1024,2048,4096]},"nsecParameters":{"type":"object","required":["nsecMode","nsec3Iterations","nsec3SaltBits"],"description":"Nsec parameters.\n","properties":{"nsecMode":{"$ref":"#/components/schemas/nsecMode"},"nsec3Iterations":{"$ref":"#/components/schemas/nsec3Iterations"},"nsec3SaltBits":{"$ref":"#/components/schemas/nsec3SaltBits"}}},"nsecMode":{"type":"string","description":"NSEC mode.\n","enum":["NSEC","NSEC3"]},"nsec3Iterations":{"type":"integer","description":"Number of iterations for NSEC3. (between 0 and 50)\n","minimum":0,"maximum":50},"nsec3SaltBits":{"type":"integer","description":"Salt length in bits for NSEC3. (between 64 and 128, multiples of 8)\n","minimum":64,"maximum":128},"validity":{"type":"integer","description":"Signature validity in days\n","minimum":90,"maximum":365}}}} ``` ## The DnssecKeyDeleteAccepted object ```json {"openapi":"3.0.3","info":{"title":"IONOS CLOUD - DNS API","version":"1.18.2"},"components":{"schemas":{"DnssecKeyDeleteAccepted":{"type":"object","description":"Acknowledgement that a DNSSEC disable request was accepted. The operation is\nasynchronous; key removal completes later.\n","required":["message"],"properties":{"message":{"type":"string","description":"Human-readable note that key removal completes asynchronously."}}}}}} ``` ## The dnssecKeyReadListProperties object ```json {"openapi":"3.0.3","info":{"title":"IONOS CLOUD - DNS API","version":"1.18.2"},"components":{"schemas":{"dnssecKeyReadListProperties":{"type":"object","description":"Properties of the key.\n","properties":{"keyParameters":{"type":"object","properties":{"algorithm":{"$ref":"#/components/schemas/algorithm"}}},"nsecParameters":{"type":"object","properties":{"nsecMode":{"$ref":"#/components/schemas/nsecMode"}}}},"required":["keyParameters","nsecParameters"]},"algorithm":{"type":"string","description":"Algorithm used to generate signing keys (both Key Signing Keys and Zone Signing Keys).","enum":["RSASHA256"]},"nsecMode":{"type":"string","description":"NSEC mode.\n","enum":["NSEC","NSEC3"]}}}} ``` ## The dnssecKeyReadList object ```json {"openapi":"3.0.3","info":{"title":"IONOS CLOUD - DNS API","version":"1.18.2"},"components":{"schemas":{"dnssecKeyReadList":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["dnsseckeys"]},"href":{"type":"string","format":"uri","readOnly":true},"metadata":{"$ref":"#/components/schemas/dnssecKeyReadListMetadata"},"properties":{"$ref":"#/components/schemas/dnssecKeyReadListProperties"}}},"dnssecKeyReadListMetadata":{"type":"object","description":"Metadata of the resource with not state information.","properties":{"zoneId":{"$ref":"#/components/schemas/zoneId"},"items":{"$ref":"#/components/schemas/dnssecKeyReadListItems"}}},"zoneId":{"type":"string","readOnly":true,"format":"uuid","description":"The ID (UUID) of the DNS zone of which record belongs to."},"dnssecKeyReadListItems":{"type":"array","title":"List of dnssec keys","items":{"$ref":"#/components/schemas/dnssecKey"}},"dnssecKey":{"type":"object","properties":{"keyTag":{"type":"integer"},"digestAlgorithmMnemonic":{"type":"string","description":"A string that denotes the digest algorithm.\nThis value must conform to the guidelines in [RFC-8624 Section 3.3](https://datatracker.ietf.org/doc/html/rfc8624#section-3.3).\n"},"digest":{"type":"string"},"keyData":{"$ref":"#/components/schemas/keyData"},"composedKeyData":{"description":"Represents the composed value of the The RDATA for a DNSKEY.\nThe format should be the following: Flags | Protocol | Algorithm | Public Key\nThe values must conform to the guidelines in [RFC-4034 Section 2.1](https://www.rfc-editor.org/rfc/rfc4034#section-2.1).\n","type":"string"}}},"keyData":{"type":"object","description":"Represents the separate components of the RDATA for a DNSKEY.\nThe values must conform to the guidelines in [RFC-4034 Section 2.1](https://www.rfc-editor.org/rfc/rfc4034#section-2.1).\n","properties":{"flags":{"description":"Represents the key's metadata and usage information.","type":"integer"},"pubKey":{"description":"Represents the public key data in Base64 encoding.","type":"string"}}},"dnssecKeyReadListProperties":{"type":"object","description":"Properties of the key.\n","properties":{"keyParameters":{"type":"object","properties":{"algorithm":{"$ref":"#/components/schemas/algorithm"}}},"nsecParameters":{"type":"object","properties":{"nsecMode":{"$ref":"#/components/schemas/nsecMode"}}}},"required":["keyParameters","nsecParameters"]},"algorithm":{"type":"string","description":"Algorithm used to generate signing keys (both Key Signing Keys and Zone Signing Keys).","enum":["RSASHA256"]},"nsecMode":{"type":"string","description":"NSEC mode.\n","enum":["NSEC","NSEC3"]}}}} ``` ## The dnssecKeyReadListMetadata object ```json {"openapi":"3.0.3","info":{"title":"IONOS CLOUD - DNS API","version":"1.18.2"},"components":{"schemas":{"dnssecKeyReadListMetadata":{"type":"object","description":"Metadata of the resource with not state information.","properties":{"zoneId":{"$ref":"#/components/schemas/zoneId"},"items":{"$ref":"#/components/schemas/dnssecKeyReadListItems"}}},"zoneId":{"type":"string","readOnly":true,"format":"uuid","description":"The ID (UUID) of the DNS zone of which record belongs to."},"dnssecKeyReadListItems":{"type":"array","title":"List of dnssec keys","items":{"$ref":"#/components/schemas/dnssecKey"}},"dnssecKey":{"type":"object","properties":{"keyTag":{"type":"integer"},"digestAlgorithmMnemonic":{"type":"string","description":"A string that denotes the digest algorithm.\nThis value must conform to the guidelines in [RFC-8624 Section 3.3](https://datatracker.ietf.org/doc/html/rfc8624#section-3.3).\n"},"digest":{"type":"string"},"keyData":{"$ref":"#/components/schemas/keyData"},"composedKeyData":{"description":"Represents the composed value of the The RDATA for a DNSKEY.\nThe format should be the following: Flags | Protocol | Algorithm | Public Key\nThe values must conform to the guidelines in [RFC-4034 Section 2.1](https://www.rfc-editor.org/rfc/rfc4034#section-2.1).\n","type":"string"}}},"keyData":{"type":"object","description":"Represents the separate components of the RDATA for a DNSKEY.\nThe values must conform to the guidelines in [RFC-4034 Section 2.1](https://www.rfc-editor.org/rfc/rfc4034#section-2.1).\n","properties":{"flags":{"description":"Represents the key's metadata and usage information.","type":"integer"},"pubKey":{"description":"Represents the public key data in Base64 encoding.","type":"string"}}}}}} ``` ## The dnssecKeyReadListItems object ```json {"openapi":"3.0.3","info":{"title":"IONOS CLOUD - DNS API","version":"1.18.2"},"components":{"schemas":{"dnssecKeyReadListItems":{"type":"array","title":"List of dnssec keys","items":{"$ref":"#/components/schemas/dnssecKey"}},"dnssecKey":{"type":"object","properties":{"keyTag":{"type":"integer"},"digestAlgorithmMnemonic":{"type":"string","description":"A string that denotes the digest algorithm.\nThis value must conform to the guidelines in [RFC-8624 Section 3.3](https://datatracker.ietf.org/doc/html/rfc8624#section-3.3).\n"},"digest":{"type":"string"},"keyData":{"$ref":"#/components/schemas/keyData"},"composedKeyData":{"description":"Represents the composed value of the The RDATA for a DNSKEY.\nThe format should be the following: Flags | Protocol | Algorithm | Public Key\nThe values must conform to the guidelines in [RFC-4034 Section 2.1](https://www.rfc-editor.org/rfc/rfc4034#section-2.1).\n","type":"string"}}},"keyData":{"type":"object","description":"Represents the separate components of the RDATA for a DNSKEY.\nThe values must conform to the guidelines in [RFC-4034 Section 2.1](https://www.rfc-editor.org/rfc/rfc4034#section-2.1).\n","properties":{"flags":{"description":"Represents the key's metadata and usage information.","type":"integer"},"pubKey":{"description":"Represents the public key data in Base64 encoding.","type":"string"}}}}}} ``` ## The Error object ```json {"openapi":"3.0.3","info":{"title":"IONOS CLOUD - DNS API","version":"1.18.2"},"components":{"schemas":{"Error":{"type":"object","additionalProperties":false,"properties":{"httpStatus":{"type":"integer","description":"HTTP status code of the operation as specified by [RFC 7231](https://datatracker.ietf.org/doc/html/rfc7231#section-6).\n"},"messages":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"errorCode":{"type":"string","description":"Internal error code.\n"},"message":{"type":"string","description":"Human readable explanation of the issue.\n"}}}}}}}}} ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.ionos.com/cloud/api-reference/network-services/cloud-dns/models.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.