Akamai APIs API Documentation
List record sets for a change list
GET https://{{host}}/config-dns/v2/changelists/:zone/recordsets
Retrieves the current list of record sets based on the selected change list. The record sets returned reflect any Changes added to this change list. This call works even if the change list is stale. This operation is (paginated](ref:use-pagination).
Body
PARAM
| Key | Datatype | Required | Description |
sortBy
|
string | (Optional) Sorts the list on the specified fields. You can specify multiple fields as a comma-separated list. Placing a dash before a field name sorts it in descending order. Allowed fields include `name` and `type`. | |
types
|
string | (Optional) Displays only record sets that match one of the provided types. Specifies multiple fields as a comma-separated list. Ignores illegal or disallowed record types. | |
search
|
string | (Optional) Displays only record sets whose NAME or RDATA field matches this value. The entire record set - all records with the same name and type - appears if any record in the set has a NAME or RDATA that matches the value case-insensitively. | |
page
|
string | (Optional) Which page of results to return. The first page is page `1`, the default value. | |
pageSize
|
string | (Optional) The number of results per page to return, `25` by default. | |
showAll
|
string | (Optional) Disables paging and sorting and shows the entire list all at once, `false` by default. Using this parameter may significantly increase the response time. | |
accountSwitchKey
|
string | (Optional) For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys). |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"metadata": {
"page": 1,
"pageSize": 25,
"totalElements": 2,
"types": [
"A"
],
"zone": "example.com"
},
"recordsets": [
{
"name": "www.example.com",
"rdata": [
"192.0.2.55",
"192.0.2.127"
],
"state": "PRISTINE",
"ttl": 300,
"type": "A"
},
{
"name": "mail.example.com",
"rdata": [
"192.0.2.13",
"192.0.2.129"
],
"state": "DELETED",
"ttl": 300,
"type": "A"
}
]
} |
Curl
curl -X GET 'https://undefined/config-dns/v2/changelists/:zone/recordsets?sortBy=&types=&search=&page=&pageSize=&showAll=&accountSwitchKey=' -H 'Accept: application/json'
ENDPOINTS