GET /domain/available/{name}
Abfrage ob Domain "name" noch verfügbar ist.
Anfrage
| Parameter | Type | # |
|---|---|---|
| name | string | Beispiel: /domain/available/mustermann.de |
Antwort
| Parameter | Type | Beschreibung |
|---|---|---|
| {name} | string array | |
| ... available | int | Verfügbarkeit 0 oder 1 |
| ... period | string | Anzahl gefolgt von M für Monat oder Y für Jahr/e. |
| ... price | string array | net für Nettopreise, tax ist die Steuer auf Grundlage des Nutzers und seines Landes., gros sind die errechneten Bruttopreise. |
Antwort
{
"code": 200,
"message": "ok",
"result": {
[mustermann.de] => Array
(
[available] => 1
[period] => 1Y
[price] => Array
(
[net] => Array
(
[create] => 6,53
[renewal] => 6,53
[transfer] => 5,08
)
[tax] => 19.0
[gros] => Array
(
[create] => 7,77
[renewal] => 7,77
[transfer] => 6,05
)
)
)
}
}
GET /domain/prices
Abfrage aller Verfügbaren Toplevel und deren Preise.
Anfrage
| Parameter | Type | # |
|---|
Antwort
| Parameter | Type | Beschreibung |
|---|---|---|
| {name} | string array | |
| ... period | string | Anzahl gefolgt von M für Monat oder Y für Jahr/e. |
| ... create | float | Nettopreis für das Anlegen der Domain. |
| ... renewal | float | Nettopreise für das Verlängern der Domain. |
| ... transfer | float | Nettopreise für den Transfer der Domain zu Everworkx. |
Antwort
{
"code": 200,
"message": "ok",
"result": {
[de] => Array
(
[period] => 1Y
[create] => 6,53
[renewal] => 6,53
[transfer] => 5,08
)
[com] => Array
(
[period] => 1Y
[create] => 14,95
[renewal] => 14,95
[transfer] => 14,95
)
}
}
POST /domain/create
Eine neue Domain registrieren.
Anfrage
| Parameter | Type | # |
|---|---|---|
| domain | string | Domainname. Zum Beispiel mustermann.de |
Antwort
| Parameter | Type | Beschreibung |
|---|
Antwort
{
"code": 201,
"message": "created",
"result": {
}
}
POST /domain/transfer
Eine neue Domain zu Everworkx transferieren.
Anfrage
| Parameter | Type | # |
|---|---|---|
| domain | string | Domainname. Zum Beispiel mustermann.de |
| authcode | string | Der Authcode zur Domain die Sie zu Everworkx umziehen möchten. |
Antwort
| Parameter | Type | Beschreibung |
|---|
Antwort
{
"code": 201,
"message": "created",
"result": {
}
}
DELETE /domain/delete/{name}
Eine vorhandene Domain zum löschen markieren.
Anfrage
| Parameter | Type | # |
|---|---|---|
| name | string | Domainname. Zum Beispiel mustermann.de |
Antwort
| Parameter | Type | Beschreibung |
|---|---|---|
| expiry | datetime | Ablaufdatum im Datetime Format. YYYY-mm-dd HH:ii:ss |
Antwort
{
"code": 200,
"message": "ok",
"result": {
[expiry] => {expiry}
}
}
GET /domain/info/{name}
Informationen zur Domain anfordern.
Anfrage
| Parameter | Type | # |
|---|---|---|
| name (optional) | string | Domainname. Zum Beispiel mustermann.de. Wird kein Name angegeben werden alle Domains aufgelistet |
Antwort
| Parameter | Type | Beschreibung |
|---|---|---|
| period | string | Verlängerungsperiode für die Domain (Zahl gefolgt von M oder Y) |
| payment_period | string | Bezahlperiode für die Domain (Zahl gefolgt von M oder Y) |
| managed | int | -1 oder 1. |
| transferlock | int | 0 oder 1. Dies gibt an ob Ihre Domain für einen Umzug freigegeben ist. |
| authcode | string | Der Authcode zur angebenen Domain |
| state | string | Mögliche Werte: ordered, acitve, updating, deleting, deleted |
| renewalmode | int | 1 gibt an das die Domain automatisch verlängert wird. |
| price | string array | net für Nettopreise, tax ist die Steuer auf Grundlage des Nutzers und seines Landes., gros sind die errechneten Bruttopreise. |
| order_datetime | datetime | Bestelldatum im Datetime Format. YYYY-mm-dd HH:ii:ss |
| max_termination_datetime | datetime | Datum an dem spätestens eine Kündigung erfolgen muss. YYYY-mm-dd HH:ii:ss |
| expiry_datetime | datetime | Datum zu dem die Domain gelöscht wird. YYYY-mm-dd HH:ii:ss (leer wenn keine Kündigung erfolgt ist) |
Antwort
{
"code": 200,
"message": "ok",
"result": {
[mustermann.de] => Array
(
[id] => 1
[period] => 1Y
[payment_period] => 1Y
[managed] => -1
[transferlock] => 1
[authcode] =>
[state] => active
[renewalmode] => 1
[price] => Array
(
[net] => Array
(
[create] => 6,53
[transfer] => 5,08
[renewal] => 6,53
)
[tax] => 19
[gros] => Array
(
[create] => 7,77
[transfer] => 6,05
[renewal] => 7,77
)
)
[order_datetime] => 2012-09-28 22:33:00
[max_termination_datetime] => 2022-09-28 22:33:00
[expiry_datetime] =>
)
}
}
PUT /domain/update/{name}
Angegebene Domain bearbeiten.
Anfrage
| Parameter | Type | # | Pflicht |
|---|---|---|---|
GET {name} |
string | Domainname. Zum Beispiel mustermann.de. | * |
DATA ... |
stringarray | * | |
| ... renewalmode | int | 0 oder 1. Gibt an ob die Domain verlängert werden soll. 1 = Ja Eine Domain wird zum Laufzeitende gekündigt sofern renewalmode auf 0 gesetzt wird. Die Kündigung einer Domain wird aufgehoben sobald renewalmode auf 1 gesetzt wird. |
|
| ... transferlock | int | 0 oder 1. Gibt an ob die Domain transferiert werden kann. 0 = Ja |
Antwort
Rückgabe erfolgt nach Anfrage. Es werden alle Änderungen zurück gegeben.
Mögliche Rückgabewerte:
Mögliche Rückgabewerte:
| Parameter | Type | Beschreibung |
|---|---|---|
| renewalmode | int | 1 gibt an das die Domain automatisch verlängert wird. |
| transferlock | int | 1 gibt an das die Domain transferiert werden kann. 0 = Ja |
| expiry | datetime | Wird ausgegeben wenn renewalmode auf 0 gesetzt (und die Domain damit gekündigt) wird. |
Antwort
{
"code": 203,
"message": "updated",
"result": {
Array
(
[renewalmode] => 1,
[transferlock] => 0
)
}
}
GET /domain/listall
Informationen zu allen Domain anfordern.
Anfrage
| Parameter | Type | # |
|---|
Antwort
| Parameter | Type | Beschreibung |
|---|---|---|
| {name} | array | |
| ...id | int | Unsere interne ID für Ihre Domain |
| ...period | string | Verlängerungsperiode für die Domain (Zahl gefolgt von M oder Y) |
| ...payment_period | string | Bezahlperiode für die Domain (Zahl gefolgt von M oder Y) |
| ...managed | int | -1 oder 1. |
| ...transferlock | int | 0 oder 1. Dies gibt an ob Ihre Domain für einen Umzug freigegeben ist. |
| ...authcode | string | Der Authcode zur angebenen Domain |
| ...state | string | Mögliche Werte: ordered, acitve, updating, deleting, deleted |
| ...renewalmode | int | 1 gibt an das die Domain automatisch verlängert wird. |
| ...price | string array | net für Nettopreise, tax ist die Steuer auf Grundlage des Nutzers und seines Landes., gros sind die errechneten Bruttopreise. |
| ...order_datetime | datetime | Bestelldatum im Datetime Format. YYYY-mm-dd HH:ii:ss |
| ...max_termination_datetime | datetime | Datum an dem spätestens eine Kündigung erfolgen muss. YYYY-mm-dd HH:ii:ss |
| ...expiry_datetime | datetime | Datum zu dem die Domain gelöscht wird. YYYY-mm-dd HH:ii:ss (leer wenn keine Kündigung erfolgt ist) |
Antwort
{
"code": 200,
"message": "ok",
"result": {
[mustermann.de] => Array
(
[id] => 1
[period] => 1Y
[payment_period] => 1Y
[managed] => -1
[transferlock] => 1
[authcode] =>
[state] => active
[renewalmode] => 1
[price] => Array
(
[net] => Array
(
[create] => 6,53
[transfer] => 5,08
[renewal] => 6,53
)
[tax] => 19
[gros] => Array
(
[create] => 7,77
[transfer] => 6,05
[renewal] => 7,77
)
)
[order_datetime] => 2012-09-28 22:33:00
[max_termination_datetime] => 2022-09-28 22:33:00
[expiry_datetime] =>
)
}
}
GET /domain/dns/{name}
Alle DNS Einträge auflisten.
Anfrage
| Parameter | Type | # |
|---|---|---|
| name | string | Domainname. Zum Beispiel mustermann.de |
Antwort
| Parameter | Type | Beschreibung |
|---|---|---|
| {id} | int | Unsere interne ID für den Eintrag |
| {name} | string | Die Bezeichnung für den Eintrag |
| {type} | string | Der Typ des Eintrags. Beispiel: A |
| {content} | string | Der Wert für den Eintrag |
| {ttl} | int | Der Time of Live Wert für Ihren Eintrag. |
| {prio} | int | Die Priorität für Ihren Eintrag. |
Antwort
{
"code": 200,
"message": "ok",
"result": {
[0] => Array
(
[id] => {id}
[name] => {name}
[type] => {type}
[content] => {content}
[ttl] => {ttl}
[prio] => {prio}
)
[1] => Array
(
[id] => {id}
[name] => {name}
[type] => {type}
[content] => {content}
[ttl] => {ttl}
[prio] => {prio}
)
}
}
POST /domain/dns/{name}
Einen DNS Eintrag hinzufügen.
Anfrage
| Parameter | Type | # | Pflicht |
|---|---|---|---|
GET {name} |
string | Domainname. Zum Beispiel mustermann.de | * |
POST ... |
stringarray | ||
| ... name | string | Name des Records | |
| ... type | type | Typ des Records. Beispiel: A | * |
| ... content | string | Wert des Records | * |
| ... ttl | int | ||
| ... prio | int |
Antwort
| Parameter | Type | Beschreibung |
|---|---|---|
| {id} | int | Unsere interne ID für den Eintrag |
Antwort
{
"code": 201,
"message": "created",
"result": {
[id] => {id}
)
}
}
PUT /domain/dns/{name}
Einen DNS Eintrag verändern.
Achtung: Wird zum Beispiel der Wert ttl nicht übergeben, wird er mit dem "default"-Wert überschrieben.
Anfrage
| Parameter | Type | # | Pflicht |
|---|---|---|---|
GET {name} |
string | Domainname. Zum Beispiel mustermann.de | * |
POST ... |
stringarray | ||
| ... name | string | Name des Records | |
| ... type | type | Typ des Records. Beispiel: A | * |
| ... content | string | Wert des Records | * |
| ... ttl | int | ||
| ... prio | int |
Antwort
| Parameter | Type | Beschreibung |
|---|
Antwort
{
"code": 203,
"message": "updated",
"result":
}
DELETE /domain/dns/{name}/{id}
Einen DNS Eintrag löschen.
Anfrage
| Parameter | Type | # | Pflicht |
|---|---|---|---|
{name} |
string | Domainname. Zum Beispiel mustermann.de | * |
{id} |
int | Unsere interne ID für den Eintrag | * |
Antwort
| Parameter | Type | Beschreibung |
|---|
Antwort
{
"code": 202,
"message": "deleted",
"result":
}