Retrieve an Existing Domain Record

v1.0.0

To retrieve a specific domain record, send a GET request to /v2/domains/$DOMAIN_NAME/records/$RECORD_ID.

Input

{
  "type": "object",
  "properties": {
    "domain_name": {
      "type": "string"
    },
    "domain_record_id": {
      "type": "integer"
    }
  },
  "required": [
    "domain_name",
    "domain_record_id"
  ],
  "additionalProperties": false
}

Output

{
  "properties": {
    "domain_record": {
      "type": "object",
      "required": [
        "type"
      ],
      "properties": {
        "data": {
          "type": "string",
          "description": "Variable data depending on record type. For example, the \"data\" value for an A record would be the IPv4 address to which the domain will be mapped. For a CAA record, it would contain the domain name of the CA being granted permission to issue certificates."
        },
        "flags": {
          "type": "integer",
          "description": "An unsigned integer between 0-255 used for CAA records."
        },
        "id": {
          "type": "integer",
          "description": "A unique identifier for each domain record."
        },
        "name": {
          "type": "string",
          "description": "The host name, alias, or service being defined by the record."
        },
        "port": {
          "type": "integer",
          "description": "The port for SRV records."
        },
        "priority": {
          "type": "integer",
          "description": "The priority for SRV and MX records."
        },
        "tag": {
          "type": "string",
          "description": "The parameter tag for CAA records. Valid values are \"issue\", \"issuewild\", or \"iodef\""
        },
        "ttl": {
          "type": "integer",
          "description": "This value is the time to live for the record, in seconds. This defines the time frame that clients can cache queried information before a refresh should be requested."
        },
        "type": {
          "type": "string",
          "description": "The type of the DNS record. For example: A, CNAME, TXT, ..."
        },
        "weight": {
          "type": "integer",
          "description": "The weight for SRV records."
        }
      }
    }
  }
}