Skip to content
TD API
/
API References
/
Connections

Treasure Data API (3)

Download OpenAPI description
td-api.json
td-api.yaml
Languages
Servers

https://api.treasuredata.com/v3/

https://api.treasuredata.co.jp/v3/

https://api.ap02.treasuredata.com/v3/

https://api.eu01.treasuredata.com/v3/

Access Control - Policies

Operations

Access Control - Permissions

Operations

Access Control - Users

Operations

Access Control - Policy Groups

Operations

Connections

Operations

Get connections

Request

Retrieves a list of connections.

Security
ApiKeyAuth
curl -i -X GET \
  https://api.treasuredata.com/v3/result/list \
  -H 'Authorization: TD1 <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
resultsArray of objectsrequired
results[].​namestringrequired
results[].​urlstringrequired
results[].​organizationstring or nullDeprecatedrequired
Response
application/json
{
  "results": [
    { … }
  ]
}

Create connection

Request

Creates a connection.

Security
ApiKeyAuth
Path
connection_namestringrequired

the connection name

Bodyapplication/x-www-form-urlencoded
urlstring
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' \
  -d url=string

Responses

OK

Bodyapplication/json
namestringrequired
resultstringrequired
Response
application/json
{
  "name": "string",
  "result": "string"
}

Delete connection

Request

Deletes a connection.

Security
ApiKeyAuth
Path
connection_namestringrequired

the connection name

curl -i -X POST \
  'https://api.treasuredata.com/v3/result/delete/{connection_name}' \
  -H 'Authorization: TD1 <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
namestringrequired
resultstringrequired
Response
application/json
{
  "name": "string",
  "result": "string"
}

Get connection id by name

Request

Retrieves the specified connection.

Security
ApiKeyAuth
Query
namestringrequired
curl -i -X GET \
  'https://api.treasuredata.com/v3/connections/lookup?name=string' \
  -H 'Authorization: TD1 <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
idinteger(ConnectionId)required

the connection id

Example: 17
Response
application/json
{
  "id": 17
}

Validate connector config

Request

Validates a connector configuration.

Security
ApiKeyAuth
Bodyapplication/x-www-form-urlencoded
typestring
settingsobject
connection_idinteger(ConnectionId)

the connection id

Example: 17
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' \
  -d type=string \
  -d connection_id=17

Responses

OK

Bodyapplication/json
typestringrequired
settingsobjectrequired
Response
application/json
{
  "type": "string",
  "settings": {}
}

Databases

Operations

Jobs

Operations

Tables

Operations

Policy Group Tags

Operations

Schedules

Operations

Users

Operations