API

API Key erstellen

Um bei uns einen API Key zu erstellen, benötigt ihr ein Netzwerk, bereits bei der Erstellung eines Netzwerks könnt ihr den API Key erstellen lassen. Solltet ihr es nachträglich nachholen wollen, so könnt Ihr dies unter der Netzwerkübersicht nachholen. Dazu müsst ihr einfach das entsprechende Netzwerk bearbeiten und den API Key generieren lassen.

API Key ändern

Solltet Ihr euren API Key einmal ändern, könnt Ihr die Schritte genau wie beim anlegen durchgehen. Der Button generieren heißt dann neu generieren schon habt ihr den Key neu erstellt.

API nutzen

Die produktive API erreicht Ihr unter:

https://api.ucp.li/v2

Sendet euren API-Key bei jeder Anfrage im Header X-API-Key mit. Alternativ kann derselbe Key als Bearer Token übergeben werden.

X-API-Key: <euer-api-key>
Accept: application/json

Die API arbeitet immer im Netzwerk, zu dem der API-Key gehört. Das Feld network darf deshalb nicht im Request-Body übergeben werden.

Weitere Details, Response-Beispiele und Schemas findet Ihr in der interaktiven VPC API v2 Reference.