hnhdigital-os/php-linode-api

View on GitHub
spec-old/Domain/Record.yml

Summary

Maintainability
Test Coverage
endpoint: domains/%s/records/%s
description: Manage a particular Domain Record your account may access.
url: https://developers.linode.com/v4/reference/endpoints/domains/$id/records/$id
load-method: get

parameters:

    domain_id:
      type: int

    record_id:
      type: int

get:

  get:
    description: Returns information for the Domain Record identified by ":id".
    url: https://developers.linode.com/v4/reference/endpoints/domains/$id/records/$id#GET
    endpoint: 

put:

  update:
    description: Modifies a given Domain Record.
    url: https://developers.linode.com/v4/reference/endpoints/domains/$id/records/$id#PUT
    endpoint: 
    attributes: true

    optional:

      type:
        type: string
        description: Type of record. Can be one of "A", "AAAA", "NS", "MX", "CNAME", "TXT", "SRV", "PTR", or "CAA".

      name:
        type: string
        description: The hostname or FQDN. When type=MX the subdomain to delegate to the Target MX server.

      target:
        type: string
        description: When Type=MX the hostname. When Type=CNAME the target of the alias. When Type=TXT or CAA the value of the record. When Type=A or AAAA the token of '[remote_addr]' will be substituted with the IP address of the request.
      
      priority:
        type: int
        description: Priority for MX and SRV records.
      
      weight:
        type: int
        description: A relative weight for records with the same priority, higher value means more preferred.
      
      port:
        type: int
        description: The TCP or UDP port on which the service is to be found.
      
      service:
        type: string
        description: The service to append to an SRV record.
      
      protocol:
        type: string
        description: The protocol to append to an SRV record.
      
      tag:
        type: string
        description: The tag attribute for a CAA record. One of "issue", "issuewild", or "iodef". Ignored on other record types.
      
      ttl:
        type: integer
        description: Time interval that the resource record may be cached before it should be discarded. In seconds. Leave as 0 to accept our default.


delete:

  delete:
    description: Deletes the Domain Record. This action cannot be undone.
    url: https://developers.linode.com/v4/reference/endpoints/domains/$id/records/$id#DELETE
    endpoint: