mirror of
https://github.com/internetee/registry.git
synced 2025-06-07 13:15:40 +02:00
343 lines
7.4 KiB
Markdown
343 lines
7.4 KiB
Markdown
# Domain related actions
|
|
|
|
## GET /api/v1/registrant/domains
|
|
|
|
Returns domains of the current registrant.
|
|
|
|
|
|
#### Parameters
|
|
|
|
| Field name | Required | Type | Allowed values | Description |
|
|
| ---------- | -------- | ---- | -------------- | ----------- |
|
|
| limit | false | Integer | [1..200] | How many domains to show |
|
|
| offset | false | Integer | | Domain number to start at |
|
|
|
|
#### Response
|
|
```
|
|
HTTP/1.1 200
|
|
Content-Type: application/json
|
|
|
|
[
|
|
{
|
|
"id":"98d1083a-8863-4153-93e4-caee4a013535",
|
|
"name":"domain0.ee",
|
|
"registrar":{
|
|
"name":"Best Names",
|
|
"website":"example.com"
|
|
},
|
|
"valid_to":"2016-09-09T09:11:14.861Z",
|
|
"registered_at":"2015-09-09T09:11:14.861Z",
|
|
"registrant":{
|
|
"name":"John Smith",
|
|
"id":"acadf23e-47c4-4606-8f67-76e071a1cca2"
|
|
},
|
|
"admin_contacts":[
|
|
{
|
|
"name":"John Smith",
|
|
"id":"62015e7d-42c8-4d68-8164-e9b71680fd95",
|
|
"email": "john@email.com"
|
|
},
|
|
{
|
|
"name":"William Smith",
|
|
"id":"a041c5b6-7772-4fac-83cd-fbce3b2c8867",
|
|
"email": "william@email.com"
|
|
}
|
|
],
|
|
"tech_contacts":[
|
|
{
|
|
"name":"John Smith",
|
|
"id":"62015e7d-42c8-4d68-8164-e9b71680fd95",
|
|
"email": "john@email.com"
|
|
},
|
|
{
|
|
"name":"William Smith",
|
|
"id":"a041c5b6-7772-4fac-83cd-fbce3b2c8867"
|
|
"email": "william@email.com"
|
|
}
|
|
],
|
|
"transfer_code":"98oiewslkfkd",
|
|
"created_at":"2015-09-09T09:11:14.861Z",
|
|
"updated_at":"2015-09-09T09:11:14.860Z",
|
|
"name_dirty":"domain0.ee",
|
|
"name_puny":"domain0.ee",
|
|
"period":1,
|
|
"period_unit":"y",
|
|
"creator_str":null,
|
|
"updator_str":null,
|
|
"outzone_at":"2016-09-24T09:11:14.861Z",
|
|
"delete_date":"2016-10-24",
|
|
"registrant_verification_asked_at":null,
|
|
"registrant_verification_token":null,
|
|
"locked_by_registrant_at":"2015-09-09T09:11:14.861Z",
|
|
"pending_json":{
|
|
|
|
},
|
|
"force_delete_date":null,
|
|
"statuses":[
|
|
"ok"
|
|
],
|
|
"nameservers":[
|
|
{
|
|
"hostname":"ns1.bestnames.test",
|
|
"ipv4":[
|
|
"173.245.58.41"
|
|
],
|
|
"ipv6":[
|
|
"2400:cb00:2049:1::adf5:3a33"
|
|
]
|
|
},
|
|
{
|
|
"hostname":"ns1.bestnames.test",
|
|
"ipv4":[
|
|
"173.245.58.51"
|
|
],
|
|
"ipv6":[
|
|
"2400:cb00:2049:1::adf5:3b29"
|
|
]
|
|
},
|
|
|
|
],
|
|
"dnssec_keys": [
|
|
"257 3 13 KlHFYV42UtxC7LpsolDpoUZ9DNPDRYQypalBRIqlubBg/zg78aqciLk+NaWUbrkN7AUaM7h7tx91sLN+ORVPxA==",
|
|
],
|
|
"dnssec_changed_at": "2015-09-09T09:11:14.860Z",
|
|
"status_notes":{
|
|
|
|
},
|
|
"statuses_backup":[
|
|
|
|
]
|
|
}
|
|
]
|
|
```
|
|
|
|
#### Request
|
|
```
|
|
GET api/v1/registrant/domains HTTP/1.1
|
|
Accept: application/json
|
|
Authorization: Bearer Z2l0bGFiOmdoeXQ5ZTRmdQ==
|
|
Content-Type: application/json
|
|
```
|
|
|
|
## GET api/v1/registrant/domains
|
|
|
|
Returns domain names with offset.
|
|
|
|
|
|
#### Request
|
|
```
|
|
GET api/v1/registrant/domains?offset=1&limit=1 HTTP/1.1
|
|
Accept: application/json
|
|
Authorization: Bearer Z2l0bGFiOmdoeXQ5ZTRmdQ==
|
|
Content-Type: application/json
|
|
```
|
|
|
|
#### Response
|
|
```
|
|
HTTP/1.1 200
|
|
Content-Type: application/json
|
|
|
|
[
|
|
{
|
|
"id":"98d1083a-8863-4153-93e4-caee4a013535",
|
|
"name":"domain0.ee",
|
|
"registrar":{
|
|
"name":"Best Names",
|
|
"website":"example.com"
|
|
},
|
|
"valid_to":"2016-09-09T09:11:14.861Z",
|
|
"registered_at":"2015-09-09T09:11:14.861Z",
|
|
"registrant":{
|
|
"name":"John Smith",
|
|
"id":"acadf23e-47c4-4606-8f67-76e071a1cca2"
|
|
},
|
|
"admin_contacts":[
|
|
{
|
|
"name":"John Smith",
|
|
"id":"62015e7d-42c8-4d68-8164-e9b71680fd95"
|
|
},
|
|
{
|
|
"name":"William Smith",
|
|
"id":"a041c5b6-7772-4fac-83cd-fbce3b2c8867"
|
|
}
|
|
],
|
|
"tech_contacts":[
|
|
{
|
|
"name":"John Smith",
|
|
"id":"62015e7d-42c8-4d68-8164-e9b71680fd95"
|
|
},
|
|
{
|
|
"name":"William Smith",
|
|
"id":"a041c5b6-7772-4fac-83cd-fbce3b2c8867"
|
|
}
|
|
],
|
|
"transfer_code":"98oiewslkfkd",
|
|
"created_at":"2015-09-09T09:11:14.861Z",
|
|
"updated_at":"2015-09-09T09:11:14.860Z",
|
|
"name_dirty":"domain0.ee",
|
|
"name_puny":"domain0.ee",
|
|
"period":1,
|
|
"period_unit":"y",
|
|
"creator_str":null,
|
|
"updator_str":null,
|
|
"outzone_at":"2016-09-24T09:11:14.861Z",
|
|
"delete_date":"2016-10-24",
|
|
"registrant_verification_asked_at":null,
|
|
"registrant_verification_token":null,
|
|
"locked_by_registrant_at":"2015-09-09T09:11:14.861Z",
|
|
"pending_json":{
|
|
|
|
},
|
|
"force_delete_date":null,
|
|
"statuses":[
|
|
"ok"
|
|
],
|
|
"nameservers":[
|
|
{
|
|
"hostname":"ns1.bestnames.test",
|
|
"ipv4":[
|
|
"173.245.58.41"
|
|
],
|
|
"ipv6":[
|
|
"2400:cb00:2049:1::adf5:3a33"
|
|
]
|
|
},
|
|
{
|
|
"hostname":"ns1.bestnames.test",
|
|
"ipv4":[
|
|
"173.245.58.51"
|
|
],
|
|
"ipv6":[
|
|
"2400:cb00:2049:1::adf5:3b29"
|
|
]
|
|
},
|
|
|
|
],
|
|
"dnssec_keys": [
|
|
"257 3 13 KlHFYV42UtxC7LpsolDpoUZ9DNPDRYQypalBRIqlubBg/zg78aqciLk+NaWUbrkN7AUaM7h7tx91sLN+ORVPxA==",
|
|
],
|
|
"dnssec_changed_at": "2015-09-09T09:11:14.860Z",
|
|
"status_notes":{
|
|
|
|
},
|
|
"statuses_backup":[
|
|
|
|
]
|
|
}
|
|
]
|
|
```
|
|
|
|
## GET api/v1/registrant/domains/$UUID
|
|
|
|
Returns a single domain object.
|
|
|
|
|
|
#### Request
|
|
```
|
|
GET api/v1/registrant/domains/98d1083a-8863-4153-93e4-caee4a013535 HTTP/1.1
|
|
Accept: application/json
|
|
Authorization: Bearer Z2l0bGFiOmdoeXQ5ZTRmdQ==
|
|
Content-Type: application/json
|
|
```
|
|
|
|
#### Response for success
|
|
|
|
```
|
|
HTTP/1.1 200
|
|
Content-Type: application/json
|
|
|
|
{
|
|
"id":"98d1083a-8863-4153-93e4-caee4a013535",
|
|
"name":"domain0.ee",
|
|
"registrar":{
|
|
"name":"Best Names",
|
|
"website":"example.com"
|
|
},
|
|
"valid_to":"2016-09-09T09:11:14.861Z",
|
|
"registered_at":"2015-09-09T09:11:14.861Z",
|
|
"registrant":{
|
|
"name":"John Smith",
|
|
"id":"acadf23e-47c4-4606-8f67-76e071a1cca2"
|
|
},
|
|
"admin_contacts":[
|
|
{
|
|
"name":"John Smith",
|
|
"id":"62015e7d-42c8-4d68-8164-e9b71680fd95"
|
|
},
|
|
{
|
|
"name":"William Smith",
|
|
"id":"a041c5b6-7772-4fac-83cd-fbce3b2c8867"
|
|
}
|
|
],
|
|
"tech_contacts":[
|
|
{
|
|
"name":"John Smith",
|
|
"id":"62015e7d-42c8-4d68-8164-e9b71680fd95"
|
|
},
|
|
{
|
|
"name":"William Smith",
|
|
"id":"a041c5b6-7772-4fac-83cd-fbce3b2c8867"
|
|
}
|
|
],
|
|
"transfer_code":"98oiewslkfkd",
|
|
"created_at":"2015-09-09T09:11:14.861Z",
|
|
"updated_at":"2015-09-09T09:11:14.860Z",
|
|
"name_dirty":"domain0.ee",
|
|
"name_puny":"domain0.ee",
|
|
"period":1,
|
|
"period_unit":"y",
|
|
"creator_str":null,
|
|
"updator_str":null,
|
|
"outzone_at":"2016-09-24T09:11:14.861Z",
|
|
"delete_date":"2016-10-24",
|
|
"registrant_verification_asked_at":null,
|
|
"registrant_verification_token":null,
|
|
"locked_by_registrant_at":"2015-09-09T09:11:14.861Z",
|
|
"pending_json":{
|
|
|
|
},
|
|
"force_delete_date":null,
|
|
"statuses":[
|
|
"ok"
|
|
],
|
|
"nameservers":[
|
|
{
|
|
"hostname":"ns1.bestnames.test",
|
|
"ipv4":[
|
|
"173.245.58.41"
|
|
],
|
|
"ipv6":[
|
|
"2400:cb00:2049:1::adf5:3a33"
|
|
]
|
|
},
|
|
{
|
|
"hostname":"ns1.bestnames.test",
|
|
"ipv4":[
|
|
"173.245.58.51"
|
|
],
|
|
"ipv6":[
|
|
"2400:cb00:2049:1::adf5:3b29"
|
|
]
|
|
}
|
|
],
|
|
"dnssec_keys": [
|
|
"257 3 13 KlHFYV42UtxC7LpsolDpoUZ9DNPDRYQypalBRIqlubBg/zg78aqciLk+NaWUbrkN7AUaM7h7tx91sLN+ORVPxA==",
|
|
],
|
|
"dnssec_changed_at": "2015-09-09T09:11:14.860Z",
|
|
"status_notes":{
|
|
|
|
},
|
|
"statuses_backup":[
|
|
|
|
]
|
|
}
|
|
```
|
|
|
|
#### Response for failure
|
|
|
|
```
|
|
HTTP/1.1 404
|
|
Content-Type: application/json
|
|
|
|
{ "errors": ["Domain not found"] }
|
|
```
|