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 Back Order

A domain back order allows a domain to be secured as it is deleted from the registry

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/back-order

    Gets all active back orders 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" : [
            {
                "domain_name" : "example.com",
                "expires_on" : "2018-08-01",
                "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
                "created_on" : "2017-12-14",
                "updated_on" : "2017-12-14"
            }
        ],
        "status_code" : 200,
        "status_message" : "OK"
    }
  • GET/dom/back-order/{uuid}

    Gets a specific active back order 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 BackOrder to query

    Response Details

    200 Response

    {
        "result" : {
            "domain_name" : "example.com",
            "expires_on" : "2018-08-01",
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
            "created_on" : "2017-12-14",
            "updated_on" : "2017-12-14"
        },
        "status_code" : 200,
        "status_message" : "OK"
    }

    404 Response

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

    POST/dom/back-order

    Creates a new back order for the provided domain name

    Back to top

    Request Details

    Response Details

    Request Details

    This command has no URL/Query String parameters

    POST body

    • Name

    • Type

    • Required

      • domain_name

      • String

      • True

      The domain name to be back ordered

    JSON all-fields example:

    {
        "domain_name" : "example.com"
    }

    Response Details

    201 Response

    {
        "result" : {
            "domain_name" : "example.com",
            "expires_on" : "2018-08-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"
    }

    409 Response

    {
        "result" : {},
        "status_code" : 409,
        "status_message" : "Conflict"
    }
  • DELETE/dom/back-order/{uuid}

    Deletes the specific back order

    Back to top

    Request Details

    Response Details

    Request Details

    URL and Query String Parameters

    • Name

    • Type

    • Required

      • uuid

      • String

      • True

      The UUID of the back order to be deleted

    Response Details

    204 Response

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

    404 Response

    {
        "result" : {},
        "status_code" : 404,
        "status_message" : "Not Found"
    }
View Desktop Site