listDnsDomainRecords
List Records
Details
- Method:
GET - Path:
/domains/{dns-domain}/records - Operation ID:
list-dns-domain-records
Parameters
{
"per_page": {
"description": "Number of items requested per page. Default is 100 and Max is 500.",
"required": false,
"location": "query",
"type": "integer"
},
"cursor": {
"description": "Cursor for paging. See [Meta and Pagination](#section/Introduction/Meta-and-Pagination).",
"required": false,
"location": "query",
"type": "string"
}
}Response Schema
{
"type": "object",
"properties": {
"records": {
"type": "array",
"items": {
"title": "dns-record",
"type": "object",
"x-tags": [
"dns"
],
"description": "DNS Record information.",
"x-examples": {
"dns-record": {
"id": "cb676a46-66fd-4dfb-b839-443f2e6c0b60",
"type": "A",
"name": "foo.example.com",
"data": "192.0.2.123",
"priority": 0,
"ttl": 300
}
},
"properties": {
"id": {
"description": "A unique ID for the DNS Record.",
"type": "string"
},
"type": {
"type": "string",
"description": "The DNS record type.\n\n* A\n* AAAA\n* CNAME\n* NS\n* MX\n* SRV\n* TXT\n* CAA\n* SSHFP"
},
"name": {
"type": "string",
"description": "The hostname for this DNS record."
},
"data": {
"type": "string",
"description": "The DNS data for this record type."
},
"priority": {
"type": "integer",
"description": "DNS priority. Does not apply to all record types."
},
"ttl": {
"type": "integer",
"description": "Time to Live in seconds."
}
}
}
},
"meta": {
"title": "meta",
"type": "object",
"x-examples": {
"meta response": {
"meta": {
"total": 31,
"links": {
"next": "WxYzExampleNext",
"prev": ""
}
}
}
},
"description": "The meta information object. See [Meta and Pagination](#section/Introduction/Meta-and-Pagination) for more information.",
"properties": {
"total": {
"type": "integer",
"description": "Total objects available in the list. This value may be greater than the number of objects returned if `per_page` is set."
},
"links": {
"type": "object",
"description": "Cursor values for pagination.",
"properties": {
"next": {
"type": "string",
"description": "Cursor value for the next page."
},
"prev": {
"type": "string",
"description": "Cursor value for the previous page."
}
}
}
}
}
}
}Usage
from ocp_agent import OCPAgent
agent = OCPAgent()
await agent.register_api('vultr')
# Call this tool
result = await agent.call_tool('listDnsDomainRecords', {
# Add required parameters here
})