Domains - API Dokumentation

Die /domains API Resource gibt Dir die Möglichkeit Deine aktiven Domains anzuzeigen, sowohl als auch die DNS Einträge Deiner Domains auszulesen oder zu modifizieren. Die GET Methode auf die /v1/domains Route zeigt alle aktiven Domains an, die der Kunde besitzt.

Anfrage:

curl -X GET -H 'X-Verosent-Token: HWsYIoW0YMwJdGaWNEsbudnHoUQuUlRxpB9L82Sc3DixhJxw7wW36j/nzCmajb46TBQ11RIZh2+X98+KpnpF+w==' https://api.verosent.com/v1/domains
Antwort:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

{
  "domains": [
    {
      "id": 3,
      "name": "verosent.com",
      "tld": "com",
      "expires_on": "2025-05-10"
    },
    {
      "id": 4,
      "name": "verosent.net",
      "tld": "net",
      "expires_on": "2025-05-11"
    }
  ]
}
Voraussetzungen:

Der Scope domains.list muss aktiv sein.
Um alle DNS Einträge für eine Domain anzeigen zu lassen, sende eine GET Anfrage an die /v1/domains/:id/dns-records Route. Stelle sicher, dass Dein API Token Zugriff auf das Produkt hat und der dazugehörige Scope aktiv ist. (siehe Voraussetzungen weiter unten)

Anfrage:

curl -X GET -H 'X-Verosent-Token: HWsYIoW0YMwJdGaWNEsbudnHoUQuUlRxpB9L82Sc3DixhJxw7wW36j/nzCmajb46TBQ11RIZh2+X98+KpnpF+w==' https://api.verosent.com/v1/domains/3/dns-records
Antwort:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86

{
   "domain":{
      "id":3,
      "name":"verosent.com"
   },
   "dns_records":[
      {
         "id":55,
         "prefix":"",
         "value":"54.36.5.99",
         "record_type":"A",
         "priority":null,
         "weight":null,
         "protocol":null,
         "service":null,
         "port":null,
         "created_at":"2019-08-02T06:57:39.000+02:00",
         "updated_at":"2019-08-02T06:57:39.000+02:00"
      },
      {
         "id":56,
         "prefix":"www",
         "value":"54.36.5.99",
         "record_type":"A",
         "priority":null,
         "weight":null,
         "protocol":null,
         "service":null,
         "port":null,
         "created_at":"2019-08-02T06:57:44.000+02:00",
         "updated_at":"2019-08-02T06:57:44.000+02:00"
      },
      {
         "id":57,
         "prefix":"mail",
         "value":"54.36.5.99",
         "record_type":"A",
         "priority":null,
         "weight":null,
         "protocol":null,
         "service":null,
         "port":null,
         "created_at":"2019-08-02T06:57:58.000+02:00",
         "updated_at":"2019-08-02T06:57:58.000+02:00"
      },
      {
         "id":58,
         "prefix":"mx0",
         "value":"mail.verosent.com",
         "record_type":"MX",
         "priority":50,
         "weight":null,
         "protocol":null,
         "service":null,
         "port":null,
         "created_at":"2019-08-02T06:58:11.000+02:00",
         "updated_at":"2019-08-02T06:58:11.000+02:00"
      },
      {
         "id":59,
         "prefix":"secret-txt-record",
         "value":"my TXT record value",
         "record_type":"TXT",
         "priority":null,
         "weight":null,
         "protocol":null,
         "service":null,
         "port":null,
         "created_at":"2019-08-02T06:58:28.000+02:00",
         "updated_at":"2019-08-02T06:58:28.000+02:00"
      },
      {
         "id":61,
         "prefix":"_minecraft._tcp",
         "value":"54.36.5.99",
         "record_type":"SRV",
         "priority":100,
         "weight":200,
         "protocol":null,
         "service":"minecraft",
         "port":25565,
         "created_at":"2019-07-27T10:08:24.000+02:00",
         "updated_at":"2019-07-27T10:08:24.000+02:00"
      }
   ]
}
Voraussetzungen:

Der Scope domains.dns_records_list muss aktiv sein und der API Token muss Zugriff auf das Produkt haben.

Api Domains Dns Records Create Desc

Anfrage:

curl -X POST -H 'Content-Type: application/json' -H 'X-Verosent-Token: HWsYIoW0YMwJdGaWNEsbudnHoUQuUlRxpB9L82Sc3DixhJxw7wW36j/nzCmajb46TBQ11RIZh2+X98+KpnpF+w==' https://api.verosent.com/v1/domains/:id/dns-records --data '$JSON_CONTENT_BODY'
Inhalt der Anfrage (application/json):

1
2
3
4
5

