Skip to main content
GET
/
api
/
airbyte
/
sources
/
{source_name}
Get source details
curl --request GET \
  --url https://api.example.com/api/airbyte/sources/{source_name} \
  --header 'Authorization: Bearer <token>'
{
  "name": "<string>",
  "package_name": "<string>",
  "display_name": "<string>",
  "category": "<string>",
  "version": "<string>",
  "description": "",
  "config_fields": [
    {
      "name": "<string>",
      "title": "<string>",
      "type": "string",
      "required": true,
      "secret": false,
      "description": ""
    }
  ],
  "config_template": {}
}

Documentation Index

Fetch the complete documentation index at: https://docs.nx1cloud.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
source_name
string
required

PyAirbyte source identifier.

Response

Source connector details.

Metadata for a single available PyAirbyte source connector.

​
name
string
required

Source identifier. For example, source-github.

​
package_name
string
required

PyPI package name. For example, airbyte-source-github.

​
display_name
string
required

Human-readable source name.

​
category
string
required

Category grouping. For example, Engineering or CRM).

​
version
string | null

Pinned PyPI package version. For example, 2.3.3. If None, latest is installed.

​
description
string
default:""

Brief description of the source.

​
config_fields
AirbyteSourceConfigField · object[]

Configuration fields required by this source.

​
config_template
Config Template · object

Template mapping flat form values to the nested config shape the connector expects. Uses {{field_name}} placeholders. If None, flat config is passed through as-is.