Aller au contenu
NimbusNexus

Zones DNS

Une zone DNS est un domaine faisant autorité, hébergé sur les serveurs de noms NimbusNexus. Créez-en une avec POST /api/v1/zones/, en donnant son name avec le point final (example.com.) et un email d’administrateur ; la zone appartient au projet appelant. Faites ensuite pointer votre registrar de domaine vers nos serveurs de noms, puis ajoutez des enregistrements pour publier les adresses, le routage du courrier et les tokens de vérification de ce domaine.

Délégation

Voici les serveurs de noms à configurer chez votre registrar :

Text
ns1.dns.nimbusnexus.net
ns2.dns.nimbusnexus.net
ns3.dns.nimbusnexus.net
ns4.dns.nimbusnexus.net

Définissez-les comme enregistrements NS de votre domaine chez votre registrar (GoDaddy, Cloudflare Registrar, Porkbun, etc.). Une fois la propagation terminée (en général de quelques minutes à quelques heures, selon les TTL du registrar), nos serveurs de noms font autorité pour le domaine.

Pendant une migration, vous pouvez continuer à utiliser votre fournisseur DNS actuel en parallèle — les enregistrements NS des deux fournisseurs peuvent coexister pendant une courte période si vous configurez le registrar pour utiliser les deux jeux ; retirez ensuite l’ancien jeu une fois tous les enregistrements déplacés.

Zone ou sous-domaine

Une zone = un domaine. example.com est une zone ; api.example.com est un sous-domaine géré par un enregistrement A ou CNAME dans la zone example.com, et non une zone distincte — sauf si vous voulez précisément déléguer api.example.com à un autre fournisseur DNS, auquel cas vous créeriez séparément example.com (avec des enregistrements NS qui pointent vers l’autre fournisseur pour le sous-domaine) et la zone du sous-domaine.

Pour un usage courant, une zone par domaine enregistré est la bonne structure.

Étapes suivantes

Reference

GET/api/v1/zones/

Zones List

Lists DNS zones accessible to the calling project.

Parameters

NameInTypeDescription
namequerystring | null—
emailquerystring | null—
statusquerystring | null—
descriptionquerystring | null—
ttlqueryinteger | null—
limitqueryinteger | null—
markerquerystring | null—

Responses

  • 200Successful Response
  • 400Bad Request
  • 401Unauthorized
  • 403Forbidden
  • 422Validation error
  • 429Too Many Requests
  • 500Internal Server Error

Example

curl -X GET "https://api.nimbusnexus.net/api/v1/zones/" \
  -H "Authorization: Bearer $NIMBUS_KEY"
POST/api/v1/zones/

Zone Create

Creates a new DNS zone for the calling project.

Request body

FieldTypeDescription
admin_domainstring | null—
admin_projectstring | null—
name*stringZone FQDN, e.g. example.com.
email*stringDNS admin email
ttlinteger | nullDefault TTL for the zone
descriptionstring | null—
typeZoneType | nullPRIMARY or SECONDARY
mastersarray of string | nullMasters for SECONDARY zones
attributesobject | null—

Responses

  • 201Successful Response
  • 400Bad Request
  • 401Unauthorized
  • 403Forbidden
  • 409Conflict
  • 422Validation error
  • 429Too Many Requests
  • 500Internal Server Error

Example

curl -X POST "https://api.nimbusnexus.net/api/v1/zones/" \
  -H "Authorization: Bearer $NIMBUS_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Example",
    "email": "[email protected]"
  }'
GET/api/v1/zones/artifacts

Get Zones Create Artifacts

Returns the DNS zone domain artifacts available for zone creation.

Responses

  • 200Successful Response
  • 401Unauthorized
  • 403Forbidden
  • 429Too Many Requests
  • 500Internal Server Error

Example

curl -X GET "https://api.nimbusnexus.net/api/v1/zones/artifacts" \
  -H "Authorization: Bearer $NIMBUS_KEY"
GET/api/v1/zones/{zone_id}

Zone Retrieve

Retrieves a single DNS zone by its identifier.

Parameters

NameInTypeDescription
zone_id*pathstring—

Responses

  • 200Successful Response
  • 400Bad Request
  • 401Unauthorized
  • 403Forbidden
  • 404Not Found
  • 422Validation error
  • 429Too Many Requests
  • 500Internal Server Error

Example

