Connections
List all available connections that can be configured.
Returns a list of available connection types with their configuration parameters.
Successful Response
GET /connections/available HTTP/1.1
Host: api.stack-ai.com
Accept: */*
Successful Response
[]List all available connections for the user in his current organization.
1000Successful Response
Validation Error
GET /connections HTTP/1.1
Host: api.stack-ai.com
Accept: */*
[]Create a new connection. The connection will be created in the user's current organization.
Successful Response
Validation Error
POST /connections HTTP/1.1
Host: api.stack-ai.com
Content-Type: application/json
Accept: */*
No content
Retrieve a connection by its ID.
falseSuccessful Response
Validation Error
GET /connections/{connection_id} HTTP/1.1
Host: api.stack-ai.com
Accept: */*
No content
Update the connection with the given id.
Successful Response
Validation Error
PUT /connections/{connection_id} HTTP/1.1
Host: api.stack-ai.com
Content-Type: application/json
Accept: */*
No content
Delete a connection given its ID.
Successful Response
No content
Validation Error
DELETE /connections/{connection_id} HTTP/1.1
Host: api.stack-ai.com
Accept: */*
No content
Check the health of a connection.
falseSuccessful Response
Validation Error
GET /connections/{connection_id}/health HTTP/1.1
Host: api.stack-ai.com
Accept: */*
{}Share the connection with the current organization.
falseSuccessful Response
Validation Error
PATCH /connections/{connection_id}/share-with-current-org?share=true HTTP/1.1
Host: api.stack-ai.com
Accept: */*
No content
Return the OAuth URL for a connection provider.
Successful Response
Validation Error
POST /connections/oauth/start HTTP/1.1
Host: api.stack-ai.com
Content-Type: application/json
Accept: */*
textCreate a new connection from an OAuth callback.
This endpoint is used to create a new connection for providers that use the OAuth protocol. The OAuth flow is initialized by the stack frontend, where the user is redirected to the provider's authorization page. Once the user authorizes the application, they are redirected back to the stack frontend with a code parameter. This code is then sent to this endpoint, which uses it to create a new connection for said provider completing the OAuth flow.
Successful Response
Validation Error
POST /connections/oauth/callback?code=text HTTP/1.1
Host: api.stack-ai.com
Content-Type: application/json
Accept: */*
No content
Get the resources associated with a connection.
This endpoint returns the information for the selected resource in the connection.
falseSuccessful Response
Validation Error
GET /connections/{connection_id}/resources HTTP/1.1
Host: api.stack-ai.com
Accept: */*
{
"ANY_ADDITIONAL_PROPERTY": null
}Get the children of a resource associated with a connection.
This endpoint can be used to navigate the resources in the connection. If no resource_id is provided, it will return the list of resources at the root of the connection. If a resource_id is provided, it will return the children of that resource. If the resource_id corresponds to a file, an empty list will be returned.
Optional identifier for the page that should be returned. If it is not provided, the first page will be returned.
ZXhhbXBsZV9jdXJzb3I=Number of items to be returned in the page.
50falseSuccessful Response
Validation Error
GET /connections/{connection_id}/resources/children HTTP/1.1
Host: api.stack-ai.com
Accept: */*
No content
Search for resources in the connection that match the query.
Search query string
Optional identifier for the page that should be returned. If it is not provided, the first page will be returned.
ZXhhbXBsZV9jdXJzb3I=Number of items to be returned in the page.
50falseSuccessful Response
Validation Error
GET /connections/{connection_id}/resources/search?query=text HTTP/1.1
Host: api.stack-ai.com
Accept: */*
No content
Was this helpful?