Models
Object models with fields and example values.
- 68 Models
- 32 Types & enums
On this page
A
No description was provided in the specification.
Fields
Response example
{
"type": "A",
"name": "www",
"data": "12.12.12.12"
}AAAA
No description was provided in the specification.
Fields
Response example
{
"type": "AAAA",
"name": "www",
"data": "2001:0db8:85a3:0000:0000:8a2e:0370:7334"
}ALIAS
No description was provided in the specification.
Fields
Response example
{
"type": "ALIAS",
"name": "www",
"data": "www.example.com."
}authinfoResponse
No description was provided in the specification.
Fields
Response example
{
"domain": "example",
"authinfo": "example"
}baseResult
No description was provided in the specification.
Fields
Response example
{
"success": true
}CAA
No description was provided in the specification.
Fields
Response example
{
"type": "CAA",
"name": "www",
"flags": 1,
"tag": "issue",
"data": "letsencrypt.org"
}CNAME
No description was provided in the specification.
Fields
Response example
{
"type": "CNAME",
"name": "www",
"data": "www.example.com."
}dnssecCapabilities
No description was provided in the specification.
Fields
Response example
{
"supported": true,
"provider": "example",
"mode_regfish_available": true,
"mode_external_available": true,
"accepted_record_kinds": [
"ds"
],
"min_records": 1,
"accepted_algorithms": [
1
]
}dnssecJobResponse
No description was provided in the specification.
Fields
Response example
{
"id": 1,
"action": "example",
"mode": "example",
"status": "example",
"source": "example",
"ts_created": 1,
"ts_updated": 1
}dnssecRecord
No description was provided in the specification.
Fields
Response example
{
"kind": "ds",
"algorithm": 1
}dnssecRequest
No description was provided in the specification.
Fields
Response example
{
"mode": "none",
"state": "disabled"
}dnssecResponse
No description was provided in the specification.
Fields
Response example
{
"configured": true,
"dnssec_state": "active",
"mode": "none",
"desired_state": "disabled",
"live_state": "disabled",
"capabilities": {
"supported": true,
"provider": "example",
"mode_regfish_available": true,
"mode_external_available": true,
"accepted_record_kinds": [
"ds"
],
"min_records": 1,
"accepted_algorithms": [
1
]
},
"desired_records": [
{
"kind": "ds",
"algorithm": 1
}
],
"live_records": [
{
"kind": "ds",
"algorithm": 1
}
],
"using_regfish_nameservers": true,
"legacy_mode": true,
"zone_signed": true,
"zone_pending_disable": true
}dnsZoneCounts
No description was provided in the specification.
Fields
Response example
{
"records_total": 1,
"records_active": 1,
"records_auto": 1,
"records_manual": 1,
"by_type": {}
}dnsZoneDelegationNameserver
No description was provided in the specification.
Fields
Response example
{
"host": "www.example.com."
}dnsZoneDetailResponse
No description was provided in the specification.
Fields
Response example
{
"domain": "www.example.com",
"origin": "www.example.com.",
"active": true,
"signed": true,
"using_regfish_nameservers": true,
"delegation_nameservers": [
{
"host": "www.example.com."
}
],
"soa": {
"primary_nameserver": "www.example.com.",
"mailbox": "www.example.com.",
"serial": 1,
"refresh": 1,
"retry": 1,
"expire": 1,
"minimum": 1,
"ttl": 1
},
"record_count": 1,
"dnssec_state": "active",
"dnssec": {
"configured": true,
"dnssec_state": "active",
"mode": "none",
"desired_state": "disabled",
"live_state": "disabled",
"capabilities": {
"supported": true,
"provider": "example",
"mode_regfish_available": true,
"mode_external_available": true,
"accepted_record_kinds": [
"ds"
],
"min_records": 1,
"accepted_algorithms": [
1
]
},
"desired_records": [
{
"kind": "ds",
"algorithm": 1
}
],
"live_records": [
{
"kind": "ds",
"algorithm": 1
}
],
"using_regfish_nameservers": true,
"legacy_mode": true,
"zone_signed": true,
"zone_pending_disable": true
},
"counts": {
"records_total": 1,
"records_active": 1,
"records_auto": 1,
"records_manual": 1,
"by_type": {}
},
"records": [
{
"id": 1,
"name": "example",
"type": "example",
"ttl": 1,
"auto": true,
"active": true,
"ts_created": 1,
"ts_updated": 1
}
]
}dnsZoneRecordResponse
Superset record representation returned by the detailed zone endpoint. Record-specific fields such as `priority`, `flags`, or `tag` are included when applicable.
Fields
Response example
{
"id": 1,
"name": "example",
"type": "example",
"ttl": 1,
"auto": true,
"active": true,
"ts_created": 1,
"ts_updated": 1
}dnsZoneSOA
No description was provided in the specification.
Fields
Response example
{
"primary_nameserver": "www.example.com.",
"mailbox": "www.example.com.",
"serial": 1,
"refresh": 1,
"retry": 1,
"expire": 1,
"minimum": 1,
"ttl": 1
}dnsZoneSummaryResponse
No description was provided in the specification.
Fields
Response example
{
"domain": "www.example.com",
"origin": "www.example.com.",
"active": true,
"signed": true,
"using_regfish_nameservers": true,
"delegation_nameservers": [
{
"host": "www.example.com."
}
],
"soa": {
"primary_nameserver": "www.example.com.",
"mailbox": "www.example.com.",
"serial": 1,
"refresh": 1,
"retry": 1,
"expire": 1,
"minimum": 1,
"ttl": 1
},
"record_count": 1,
"dnssec_state": "active"
}domainDetailsResponse
No description was provided in the specification.
Fields
Response example
{
"domain": "www.example.com",
"sld": "example",
"tld": "example",
"favorite": true,
"owner": "example",
"primary_nameserver": "example",
"dnssec_state": "active",
"auto_renew": true,
"cancelled": true,
"registered_at": 1,
"expires_at": 1,
"nameservers": [
"example"
]
}domainListResponse
No description was provided in the specification.
Fields
Response example
{
"domains": [
{
"domain": "www.example.com",
"sld": "example",
"tld": "example",
"favorite": true,
"owner": "example",
"primary_nameserver": "example",
"dnssec_state": "active",
"auto_renew": true,
"cancelled": true,
"registered_at": 1,
"expires_at": 1
}
],
"total_items": 1,
"total_pages": 1,
"page": 1,
"page_size": 1,
"search": "example",
"filters": [
"cancelled"
],
"sort_by": "domain",
"sort_order": "asc"
}domainResponse
No description was provided in the specification.
Fields
Response example
{
"domain": "www.example.com",
"sld": "example",
"tld": "example",
"favorite": true,
"owner": "example",
"primary_nameserver": "example",
"dnssec_state": "active",
"auto_renew": true,
"cancelled": true,
"registered_at": 1,
"expires_at": 1
}Error
No description was provided in the specification.
Fields
Response example
{
"success": false,
"message": "Unauthorized",
"error": "Invalid API key"
}helpSearchResponse
No description was provided in the specification.
Fields
Response example
{
"question": "example",
"answer": "example",
"truncated": true,
"sources": "example",
"dashboard_url": "example"
}HINFOStored
A record of a type the API returns as stored but does not create or update (managed in the dash). `data` is the raw record data. Apex NS records are not part of the record list; see the nameserver endpoints.
Fields
Response example
{
"type": "HINFO",
"name": "www",
"data": "example"
}hostingAlias
No description was provided in the specification.
Fields
Response example
{
"name": "example"
}hostingDatabase
No description was provided in the specification.
Fields
Response example
{
"name": "example",
"user": "example"
}hostingPackage
No description was provided in the specification.
Fields
Response example
{
"id": "example",
"webhost_id": 1,
"plan": "example",
"status": "example",
"active": true
}MX
No description was provided in the specification.
Fields
Response example
{
"type": "MX",
"name": "www",
"data": "www.example.com.",
"priority": 1
}nameserversResponse
No description was provided in the specification.
Fields
Response example
{
"domain": "example",
"mode": "standard",
"current": [
"example"
],
"vanity_set_id": 1,
"vanity_sets": [
{
"id": 1,
"host": "example",
"nameservers": [
"example"
]
}
]
}nameserversUpdateRequest
No description was provided in the specification.
Fields
Response example
{
"vanity_set_id": 1
}NAPTRStored
A record of a type the API returns as stored but does not create or update (managed in the dash). `data` is the raw record data. Apex NS records are not part of the record list; see the nameserver endpoints.
Fields
Response example
{
"type": "NAPTR",
"name": "www",
"data": "example"
}NSStored
A record of a type the API returns as stored but does not create or update (managed in the dash). `data` is the raw record data. Apex NS records are not part of the record list; see the nameserver endpoints.
Fields
Response example
{
"type": "NS",
"name": "www",
"data": "example"
}prepareOrderPosition
No description was provided in the specification.
Fields
Response example
{
"ok": true,
"domain": "example"
}prepareOrderRequest
No description was provided in the specification.
Fields
Response example
{
"items": [
{
"domain": "example"
}
]
}prepareOrderResponse
No description was provided in the specification.
Fields
Response example
{
"checkout_url": "https://api.regfish.com",
"expires_at": "2026-03-11T12:00:00Z",
"total_gross": 1,
"currency": "EUR",
"positions": [
{
"ok": true,
"domain": "example"
}
]
}PTRStored
A record of a type the API returns as stored but does not create or update (managed in the dash). `data` is the raw record data. Apex NS records are not part of the record list; see the nameserver endpoints.
Fields
Response example
{
"type": "PTR",
"name": "www",
"data": "example"
}record
No description was provided in the specification.
Fields
Response example
{
"type": "A",
"name": "www"
}recordRequest
No description was provided in the specification.
Fields
Response example
{
"type": "A",
"name": "www",
"data": "12.12.12.12"
}recordRequestFQDN
No description was provided in the specification.
Fields
Response example
{
"type": "A",
"name": "www.example.com.",
"data": "12.12.12.12"
}recordResponse
No description was provided in the specification.
Fields
Response example
{
"type": "A",
"name": "www.example.com.",
"data": "12.12.12.12",
"id": 1,
"auto": true,
"active": true,
"ts_created": 1,
"ts_updated": 1
}recordResponseAdditionalReqFQDN
No description was provided in the specification.
Fields
Response example
{
"name": "www.example.com."
}recordResponseAdditionalReqRRID
No description was provided in the specification.
Fields
Response example
{
"id": 1
}recordResponseAdditionalState
No description was provided in the specification.
Fields
Response example
{
"auto": true,
"active": true,
"ts_created": 1,
"ts_updated": 1
}recordStored
A record of a type the API returns as stored but does not create or update (managed in the dash). `data` is the raw record data. Apex NS records are not part of the record list; see the nameserver endpoints.
Fields
Response example
{
"type": "NS",
"name": "www",
"data": "example"
}recordType
No description was provided in the specification.
Fields
Response example
{
"type": "A",
"name": "www",
"data": "12.12.12.12"
}recordTypeStored
No description was provided in the specification.
Fields
Response example
{
"type": "A",
"name": "www",
"data": "12.12.12.12"
}RPStored
A record of a type the API returns as stored but does not create or update (managed in the dash). `data` is the raw record data. Apex NS records are not part of the record list; see the nameserver endpoints.
Fields
Response example
{
"type": "RP",
"name": "www",
"data": "example"
}SRV
No description was provided in the specification.
Fields
Response example
{
"type": "SRV",
"name": "www",
"priority": 10,
"weight": 0,
"port": 993,
"data": "www.example.com."
}TLSA
No description was provided in the specification.
Fields
Response example
{
"type": "TLSA",
"name": "www",
"usage": 3,
"selector": 1,
"matching_type": 1,
"data": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"
}tlsCertificateCancelRequest
No description was provided in the specification.
Fields
Response example
{
"note": "example"
}tlsCertificateCompleteRequest
No description was provided in the specification.
Fields
Response example
{
"org_id": "hdl_7K9QW3M2ZT8HJ"
}tlsCertificateOrderCancelRequest
No description was provided in the specification.
Fields
Response example
{
"comment": "example",
"revocation_reason": "unspecified"
}tlsCertificateOrganization
No description was provided in the specification.
Fields
Response example
{
"id": "hdl_7K9QW3M2ZT8HJ",
"name": "example",
"status": "ready",
"usable_for_ordering": true
}tlsCertificateReissueRequest
No description was provided in the specification.
Fields
Response example
{
"csr": "-----BEGIN CERTIFICATE REQUEST-----\nMIIC...\n-----END CERTIFICATE REQUEST-----",
"dcv_method": "dns-cname-token"
}tlsCertificateReissueResponse
No description was provided in the specification.
Fields
Response example
{
"id": 1,
"status": "pending",
"common_name": "example",
"dns_names": [
"example"
]
}tlsCertificateRequest
No description was provided in the specification.
Fields
Response example
{
"sku": "RapidSSL",
"common_name": "www.example.com",
"csr": "-----BEGIN CERTIFICATE REQUEST-----\nMIIC...\n-----END CERTIFICATE REQUEST-----",
"dcv_method": "dns-cname-token"
}tlsCertificateResponse
No description was provided in the specification.
Fields
Response example
{
"id": "7K9QW3M2ZT8HJ",
"status": "pending",
"common_name": "example",
"product": "example",
"provider": "digicert",
"dns_names": [
"example"
],
"action_required": false,
"pending_reason": "validation_pending",
"pending_message": "The TLS certificate order is waiting for domain validation.",
"completion_url": "",
"organization_id": null,
"certificate_pem_available": false
}tlsCertificateRevokeRequest
No description was provided in the specification.
Fields
Response example
{
"comment": "example",
"revocation_reason": "unspecified"
}tlsOrganizationCreateRequest
No description was provided in the specification.
Fields
Response example
{
"organization": "example",
"first_name": "example",
"last_name": "example",
"address": "example",
"postal_code": "example",
"city": "example",
"country_code": "example",
"phone": "example",
"email": "example"
}tlsOrganizationPatchRequest
No description was provided in the specification.
Fields
Response example
{
"edit_mode": "create_replacement",
"organization": "example",
"first_name": "example",
"last_name": "example"
}tlsOrganizationResponse
No description was provided in the specification.
Fields
Response example
{
"id": "hdl_7K9QW3M2ZT8HJ",
"organization": "example",
"status": "ready",
"usable_for_ordering": true,
"first_name": "example",
"last_name": "example",
"address": "example",
"postal_code": "example",
"city": "example",
"country_code": "example",
"phone": "example",
"email": "example"
}tlsProductResponse
No description was provided in the specification.
Fields
Response example
{
"sku": "RapidSSL",
"name": "example",
"type": "DV",
"validation_level": "dv",
"organization_required": false,
"ca": "digicert",
"price": {
"yearly": 1,
"daily": 1
},
"specs": {
"seal": true,
"san_support": true,
"www_on_apex": true,
"apex_on_wc": true
}
}tlsProductSpecs
No description was provided in the specification.
Fields
Response example
{
"seal": true,
"san_support": true,
"www_on_apex": true,
"apex_on_wc": true
}tlsValidation
No description was provided in the specification.
Fields
Response example
{
"method": "dns-cname-token"
}tlsValidationDnsRecord
No description was provided in the specification.
Fields
Response example
{
"name": "www.example.com.",
"type": "CNAME",
"value": "www.example.com."
}tokenInfoResponse
No description was provided in the specification.
Fields
Response example
{
"key_id": "example",
"token_l4": "example",
"permissions": [
"example"
],
"scope": "example",
"customer_id": 1
}TXT
No description was provided in the specification.
Fields
Response example
{
"type": "TXT",
"name": "www",
"data": "example"
}Devenez membre de la communauté
L'API DNS regfish est une excellente solution pour les développeurs qui souhaitent automatiser les domaines et les zones DNS. Faites partie de la communauté et bénéficiez de l'automatisation DNS. L'API DNS est disponible gratuitement pour chaque client regfish.