NimbusNexus V1:designate:record Set API
The v1:designate:record_set API from NimbusNexus — 3 operation(s) for v1:designate:record_set.
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-record-set-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:record Set 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:record_set
paths:
/api/v1/zones/{zone_id}/recordsets/:
post:
tags:
- v1:designate:record_set
summary: Create Recordset
description: Creates a new recordset within the specified DNS zone.
operationId: create_recordset_api_v1_zones__zone_id__recordsets__post
security:
- SwaggerLogin: []
- ApiKeyAuth: []
parameters:
- name: zone_id
in: path
required: true
schema:
type: string
pattern: ^[a-fA-F\d]{8}(?:\-[a-fA-F\d]{4}){3}\-[a-fA-F\d]{12}$
description: Parent zone ID
title: Zone Id
description: Parent zone ID
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/RecordSetCreate'
responses:
'201':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/RecordSetSuccessOutSingle'
'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'
get:
tags:
- v1:designate:record_set
summary: List Zone Recordsets
description: Lists the recordsets contained in the specified DNS zone.
operationId: list_zone_recordsets_api_v1_zones__zone_id__recordsets__get
security:
- SwaggerLogin: []
- ApiKeyAuth: []
parameters:
- name: zone_id
in: path
required: true
schema:
type: string
pattern: ^[a-fA-F\d]{8}(?:\-[a-fA-F\d]{4}){3}\-[a-fA-F\d]{12}$
description: Parent zone ID
title: Zone Id
description: Parent zone ID
- 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
- name: sort_dir
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Sort Dir
- name: sort_key
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Sort Key
- name: name
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Name
- name: type
in: query
required: false
schema:
anyOf:
- enum:
- A
- AAAA
- MX
- CNAME
- TXT
- NS
- SOA
- SPF
- SRV
- PTR
- CAA
- SSHFP
- NAPTR
type: string
- type: 'null'
title: Type
- name: ttl
in: query
required: false
schema:
anyOf:
- type: integer
minimum: 0
- type: 'null'
title: Ttl
- 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
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/RecordSetSuccessOutList'
'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'
/api/v1/zones/{zone_id}/recordsets/{recordset_id}:
get:
tags:
- v1:designate:record_set
summary: Get Recordset
description: Retrieves a single recordset by zone and recordset identifiers.
operationId: get_recordset_api_v1_zones__zone_id__recordsets__recordset_id__get
security:
- SwaggerLogin: []
- ApiKeyAuth: []
parameters:
- name: zone_id
in: path
required: true
schema:
type: string
pattern: ^[a-fA-F\d]{8}(?:\-[a-fA-F\d]{4}){3}\-[a-fA-F\d]{12}$
description: Parent zone ID
title: Zone Id
description: Parent zone ID
- name: recordset_id
in: path
required: true
schema:
type: string
pattern: ^[a-fA-F\d]{8}(?:\-[a-fA-F\d]{4}){3}\-[a-fA-F\d]{12}$
description: Recordset ID
title: Recordset Id
description: Recordset ID
- name: admin_domain
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Admin Domain
- name: admin_project
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Admin Project
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/RecordSetSuccessOutSingle'
'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:record_set
summary: Update Recordset
description: Updates the records or attributes of an existing recordset.
operationId: update_recordset_api_v1_zones__zone_id__recordsets__recordset_id__put
security:
- SwaggerLogin: []
- ApiKeyAuth: []
parameters:
- name: recordset_id
in: path
required: true
schema:
type: string
pattern: ^[a-fA-F\d]{8}(?:\-[a-fA-F\d]{4}){3}\-[a-fA-F\d]{12}$
description: Recordset ID
title: Recordset Id
description: Recordset ID
- name: zone_id
in: path
required: true
schema:
type: string
pattern: ^[a-fA-F\d]{8}(?:\-[a-fA-F\d]{4}){3}\-[a-fA-F\d]{12}$
description: Parent zone ID
title: Zone Id
description: Parent zone ID
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/RecordSetUpdate'
responses:
'202':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/RecordSetSuccessOutSingle'
'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:record_set
summary: Delete Recordset
description: Deletes a recordset from the specified DNS zone.
operationId: delete_recordset_api_v1_zones__zone_id__recordsets__recordset_id__delete
security:
- SwaggerLogin: []
- ApiKeyAuth: []
parameters:
- name: recordset_id
in: path
required: true
schema:
type: string
pattern: ^[a-fA-F\d]{8}(?:\-[a-fA-F\d]{4}){3}\-[a-fA-F\d]{12}$
description: Recordset ID
title: Recordset Id
description: Recordset ID
- name: zone_id
in: path
required: true
schema:
type: string
pattern: ^[a-fA-F\d]{8}(?:\-[a-fA-F\d]{4}){3}\-[a-fA-F\d]{12}$
description: Parent zone ID
title: Zone Id
description: Parent zone ID
- name: admin_domain
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Admin Domain
- name: admin_project
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Admin Project
responses:
'202':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/RecordSetSuccessOutSingle'
'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'
/api/v1/recordsets/:
get:
tags:
- v1:designate:record_set
summary: List All Recordsets
description: Lists all DNS recordsets owned by the calling project across zones.
operationId: list_all_recordsets_api_v1_recordsets__get
security:
- SwaggerLogin: []
- ApiKeyAuth: []
parameters:
- 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
- name: sort_dir
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Sort Dir
- name: sort_key
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Sort Key
- name: name
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Name
- name: type
in: query
required: false
schema:
anyOf:
- enum:
- A
- AAAA
- MX
- CNAME
- TXT
- NS
- SOA
- SPF
- SRV
- PTR
- CAA
- SSHFP
- NAPTR
type: string
- type: 'null'
title: Type
- name: ttl
in: query
required: false
schema:
anyOf:
- type: integer
minimum: 0
- type: 'null'
title: Ttl
- 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: data
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Data
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/RecordSetSuccessOutList'
'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'
components:
schemas:
RecordSetSuccessOutList:
properties:
success:
type: boolean
title: Success
default: true
data:
items:
$ref: '#/components/schemas/RecordSetOut'
type: array
title: Data
type: object
required:
- data
title: RecordSetSuccessOutList
RecordSetOut:
properties:
id:
anyOf:
- type: string
- type: 'null'
title: Id
description: Unique ID for the recordset
zone_id:
anyOf:
- type: string
- type: 'null'
title: Zone Id
description: Unique ID for the zone
project_id:
anyOf:
- type: string
- type: 'null'
title: Project Id
description: Unique ID for the project
name:
anyOf:
- type: string
- type: 'null'
title: Name
description: Name of recordset
zone_name:
anyOf:
- type: string
- type: 'null'
title: Zone Name
description: Name of zone
type:
anyOf:
- type: string
enum:
- A
- AAAA
- MX
- CNAME
- TXT
- NS
- SOA
- SPF
- SRV
- PTR
- CAA
- SSHFP
- NAPTR
- type: 'null'
title: Type
description: RRTYPE of recordset
records:
items:
type: string
type: array
title: Records
description: List of records
description:
anyOf:
- type: string
- type: 'null'
title: Description
description: Human-readable description
ttl:
anyOf:
- type: integer
- type: 'null'
title: Ttl
description: TTL for the recordset
status:
anyOf:
- type: string
- type: 'null'
title: Status
description: The status of the resource.
action:
anyOf:
- type: string
- type: 'null'
title: Action
description: Current action in progress on the resource
version:
anyOf:
- type: integer
- type: 'null'
title: Version
description: Version of the resource
created_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Created At
description: Date / Time when resource was created
updated_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Updated At
description: Date / Time when resource last updated
links:
anyOf:
- additionalProperties:
type: string
type: object
- type: 'null'
title: Links
description: Links to this recordset
type: object
required:
- records
title: RecordSetOut
ResponseBaseErrorOut:
properties:
success:
type: boolean
title: Success
default: false
message:
type: string
title: Message
type: object
required:
- message
title: ResponseBaseErrorOut
RecordSetUpdate:
properties:
ttl:
anyOf:
- type: integer
minimum: 0.0
- type: 'null'
title: Ttl
description:
anyOf:
- type: string
- type: 'null'
title: Description
records:
anyOf:
- items:
type: string
type: array
minItems: 1
- type: 'null'
title: Records
description: List of RR data strings
additionalProperties: false
type: object
title: RecordSetUpdate
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
RecordSetCreate:
properties:
name:
type: string
title: Name
description: RecordSet name (relative or FQDN)
type:
type: string
enum:
- A
- AAAA
- MX
- CNAME
- TXT
- NS
- SOA
- SPF
- SRV
- PTR
- CAA
- SSHFP
- NAPTR
title: Type
records:
items:
type: string
type: array
minItems: 1
title: Records
description: List of RR data strings
ttl:
anyOf:
- type: integer
- type: 'null'
title: Ttl
description: TTL for the recordset
description:
anyOf:
- type: string
- type: 'null'
title: Description
description: Human-readable description
type: object
required:
- name
- type
- records
title: RecordSetCreate
RecordSetSuccessOutSingle:
properties:
success:
type: boolean
title: Success
default: true
data:
$ref: '#/components/schemas/RecordSetOut'
type: object
required:
- data
title: RecordSetSuccessOutSingle
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>')