Connections

Get connections

Retrieves a list of connections.

Request
Security:
ApiKeyAuth
Responses
200

OK

get/result/list
Request samples
curl -i -X GET \
  https://api.treasuredata.com/v3/result/list \
  -H 'Authorization: TD1 <YOUR_TOKEN_HERE>'
Response samples
application/json
{
  • "results": [
    ]
}

Create connection

Creates a connection.

Request
Security:
ApiKeyAuth
path Parameters
connection_name
required
string

the connection name

Request Body schema: application/x-www-form-urlencoded
url
string
Responses
200

OK

post/result/create/{connection_name}
Request samples
curl -i -X POST \
  'https://api.treasuredata.com/v3/result/create/{connection_name}' \
  -H 'Authorization: TD1 <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/x-www-form-urlencoded'
Response samples
application/json
{
  • "name": "string",
  • "result": "string"
}

Delete connection

Deletes a connection.

Request
Security:
ApiKeyAuth
path Parameters
connection_name
required
string

the connection name

Responses
200

OK

post/result/delete/{connection_name}
Request samples
curl -i -X POST \
  'https://api.treasuredata.com/v3/result/delete/{connection_name}' \
  -H 'Authorization: TD1 <YOUR_TOKEN_HERE>'
Response samples
application/json
{
  • "name": "string",
  • "result": "string"
}

Get connection id by name

Retrieves the specified connection.

Request
Security:
ApiKeyAuth
query Parameters
name
required
string
Responses
200

OK

get/connections/lookup
Request samples
curl -i -X GET \
  'https://api.treasuredata.com/v3/connections/lookup?name=string' \
  -H 'Authorization: TD1 <YOUR_TOKEN_HERE>'
Response samples
application/json
{
  • "id": 17
}

Validate connector config

Validates a connector configuration.

Request
Security:
ApiKeyAuth
Request Body schema: application/x-www-form-urlencoded
type
string
settings
object
connection_id
integer (ConnectionId)

the connection id

Responses
200

OK

post/connector_configs/validate_with_connection
Request samples
curl -i -X POST \
  https://api.treasuredata.com/v3/connector_configs/validate_with_connection \
  -H 'Authorization: TD1 <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/x-www-form-urlencoded'
Response samples
application/json
{
  • "type": "string",
  • "settings": { }
}
Support
Copyright © 2021 Treasure Data, Inc. (or its affiliates). All rights reserved.