Add disputed domains to API documentation

This commit is contained in:
Maciej Szlosarczyk 2020-05-28 14:02:58 +03:00
parent 011967d8ea
commit 3aa978f722
No known key found for this signature in database
GPG key ID: 41D62D42D3B0D765

View file

@ -1,16 +1,20 @@
## GET /repp/v1/retained_domains ## GET /repp/v1/retained_domains
Return a list of reserved and blocked domains, along with total count. You can Return a list of disputed, reserved and blocked domains, along with total count.
filter them by type of the domain, which can be either reserved or blocked. You can filter them by type of the domain, which can be: `reserved`, `blocked`
or `disputed`.
NB! A domain name can be both `disputed` and `reserved` at the same time, and it
will appear on the list as two separate objects.
In contrast with other endpoints in REPP, this one is publicly available for In contrast with other endpoints in REPP, this one is publicly available for
anyone without authentication. anyone without authentication.
#### Parameters #### Parameters
| Field name | Required | Type | Allowed values | Description | | Field name | Required | Type | Allowed values | Description |
| ---------- | -------- | ---- | -------------- | ----------- | | ---------- | -------- | ---- | -------------- | ----------- |
| type | false | string | ["reserved", "blocked"] | Type of domains to show | | type | false | string | ["reserved", "blocked", "disputed"] | Type of domains to show |
#### Request #### Request