curl --request POST \
--url https://api.netzfabrik.com/user/api-tokens \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"description": "Deploy-Pipeline",
"expiresAt": "2027-12-31T23:59:59+00:00"
}
'import requests
url = "https://api.netzfabrik.com/user/api-tokens"
payload = {
"description": "Deploy-Pipeline",
"expiresAt": "2027-12-31T23:59:59+00:00"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({description: 'Deploy-Pipeline', expiresAt: '2027-12-31T23:59:59+00:00'})
};
fetch('https://api.netzfabrik.com/user/api-tokens', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.netzfabrik.com/user/api-tokens",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'description' => 'Deploy-Pipeline',
'expiresAt' => '2027-12-31T23:59:59+00:00'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.netzfabrik.com/user/api-tokens"
payload := strings.NewReader("{\n \"description\": \"Deploy-Pipeline\",\n \"expiresAt\": \"2027-12-31T23:59:59+00:00\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.netzfabrik.com/user/api-tokens")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"description\": \"Deploy-Pipeline\",\n \"expiresAt\": \"2027-12-31T23:59:59+00:00\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.netzfabrik.com/user/api-tokens")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"description\": \"Deploy-Pipeline\",\n \"expiresAt\": \"2027-12-31T23:59:59+00:00\"\n}"
response = http.request(request)
puts response.read_body{
"id": "A1B2C3D4E5F6G7H8I9J0",
"token": "api_1a2b3c4d…",
"tokenPrefix": "api_1a2b3c4d",
"scope": "read",
"customerId": "<string>",
"customerName": "Acme GmbH",
"description": "My API token",
"expiresAt": "2021-01-01T00:00:00+00:00"
}{
"title": "<string>",
"detail": "<string>",
"status": 404,
"instance": "<string>",
"type": "<string>"
}{
"status": 422,
"violations": [
{
"propertyPath": "<string>",
"message": "<string>",
"code": "<string>",
"hint": "<string>",
"payload": {}
}
],
"detail": "<string>",
"type": "<string>",
"title": "<string>",
"instance": "<string>"
}API-Token erstellen
Erstellt einen persönlichen API-Token für Skripte und Server-Integrationen. Der Klartext steht nur in dieser Antwort im Feld token; speichere ihn sicher. Anschließend authentifizierst du Anfragen mit dem Header X-API-TOKEN: <token>.
Ohne expiresAt läuft der Token nicht ab. Er handelt mit den Rechten des Benutzers, der ihn erstellt. Ist für den Benutzer ein zweiter Faktor aktiv, muss er zuvor mit POST /auth/2fa/step-up bestätigt werden, sonst antwortet der Endpunkt mit 403 mfa_step_up_required.
Tokens lassen sich auch im Kundenpanel unter Einstellungen → Sicherheit anlegen.
curl --request POST \
--url https://api.netzfabrik.com/user/api-tokens \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"description": "Deploy-Pipeline",
"expiresAt": "2027-12-31T23:59:59+00:00"
}
'import requests
url = "https://api.netzfabrik.com/user/api-tokens"
payload = {
"description": "Deploy-Pipeline",
"expiresAt": "2027-12-31T23:59:59+00:00"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({description: 'Deploy-Pipeline', expiresAt: '2027-12-31T23:59:59+00:00'})
};
fetch('https://api.netzfabrik.com/user/api-tokens', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.netzfabrik.com/user/api-tokens",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'description' => 'Deploy-Pipeline',
'expiresAt' => '2027-12-31T23:59:59+00:00'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.netzfabrik.com/user/api-tokens"
payload := strings.NewReader("{\n \"description\": \"Deploy-Pipeline\",\n \"expiresAt\": \"2027-12-31T23:59:59+00:00\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.netzfabrik.com/user/api-tokens")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"description\": \"Deploy-Pipeline\",\n \"expiresAt\": \"2027-12-31T23:59:59+00:00\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.netzfabrik.com/user/api-tokens")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"description\": \"Deploy-Pipeline\",\n \"expiresAt\": \"2027-12-31T23:59:59+00:00\"\n}"
response = http.request(request)
puts response.read_body{
"id": "A1B2C3D4E5F6G7H8I9J0",
"token": "api_1a2b3c4d…",
"tokenPrefix": "api_1a2b3c4d",
"scope": "read",
"customerId": "<string>",
"customerName": "Acme GmbH",
"description": "My API token",
"expiresAt": "2021-01-01T00:00:00+00:00"
}{
"title": "<string>",
"detail": "<string>",
"status": 404,
"instance": "<string>",
"type": "<string>"
}{
"status": 422,
"violations": [
{
"propertyPath": "<string>",
"message": "<string>",
"code": "<string>",
"hint": "<string>",
"payload": {}
}
],
"detail": "<string>",
"type": "<string>",
"title": "<string>",
"instance": "<string>"
}Authorizations
Access-Token aus POST /auth/login (E-Mail und Passwort), gesendet als Authorization: Bearer <token>.
Das Token ist zeitlich begrenzt gültig. Mit dem refresh_token aus derselben Antwort holt POST /auth/token/refresh ein neues Token-Paar, ohne das Passwort erneut zu senden; POST /auth/token/invalidate macht den Refresh-Token beim Abmelden ungültig.
Ist für das Konto ein zweiter Faktor aktiv oder vorgeschrieben, liefert der Login statt des Token-Paars mfaRequired: true bzw. mfaEnrollmentRequired: true und ein kurzlebiges preAuthToken. Mit diesem Token (ebenfalls als Bearer) wird der zweite Faktor über POST /auth/2fa/verify bestätigt; erst danach gibt es das volle Token-Paar.
Headers
Optionaler Kundenkontext. Ohne Header arbeitet die Anfrage im Standard-Kunden des angemeldeten Benutzers. Mit der ID eines anderen Kunden handelt die Anfrage in dessen Kontext: Listen, Lese- und Schreibzugriffe beziehen sich dann auf diesen Kunden.
Erlaubt sind der eigene Kunde, jeder Unterkunde im eigenen Teilbaum (Reseller handelt für seinen Endkunden) sowie Kunden, in denen der Benutzer selbst Mitglied ist. Übergeordnete oder fremde Kunden werden mit 403 Forbidden abgewiesen, eine unbekannte ID ebenfalls.
Die IDs der erreichbaren Kunden liefern GET /user/customers und GET /customers/{id}/children.
"01JD4Q8W3N6Y2K5T7R9V0B1C2D"
Body
The new ApiToken resource
Response
ApiToken resource created
Was this page helpful?