NimbusNexus V1:designate:zones API
The v1:designate:zones API from NimbusNexus — 3 operation(s) for v1:designate:zones.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/nimbusnexus:nimbusnexus-v1-designate-zones-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: NimbusNexus API — External V1:designate:zones API
description: 'External (public) API intended for client-facing integrations and the web portal.
Authentication:
- This API uses JWT Bearer authentication.
- In Swagger UI, click ''Authorize'' and sign in via the configured token endpoint.
- Swagger will automatically attach the header: Authorization: Bearer .'
version: test
servers:
- url: /
description: Current host
- url: https://fastapi.dev.nimbusnexus.net
description: Development
security:
- SwaggerLogin: []
- ApiKeyAuth: []
tags:
- name: v1:designate:zones
paths:
/api/v1/zones/:
post:
tags:
- v1:designate:zones
summary: Zone Create
description: Creates a new DNS zone for the calling project.
operationId: zone_create_api_v1_zones__post
security:
- SwaggerLogin: []
- ApiKeyAuth: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ZoneCreate'
responses:
'201':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/RetrieveZoneOut'
'400':
description: Bad Request
content:
application/json:
example:
success: false
message: Bad Request
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
'401':
description: Unauthorized
content:
application/json:
example:
success: false
message: Unauthorized | Invalid token | Expired token | Authentication required
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
'403':
description: Forbidden
content:
application/json:
example:
success: false
message: Forbidden
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
'409':
description: Conflict
content:
application/json:
example:
success: false
message: Conflict
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
'422':
description: Validation error
content:
application/json:
example:
success: false
errors:
field:
- Invalid value
schema:
$ref: '#/components/schemas/ResponseValidationErrorOut'
'429':
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before retrying the request
schema:
type: string
example: '30'
content:
application/json:
example:
code: 429
message: Too many requests
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
'500':
description: Internal Server Error
content:
application/json:
example:
success: false
message: Internal Server Error
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
get:
tags:
- v1:designate:zones
summary: Zones List
description: Lists DNS zones accessible to the calling project.
operationId: zones_list_api_v1_zones__get
security:
- SwaggerLogin: []
- ApiKeyAuth: []
parameters:
- name: name
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Name
- name: email
in: query
required: false
schema:
anyOf:
- type: string
format: email
- type: 'null'
title: Email
- name: status
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Status
- name: description
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Description
- name: ttl
in: query
required: false
schema:
anyOf:
- type: integer
- type: 'null'
title: Ttl
- name: limit
in: query
required: false
schema:
anyOf:
- type: integer
- type: 'null'
title: Limit
- name: marker
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Marker
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ListZonesOut'
'400':
description: Bad Request
content:
application/json:
example:
success: false
message: Bad Request
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
'401':
description: Unauthorized
content:
application/json:
example:
success: false
message: Unauthorized | Invalid token | Expired token | Authentication required
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
'403':
description: Forbidden
content:
application/json:
example:
success: false
message: Forbidden
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
'422':
description: Validation error
content:
application/json:
example:
success: false
errors:
field:
- Invalid value
schema:
$ref: '#/components/schemas/ResponseValidationErrorOut'
'429':
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before retrying the request
schema:
type: string
example: '30'
content:
application/json:
example:
code: 429
message: Too many requests
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
'500':
description: Internal Server Error
content:
application/json:
example:
success: false
message: Internal Server Error
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
/api/v1/zones/artifacts:
get:
tags:
- v1:designate:zones
summary: Get Zones Create Artifacts
description: Returns the DNS zone domain artifacts available for zone creation.
operationId: get_zones_create_artifacts_api_v1_zones_artifacts_get
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ZoneArtifactsOut'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
example:
success: false
message: Unauthorized | Invalid token | Expired token | Authentication required
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
example:
success: false
message: Forbidden
'429':
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before retrying the request
schema:
type: string
example: '30'
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
example:
code: 429
message: Too many requests
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
example:
success: false
message: Internal Server Error
security:
- SwaggerLogin: []
- ApiKeyAuth: []
/api/v1/zones/{zone_id}:
get:
tags:
- v1:designate:zones
summary: Zone Retrieve
description: Retrieves a single DNS zone by its identifier.
operationId: zone_retrieve_api_v1_zones__zone_id__get
security:
- SwaggerLogin: []
- ApiKeyAuth: []
parameters:
- name: zone_id
in: path
required: true
schema:
type: string
format: uuid
title: Zone Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/RetrieveZoneOut'
'400':
description: Bad Request
content:
application/json:
example:
success: false
message: Bad Request
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
'401':
description: Unauthorized
content:
application/json:
example:
success: false
message: Unauthorized | Invalid token | Expired token | Authentication required
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
'403':
description: Forbidden
content:
application/json:
example:
success: false
message: Forbidden
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
'404':
description: Not Found
content:
application/json:
example:
success: false
message: Not Found
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
'422':
description: Validation error
content:
application/json:
example:
success: false
errors:
field:
- Invalid value
schema:
$ref: '#/components/schemas/ResponseValidationErrorOut'
'429':
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before retrying the request
schema:
type: string
example: '30'
content:
application/json:
example:
code: 429
message: Too many requests
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
'500':
description: Internal Server Error
content:
application/json:
example:
success: false
message: Internal Server Error
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
put:
tags:
- v1:designate:zones
summary: Zone Update
description: Updates the editable attributes of a DNS zone.
operationId: zone_update_api_v1_zones__zone_id__put
security:
- SwaggerLogin: []
- ApiKeyAuth: []
parameters:
- name: zone_id
in: path
required: true
schema:
type: string
format: uuid
title: Zone Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ZoneUpdate'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/RetrieveZoneOut'
'400':
description: Bad Request
content:
application/json:
example:
success: false
message: Bad Request
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
'401':
description: Unauthorized
content:
application/json:
example:
success: false
message: Unauthorized | Invalid token | Expired token | Authentication required
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
'403':
description: Forbidden
content:
application/json:
example:
success: false
message: Forbidden
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
'404':
description: Not Found
content:
application/json:
example:
success: false
message: Not Found
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
'409':
description: Conflict
content:
application/json:
example:
success: false
message: Conflict
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
'422':
description: Validation error
content:
application/json:
example:
success: false
errors:
field:
- Invalid value
schema:
$ref: '#/components/schemas/ResponseValidationErrorOut'
'429':
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before retrying the request
schema:
type: string
example: '30'
content:
application/json:
example:
code: 429
message: Too many requests
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
'500':
description: Internal Server Error
content:
application/json:
example:
success: false
message: Internal Server Error
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
delete:
tags:
- v1:designate:zones
summary: Zone Delete
description: Deletes a DNS zone, optionally removing its shares first.
operationId: zone_delete_api_v1_zones__zone_id__delete
security:
- SwaggerLogin: []
- ApiKeyAuth: []
parameters:
- name: zone_id
in: path
required: true
schema:
type: string
format: uuid
title: Zone Id
- name: delete_shares
in: query
required: false
schema:
type: boolean
description: Delete all zone shares before deleting the zone
default: false
title: Delete Shares
description: Delete all zone shares before deleting the zone
responses:
'204':
description: Successful Response
'400':
description: Bad Request
content:
application/json:
example:
success: false
message: Bad Request
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
'401':
description: Unauthorized
content:
application/json:
example:
success: false
message: Unauthorized | Invalid token | Expired token | Authentication required
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
'403':
description: Forbidden
content:
application/json:
example:
success: false
message: Forbidden
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
'404':
description: Not Found
content:
application/json:
example:
success: false
message: Not Found
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
'409':
description: Conflict
content:
application/json:
example:
success: false
message: Conflict
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
'429':
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before retrying the request
schema:
type: string
example: '30'
content:
application/json:
example:
code: 429
message: Too many requests
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
'500':
description: Internal Server Error
content:
application/json:
example:
success: false
message: Internal Server Error
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
ZoneArtifactsOut:
properties:
success:
type: boolean
title: Success
default: true
data:
additionalProperties:
type: string
type: object
title: Data
type: object
required:
- data
title: ZoneArtifactsOut
RetrieveZoneOut:
properties:
success:
type: boolean
title: Success
default: true
data:
$ref: '#/components/schemas/ZoneOut'
type: object
required:
- data
title: RetrieveZoneOut
ZoneCreate:
properties:
admin_domain:
anyOf:
- type: string
- type: 'null'
title: Admin Domain
admin_project:
anyOf:
- type: string
- type: 'null'
title: Admin Project
name:
type: string
maxLength: 255
minLength: 1
title: Name
description: Zone FQDN, e.g. example.com.
email:
type: string
maxLength: 255
minLength: 1
format: email
title: Email
description: DNS admin email
ttl:
anyOf:
- type: integer
minimum: 1.0
- type: 'null'
title: Ttl
description: Default TTL for the zone
default: 3600
description:
anyOf:
- type: string
maxLength: 255
minLength: 1
- type: 'null'
title: Description
type:
anyOf:
- $ref: '#/components/schemas/ZoneType'
- type: 'null'
description: PRIMARY or SECONDARY
default: PRIMARY
masters:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Masters
description: Masters for SECONDARY zones
attributes:
anyOf:
- additionalProperties:
type: string
type: object
- type: 'null'
title: Attributes
type: object
required:
- name
- email
title: ZoneCreate
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
ZoneUpdate:
properties:
admin_domain:
anyOf:
- type: string
- type: 'null'
title: Admin Domain
admin_project:
anyOf:
- type: string
- type: 'null'
title: Admin Project
email:
anyOf:
- type: string
maxLength: 255
minLength: 1
format: email
- type: 'null'
title: Email
description:
anyOf:
- type: string
maxLength: 255
minLength: 1
- type: 'null'
title: Description
ttl:
anyOf:
- type: integer
minimum: 1.0
- type: 'null'
title: Ttl
type: object
title: ZoneUpdate
ResponseBaseErrorOut:
properties:
success:
type: boolean
title: Success
default: false
message:
type: string
title: Message
type: object
required:
- message
title: ResponseBaseErrorOut
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
type: object
required:
- loc
- msg
- type
title: ValidationError
ZoneType:
type: string
enum:
- PRIMARY
- SECONDARY
title: ZoneType
ResponseValidationErrorOut:
properties:
success:
type: boolean
title: Success
default: false
errors:
additionalProperties:
items:
type: string
type: array
type: object
title: Errors
type: object
required:
- errors
title: ResponseValidationErrorOut
ListZonesOut:
properties:
success:
type: boolean
title: Success
default: true
data:
items:
$ref: '#/components/schemas/ZoneOut'
type: array
title: Data
type: object
required:
- data
title: ListZonesOut
ZoneOut:
properties:
id:
anyOf:
- type: string
- type: 'null'
title: Id
description: Unique ID for the zone
pool_id:
anyOf:
- type: string
- type: 'null'
title: Pool Id
description: Pool ID for the zone
project_id:
anyOf:
- type: string
- type: 'null'
title: Project Id
description: Project ID for the zone
name:
anyOf:
- type: string
- type: 'null'
title: Name
description: Name of the zone
email:
anyOf:
- type: string
- type: 'null'
title: Email
description: Email address of the zone
ttl:
anyOf:
- type: integer
- type: 'null'
title: Ttl
description: TTL for the zone
serial:
anyOf:
- type: integer
- type: 'null'
title: Serial
description: Serial number of the zone
status:
anyOf:
- type: string
- type: 'null'
title: Status
description: The status of the resource
active:
anyOf:
- type: boolean
- type: 'null'
title: Active
description: Current action in progress on the resource
description:
anyOf:
- type: string
- type: 'null'
title: Description
description: Description of the zone
masters:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Masters
description: Masters for SECONDARY zones
type:
anyOf:
- type: string
- type: 'null'
title: Type
description: Type of the zone
transfered_at:
anyOf:
- type: string
- type: 'null'
title: Transfered At
description: For secondary zones. The last time an update was retrieved from the master servers
version:
anyOf:
- type: integer
- type: 'null'
title: Version
description: Version of the zone
created_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Created At
description: Date and time the zone was created
updated_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Updated At
description: Date and time the zone was last updated
shared:
anyOf:
- type: boolean
- type: 'null'
title: Shared
description: Whether or not the zone is shared
type: object
title: ZoneOut
securitySchemes:
HTTPBearer:
type: http
scheme: bearer
APIKeyHeader:
type: apiKey
in: header
name: X-API-Key
SwaggerLogin:
type: oauth2
flows:
password:
tokenUrl: /api/v1/account/login_swagger
scopes: {}
ApiKeyAuth:
type: apiKey
in: header
name: X-API-Key
description: API Key format - base64('<id>:<secret>')