> ## Documentation Index
> Fetch the complete documentation index at: https://documents.trocco.io/llms.txt
> Use this file to discover all available pages before exploring further.
# カスタムコネクタ一覧取得
> カスタムコネクタ定義の一覧を取得します。転送元(input)・転送先(output)を横断して返します。
## OpenAPI
````json GET /api/custom_connectors
{
"openapi": "3.0.3",
"info": {
"title": "trocco APIリファレンス",
"description": "trocco APIリファレンス",
"version": "0.0.1"
},
"servers": [
{
"url": "https://trocco.io"
}
],
"security": [
{
"ApiKeyAuth": []
}
],
"tags": [
{
"name": "users",
"description": "ユーザー",
"externalDocs": {
"url": "https://documents.trocco.io/docs/about-account-user"
}
},
{
"name": "teams",
"description": "チーム",
"externalDocs": {
"url": "https://documents.trocco.io/docs/team"
}
},
{
"name": "connections",
"description": "接続情報",
"externalDocs": {
"url": "https://documents.trocco.io/docs/connection-configurations"
}
},
{
"name": "custom_connectors",
"description": "カスタムコネクタ定義"
},
{
"name": "datamart_definitions",
"description": "データマート定義",
"externalDocs": {
"url": "https://documents.trocco.io/docs/data-mart"
}
},
{
"name": "environment_groups",
"description": "環境グループ"
},
{
"name": "environments",
"description": "環境"
},
{
"name": "jobs",
"description": "転送ジョブ",
"externalDocs": {
"url": "https://documents.trocco.io/docs/etl-configuration"
}
},
{
"name": "pipeline_jobs",
"description": "ワークフロージョブ",
"externalDocs": {
"url": "https://documents.trocco.io/docs/about-workflow"
}
},
{
"name": "resource_groups",
"description": "リソースグループ",
"externalDocs": {
"url": "https://documents.trocco.io/docs/resource-group"
}
},
{
"name": "dbt_git_repositories",
"description": "dbt Gitリポジトリ"
},
{
"name": "dbt_job_definitions",
"description": "dbtジョブ設定",
"externalDocs": {
"url": "https://documents.trocco.io/docs/dbt-job-configuration"
}
},
{
"name": "dbt_jobs",
"description": "dbtジョブ",
"externalDocs": {
"url": "https://documents.trocco.io/docs/dbt-job-configuration"
}
},
{
"name": "notification_destinations",
"description": "通知先",
"externalDocs": {
"url": "https://documents.trocco.io/docs/trocco-tutorial-additional-settings"
}
}
],
"externalDocs": {
"description": "trocco APIについて",
"url": "https://documents.trocco.io/docs/trocco-api"
},
"paths": {
"/api/custom_connectors": {
"get": {
"summary": "カスタムコネクタ一覧取得\n",
"description": "カスタムコネクタ定義の一覧を取得します。転送元(input)・転送先(output)を横断して返します。\n",
"operationId": "listCustomConnector",
"tags": [
"custom_connectors"
],
"parameters": [
{
"name": "limit",
"description": "取得する最大件数を指定します。",
"in": "query",
"schema": {
"type": "integer",
"format": "int64",
"default": 50,
"maximum": 200
}
},
{
"name": "cursor",
"description": "取得開始レコードを示すページネーションカーソルを指定します。
\nレスポンスに含まれる `next_cursor` をセットすると、後続の一覧を取得できます。\n",
"in": "query",
"schema": {
"type": "string"
},
"example": "eyJpZCI6MjF9"
}
],
"responses": {
"200": {
"description": "カスタムコネクタ一覧を返します。",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"title": "CustomConnectorListItem",
"type": "object",
"properties": {
"id": {
"description": "カスタムコネクタIDです。",
"type": "integer",
"format": "int64",
"example": 1
},
"name": {
"description": "カスタムコネクタ名です。",
"type": "string",
"example": "My API Connector"
},
"description": {
"description": "メモです。",
"type": "string",
"example": "desc",
"nullable": true
},
"url": {
"description": "ベースURLです。",
"type": "string",
"example": "https://api.example.com"
},
"auth_type": {
"description": "認証方式です。",
"type": "string",
"enum": [
"api_key",
"oauth2"
],
"example": "api_key"
},
"transfer_type": {
"description": "転送方向です。転送元は input、転送先は output です。",
"type": "string",
"enum": [
"input",
"output"
],
"example": "input"
}
},
"required": [
"id",
"name",
"url",
"auth_type",
"transfer_type"
]
}
}
},
"required": [
"items"
]
},
{
"title": "Pagination",
"type": "object",
"properties": {
"next_cursor": {
"description": "後続のページネーションリクエストの取得開始レコードを示すカーソル値です。",
"type": "string"
}
}
}
]
}
}
}
},
"401": {
"description": "Not authenticated.
\n認証エラーです。API KEYをご確認ください。\n"
}
}
}
}
},
"components": {
"securitySchemes": {
"ApiKeyAuth": {
"type": "apiKey",
"in": "header",
"name": "Authorization",
"description": "認証キーとなるAPI KEYをAuthorization: Token {{API KEY}}の形式でヘッダーにセットします。
\nAPI KEYがabc123の場合は、Authorization: Token abc123とします。
\nAPI KEYの作成方法は、TROCCO API KEYの作成を参照ください。\n"
}
}
}
}
````