Issue with Airbyte API endpoints

Slack Knowledge Base Q&A API, Terraform and Other Topics
, , , ,
1

Summary

User is facing issues with Airbyte API endpoints ‘/api/v1/health’ and ‘/v1/connections’. They are getting unexpected responses and are unsure if they are using the correct URLs.


Question

[Airbyte API]

Hey, we just deployed airbyte using <Artifact Hub chart> and now we are running it using the latest airbyte version: 0.58.0.
This can be just a silly problem, but I’m trying to run the airbyte apis, the first one is the /api/v1/health , and I got {"available":true} as response (is this correct?).

But, now I’m trying to list all connections in my env, according to the https://reference.airbyte.com/reference/listconnections|documentation, need to run this endpoint /v1/connections?includeDeleted=false&limit=20&offset=0" , but now, I’m geeting this Object not found. as response. Am I doing sth wrong?

Btw, this is my url http://my-host/api/v1. I’m not declaring any port (like 8006 for example, should I?).


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

["airbyte-api", "health-endpoint", "list-connections", "api-url"]
2

are you using correct service? it’s not exposed by default

3

airbyte-api ClusterIP 10.109.190.37 <none> 8006/TCP 21d

4

<@U06AQE1UMMH> it worked, I had to expose the service. Also need to use /api/public/v1

5

note that the /api/v1/* path generally works (I don’t know if this is intended or not) from the webapp service URL, but if you expose the API service directly, you need to just use /v1/*. This is often why you see mixed usage when looking at posts around here.

6

<@U06SV3WK399> I’m having a similar issue but we’re running a slightly older Airbyte version. How did you expose the service? I’ve added an ingress rule to expose airbyte-api-server on port 8006 but I’m getting 404 response.

7

<@U04FATFMQ93> What path are you using for the API? it’s actually available on the main webapp service at /api/*, but drops that prefix on the API server.

8

I tried using /api/* but without success. The only endpoint that works is /api/v1/health.