Menu dokumentacji

API źródeł#

Odczyt źródeł wymaga data:read. Tworzenie, zmiany, testy, stan wstrzymania i usuwanie wymagają apps:manage.

Wyświetlanie i tworzenie#

GET/sources

Zwraca nieusunięte źródła od najnowszych wraz z podsumowaniem ostatniej synchronizacji.

POST/sources

Tworzy źródło konfigurowane kluczem i zwraca 201 z jego nagłówkiem Location. Konektory OAuth używają pośredniczonego procesu autoryzacji, zamiast przyjmować sekrety OAuth w tej treści. Konektory wyłącznie dla zespołu, starsze aliasy i konektory niesynchronizujące są odrzucane.

Treść JSON zawiera connector, jego config oraz pola sekretów przyjmowane przez ten konektor. Nieprawidłowe pola zwracają 400 invalid_source_parameters z param.

Przeglądanie i zmienianie#

GET/sources/{id}

Zwraca szczegóły źródła, ostatnią synchronizację i bieżącą konfigurację tabel.

PATCH/sources/{id}

Zmienia obsługiwaną konfigurację lub paused. Aktualizacja w konflikcie zwraca 409 source_config_unavailable albo 409 source_pause_failed.

DELETE/sources/{id}

Miękko usuwa źródło i zwraca {"object":"source_deletion","deleted":true,"data_retained":true}. Istniejące dane jeziora pozostają, a usunięcie zatrzymuje przyszłą aktywność źródła.

Testowanie połączenia#

POST/sources/{id}/test

Zwraca supported, ok i celowo ogólny błąd. PostgreSQL obsługuje test aktywnego połączenia. Inne konektory mogą zwrócić supported: false. Nazwy hostów i użytkowników danych uwierzytelniających ani komunikaty miejsca docelowego nie są powtarzane.

Niedostępny identyfikator zawsze zwraca 404 source_not_found.