---
title: ソース API
description: スコープで保護されたエンドポイントを通じて、データソースの一覧表示、確認、作成、変更、テスト、一時停止、削除を行います。
species: reference
---
# ソース API

ソースの読み取りには `data:read` が必要です。作成、変更、テスト、一時停止状態の変更、削除には `apps:manage` が必要です。

## 一覧表示と作成

```endpoint
GET /sources
```

削除されていないソースを、最新の同期概要とともに新しい順で返します。

```endpoint
POST /sources
```

キーで設定するソースを作成し、その `Location` とともに `201` を返します。OAuth コネクターは、この本文で OAuth シークレットを受け取るのではなく、仲介された認可フローを使用します。スタッフ専用、従来のエイリアス、同期を行わないコネクターは拒否されます。

JSON 本文には、`connector`、コネクターの `config`、そのコネクターが受け付けるシークレットのフィールドを指定します。無効なフィールドには、`param` を含む `400 invalid_source_parameters` を返します。

## 確認と変更

```endpoint
GET /sources/{id}
```

ソースの詳細、最新の同期、現在のテーブル設定を返します。

```endpoint
PATCH /sources/{id}
```

対応する設定または `paused` を変更します。更新が競合する場合は、`409 source_config_unavailable` または `409 source_pause_failed` を返します。

```endpoint
DELETE /sources/{id}
```

ソースを論理削除し、`{"object":"source_deletion","deleted":true,"data_retained":true}` を返します。レイクにある既存のデータは残ります。削除すると、以降のソースの動作が停止します。

## 接続をテスト

```endpoint
POST /sources/{id}/test
```

`supported`、`ok`、意図的に詳細を伏せたエラーを返します。PostgreSQL は、実際の接続テストに対応しています。他のコネクターは、`supported: false` を返す場合があります。認証情報のホスト名、ユーザー名、接続先のメッセージはレスポンスに含めません。

アクセスできない ID は、常に `404 source_not_found` を返します。