Download OpenAPI specification:
APIs for Vega Backend connector types.
A connector type describes a registered data-source driver, such as mysql,
postgresql, or opensearch, together with its registration metadata and enabled
state. Field configuration (field_config, compatible with JSON Schema
properties) is returned only by the detail endpoint and is obtained from the
runtime implementation. Local definitions come from implementations in the
current process; runtime field definitions for remote connectors are not yet
implemented. mode distinguishes in-process local connectors from remote
connectors invoked over HTTP. category identifies the data-source category.
Returns paginated summaries of registered connector types to any authenticated user without connector type permission filtering. Summaries omit field_config and report only view_detail in operations. Supports filtering by name, tag, mode, category, enabled, and available.
| name | string Filters connector types whose name contains this value. |
| tag | string Filters by an exact tag match. Empty by default. |
| mode | string Enum: "local" "remote" Filters by runtime mode. |
| category | string Enum: "table" "index" "topic" "file" "fileset" "metric" "api" Filters by category. |
| enabled | boolean Filters by enabled state. Omit to disable this filter. |
| available | boolean Filters by whether the running binary includes the connector implementation. Omit to disable this filter. |
| offset | integer <int64> >= 0 Default: 0 Pagination offset. Must be at least 0 and defaults to 0. |
| limit | integer <int64> Default: 20 Page size from 1 to 1000. Use -1 to disable pagination. Defaults to 20. |
| sort | string Default: "name" Value: "name" Sort field. Defaults to |
| direction | string Default: "desc" Enum: "asc" "desc" Sort direction. Defaults to |
{- "entries": [
- {
- "type": "string",
- "name": "string",
- "tags": [
- "string"
], - "description": "string",
- "mode": "local",
- "category": "table",
- "endpoint": "string",
- "enabled": true,
- "available": true,
- "required_edition": "community",
- "operations": [
- "view_detail"
]
}
], - "total_count": 0
}Creates a connector type. type must be unique; an existing value returns 409.
| type required | string Connector type identifier. Required for POST and PUT; for PUT it must match the path parameter. |
| name required | string Connector type display name |
| tags | Array of strings Tags |
| description | string Type description |
| mode required | string Enum: "local" "remote" Runtime mode |
| category required | string Enum: "table" "index" "topic" "file" "fileset" "metric" "api" Category. When POST or PUT registers or updates a local connector, this must match the backend code definition. |
| endpoint | string Remote service address, used only in |
| enabled | boolean Default: false Whether the connector type is enabled |
{- "type": "string",
- "name": "string",
- "tags": [
- "string"
], - "description": "string",
- "mode": "local",
- "category": "table",
- "endpoint": "string",
- "enabled": false
}{- "type": "string"
}| type required | string Connector type identifier, such as |
{- "type": "string",
- "name": "string",
- "tags": [
- "string"
], - "description": "string",
- "mode": "local",
- "category": "table",
- "endpoint": "string",
- "field_config": {
- "property1": {
- "name": "string",
- "type": "string",
- "description": "string",
- "required": false,
- "encrypted": false
}, - "property2": {
- "name": "string",
- "type": "string",
- "description": "string",
- "required": false,
- "encrypted": false
}
}, - "enabled": true,
- "available": true,
- "required_edition": "community",
- "operations": [
- "view_detail"
]
}Fully updates the connector type identified by the type path parameter.
The primary key cannot be changed.
The request body must include type, and it must exactly match the path parameter:
VegaBackend.ConnectorType.InvalidParameter.Type.VegaBackend.ConnectorType.TypeMismatch.If a new name is already used by another type, the endpoint returns 409
VegaBackend.ConnectorType.NameExists.
| type required | string Connector type identifier, such as |
| type required | string Connector type identifier. Required for POST and PUT; for PUT it must match the path parameter. |
| name required | string Connector type display name |
| tags | Array of strings Tags |
| description | string Type description |
| mode required | string Enum: "local" "remote" Runtime mode |
| category required | string Enum: "table" "index" "topic" "file" "fileset" "metric" "api" Category. When POST or PUT registers or updates a local connector, this must match the backend code definition. |
| endpoint | string Remote service address, used only in |
| enabled | boolean Default: false Whether the connector type is enabled |
{- "type": "string",
- "name": "string",
- "tags": [
- "string"
], - "description": "string",
- "mode": "local",
- "category": "table",
- "endpoint": "string",
- "enabled": false
}{- "error_code": "string",
- "description": "string",
- "error_details": null,
- "metadata": { }
}Deletes the connector type identified by type. Built-in types with mode=local cannot be deleted and return 403.
| type required | string Connector type identifier, such as |
{- "error_code": "string",
- "description": "string",
- "error_details": null,
- "metadata": { }
}Enables the connector type. The operation is idempotent.
| type required | string Connector type identifier |
{- "error_code": "string",
- "description": "string",
- "error_details": null,
- "metadata": { }
}Disables the connector type. The operation is idempotent.
| type required | string Connector type identifier |
{- "error_code": "string",
- "description": "string",
- "error_details": null,
- "metadata": { }
}