Adding new low-code connector with API

Summary

Exploring the possibility of adding a new low-code connector using the API


Question

hey! is there any way to add a new low-code connector (yaml) with the api? i looked through the documentation, but couldn’t find anything :thinking_face:



This topic has been created from a Slack thread to give it more visibility.
It will be on Read-Only mode here. Click here if you want to access the original thread.

Join the conversation on Slack

["add-new-connector", "low-code-connector", "yaml", "api", "documentation"]

Hmm, I don’t know enough to give you a confident answer yet. The information provided does not include specific details on how to add a new low-code connector using the API. However, I can guide you on how to add a new low-code connector using the Airbyte’s low-code framework and connector builder UI. Here’s a brief overview of the process: 1. Generate the API key or credentials for the source you want to build a connector for. 2. Set up the project on your local machine. 3. Set up your local development environment. 4. Use the connector builder UI to define the connector YAML manifest and test the connector. 5. Specify stream schemas. 6. Add the connector to the Airbyte platform. For a step-by-step tutorial, you can refer to the Getting Started tutorial or the video tutorial provided in the documentation. If you want to contribute your connector back to the Airbyte connector catalog to make it available outside of your workspace, you can follow the steps provided in the Exporting the connector section of the documentation. For more information, you can refer to the Connector Development section of the Airbyte documentation.

i could find in the management api using the same endpoint as the no-code builder in the ui, but i guess i don’t have access to that

You mean you want to poke Airbyte cluster via it’s management API and ask it to please save a new “builder connector” via the API, and not with the builder?

I can show you the endpoints that Builder is using, but that’s not something we officially support I think — so it might get bumpy.

Do you need the connector in your workspace, or do you need the connector in the builder specifically?

If you need a custom connector in your workspace, it’s probably cheaper to build it into a docker image, and then import a connector as a docker image instead (I assume the API has endpoints to do that).

I pretty much want to post the low-code yaml to some API, then it would appear as a source in my Airbyte workspace. It doesn’t have to be in the builder necessarily, just figured that’ d be easiest.

I found the various APIs the builder is using, but if I’m using Airbyte Cloud I guess those can’t be used by customers?

Curious about the docker image, how do I do that? Is it possible to use it for Airbyte Cloud?

> I found the various APIs the builder is using, but if I’m using Airbyte Cloud I guess those can’t be used by customers?
Yeah, at least they’re not intended for use by customers, and they are not guaranteed to not change.

> Curious about the docker image, how do I do that? Is it possible to use it for Airbyte Cloud?
Hmm, if you want a fully custom connector on cloud — that’s tricky, you’d have to post it to your workspace specifically, and you’re on the right track — it would have to be builder area, not a custom docker image.

Custom images are something you could more easy ship to an OSS version, Cloud I believe is more strict.

Let me ask the team re: API for that.