Skip to content
TD API
/
API References
/
Databases
/
Get database

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

Databases

Operations

Get databases

Request

Retrieves a list of databases.

Security
ApiKeyAuth
Query
require_permissionsstringtrue
curl -i -X GET \
  'https://api.treasuredata.com/v3/database/list?require_permissions=string' \
  -H 'Authorization: TD1 <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
databasesArray of objects(Database)required
databases[].​countintegerrequired

the number of records in the database

Example: 5
databases[].​created_atstring(DateTimeAsString)\d{4}-\d{2}-\d{2}\s\d{2}:\d{2}:\d{2}\s(([+-]\...required

Datetime in custom format (2020-12-31 11:22:33 -0500 or 2020-12-31 11:22:33 UTC for UTC)

Example: "2020-12-31 11:22:33 UTC"
databases[].​delete_protectedbooleanrequired

whether the database is delete protected

Example: true
databases[].​namestringrequired

database name

Example: "Alpha"
databases[].​organizationstring or nullrequired

the organization

Example: "Treasure Data"
databases[].​permissionstring or nullrequired

permissions

databases[].​database_permissionsobject

permissions

databases[].​updated_atstring(DateTimeAsString)\d{4}-\d{2}-\d{2}\s\d{2}:\d{2}:\d{2}\s(([+-]\...required

Datetime in custom format (2020-12-31 11:22:33 -0500 or 2020-12-31 11:22:33 UTC for UTC)

Example: "2020-12-31 11:22:33 UTC"
Response
application/json
{
  "databases": [
    { … }
  ]
}

Get database

Request

Retrieves a specified database.

Security
ApiKeyAuth
Path
database_namestringrequired

database name

Example: Alpha
Query
require_permissionsstringtrue
curl -i -X GET \
  'https://api.treasuredata.com/v3/database/show/Alpha?require_permissions=string' \
  -H 'Authorization: TD1 <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
countintegerrequired

???

Example: 5
created_atstring(DateTimeAsString)\d{4}-\d{2}-\d{2}\s\d{2}:\d{2}:\d{2}\s(([+-]\...required

Datetime in custom format (2020-12-31 11:22:33 -0500 or 2020-12-31 11:22:33 UTC for UTC)

Example: "2020-12-31 11:22:33 UTC"
delete_protectedbooleanrequired

wheter the database is delete protected

Example: true
datatankboolean
idstring(DatabaseIdAsString)
Example: "7"
namestringrequired

database name

Example: "Alpha"
organizationstring or nullrequired

the organization

Example: "Treasure Data"
permissionstring or nullrequired

permissions

database_permissionsobject

permissions

updated_atstring(DateTimeAsString)\d{4}-\d{2}-\d{2}\s\d{2}:\d{2}:\d{2}\s(([+-]\...required

Datetime in custom format (2020-12-31 11:22:33 -0500 or 2020-12-31 11:22:33 UTC for UTC)

Example: "2020-12-31 11:22:33 UTC"
Response
application/json
{
  "count": 5,
  "created_at": "2020-12-31 11:22:33 UTC",
  "delete_protected": true,
  "datatank": true,
  "id": "7",
  "name": "Alpha",
  "organization": "Treasure Data",
  "permission": "string",
  "database_permissions": {
    "edit": true,
    "delete": true,
    "query": true,
    "import": true,
    "download": true
  },
  "updated_at": "2020-12-31 11:22:33 UTC"
}

Create database

Request

Creates a database.

Security
ApiKeyAuth
Path
database_namestringrequired

database name

Example: Alpha
curl -i -X POST \
  https://api.treasuredata.com/v3/database/create/Alpha \
  -H 'Authorization: TD1 <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
databasestringrequired

database name

Example: "Alpha"
Response
application/json
{
  "database": "Alpha"
}

Delete database

Request

Deletes a specified database.

Security
ApiKeyAuth
Path
database_namestringrequired

database name

Example: Alpha
curl -i -X POST \
  https://api.treasuredata.com/v3/database/delete/Alpha \
  -H 'Authorization: TD1 <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
databasestringrequired

database name

Example: "Alpha"
Response
application/json
{
  "database": "Alpha"
}

Jobs

Operations

Tables

Operations

Policy Group Tags

Operations

Schedules

Operations

Users

Operations