API Reference
This page defines SQLpipe's API routes and the data payloads they expect to receive.
Send a
POST
request to:/api/v1/transfers
With the following fields:
sourceID int
targetID int
query string
targetSchema string
targetTable string
overwrite bool
Send a
GET
request to:/api/v1/transfers
page
page_size
sort
page
andpage_size
are for pagination.sort
's value may beid
orcreated_at
Send a
GET
request to:/api/v1/transfers/<transfer_id>
Send a
PATCH
request to:/api/v1/cancel-transfer/<transfer_id>
Send a
DELETE
request to:/api/v1/transfers/<transfer_id>
Send a
POST
request to:/api/v1/queries
With the following fields:
connectionId int
query string
Send a
GET
request to:/api/v1/queries
page
page_size
sort
page
andpage_size
are for pagination.sort
's value may beid
orcreated_at
Send a
GET
request to:/api/v1/queries/<query_id>
Send a
PATCH
request to:/api/v1/cancel-query/<query_id>
Send a
DELETE
request to:/api/v1/queries/<query_id>
Send a
POST
request to:/api/v1/queries
With the following fields:
connectionId int
query string
Send a
GET
request to:/api/v1/connections
page
page_size
sort
page
andpage_size
are for pagination.sort
's value may beid
orcreated_at
Send a
GET
request to:/api/v1/connections/<connection_id>
Send a
PATCH
request to:/api/v1/connections/<connection_id>
Using the same fields as you would to create a connection.
Send a
DELETE
request to:/api/v1/connection/<connection_id>
Send a
POST
request to:/api/v1/users
With the following fields:
username string
password string
admin bool
Send a
GET
request to:/api/v1/users
page
page_size
sort
page
andpage_size
are for pagination.sort
's value may beid
orcreated_at
Send a
GET
request to:/api/v1/users/<user_id>
Send a
PATCH
request to:/api/v1/users/<user_id>
Using the same fields as you would to create a user.
Send a
DELETE
request to:/api/v1/user/<user_id>
Last modified 10mo ago