Push API

Initiate a push

POST /:account/domains/:domain/pushes

Parameters

Name Type Description
:account integer The account id
:domain string, integer The domain name or id

Example

Initiate a push from the source account 1010 for the example.com domain:

curl  -H 'Authorization: Bearer <token>' \
      -H 'Accept: application/json' \
      -H 'Content-Type: application/json' \
      -X POST \
      -d '<json>' \
      https://api.dnsimple.com/v2/1010/domains/example.com/pushes

Input

Name Type Description
new_account_email string Required - The email address of the target DNSimple account.
Example
{
  "new_account_email": "admin@target-account.test"
}

Response

Responds with HTTP 201 on success, renders the push.

{
  "data": {
    "id": 1,
    "domain_id": 100,
    "contact_id": null,
    "account_id": 2020,
    "created_at": "2016-08-11T10:16:03Z",
    "updated_at": "2016-08-11T10:16:03Z",
    "accepted_at": null
  }
}

Errors

Responds with HTTP 400 if the push cannot be initiated.

Responds with HTTP 401 in case of case of authentication issues.

List pushes

GET /:account/pushes

List pending pushes for the target account.

Parameters

Name Type Description
:account integer The account id

Example

List all the pending pushes for the target account 2020:

curl  -H 'Authorization: Bearer <token>' \
      -H 'Accept: application/json' \
      https://api.dnsimple.com/v2/2020/pushes

Response

Responds with HTTP 200.

{
  "data": [
    {
      "id": 1,
      "domain_id": 100,
      "contact_id": null,
      "account_id": 2020,
      "created_at": "2016-08-11T10:16:03Z",
      "updated_at": "2016-08-11T10:16:03Z",
      "accepted_at": null
    },
    {
      "id": 2,
      "domain_id": 101,
      "contact_id": null,
      "account_id": 2020,
      "created_at": "2016-08-11T10:18:48Z",
      "updated_at": "2016-08-11T10:18:48Z",
      "accepted_at": null
    }
  ],
  "pagination": {
    "current_page": 1,
    "per_page": 30,
    "total_entries": 2,
    "total_pages": 1
  }
}

Errors

Responds with HTTP 401 in case of case of authentication issues.

Accept a push

POST /:account/pushes/:push

Parameters

Name Type Description
:account integer The account id
:push integer The push id

Example

Accept a push for the target account 2020:

curl  -H 'Authorization: Bearer <token>' \
      -H 'Accept: application/json' \
      -H 'Content-Type: application/json' \
      -X POST \
      -d '<json>' \
      https://api.dnsimple.com/v2/2020/pushes/1

Input

Name Type Description
contact_id integer Required - A contact that belongs to the target DNSimple account. The contact will be used as new registrant for the domain, if the domain is registered with DNSimple.
Example
{
  "contact_id": "2"
}

Response

Responds with HTTP 204 on success.

Errors

Responds with HTTP 400 if the push cannot be accepted.

Responds with HTTP 401 in case of case of authentication issues.

Reject a push

DELETE /:account/pushes/:push

Parameters

Name Type Description
:account integer The account id
:push integer The push id

Example

Reject a push for the target account 2020:

curl  -H 'Authorization: Bearer <token>' \
      -H 'Accept: application/json' \
      -H 'Content-Type: application/json' \
      -X DELETE \
      https://api.dnsimple.com/v2/2020/pushes/1

Response

Responds with HTTP 204 on success.

Errors

Responds with HTTP 401 in case of case of authentication issues.