mirror of
https://github.com/internetee/registry.git
synced 2025-06-11 15:14:47 +02:00
Add disputed domains to API documentation
This commit is contained in:
parent
011967d8ea
commit
3aa978f722
1 changed files with 9 additions and 5 deletions
|
@ -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
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue