Skip to Content
Uptimeify Docs

Benutzerdefiniertes Feld erstellen

Erstellt eine neue Definition für ein benutzerdefiniertes Feld.

POST /api/custom-fields

Erfordert die Rolle admin (oder einen globalen Admin). Editoren und Nur-Lese-Benutzer erhalten 403.

Anfrage (Request Body)

FeldTypErforderlichStandardBeschreibung
organizationIdnumberNeinaus der SessionMuss, falls angegeben, deine eigene Organisation sein
namestringJa-Anzeigename, 1 bis 100 Zeichen
fieldKeystringNeinauto aus nameEindeutiger Schlüssel, max. 100 Zeichen (automatisch normalisiert: Kleinbuchstaben, nicht-alphanumerisch → _)
fieldTypestringNeintextEiner von text, number, email, url, select
isRequiredbooleanNeinfalseOb das Feld erforderlich ist
displayOrdernumberNein0Sortierreihenfolge, Ganzzahl 0 bis 10000
optionsstring[]Nein[]Optionen für den Typ select, max. 50 Einträge mit je max. 100 Zeichen
placeholderstring|nullNeinnullPlatzhaltertext, max. 200 Zeichen
helpTextstring|nullNeinnullHilfetext unterhalb des Feldes, max. 500 Zeichen
showInTablebooleanNeintrueIn Tabellenansichten anzeigen

Beispiel (cURL)

curl -X POST "$BASE_URL/api/custom-fields" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "organizationId": 1,
    "name": "Environment",
    "fieldType": "select",
    "options": ["production", "staging", "development"],
    "isRequired": true,
    "showInTable": true
  }'

Häufige Fehler

  • 400 Bad Request wenn der Body die Validierung nicht besteht (unbekannter fieldType, name fehlt oder hat mehr als 100 Zeichen, mehr als 50 options)
  • 403 Forbidden wenn deine Rolle nicht admin ist oder organizationId eine fremde Organisation nennt
  • 409 Conflict (customFieldAlreadyExists), wenn für die Organisation bereits ein aktives Feld mit diesem fieldKey existiert. Ein gelöschtes (deaktiviertes) Feld mit demselben Schlüssel wird stattdessen mit den Angaben aus dem Body reaktiviert; bereits an Kunden gespeicherte Werte unter dem Schlüssel bleiben unverändert.

Antwort (Response)

Gibt das erstellte benutzerdefinierte Feld-Objekt zurück. Siehe Fehlercodes für Fehlerantworten.

Auf dieser Seite