Domänen

Anmerkungen
Expertenstufe
Der API-Schlüssel sollte als Bearer-Token in den Autorisierungsheader der Anforderung gesendet werden. API-Schlüssel abrufen.
Liste

API-Endpunkt:

GET 
https://klickeaufdenlink.de/api/v1/domains

Beispiel für Anforderung: 

curl --location --request GET 'https://klickeaufdenlink.de/api/v1/domains' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Parameter
Typ
Beschreibung
search
optional string
Die Suchabfrage.
search_by
optional string
Suche nach. Gültige Werte sind: name for: name. Standardwert: name.
sort_by
optional string
Sort by. Gültige Werte sind: id for: name, name for: name. Standardwert: id.
sort
optional string
Sortieren. Gültige Werte sind: desc for: name, asc for: name. Standardwert: desc.
per_page
optional integer
Ergebnisse pro Seite. Gültige Werte sind: 10, 25, 50, 100. Standardwert: 10.
Anzeigen

API-Endpunkt:

GET 
https://klickeaufdenlink.de/api/v1/domains/{id}

Beispiel für Anforderung: 

curl --location --request GET 'https://klickeaufdenlink.de/api/v1/domains/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Speicher

API-Endpunkt:

POST 
https://klickeaufdenlink.de/api/v1/domains

Beispiel für Anforderung: 

curl --location --request POST 'https://klickeaufdenlink.de/api/v1/domains' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'name={name}'
Parameter
Typ
Beschreibung
name
erforderlich string
Der Bereichsname.
index_page
optional string
Die Indexseite, auf die umgeleitet werden soll.
not_found_page
optional string
Die 404-Seite, auf die umgeleitet werden soll.
Aktualisieren

API-Endpunkt:

PUT PATCH 
https://klickeaufdenlink.de/api/v1/domains/{id}

Beispiel für Anforderung: 

curl --location --request PUT 'https://klickeaufdenlink.de/api/v1/domains/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'
Parameter
Typ
Beschreibung
index_page
optional string
Die Indexseite, auf die umgeleitet werden soll.
not_found_page
optional string
Die 404-Seite, auf die umgeleitet werden soll.
Löschen

API-Endpunkt:

DELETE 
https://klickeaufdenlink.de/api/v1/domains/{id}

Beispiel für Anforderung: 

curl --location --request DELETE 'https://klickeaufdenlink.de/api/v1/domains/{id}' \
--header 'Authorization: Bearer {api_key}'