# Treasure Data API

Version: 3

## Servers

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

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

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

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

## Security

### ApiKeyAuth

Type: http
Scheme: TD1

## Download OpenAPI description

 - [Treasure Data API](https://docs.treasure.ai/_bundle/apis/td_api_v3-public.yaml)

## Access Control - Policies

 - [GET /access_control/policies](https://docs.treasure.ai/apis/td_api_v3-public/access-control-policies/getaccesscontrolpolicies.md): Retrieves a list of policies.
 - [POST /access_control/policies](https://docs.treasure.ai/apis/td_api_v3-public/access-control-policies/createaccesscontrolpolicy.md): Creates a policy.
 - [GET /access_control/policies/export](https://docs.treasure.ai/apis/td_api_v3-public/access-control-policies/exportaccesscontrolpolicies.md): Returns a policy export document for the selected policy IDs. Requires administrator or delegated-admin access and the eng-lc-sub-users feature flag. The document is a strict subset of the sub-user po
 - [GET /access_control/policies/{policy_id}](https://docs.treasure.ai/apis/td_api_v3-public/access-control-policies/getaccesscontrolpolicybyid.md): Retrieves information about the specified policy.
 - [PATCH /access_control/policies/{policy_id}](https://docs.treasure.ai/apis/td_api_v3-public/access-control-policies/updateaccesscontrolpolicybyid.md): Updates information related to a policy.
 - [DELETE /access_control/policies/{policy_id}](https://docs.treasure.ai/apis/td_api_v3-public/access-control-policies/deleteaccesscontrolpolicybyid.md): Deletes a policy.
 - [GET /access_control/users/{user_id}/policies](https://docs.treasure.ai/apis/td_api_v3-public/access-control-policies/getaccesscontrolpoliciesbyuserid.md): Retrieves a list of policies by user.
 - [PATCH /access_control/users/{user_id}/policies](https://docs.treasure.ai/apis/td_api_v3-public/access-control-policies/updateaccesscontrolpoliciesbyuserid.md): Updates policies by user ID.
 - [POST /access_control/users/{user_id}/policies/{policy_id}](https://docs.treasure.ai/apis/td_api_v3-public/access-control-policies/attachuserandpolicy.md): Attaches a policy to a user.
 - [DELETE /access_control/users/{user_id}/policies/{policy_id}](https://docs.treasure.ai/apis/td_api_v3-public/access-control-policies/detachuserandpolicy.md): Detaches a policy from a user.
 - [POST /access_control/policies/{policy_id}/users/{user_id}](https://docs.treasure.ai/apis/td_api_v3-public/access-control-policies/attachpolicyanduser.md): This operation attaches a policy to a user.
 - [DELETE /access_control/policies/{policy_id}/users/{user_id}](https://docs.treasure.ai/apis/td_api_v3-public/access-control-policies/detachpolicyanduser.md): Detaches a user from a policy.
## Access Control - Permissions

 - [GET /access_control/policies/{policy_id}/column_permissions](https://docs.treasure.ai/apis/td_api_v3-public/access-control-permissions/getcolumnpermissionbypolicyid.md): Shows column permission by policy ID.
 - [PATCH /access_control/policies/{policy_id}/column_permissions](https://docs.treasure.ai/apis/td_api_v3-public/access-control-permissions/updatecolumnpermissionbypolicyid.md): Updates column permissions by policy ID.
 - [GET /access_control/policies/{policy_id}/permissions](https://docs.treasure.ai/apis/td_api_v3-public/access-control-permissions/gerpermissionbypolicyid.md): Shows policy permissions by policy ID.
 - [PATCH /access_control/policies/{policy_id}/permissions](https://docs.treasure.ai/apis/td_api_v3-public/access-control-permissions/updatepermissionbypolicyid.md): Updates policy permissions.
## Access Control - Users

 - [GET /access_control/users](https://docs.treasure.ai/apis/td_api_v3-public/access-control-users/getaccesscontrolusers.md): Retrieves a list of users and their permissions.
 - [GET /access_control/users/{user_id}](https://docs.treasure.ai/apis/td_api_v3-public/access-control-users/getaccesscontroluserbyid.md): Retrieves the specified user.
 - [PATCH /access_control/users/{user_id}/permissions](https://docs.treasure.ai/apis/td_api_v3-public/access-control-users/updateaccesscontroluserpermissions.md): Updates a user's permissions.
 - [GET /access_control/users/{user_id}/profile_options](https://docs.treasure.ai/apis/td_api_v3-public/access-control-users/getaccesscontroluserprofileoptions.md): Retrieves all profile option keys with their resolved values for the specified user.
 - [GET /access_control/users/{user_id}/profile_options/{key}](https://docs.treasure.ai/apis/td_api_v3-public/access-control-users/getaccesscontroluserprofileoption.md): Retrieves the resolved value of a single profile option for the specified user.
 - [PUT /access_control/users/{user_id}/profile_options/{key}](https://docs.treasure.ai/apis/td_api_v3-public/access-control-users/updateaccesscontroluserprofileoption.md): Sets the value of a profile option for the specified user. Admin only.
 - [DELETE /access_control/users/{user_id}/profile_options/{key}](https://docs.treasure.ai/apis/td_api_v3-public/access-control-users/deleteaccesscontroluserprofileoption.md): Removes a profile option for the specified user, reverting it to the account default. Admin only.
 - [GET /access_control/policies/{policy_id}/users](https://docs.treasure.ai/apis/td_api_v3-public/access-control-users/getaccesscontrolpolicyusers.md): Retrieves a list of users attached to a policy.
 - [PATCH /access_control/policies/{policy_id}/users](https://docs.treasure.ai/apis/td_api_v3-public/access-control-users/updateaccesscontrolpolicyusers.md): Updates users attached to a policy.
## Access Control - Policy Groups

 - [GET /access_control/policy_groups](https://docs.treasure.ai/apis/td_api_v3-public/access-control-policy-groups/getaccesscontrolpolicygroups.md): Retrieves a list of policy groups.
 - [POST /access_control/policy_groups](https://docs.treasure.ai/apis/td_api_v3-public/access-control-policy-groups/createaccesscontrolpolicygroup.md): Creates a policy group.
 - [GET /access_control/policy_groups/{policy_group_id_or_taggable_name}](https://docs.treasure.ai/apis/td_api_v3-public/access-control-policy-groups/getaccesscontrolpolicygroupbyid.md): Retrieves information about the specified policy group.
 - [PATCH /access_control/policy_groups/{policy_group_id_or_taggable_name}](https://docs.treasure.ai/apis/td_api_v3-public/access-control-policy-groups/updateaccesscontrolpolicygroupbyid.md): Updates information related to a policy group.
 - [DELETE /access_control/policy_groups/{policy_group_id_or_taggable_name}](https://docs.treasure.ai/apis/td_api_v3-public/access-control-policy-groups/deleteaccesscontrolpolicygroupbyid.md): Deletes a policy group.
 - [GET /access_control/policy_groups/{policy_group_id_or_taggable_name}/policies](https://docs.treasure.ai/apis/td_api_v3-public/access-control-policy-groups/getaccesscontrolpolicygrouppoliciesbyid.md): Retrieves the list of the specified policy group's policies.
 - [PATCH /access_control/policy_groups/{policy_group_id_or_taggable_name}/policies](https://docs.treasure.ai/apis/td_api_v3-public/access-control-policy-groups/updateaccesscontrolpolicygrouppolicies.md): Updates the policies attached to a policy group.
## Connections

 - [GET /result/list](https://docs.treasure.ai/apis/td_api_v3-public/connections/getconnections.md): Retrieves a list of connections.
 - [POST /result/create/{connection_name}](https://docs.treasure.ai/apis/td_api_v3-public/connections/createconnection.md): Creates a connection.
 - [POST /result/delete/{connection_name}](https://docs.treasure.ai/apis/td_api_v3-public/connections/deleteconnection.md): Deletes a connection.
 - [GET /connections/lookup](https://docs.treasure.ai/apis/td_api_v3-public/connections/getconnectionidbyname.md): Retrieves the specified connection.
 - [POST /connector_configs/validate_with_connection](https://docs.treasure.ai/apis/td_api_v3-public/connections/validateconnectorconfig.md): Validates a connector configuration.
## Databases

 - [GET /database/list](https://docs.treasure.ai/apis/td_api_v3-public/databases/getdatabases.md): Retrieves a list of databases.
 - [GET /database/show/{database_name}](https://docs.treasure.ai/apis/td_api_v3-public/databases/getdatabasebyname.md): Retrieves a specified database.
 - [POST /database/create/{database_name}](https://docs.treasure.ai/apis/td_api_v3-public/databases/createdatabase.md): Creates a database.
 - [POST /database/delete/{database_name}](https://docs.treasure.ai/apis/td_api_v3-public/databases/deletedatabase.md): Deletes a specified database.
## Jobs

 - [GET /job/list](https://docs.treasure.ai/apis/td_api_v3-public/jobs/getjobs.md): Retrieves a list of jobs.
 - [GET /job/show/{job_id}](https://docs.treasure.ai/apis/td_api_v3-public/jobs/getjobbyid.md): Retrieves a list of jobs with specified job id.
 - [GET /job/status/{job_id}](https://docs.treasure.ai/apis/td_api_v3-public/jobs/getjobstatusbyid.md): Show the status information of the given job id at last execution as well as other related information.
 - [GET /job/status_by_domain_key/{domain_key}](https://docs.treasure.ai/apis/td_api_v3-public/jobs/getjobstatusbydomainkey.md): Checks the status of a job using the domain key.
 - [GET /job/statistics/{job_id}](https://docs.treasure.ai/apis/td_api_v3-public/jobs/getjobstatisticsbyid.md): Show the statistics of the job, including records inserted.
 - [POST /job/issue/{job_type}/{database_name}](https://docs.treasure.ai/apis/td_api_v3-public/jobs/createjob.md): Creates a job of a given type under a specified database.
 - [POST /job/kill/{job_id}](https://docs.treasure.ai/apis/td_api_v3-public/jobs/killjobbyid.md): Stops a specified job ID.
 - [POST /job/result_export/{job_id}](https://docs.treasure.ai/apis/td_api_v3-public/jobs/setresultexport.md): Sets the results of a specified job ID.
 - [POST /export/run/{database_name}/{table_name}](https://docs.treasure.ai/apis/td_api_v3-public/jobs/createexportjob.md): Creates an export job.
 - [GET /job/result/{job_id}](https://docs.treasure.ai/apis/td_api_v3-public/jobs/getjobresults.md): Retrieves job results.
## OAuth Tokens

 - [GET /oauth_token/list](https://docs.treasure.ai/apis/td_api_v3-public/oauth-tokens/getoauthtokens.md): Retrieves the account's live OAuth tokens: those whose row is not revoked, including tokens whose access half has expired, because a `refreshable` one can be exchanged for a new access token until the
 - [POST /oauth_token/remove/{oauth_token_id}](https://docs.treasure.ai/apis/td_api_v3-public/oauth-tokens/deleteoauthtokenbyid.md): Revokes the token named, every other live token the same user holds for the same OAuth client, and every authorization code that user was issued for the client and has not yet exchanged. Both halves o
## Policy Group Tags

 - [GET /policy_group_tags/{tag}/delegated_admins](https://docs.treasure.ai/apis/td_api_v3-public/policy-group-tags/getpolicygrouptagsdelegatedadmins.md): Returns a list of delegated admin user ids that manage a policy group.
 - [PATCH /policy_group_tags/{tag}/delegated_admins](https://docs.treasure.ai/apis/td_api_v3-public/policy-group-tags/updatepolicygrouptagsdelegatedadmins.md): Tags a list of delegated admin user ids to manage a policy group.
 - [GET /policy_group_tags/{tag}/users](https://docs.treasure.ai/apis/td_api_v3-public/policy-group-tags/getpolicygrouptagsusers.md): Returns a list of user ids that are tagged with a policy group.
 - [PATCH /policy_group_tags/{tag}/users](https://docs.treasure.ai/apis/td_api_v3-public/policy-group-tags/updatepolicygrouptagsusers.md): Tags a list of user ids with a policy group.
## Schedules

 - [GET /schedule/list](https://docs.treasure.ai/apis/td_api_v3-public/schedules/getschedules.md): Gets a list of schedules.
 - [POST /schedule/create/{schedule_name}](https://docs.treasure.ai/apis/td_api_v3-public/schedules/createschedule.md): Creates a schedule.
 - [POST /schedule/delete/{schedule_name}](https://docs.treasure.ai/apis/td_api_v3-public/schedules/deleteschedulebyname.md): Deletes a specified schedule.
 - [POST /schedule/update/{schedule_name}](https://docs.treasure.ai/apis/td_api_v3-public/schedules/updateschedule.md): Updates a schedule.
 - [POST /schedule/run/{schedule_name}/{schedule_time}](https://docs.treasure.ai/apis/td_api_v3-public/schedules/runschedule.md): Schedules a run.
 - [GET /schedule/history/{schedule_name}](https://docs.treasure.ai/apis/td_api_v3-public/schedules/getscheduleexecutionhistorybyname.md): Gets a history of scheduled executions by name.
## Sub Users

 - [GET /sub_user/list](https://docs.treasure.ai/apis/td_api_v3-public/sub-users/getsubusers.md): Retrieves the sub users the calling user may manage: every sub user in the account for an administrator, only the caller's own sub users otherwise. Sub users themselves are refused entirely.
 - [POST /sub_user/remove/{sub_user_id}](https://docs.treasure.ai/apis/td_api_v3-public/sub-users/deletesubuserbyid.md): Revokes (soft-destroys) a sub user and every credential it holds: its API keys are deleted, and its OAuth access tokens, refresh tokens and unexchanged authorization codes are revoked. It does not wor
## Tables

 - [GET /table/list/{database_name}](https://docs.treasure.ai/apis/td_api_v3-public/tables/gettablesbydatabasename.md): Retrieves a list of tables according to database specified.
 - [GET /table/show/{database_name}/{table_name}](https://docs.treasure.ai/apis/td_api_v3-public/tables/gettablebydatabasenameandtablename.md): Shows a table according to specified database and table.
 - [POST /table/delete/{database_name}/{table_name}](https://docs.treasure.ai/apis/td_api_v3-public/tables/deletetable.md): Deletes specified table.
 - [POST /table/create/{database_name}/{table_name}/{table_type}](https://docs.treasure.ai/apis/td_api_v3-public/tables/createtablewithtabletype.md): Creates a table of a specified type. Currently only 'log' is supported as table_type. This endpoint supports creating tables with schema, options, and can copy properties from existing tables. Schema
 - [POST /table/create/{database_name}/{table_name}](https://docs.treasure.ai/apis/td_api_v3-public/tables/createtable.md): Creates a table with default type 'log'. This endpoint offers the same functionality as the typed endpoint but without explicitly specifying the table type. Schema can include column descriptions in t
 - [POST /table/update/{database_name}/{table_name}](https://docs.treasure.ai/apis/td_api_v3-public/tables/updatetable.md): Updates a table.
 - [POST /table/rename/{database_name}/{current_table_name}/{new_table_name}](https://docs.treasure.ai/apis/td_api_v3-public/tables/renametable.md): Renames a specified table.
 - [POST /table/swap/{database_name}/{table_name_1}/{table_name_2}](https://docs.treasure.ai/apis/td_api_v3-public/tables/swaptables.md): Swaps specified tables.
 - [GET /table/tail/{database_name}/{table_name}{path_format}](https://docs.treasure.ai/apis/td_api_v3-public/tables/tailtable.md): Shows the last record in a table.
 - [GET /table/distribution/{database_name}/{table_name}](https://docs.treasure.ai/apis/td_api_v3-public/tables/gettabledistribution.md): Retrieve a table distribution.
 - [POST /table/change_database/{database_name}/{table_name}](https://docs.treasure.ai/apis/td_api_v3-public/tables/changetabledatabase.md): Changes to the specified table database.
 - [POST /table/transfer/{database_name}/{table_name}](https://docs.treasure.ai/apis/td_api_v3-public/tables/transfertable.md): Transfer the specified table to a different account. (Limited Access)
 - [POST /table/append-schema/{database_name}/{table_name}](https://docs.treasure.ai/apis/td_api_v3-public/tables/appendtableschema.md): Appends the specified table schema.
 - [POST /table/update-schema/{database_name}/{table_name}](https://docs.treasure.ai/apis/td_api_v3-public/tables/updatetableschema.md): Updates the specified table schema. Schema can include column descriptions in the format `[name, type, alias, description]`.
 - [GET /table/deleted](https://docs.treasure.ai/apis/td_api_v3-public/tables/listdeletedtables.md): Returns a paginated list of deleted recoverable tables for the authenticated account.
 - [POST /table/recover/{table_id}](https://docs.treasure.ai/apis/td_api_v3-public/tables/recovertablebyid.md): Recovers a deleted table. If the parent database is also deleted, with proper permissions it will be recovered automatically.
## Users

 - [POST /user/delegated_admin/add/{user_email}](https://docs.treasure.ai/apis/td_api_v3-public/users/promotedelegatedadmin.md): Promotes a user to a delegated admin.
 - [POST /user/delegated_admin/remove/{user_email}](https://docs.treasure.ai/apis/td_api_v3-public/users/demotedelegatedadmin.md): Demotes a user from a delegated admin.
## Data Connector Restrictions

 - [GET /data_connector_restrictions](https://docs.treasure.ai/apis/td_api_v3-public/data-connector-restrictions/getdataconnectorrestrictions.md): Returns an object of data connector restrictions