Uptimeify Docs

Benutzerdefiniertes Feld erstellen

Erstellt eine neue Definition für ein benutzerdefiniertes Feld.

POST /api/custom-fields

Anfrage (Request Body)

FeldTypErforderlichStandardBeschreibung
organizationIdnumberJaOrganisations-ID
namestringJaAnzeigename
fieldKeystringNeinauto aus nameEindeutiger Schlüssel (automatisch normalisiert: Kleinbuchstaben, nicht-alphanumerisch → _)
fieldTypestringNeintexttext, select oder multiselect
isRequiredbooleanNeinfalseOb das Feld erforderlich ist
displayOrdernumberNein0Sortierreihenfolge
optionsarrayNein[]Optionen für die Typen select/multiselect
placeholderstring|nullNeinnullPlatzhaltertext
helpTextstring|nullNeinnullHilfetext unterhalb des Feldes
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

  • 409 Conflict wenn fieldKey für die Organisation bereits existiert

Antwort (Response)

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

Auf dieser Seite