get_domain_changes

The get_domain_changes method retrieves a summary of the changes that have been made to a domain.

Syntax

{
  <credentials object> 
  "domain":<domain> 
  "range": {
    "first": <number>,
    "limit": <number> 
}

Request fields for get_domain_changes

The following fields can be used in the get_domain_changes method:

Field nameObligationDefinition/Value
domainRequiredThe name of the domain.
rangeOptionalThe range of results to return. Allowed values are:

first — The 0-based index of the first result to return.

limit — The maximum number of results to return.

Response fields for get_domain_changes

The following fields may be returned in response to the get_domain_changes method:

Field nameObligationDescription/Value
changesReturned if success = trueAn array of hashes, one hash for each change returned. The array is sorted by the time of the change, with the earliest change listed first. For each change the following information is returned:

application — The name of the application used to perform the change.

msg — A brief summary of the change made. If the changed data is short, it is shown; otherwise, the number of bytes in the new value is shown.

time — The time that the change was made, in UNIX Epoch time.

user — The name of the user that performed the change. If the change was performed by the system, the user "OpenSRS" is shown.
countReturned if success = trueThe number of items (changes) in the array.
errorReturned if success = falseA text string that explains the error.
error_numberReturned if success = falseA number that represents the error.
successAlways returnedIndicates whether the request was successful or not. Allowed values are true and false.
total_countReturned if success = trueThe total number of changes available.

Examples for get_domain_changes

Request

{
  "credentials": {
"user": "[email protected]",
    "password": "pencil75"
  },
  "range": {
    "first": 15,
    "limit": 5
  },
  "domain": "example.com"
}

Response

{
  "success": true,
  "count": 3,
  "total_count": 18,
  "changes": [
    {
      "msg": "changed language [en]",
      "time": "1321901972",
      "application": "OMA",
      "user": "OpenSRS"
    }, 
    {
      "msg": "changed aliases [schmemoco.com]", 
      "time": "1323812345",
            "application": "OMA",
            "user": "[email protected]"
    }, 
    {
        "msg": "changed allow 
[*@example.com,[email protected]]",
            "time": "1323814260", 
      "application": "OMA",
            "user": "[email protected]"
    } 
  ]
}