curl -X GET "https://api.nimbusnexus.net/api/v1/zones/<zone_id>" \
  -H "Authorization: Bearer $NIMBUS_KEY"
PUT/api/v1/zones/{zone_id}

Zone Update

Updates the editable attributes of a DNS zone.

Parameters

NameInTypeDescription
zone_id*pathstring—

Request body

FieldTypeDescription
admin_domainstring | null—
admin_projectstring | null—
emailstring | null—
descriptionstring | null—
ttlinteger | null—

Responses

  • 200Successful Response
  • 400Bad Request
  • 401Unauthorized
  • 403Forbidden
  • 404Not Found
  • 409Conflict
  • 422Validation error
  • 429Too Many Requests
  • 500Internal Server Error

Example

curl -X PUT "https://api.nimbusnexus.net/api/v1/zones/<zone_id>" \
  -H "Authorization: Bearer $NIMBUS_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
DELETE/api/v1/zones/{zone_id}

Zone Delete

Deletes a DNS zone, optionally removing its shares first.

Parameters

NameInTypeDescription
zone_id*pathstring—
delete_sharesquerybooleanDelete all zone shares before deleting the zone

Responses

  • 204Successful Response
  • 400Bad Request
  • 401Unauthorized
  • 403Forbidden
  • 404Not Found
  • 409Conflict
  • 422Validation Error
  • 429Too Many Requests
  • 500Internal Server Error

Example

curl -X DELETE "https://api.nimbusnexus.net/api/v1/zones/<zone_id>" \
  -H "Authorization: Bearer $NIMBUS_KEY"
GET/api/v1/zones/{zone_id}/shares/

Shared Zones List

Lists the projects a DNS zone is shared with.

Parameters

NameInTypeDescription
zone_id*pathstring—
admin_domainquerystring | null—
admin_projectquerystring | null—
target_project_idquerystring | null—
limitqueryinteger | null—
markerquerystring | null—

Responses

  • 200Successful Response
  • 401Unauthorized
  • 403Forbidden
  • 404Not Found
  • 422Validation error
  • 429Too Many Requests
  • 500Internal Server Error

Example

curl -X GET "https://api.nimbusnexus.net/api/v1/zones/<zone_id>/shares/" \
  -H "Authorization: Bearer $NIMBUS_KEY"
POST/api/v1/zones/{zone_id}/shares/

Shared Zones Create

Shares a DNS zone with another project.

Parameters

NameInTypeDescription
zone_id*pathstring—

Request body

FieldTypeDescription
target_project_id*stringTarget project UUID to share the zone with

Responses

  • 201Successful Response
  • 401Unauthorized
  • 403Forbidden
  • 404Not Found
  • 409Conflict
  • 422Validation error
  • 429Too Many Requests
  • 500Internal Server Error

Example

curl -X POST "https://api.nimbusnexus.net/api/v1/zones/<zone_id>/shares/" \
  -H "Authorization: Bearer $NIMBUS_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "target_project_id": "<target_project_id>"
  }'
GET/api/v1/zones/{zone_id}/shares/{shared_zone_id}

Shared Zone Retrieve

Retrieves details of a single DNS zone share.

Parameters

NameInTypeDescription
zone_id*pathstring—
shared_zone_id*pathstring—

Responses

  • 200Successful Response
  • 401Unauthorized
  • 403Forbidden
  • 404Not Found
  • 422Validation error
  • 429Too Many Requests
  • 500Internal Server Error

Example

curl -X GET "https://api.nimbusnexus.net/api/v1/zones/<zone_id>/shares/<shared_zone_id>" \
  -H "Authorization: Bearer $NIMBUS_KEY"
DELETE/api/v1/zones/{zone_id}/shares/{shared_zone_id}

Shared Zone Delete

Revokes a DNS zone share from a target project.

Parameters

NameInTypeDescription
zone_id*pathstring—
shared_zone_id*pathstring—

Responses

  • 204Successful Response
  • 401Unauthorized
  • 403Forbidden
  • 404Not Found
  • 422Validation error
  • 429Too Many Requests
  • 500Internal Server Error

Example

curl -X DELETE "https://api.nimbusnexus.net/api/v1/zones/<zone_id>/shares/<shared_zone_id>" \
  -H "Authorization: Bearer $NIMBUS_KEY"

Need to make a real call? Try these endpoints in the live Swagger UI →