---
title: "Retrieve RecordCNAME objects."
method: GET
path: "/record:cname"
tags: ["record:cname"]
---

# Retrieve RecordCNAME objects.

`GET /record:cname`

## Request

- Base URL: `https://csp.infoblox.com/wapi/v3`
- URL: `https://csp.infoblox.com/wapi/v3/record:cname`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/infoblox/apis/dns-data-web-api/docs/record:cname/get.ts> (a function with typed inputs; its response is checked against the schema)

Use this method to retrieve __RecordCNAME__ objects.

## Query parameters

- `paging` string
- `options` string

## Response `200`

GET operation response

- V3ListRecordCNAMEResponse: The response format to retrieve __RecordCNAME__ objects.
  - `next_page_id` string: If there was a paging request, this is the paging token for the next page of results. This field is only set when paging is enabled and there are more results to retrieve.
  - `result` V3RecordCNAME[]: List of RecordCNAME objects.
    - `canonical` string, required: The canonical name (target) in FQDN format. This is the true name that the alias points to.
    - `comment` string: Comment for the RecordCNAME; maximum 1024 characters.
    - `creator` string: Creator for the RecordCNAME. Note that changing creator from or to 'SYSTEM' value is not allowed.
    - `disable` boolean: Determines if the RecordCNAME is disabled or not. False means that the RecordCNAME is enabled.
    - `name` string, required: Name for the RecordCNAME (alias) in FQDN format. This value can be in unicode format.
    - `ref` string: infoblox.ddi.wapi.objectref
    - `tags` object: The tags for the RecordCNAME in JSON format.
    - `ttl` integer: The Time To Live (TTL) value for record. A 32-bit unsigned integer that represents the duration, in seconds, for which the RecordCNAME is valid (cached). Zero indicates that the RecordCNAME should not be cached.
    - `use_ttl` boolean: Use flag for: _ttl_. If set to _true_, the TTL value is used for the record. If set to _false_, the TTL value is inherited from the zone.
    - `view` string: The name of the DNS view in which the RecordCNAME resides. Example: "external".
    - `zone` string: The name of the zone in which the RecordCNAME resides. Example: "zone.com". If a view is not specified when searching by zone, the default view is used.

---

[API](https://skmtc.dev/infoblox/apis/dns-data-web-api.md) - [All operations](https://skmtc.dev/infoblox/apis/dns-data-web-api/llms.txt) - [OpenAPI document](https://skmtc.dev/infoblox/apis/dns-data-web-api/revisions/b4b272e5590c?raw)
