Yay.com loading

Loading

  • My Shopping Cart (0) £0.00

  • Register

Domain Management

API Access

Build custom apps using our JSON API

FREE
Get your free API Key

Domain Names

Commands to create, renew and update domain names.

Get your free API Key

Filter:

  • All
  • GET
  • POST
  • PUT
  • DELETE
  • DELETE
  • Chargeable *

* You will be charged every time this command is run.

  • GET/dom/domain/{uuid}

    Gets a specific domain name on an account

    Back to top

    Request Details

    Response Details

    Request Details

    URL and Query String Parameters

    • Name

    • Type

    • Required

      • uuid

      • String

      • True

      The UUID of the domain to query

    Response Details

    200 Response

    {
        "result" : {
            "registry_object_id" : "COM-12345-X",
            "domain_name" : "example",
            "domain_name_complete" : "example.com",
            "auto_renew" : true,
            "nameserver_group" : "5f925d9c-6d98-463b-924b-4096465665bd",
            "has_privacy" : true,
            "auth_code" : "auth-code-1",
            "expires_on" : "2018-09-01",
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
            "created_on" : "2017-12-14",
            "updated_on" : "2017-12-14"
        },
        "status_code" : 200,
        "status_message" : "OK"
    }

    400 Response

    {
        "result" : {},
        "status_code" : 400,
        "status_message" : "Bad Request"
    }

    404 Response

    {
        "result" : {},
        "status_code" : 404,
        "status_message" : "Not Found"
    }
  • GET/dom/domain

    Gets all domain names on an account

    Back to top

    Request Details

    Response Details

    Request Details

    This command has no URL/Query String parameters

    Response Details

    200 Response

    {
        "result" : [
            {
                "registry_object_id" : "COM-12345-X",
                "domain_name" : "example",
                "domain_name_complete" : "example.com",
                "auto_renew" : true,
                "nameserver_group" : "5f925d9c-6d98-463b-924b-4096465665bd",
                "has_privacy" : true,
                "auth_code" : "auth-code-1",
                "expires_on" : "2018-09-01",
                "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
                "created_on" : "2017-12-14",
                "updated_on" : "2017-12-14"
            }
        ],
        "status_code" : 200,
        "status_message" : "OK"
    }
  • Chargeable *

    POST/dom/domain

    Create a new domain name

    Back to top

    Request Details

    Response Details

    Request Details

    This command has no URL/Query String parameters

    POST body

    • Name

    • Type

    • Required

      • auto_renew

      • boolean

      • True

      Should this domain be automatically renewed at the end of its current registraiton period

      • contacts

      • Map of String

      • True

      A list of contacts to apply to the domain

      • domain_name

      • String

      • True

      The domain name, including TLD

      • group_uuid

      • String

      • True

      The UUID of the name server group assigned to this domain

      • has_privacy

      • boolean

      • True

      Indicates if the domain has privacy applied to it or not

      • nameservers

      • Array of String

      • True

      A list of name servers that are current applied to the domain

      • period

      • int

      • True

      The period to register or renew the domain for

      • status

      • Array of String

      • True

      A list of status to apply for the domain

    JSON all-fields example:

    {
        "domain_name" : "example.com",
        "status" : [
            "clientUpdateProhibited",
            "clientTransferProhibited",
            "clientDeleteProhibited"
        ],
        "contacts" : {
            "registrant" : "4fb1d77a-8598-4fd3-a442-664c9aae7a74",
            "admin" : "82607d4a-4b61-46f3-88ba-1f8ea38c9ea3"
        },
        "auto_renew" : true,
        "group_uuid" : "7aca94f2-97f0-4f30-8ed3-32901782a0c4",
        "nameservers" : [
            "ns1.example.com",
            "ns2.example.com"
        ],
        "has_privacy" : true,
        "period" : 1
    }

    Response Details

    201 Response

    {
        "result" : {
            "registry_object_id" : "COM-12345-X",
            "domain_name" : "example",
            "domain_name_complete" : "example.com",
            "auto_renew" : true,
            "nameserver_group" : "5f925d9c-6d98-463b-924b-4096465665bd",
            "has_privacy" : true,
            "auth_code" : "auth-code-1",
            "expires_on" : "2018-09-01",
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
            "created_on" : "2017-12-14"
        },
        "status_code" : 201,
        "status_message" : "Created"
    }

    400 Response

    {
        "result" : {},
        "status_code" : 400,
        "status_message" : "Bad Request"
    }

    402 Response

    {
        "result" : {},
        "status_code" : 402,
        "status_message" : "Payment Required"
    }

    404 Response

    {
        "result" : {},
        "status_code" : 404,
        "status_message" : "Not Found"
    }
  • Chargeable *

    POST/dom/domain/{uuid}/renew

    Renews the specified domain name

    Back to top

    Request Details

    Response Details

    Request Details

    URL and Query String Parameters

    • Name

    • Type

    • Required

      • uuid

      • String

      • True

      The UUID of the domain to be renewed

    POST body

    • Name

    • Type

    • Required

      • auto_renew

      • boolean

      • True

      Should this domain be automatically renewed at the end of its current registraiton period

      • contacts

      • Map of String

      • True

      A list of contacts to apply to the domain

      • domain_name

      • String

      • True

      The domain name, including TLD

      • group_uuid

      • String

      • True

      The UUID of the name server group assigned to this domain

      • has_privacy

      • boolean

      • True

      Indicates if the domain has privacy applied to it or not

      • nameservers

      • Array of String

      • True

      A list of name servers that are current applied to the domain

      • period

      • int

      • True

      The period to register or renew the domain for

      • status

      • Array of String

      • True

      A list of status to apply for the domain

    JSON all-fields example:

    {
        "domain_name" : "example.com",
        "status" : [
            "clientUpdateProhibited",
            "clientTransferProhibited",
            "clientDeleteProhibited"
        ],
        "contacts" : {
            "registrant" : "4fb1d77a-8598-4fd3-a442-664c9aae7a74",
            "admin" : "82607d4a-4b61-46f3-88ba-1f8ea38c9ea3"
        },
        "auto_renew" : true,
        "group_uuid" : "7aca94f2-97f0-4f30-8ed3-32901782a0c4",
        "nameservers" : [
            "ns1.example.com",
            "ns2.example.com"
        ],
        "has_privacy" : true,
        "period" : 1
    }

    Response Details

    200 Response

    {
        "result" : {
            "registry_object_id" : "COM-12345-X",
            "domain_name" : "example",
            "domain_name_complete" : "example.com",
            "auto_renew" : true,
            "nameserver_group" : "5f925d9c-6d98-463b-924b-4096465665bd",
            "has_privacy" : true,
            "auth_code" : "auth-code-1",
            "expires_on" : "2018-09-01",
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
            "created_on" : "2017-12-14"
        },
        "status_code" : 200,
        "status_message" : "OK"
    }

    400 Response

    {
        "result" : {},
        "status_code" : 400,
        "status_message" : "Bad Request"
    }

    402 Response

    {
        "result" : {},
        "status_code" : 402,
        "status_message" : "Payment Required"
    }

    404 Response

    {
        "result" : {},
        "status_code" : 404,
        "status_message" : "Not Found"
    }
  • PUT/dom/domain/{uuid}/status

    Updates the status on the specified domain name

    Back to top

    Request Details

    Response Details

    Request Details

    URL and Query String Parameters

    • Name

    • Type

    • Required

      • uuid

      • String

      • True

      The UUID of the domain to be updated

    PUT body

    • Name

    • Type

    • Required

      • auto_renew

      • boolean

      • True

      Should this domain be automatically renewed at the end of its current registraiton period

      • contacts

      • Map of String

      • True

      A list of contacts to apply to the domain

      • domain_name

      • String

      • True

      The domain name, including TLD

      • group_uuid

      • String

      • True

      The UUID of the name server group assigned to this domain

      • has_privacy

      • boolean

      • True

      Indicates if the domain has privacy applied to it or not

      • nameservers

      • Array of String

      • True

      A list of name servers that are current applied to the domain

      • period

      • int

      • True

      The period to register or renew the domain for

      • status

      • Array of String

      • True

      A list of status to apply for the domain

    JSON all-fields example:

    {
        "domain_name" : "example.com",
        "status" : [
            "clientUpdateProhibited",
            "clientTransferProhibited",
            "clientDeleteProhibited"
        ],
        "contacts" : {
            "registrant" : "4fb1d77a-8598-4fd3-a442-664c9aae7a74",
            "admin" : "82607d4a-4b61-46f3-88ba-1f8ea38c9ea3"
        },
        "auto_renew" : true,
        "group_uuid" : "7aca94f2-97f0-4f30-8ed3-32901782a0c4",
        "nameservers" : [
            "ns1.example.com",
            "ns2.example.com"
        ],
        "has_privacy" : true,
        "period" : 1
    }

    Response Details

    200 Response

    {
        "result" : {
            "registry_object_id" : "COM-12345-X",
            "domain_name" : "example",
            "domain_name_complete" : "example.com",
            "auto_renew" : true,
            "nameserver_group" : "5f925d9c-6d98-463b-924b-4096465665bd",
            "has_privacy" : true,
            "auth_code" : "auth-code-1",
            "expires_on" : "2018-09-01",
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
            "created_on" : "2017-12-14",
            "updated_on" : "2017-12-14"
        },
        "status_code" : 200,
        "status_message" : "OK"
    }

    400 Response

    {
        "result" : {},
        "status_code" : 400,
        "status_message" : "Bad Request"
    }

    404 Response

    {
        "result" : {},
        "status_code" : 404,
        "status_message" : "Not Found"
    }
  • PUT/dom/domain/{uuid}/privacy

    Updates the privacy on the specified domain name

    Back to top

    Request Details

    Response Details

    Request Details

    URL and Query String Parameters

    • Name

    • Type

    • Required

      • uuid

      • String

      • True

      The UUID of the domain to be updated

    PUT body

    • Name

    • Type

    • Required

      • auto_renew

      • boolean

      • True

      Should this domain be automatically renewed at the end of its current registraiton period

      • contacts

      • Map of String

      • True

      A list of contacts to apply to the domain

      • domain_name

      • String

      • True

      The domain name, including TLD

      • group_uuid

      • String

      • True

      The UUID of the name server group assigned to this domain

      • has_privacy

      • boolean

      • True

      Indicates if the domain has privacy applied to it or not

      • nameservers

      • Array of String

      • True

      A list of name servers that are current applied to the domain

      • period

      • int

      • True

      The period to register or renew the domain for

      • status

      • Array of String

      • True

      A list of status to apply for the domain

    JSON all-fields example:

    {
        "domain_name" : "example.com",
        "status" : [
            "clientUpdateProhibited",
            "clientTransferProhibited",
            "clientDeleteProhibited"
        ],
        "contacts" : {
            "registrant" : "4fb1d77a-8598-4fd3-a442-664c9aae7a74",
            "admin" : "82607d4a-4b61-46f3-88ba-1f8ea38c9ea3"
        },
        "auto_renew" : true,
        "group_uuid" : "7aca94f2-97f0-4f30-8ed3-32901782a0c4",
        "nameservers" : [
            "ns1.example.com",
            "ns2.example.com"
        ],
        "has_privacy" : true,
        "period" : 1
    }

    Response Details

    200 Response

    {
        "result" : {
            "registry_object_id" : "COM-12345-X",
            "domain_name" : "example",
            "domain_name_complete" : "example.com",
            "auto_renew" : true,
            "nameserver_group" : "5f925d9c-6d98-463b-924b-4096465665bd",
            "has_privacy" : true,
            "auth_code" : "auth-code-1",
            "expires_on" : "2018-09-01",
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
            "created_on" : "2017-12-14",
            "updated_on" : "2017-12-14"
        },
        "status_code" : 200,
        "status_message" : "OK"
    }

    400 Response

    {
        "result" : {},
        "status_code" : 400,
        "status_message" : "Bad Request"
    }

    404 Response

    {
        "result" : {},
        "status_code" : 404,
        "status_message" : "Not Found"
    }
  • PUT/dom/domain/{uuid}/contacts

    Updates the contacts on the specified domain name

    Back to top

    Request Details

    Response Details

    Request Details

    URL and Query String Parameters

    • Name

    • Type

    • Required

      • uuid

      • String

      • True

      The UUID of the domain to be updated

    PUT body

    • Name

    • Type

    • Required

      • auto_renew

      • boolean

      • True

      Should this domain be automatically renewed at the end of its current registraiton period

      • contacts

      • Map of String

      • True

      A list of contacts to apply to the domain

      • domain_name

      • String

      • True

      The domain name, including TLD

      • group_uuid

      • String

      • True

      The UUID of the name server group assigned to this domain

      • has_privacy

      • boolean

      • True

      Indicates if the domain has privacy applied to it or not

      • nameservers

      • Array of String

      • True

      A list of name servers that are current applied to the domain

      • period

      • int

      • True

      The period to register or renew the domain for

      • status

      • Array of String

      • True

      A list of status to apply for the domain

    JSON all-fields example:

    {
        "domain_name" : "example.com",
        "status" : [
            "clientUpdateProhibited",
            "clientTransferProhibited",
            "clientDeleteProhibited"
        ],
        "contacts" : {
            "registrant" : "4fb1d77a-8598-4fd3-a442-664c9aae7a74",
            "admin" : "82607d4a-4b61-46f3-88ba-1f8ea38c9ea3"
        },
        "auto_renew" : true,
        "group_uuid" : "7aca94f2-97f0-4f30-8ed3-32901782a0c4",
        "nameservers" : [
            "ns1.example.com",
            "ns2.example.com"
        ],
        "has_privacy" : true,
        "period" : 1
    }

    Response Details

    200 Response

    {
        "result" : {
            "registry_object_id" : "COM-12345-X",
            "domain_name" : "example",
            "domain_name_complete" : "example.com",
            "auto_renew" : true,
            "nameserver_group" : "5f925d9c-6d98-463b-924b-4096465665bd",
            "has_privacy" : true,
            "auth_code" : "auth-code-1",
            "expires_on" : "2018-09-01",
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
            "created_on" : "2017-12-14",
            "updated_on" : "2017-12-14"
        },
        "status_code" : 200,
        "status_message" : "OK"
    }

    400 Response

    {
        "result" : {},
        "status_code" : 400,
        "status_message" : "Bad Request"
    }

    404 Response

    {
        "result" : {},
        "status_code" : 404,
        "status_message" : "Not Found"
    }
  • PUT/dom/domain/{uuid}/auto-renew

    Updates the auto-renew setting on the specified domain name

    Back to top

    Request Details

    Response Details

    Request Details

    URL and Query String Parameters

    • Name

    • Type

    • Required

      • uuid

      • String

      • True

      The UUID of the domain to be updated

    PUT body

    • Name

    • Type

    • Required

      • auto_renew

      • boolean

      • True

      Should this domain be automatically renewed at the end of its current registraiton period

      • contacts

      • Map of String

      • True

      A list of contacts to apply to the domain

      • domain_name

      • String

      • True

      The domain name, including TLD

      • group_uuid

      • String

      • True

      The UUID of the name server group assigned to this domain

      • has_privacy

      • boolean

      • True

      Indicates if the domain has privacy applied to it or not

      • nameservers

      • Array of String

      • True

      A list of name servers that are current applied to the domain

      • period

      • int

      • True

      The period to register or renew the domain for

      • status

      • Array of String

      • True

      A list of status to apply for the domain

    JSON all-fields example:

    {
        "domain_name" : "example.com",
        "status" : [
            "clientUpdateProhibited",
            "clientTransferProhibited",
            "clientDeleteProhibited"
        ],
        "contacts" : {
            "registrant" : "4fb1d77a-8598-4fd3-a442-664c9aae7a74",
            "admin" : "82607d4a-4b61-46f3-88ba-1f8ea38c9ea3"
        },
        "auto_renew" : true,
        "group_uuid" : "7aca94f2-97f0-4f30-8ed3-32901782a0c4",
        "nameservers" : [
            "ns1.example.com",
            "ns2.example.com"
        ],
        "has_privacy" : true,
        "period" : 1
    }

    Response Details

    200 Response

    {
        "result" : {
            "registry_object_id" : "COM-12345-X",
            "domain_name" : "example",
            "domain_name_complete" : "example.com",
            "auto_renew" : true,
            "nameserver_group" : "5f925d9c-6d98-463b-924b-4096465665bd",
            "has_privacy" : true,
            "auth_code" : "auth-code-1",
            "expires_on" : "2018-09-01",
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
            "created_on" : "2017-12-14",
            "updated_on" : "2017-12-14"
        },
        "status_code" : 200,
        "status_message" : "OK"
    }

    400 Response

    {
        "result" : {},
        "status_code" : 400,
        "status_message" : "Bad Request"
    }

    404 Response

    {
        "result" : {},
        "status_code" : 404,
        "status_message" : "Not Found"
    }
  • PUT/dom/domain/{uuid}/nameservers

    Updates the nameservers on the specified domain name

    Back to top

    Request Details

    Response Details

    Request Details

    URL and Query String Parameters

    • Name

    • Type

    • Required

      • uuid

      • String

      • True

      The UUID of the domain to be updated

    PUT body

    • Name

    • Type

    • Required

      • auto_renew

      • boolean

      • True

      Should this domain be automatically renewed at the end of its current registraiton period

      • contacts

      • Map of String

      • True

      A list of contacts to apply to the domain

      • domain_name

      • String

      • True

      The domain name, including TLD

      • group_uuid

      • String

      • True

      The UUID of the name server group assigned to this domain

      • has_privacy

      • boolean

      • True

      Indicates if the domain has privacy applied to it or not

      • nameservers

      • Array of String

      • True

      A list of name servers that are current applied to the domain

      • period

      • int

      • True

      The period to register or renew the domain for

      • status

      • Array of String

      • True

      A list of status to apply for the domain

    JSON all-fields example:

    {
        "domain_name" : "example.com",
        "status" : [
            "clientUpdateProhibited",
            "clientTransferProhibited",
            "clientDeleteProhibited"
        ],
        "contacts" : {
            "registrant" : "4fb1d77a-8598-4fd3-a442-664c9aae7a74",
            "admin" : "82607d4a-4b61-46f3-88ba-1f8ea38c9ea3"
        },
        "auto_renew" : true,
        "group_uuid" : "7aca94f2-97f0-4f30-8ed3-32901782a0c4",
        "nameservers" : [
            "ns1.example.com",
            "ns2.example.com"
        ],
        "has_privacy" : true,
        "period" : 1
    }

    Response Details

    200 Response

    {
        "result" : {
            "registry_object_id" : "COM-12345-X",
            "domain_name" : "example",
            "domain_name_complete" : "example.com",
            "auto_renew" : true,
            "nameserver_group" : "5f925d9c-6d98-463b-924b-4096465665bd",
            "has_privacy" : true,
            "auth_code" : "auth-code-1",
            "expires_on" : "2018-09-01",
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
            "created_on" : "2017-12-14",
            "updated_on" : "2017-12-14"
        },
        "status_code" : 200,
        "status_message" : "OK"
    }

    400 Response

    {
        "result" : {},
        "status_code" : 400,
        "status_message" : "Bad Request"
    }

    404 Response

    {
        "result" : {},
        "status_code" : 404,
        "status_message" : "Not Found"
    }
  • POST/dom/domain/{uuid}/label

    Adds a label to the specified domain name

    Back to top

    Request Details

    Response Details

    Request Details

    URL and Query String Parameters

    • Name

    • Type

    • Required

      • uuid

      • String

      • True

      The UUID of the domain to be updated

    POST body

    • Name

    • Type

    • Required

      • label_name

      • String

      • True

      The label to be applied

    JSON all-fields example:

    {
        "label_name" : "work-domains"
    }

    Response Details

    200 Response

    {
        "result" : {
            "registry_object_id" : "COM-12345-X",
            "domain_name" : "example",
            "domain_name_complete" : "example.com",
            "auto_renew" : true,
            "nameserver_group" : "5f925d9c-6d98-463b-924b-4096465665bd",
            "has_privacy" : true,
            "auth_code" : "auth-code-1",
            "expires_on" : "2018-09-01",
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
            "created_on" : "2017-12-14"
        },
        "status_code" : 200,
        "status_message" : "OK"
    }

    400 Response

    {
        "result" : {},
        "status_code" : 400,
        "status_message" : "Bad Request"
    }

    404 Response

    {
        "result" : {},
        "status_code" : 404,
        "status_message" : "Not Found"
    }

    409 Response

    {
        "result" : {},
        "status_code" : 409,
        "status_message" : "Conflict"
    }
  • DELETE/dom/domain/{uuid}/label/{label}

    Deletes the specified label from the specified domain

    Back to top

    Request Details

    Response Details

    Request Details

    URL and Query String Parameters

    • Name

    • Type

    • Required

      • uuid

      • String

      • True

      The UUID of the domain to be updated

      • label

      • String

      • True

      The label to be deleted

    Response Details

    204 Response

    {
        "result" : {},
        "status_code" : 204,
        "status_message" : "No Content"
    }

    400 Response

    {
        "result" : {},
        "status_code" : 400,
        "status_message" : "Bad Request"
    }

    404 Response

    {
        "result" : {},
        "status_code" : 404,
        "status_message" : "Not Found"
    }
  • Chargeable *

    DELETE/dom/domain/{uuid}

    Delete the specified domain

    Back to top

    Request Details

    Response Details

    Request Details

    URL and Query String Parameters

    • Name

    • Type

    • Required

      • uuid

      • String

      • True

      The UUID of the domain to be deleted

    Response Details

    204 Response

    {
        "result" : {},
        "status_code" : 204,
        "status_message" : "No Content"
    }

    400 Response

    {
        "result" : {},
        "status_code" : 400,
        "status_message" : "Bad Request"
    }

    404 Response

    {
        "result" : {},
        "status_code" : 404,
        "status_message" : "Not Found"
    }
  • DELETE/dom/domain/{uuid}/release?tag={ips_tag}

    Releases the domain to the given Nominet Tag

    Back to top

    Request Details

    Response Details

    Request Details

    URL and Query String Parameters

    • Name

    • Type

    • Required

      • uuid

      • String

      • True

      The UUID of the domain to be released

      • ips_tag

      • String

      • True

      The IPS TAG of the registrar to release the domain to

    Response Details

    204 Response

    {
        "result" : {},
        "status_code" : 204,
        "status_message" : "No Content"
    }

    400 Response

    {
        "result" : {},
        "status_code" : 400,
        "status_message" : "Bad Request"
    }
View Desktop Site