{
   "record_type": "A",
   "prefix": "www",
   "value": "54.36.5.99"
}
Je nachdem um welchen DNS Eintrag Typ es sich handelt, kann der Inhalt der Anfrage mit unterschiedlichen Parametern aufgebaut sein.
  • prefix (String): Der hier festgelegte Wert dient als Präfix für den DNS Eintrag. (z.B. wenn der Präfix auf "www" gesetzt wird, würde der Eintrag unter www.example.com erreichbar sein)
  • value (String): Der hier definierte Inhalt wird für verschiedene DNS Eintrag Typen unterschiedlich validiert. Als Beispiel: Bei einem A Eintrag wird nach einer IPv4 Adresse geprüft, für AAAA Einträge wird nach einer IPv6 Adresse geprüft und TXT Einträge können einen beliebigen Text beinhalten (usw.). Dieser Parameter wird für jeden DNS Eintrag Typ unterstützt.
  • priority (Integer): Legt die Priorität von einem DNS Eintrag fest. Je niedriger die Priorität ist, desto wahrscheinlicher ist es, dass der Eintrag als erstes von Clients ausgesucht wird, sofern der festgelegte Server verfügbar ist. Der Parameter wird nur für MX und SRV DNS Einträge verwendet.
  • weight (Integer): Setzt die Gewichtung von einem DNS Eintrag fest. Je höher der Wert ist, desto wahrscheinlicher ist es, dass Clients den Eintrag bevorzugen, sofern es mehrere Einträge mit der gleichen Priorität aber unterschiedlichen Gewichtung gibt. Die Gewichtung kann nur für SRV Einträge festgelegt werden.
  • port (Integer): Der Parameter wird nur von SRV DNS Einträgen verwendet und legt fest, auf welchen Port sich Clients mit dem festgelegten Zielserver verbinden sollen.
  • protocol (String): Definiert das zu verwendende Protokoll für einen SRV Eintrag. Kann entweder "udp" oder "tcp" sein.
  • service (String): Der Service Name der für einen SRV Eintrag verwendet werden soll. Für das Spiel "Minecraft" als Beispiel, würde der Service Name "minecraft" heißen. Der Wert hängt von der jewiligen Applikation ab, für die der SRV Eintrag erstellt werden soll. Bitte siehe dazu bei der Dokumentation des Herstellers nach, um mehr Informationen zu erhalten.
Antwort:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

{
   "message":"ok",
   "dns_record":{
      "id":1,
      "prefix":"www",
      "value":"54.36.5.99",
      "record_type":"A",
      "priority":null,
      "weight":null,
      "protocol":null,
      "service":null,
      "port":null,
      "created_at":"2019-07-27T10:08:24.000+02:00",
      "updated_at":"2019-07-27T10:08:24.000+02:00"
   }
}
Voraussetzungen:

Der Scope domains.dns_records_create muss aktiv sein und der API Token muss Zugriff auf das Produkt haben.

Diese API Schnittstelle erlaubt es Dir einen existierenden DNS Eintrag zu bearbeiten. Sie nimmt Daten im JSON Format (application/json) entgegen. Bitte siehe unten, um alle verfügbaren Parameter zu sehen. Der Request Typ muss PUT sein.

Anfrage:

curl -X PUT -H 'Content-Type: application/json' -H 'X-Verosent-Token: HWsYIoW0YMwJdGaWNEsbudnHoUQuUlRxpB9L82Sc3DixhJxw7wW36j/nzCmajb46TBQ11RIZh2+X98+KpnpF+w==' https://api.verosent.com/v1/domains/dns-records/:id --data '$JSON_CONTENT_BODY'
Inhalt der Anfrage (application/json):

1
2
3

{
  "value": "54.36.5.99"
}
Je nachdem um welchen DNS Eintrag Typ es sich handelt, kann der Inhalt der Anfrage mit unterschiedlichen Parametern aufgebaut sein.
  • value (String): Der hier definierte Inhalt wird für verschiedene DNS Eintrag Typen unterschiedlich validiert. Als Beispiel: Bei einem A Eintrag wird nach einer IPv4 Adresse geprüft, für AAAA Einträge wird nach einer IPv6 Adresse geprüft und TXT Einträge können einen beliebigen Text beinhalten (usw.). Dieser Parameter wird für jeden DNS Eintrag Typ unterstützt.
  • priority (Integer): Legt die Priorität von einem DNS Eintrag fest. Je niedriger die Priorität ist, desto wahrscheinlicher ist es, dass der Eintrag als erstes von Clients ausgesucht wird, sofern der festgelegte Server verfügbar ist. Der Parameter wird nur für MX und SRV DNS Einträge verwendet.
  • weight (Integer): Setzt die Gewichtung von einem DNS Eintrag fest. Je höher der Wert ist, desto wahrscheinlicher ist es, dass Clients den Eintrag bevorzugen, sofern es mehrere Einträge mit der gleichen Priorität aber unterschiedlichen Gewichtung gibt. Die Gewichtung kann nur für SRV Einträge festgelegt werden.
  • port (Integer): Der Parameter wird nur von SRV DNS Einträgen verwendet und legt fest, auf welchen Port sich Clients mit dem festgelegten Zielserver verbinden sollen.
Antwort:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

{
   "message":"ok",
   "dns_record":{
      "id":1,
      "prefix":"www",
      "value":"54.36.5.99",
      "record_type":"A",
      "priority":null,
      "weight":null,
      "protocol":null,
      "service":null,
      "port":null,
      "created_at":"2019-07-27T10:27:10.000+02:00",
      "updated_at":"2019-07-27T10:08:24.000+02:00"
   }
}
Voraussetzungen:

Der Scope domains.dns_records_update muss aktiv sein und der API Token muss Zugriff auf das Produkt haben.

Um DNS Einträge zu löschen, sende eine DELETE Anfrage an die /v1/domains/dns-records/:id Route. Stelle sicher, dass Dein API Token Zugriff auf das Produkt hat und der dazugehörige Scope aktiv ist. (siehe Voraussetzungen weiter unten). Die in der URL angehängte ID, ist die ID des DNS Eintrags, die wie in Abschnitt 2. DNS Einträge anzeigen dieser Dokumentation entnommen werden kann.

Anfrage:

curl -X DELETE -H 'X-Verosent-Token: HWsYIoW0YMwJdGaWNEsbudnHoUQuUlRxpB9L82Sc3DixhJxw7wW36j/nzCmajb46TBQ11RIZh2+X98+KpnpF+w==' https://api.verosent.com/v1/domains/dns-records/:id
Antwort:

1
2
3

{
  "message": "ok"
}
Voraussetzungen:

Der Scope domains.dns_records_delete muss aktiv sein und der API Token muss Zugriff auf das Produkt haben.