# 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://td-public.redocly.app/_spec/apis/td-api.yaml) ## Access Control - Policies ### get Access Control Policies - [GET /access_control/policies](https://td-public.redocly.app/apis/td-api/access-control-policies/getaccesscontrolpolicies.md): Retrieves a list of policies. ### Create an Access Control Policy - [POST /access_control/policies](https://td-public.redocly.app/apis/td-api/access-control-policies/createaccesscontrolpolicy.md): Creates a policy. ### Get an Access Control Policy - [GET /access_control/policies/{policy_id}](https://td-public.redocly.app/apis/td-api/access-control-policies/getaccesscontrolpolicybyid.md): Retrieves information about the specified policy. ### Update an Access Control Policy - [PATCH /access_control/policies/{policy_id}](https://td-public.redocly.app/apis/td-api/access-control-policies/updateaccesscontrolpolicybyid.md): Updates information related to a policy. ### Delete an Access Control Policy - [DELETE /access_control/policies/{policy_id}](https://td-public.redocly.app/apis/td-api/access-control-policies/deleteaccesscontrolpolicybyid.md): Deletes a policy. ### get User Policies - [GET /access_control/users/{user_id}/policies](https://td-public.redocly.app/apis/td-api/access-control-policies/getaccesscontrolpoliciesbyuserid.md): Retrieves a list of policies by user. ### Update User Policies - [PATCH /access_control/users/{user_id}/policies](https://td-public.redocly.app/apis/td-api/access-control-policies/updateaccesscontrolpoliciesbyuserid.md): Updates policies by user ID. ### Attach a policy to a user. - [POST /access_control/users/{user_id}/policies/{policy_id}](https://td-public.redocly.app/apis/td-api/access-control-policies/attachuserandpolicy.md): Attaches a policy to a user. ### Detach a Policy from a User - [DELETE /access_control/users/{user_id}/policies/{policy_id}](https://td-public.redocly.app/apis/td-api/access-control-policies/detachuserandpolicy.md): Detaches a policy from a user. ### Attach - [POST /access_control/policies/{policy_id}/users/{user_id}](https://td-public.redocly.app/apis/td-api/access-control-policies/attachpolicyanduser.md): This operation attaches a policy to a user. ### Detach - [DELETE /access_control/policies/{policy_id}/users/{user_id}](https://td-public.redocly.app/apis/td-api/access-control-policies/detachpolicyanduser.md): Detaches a user from a policy. ## Access Control - Permissions ### Show Column Permissions - [GET /access_control/policies/{policy_id}/column_permissions](https://td-public.redocly.app/apis/td-api/access-control-permissions/getcolumnpermissionbypolicyid.md): Shows column permission by policy ID. ### Update Column Permissions - [PATCH /access_control/policies/{policy_id}/column_permissions](https://td-public.redocly.app/apis/td-api/access-control-permissions/updatecolumnpermissionbypolicyid.md): Updates column permissions by policy ID. ### Show Policy Permissions - [GET /access_control/policies/{policy_id}/permissions](https://td-public.redocly.app/apis/td-api/access-control-permissions/gerpermissionbypolicyid.md): Shows policy permissions by policy ID. ### Update Policy Permissions - [PATCH /access_control/policies/{policy_id}/permissions](https://td-public.redocly.app/apis/td-api/access-control-permissions/updatepermissionbypolicyid.md): Updates policy permissions. ## Access Control - Users ### Get Access Control users. - [GET /access_control/users](https://td-public.redocly.app/apis/td-api/access-control-users/getaccesscontrolusers.md): Retrieves a list of users and their permissions. ### Get Access Control User - [GET /access_control/users/{user_id}](https://td-public.redocly.app/apis/td-api/access-control-users/getaccesscontroluserbyid.md): Retrieves the specified user. ### Update Access Control User Permissions - [PATCH /access_control/users/{user_id}/permissions](https://td-public.redocly.app/apis/td-api/access-control-users/updateaccesscontroluserpermissions.md): Updates a user's permissions. ### Get Policy users - [GET /access_control/policies/{policy_id}/users](https://td-public.redocly.app/apis/td-api/access-control-users/getaccesscontrolpolicyusers.md): Retrieves a list of users attached to a policy. ### Update Policy Users - [PATCH /access_control/policies/{policy_id}/users](https://td-public.redocly.app/apis/td-api/access-control-users/updateaccesscontrolpolicyusers.md): Updates users attached to a policy. ## Access Control - Policy Groups ### get Access Control Policy Groups - [GET /access_control/policy_groups](https://td-public.redocly.app/apis/td-api/access-control-policy-groups/getaccesscontrolpolicygroups.md): Retrieves a list of policy groups. ### Create an Access Control Policy Group - [POST /access_control/policy_groups](https://td-public.redocly.app/apis/td-api/access-control-policy-groups/createaccesscontrolpolicygroup.md): Creates a policy group. ### Get an Access Control Policy Group - [GET /access_control/policy_groups/{policy_group_id_or_taggable_name}](https://td-public.redocly.app/apis/td-api/access-control-policy-groups/getaccesscontrolpolicygroupbyid.md): Retrieves information about the specified policy group. ### Update an Access Control Policy Group - [PATCH /access_control/policy_groups/{policy_group_id_or_taggable_name}](https://td-public.redocly.app/apis/td-api/access-control-policy-groups/updateaccesscontrolpolicygroupbyid.md): Updates information related to a policy group. ### Delete an Access Control Policy Group - [DELETE /access_control/policy_groups/{policy_group_id_or_taggable_name}](https://td-public.redocly.app/apis/td-api/access-control-policy-groups/deleteaccesscontrolpolicygroupbyid.md): Deletes a policy group. ### Get an Access Control Policy Group's Policies - [GET /access_control/policy_groups/{policy_group_id_or_taggable_name}/policies](https://td-public.redocly.app/apis/td-api/access-control-policy-groups/getaccesscontrolpolicygrouppoliciesbyid.md): Retrieves the list of the specified policy group's policies. ### Update an Access Control Policy Group's Policies - [PATCH /access_control/policy_groups/{policy_group_id_or_taggable_name}/policies](https://td-public.redocly.app/apis/td-api/access-control-policy-groups/updateaccesscontrolpolicygrouppolicies.md): Updates the policies attached to a policy group. ## Connections ### Get connections - [GET /result/list](https://td-public.redocly.app/apis/td-api/connections/getconnections.md): Retrieves a list of connections. ### Create connection - [POST /result/create/{connection_name}](https://td-public.redocly.app/apis/td-api/connections/createconnection.md): Creates a connection. ### Delete connection - [POST /result/delete/{connection_name}](https://td-public.redocly.app/apis/td-api/connections/deleteconnection.md): Deletes a connection. ### Get connection id by name - [GET /connections/lookup](https://td-public.redocly.app/apis/td-api/connections/getconnectionidbyname.md): Retrieves the specified connection. ### Validate connector config - [POST /connector_configs/validate_with_connection](https://td-public.redocly.app/apis/td-api/connections/validateconnectorconfig.md): Validates a connector configuration. ## Databases ### Get databases - [GET /database/list](https://td-public.redocly.app/apis/td-api/databases/getdatabases.md): Retrieves a list of databases. ### Get database - [GET /database/show/{database_name}](https://td-public.redocly.app/apis/td-api/databases/getdatabasebyname.md): Retrieves a specified database. ### Create database - [POST /database/create/{database_name}](https://td-public.redocly.app/apis/td-api/databases/createdatabase.md): Creates a database. ### Delete database - [POST /database/delete/{database_name}](https://td-public.redocly.app/apis/td-api/databases/deletedatabase.md): Deletes a specified database. ## Jobs ### Get jobs - [GET /job/list](https://td-public.redocly.app/apis/td-api/jobs/getjobs.md): Retrieves a list of jobs. ### Get job - [GET /job/show/{job_id}](https://td-public.redocly.app/apis/td-api/jobs/getjobbyid.md): Retrieves a list of jobs with specified job id. ### Get job status by id - [GET /job/status/{job_id}](https://td-public.redocly.app/apis/td-api/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 - [GET /job/status_by_domain_key/{domain_key}](https://td-public.redocly.app/apis/td-api/jobs/getjobstatusbydomainkey.md): Checks the status of a job using the domain key. ### Get job statistics by id - [GET /job/statistics/{job_id}](https://td-public.redocly.app/apis/td-api/jobs/getjobstatisticsbyid.md): Show the statistics of the job, including records inserted. ### Create job - [POST /job/issue/{job_type}/{database_name}](https://td-public.redocly.app/apis/td-api/jobs/createjob.md): Creates a job of a given type under a specified database. ### kill job by id - [POST /job/kill/{job_id}](https://td-public.redocly.app/apis/td-api/jobs/killjobbyid.md): Stops a specified job ID. ### Set result export - [POST /job/result_export/{job_id}](https://td-public.redocly.app/apis/td-api/jobs/setresultexport.md): Sets the results of a specified job ID. ### Create export job - [POST /export/run/{database_name}/{table_name}](https://td-public.redocly.app/apis/td-api/jobs/createexportjob.md): Creates an export job. ### Get job results - [GET /job/result/{job_id}](https://td-public.redocly.app/apis/td-api/jobs/getjobresults.md): Retrieves job results. ### Create partial delete job (deprecated) - [POST /table/partialdelete/{database_name}/{table_name}](https://td-public.redocly.app/apis/td-api/jobs/createpartialdeletejob.md): Creates a partial delete job. ### Create partial delete job (deprecated) - [POST /table/partialdelete/{database_name}/{table_name}](https://td-public.redocly.app/apis/td-api/tables/createpartialdeletejob.md): Creates a partial delete job. ## Tables ### Create partial delete job (deprecated) - [POST /table/partialdelete/{database_name}/{table_name}](https://td-public.redocly.app/apis/td-api/jobs/createpartialdeletejob.md): Creates a partial delete job. ### Get tables - [GET /table/list/{database_name}](https://td-public.redocly.app/apis/td-api/tables/gettablesbydatabasename.md): Retrieves a list of tables according to database specified. ### Get table - [GET /table/show/{database_name}/{table_name}](https://td-public.redocly.app/apis/td-api/tables/gettablebydatabasenameandtablename.md): Shows a table according to specified database and table. ### Delete table - [POST /table/delete/{database_name}/{table_name}](https://td-public.redocly.app/apis/td-api/tables/deletetable.md): Deletes specified table. ### Create table - [POST /table/create/{database_name}/{table_name}](https://td-public.redocly.app/apis/td-api/tables/createtable.md): Creates a table. ### Update table - [POST /table/update/{database_name}/{table_name}](https://td-public.redocly.app/apis/td-api/tables/updatetable.md): Updates a table. ### Rename table - [POST /table/rename/{database_name}/{current_table_name}/{new_table_name}](https://td-public.redocly.app/apis/td-api/tables/renametable.md): Renames a specified table. ### Swap tables - [POST /table/swap/{database_name}/{table_name_1}/{table_name_2}](https://td-public.redocly.app/apis/td-api/tables/swaptables.md): Swaps specified tables. ### Tail table - [GET /table/tail/{database_name}/{table_name}{path_format}](https://td-public.redocly.app/apis/td-api/tables/tailtable.md): Shows the last record in a table. ### Get table distribution - [GET /table/distribution/{database_name}/{table_name}](https://td-public.redocly.app/apis/td-api/tables/gettabledistribution.md): Retrieve a table distribution. ### Change database - [POST /table/change_database/{database_name}/{table_name}](https://td-public.redocly.app/apis/td-api/tables/changetabledatabase.md): Changes to the specified table database. ### Transfer table to a different account - [POST /table/transfer/{database_name}/{table_name}](https://td-public.redocly.app/apis/td-api/tables/transfertable.md): Transfer the specified table to a different account. (Limited Access) ### Append table schema - [POST /table/append-schema/{database_name}/{table_name}](https://td-public.redocly.app/apis/td-api/tables/appendtableschema.md): Appends the specified table schema. ### Update table schema - [POST /table/update-schema/{database_name}/{table_name}](https://td-public.redocly.app/apis/td-api/tables/updatetableschema.md): Updates the specified table schema. ### Create partial delete job (deprecated) - [POST /table/partialdelete/{database_name}/{table_name}](https://td-public.redocly.app/apis/td-api/tables/createpartialdeletejob.md): Creates a partial delete job. ## Policy Group Tags ### Get the delegated admins of a policy group - [GET /policy_group_tags/{tag}/delegated_admins](https://td-public.redocly.app/apis/td-api/policy-group-tags/getpolicygrouptagsdelegatedadmins.md): Returns a list of delegated admin user ids that manage a policy group. ### Update the delegated admins of a policy group - [PATCH /policy_group_tags/{tag}/delegated_admins](https://td-public.redocly.app/apis/td-api/policy-group-tags/updatepolicygrouptagsdelegatedadmins.md): Tags a list of delegated admin user ids to manage a policy group. ### Get the users of a policy group - [GET /policy_group_tags/{tag}/users](https://td-public.redocly.app/apis/td-api/policy-group-tags/getpolicygrouptagsusers.md): Returns a list of user ids that are tagged with a policy group. ### Update the users of a policy group - [PATCH /policy_group_tags/{tag}/users](https://td-public.redocly.app/apis/td-api/policy-group-tags/updatepolicygrouptagsusers.md): Tags a list of user ids with a policy group. ## Schedules ### Get schedules - [GET /schedule/list](https://td-public.redocly.app/apis/td-api/schedules/getschedules.md): Gets a list of schedules. ### Create schedule - [POST /schedule/create/{schedule_name}](https://td-public.redocly.app/apis/td-api/schedules/createschedule.md): Creates a schedule. ### Delete schedule - [POST /schedule/delete/{schedule_name}](https://td-public.redocly.app/apis/td-api/schedules/deleteschedulebyname.md): Deletes a specified schedule. ### Update schedule - [POST /schedule/update/{schedule_name}](https://td-public.redocly.app/apis/td-api/schedules/updateschedule.md): Updates a schedule. ### Run schedule - [POST /schedule/run/{schedule_name}/{schedule_time}](https://td-public.redocly.app/apis/td-api/schedules/runschedule.md): Schedules a run. ### Get execution history - [GET /schedule/history/{schedule_name}](https://td-public.redocly.app/apis/td-api/schedules/getscheduleexecutionhistorybyname.md): Gets a history of scheduled executions by name. ## Users ### Promote a user to a delegated Admin - [POST /user/delegated_admin/add/{user_email}](https://td-public.redocly.app/apis/td-api/users/promotedelegatedadmin.md): Promotes a user to a delegated admin. ### Demote a user from a delegated admin - [POST /user/delegated_admin/remove/{user_email}](https://td-public.redocly.app/apis/td-api/users/demotedelegatedadmin.md): Demotes a user from a delegated admin.