Logo
Akamai APIs API Documentation

Get a version's record sets

GET https://{{host}}/config-dns/v2/zones/:zone/versions/:uuid/recordsets

Lists all record sets for this zone. It works only for PRIMARY and SECONDARY zones. This operation paginates.

 

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) Display only record sets whose RDATA field matches this value. The entire record set - all records with the same name and type - displays if any record in the set has RDATA that matches the supplied value.
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.11", "192.0.2.24" ], "ttl": 300, "type": "A" }, { "name": "mail.example.com", "rdata": [ "192.0.2.245", "192.0.2.117" ], "ttl": 300, "type": "A" } ] }



Curl
curl -X GET 'https://undefined/config-dns/v2/zones/:zone/versions/:uuid/recordsets?sortBy=&types=&search=&page=&pageSize=&showAll=&accountSwitchKey=' -H 'Accept: application/json'

ENDPOINTS