Data sources API

Update data source details

PUT /api/data_sources/:id

Parameters

Name Description
id Data source id
name Name to show Chorus users for data source
description Description of data source
host Host IP or address of data source
port Port of data source
db_name Database on data source to use for initial connection (usually 'postgres')
public Are data sources available to all workspaces automatically?

Request

Headers

Host: example.org
Content-Type: application/x-www-form-urlencoded
Cookie: _session_id=UFZvaGRiTVZnL3FHM2FLS1NleVVjTHU2RnlSRmtiL2xTT3kxaXh4MkF5OXJxRmI3QTBETG5mRDBEME50Q2wwVitPN1MvMUtJVVdkQW4wVVBVdlN5RmN0MFE0MEVFdGw2WEJNWmdMQ0tyMGZCSVJnQVVOeXBvU3JlbVM1S3Z0ckJaZW5VVm5rZ1hyQ3lWWTErQ0dMdGl3NWpWYmp5VmtkVStjOGRoYzdlUkl2Vkh6Zzd3cTdDcEIvTGU4S3d2aGMvTjcrRzYwMmpYdEJzWGlUSkZxN3FheFRLTHk3VHRPNDExNGJMaGF1dlJlWDd4QmtsTTlPOHRBbkt5THhwSHdaa2dkdG1IOUU2ZVA3K0UrZyt6VXRLMWNYR1FEaVBZWDVTMGUzSEpsY3llNUYwZ29GenhsaGFaR1VYWG1yYmpDYkNBcnR4dFhzZnRRMjRPdUdLb2JSTmtVS0k2ajc4U05Ma2hpRi9UR3FJZHk0RExzZjB3amxlN1FuVEdBeGhDQ0d6MlppRCt3YlFnM3ljVUZTK01MUEJINktOckdzQ21KcEIxbGszUHNGd2M0cz0tLURzbk53aEpnUkVpTnduY3lFbElQaXc9PQ%3D%3D--1d391c88fe21625a03f6fb114e32964fd8e0510c

Route

PUT /api/data_sources/1000002

Body

1
 
name=Sesame_Street&description=Can+you+tell+me+how+to+get...&host=sesame.street.local&port=5432&db_name=postgres

Response

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
ETag: W/"33c4013b18abea282736953c1f520778"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: _session_id=dm9OZk42YTgyUk9IMld2OENjRjhoSDVKWWcrQVZOMHFiR3hJRTV5Nk5xS1U4ajZPczFhTnVPQ2I2cm9HbXJPeitVUHg3MitNekNpZ2tUK1dST2IreFpVNWMxUTh2cHZ1U0tBcnB6ZUZnR21kdVVLQmR0WUtuNmJGMzQrbXNYYXVRN296T3NSTzF1VFZHRUlvSDRPWCtFajRLcnR1K0p6VHNpYVcvS241QXAvNU1ZVUtwbjB0TGpUUTI5d0pMU0NLM3ZUS1ZhZUNaalFNOVJ6YmFYQnFkSitWS1d4WXV6dnJaZXNQdGw0VkZ4YWR2ZkRxMnlsdXM4cVZEMW9MdHhncC8zbjJkbDd1c1loY3F6NmJQYmR0Q2lvUDB4N3FFQW1ITUY3R3BiSnpPdm5pRVdhWmMyU1ZmRmpNdEJhOW5yNXFvQmg5YmliM3hEalBCVHN1OG9RNVV1aEQ0cHhoZ3pLYXZuSEs1NlZFSXRUYjJEdXZON1ZZNkZTVVYxeGU1a3VtRHRJWEh6TmtXYTFhUk91NVNtNy9XdlI5V2VzZTV3NnYzak5zNXVTSDRqZmt3akkvdktQU25vamZhVlMrV0NGRS0tUjBSWnZ3cDRiMHJCVGs4dGpRM20yUT09--b0f48506d5aee45d993889ce4e269cc5aa0129a9; path=/; HttpOnly
X-Request-Id: 6b47ea0c-8bf1-49f4-aa82-62148e209a20
X-Runtime: 0.098669
Content-Length: 1214

Status

200 OK

Body

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
{
  "response": {
    "id": 1000002,
    "name": "Sesame_Street",
    "entity_type": "gpdb_data_source",
    "is_deleted": false,
    "shared": false,
    "owner_id": 1000006,
    "version": "9.1.2 - FactoryVersion",
    "is_hawq": null,
    "state": "online",
    "public": false,
    "host": "sesame.street.local",
    "port": 5432,
    "ssl": false,
    "online": true,
    "db_name": "postgres",
    "description": "Can you tell me how to get...",
    "db_username": "username",
    "owner": {
      "id": 1000006,
      "username": "owner",
      "first_name": "searchquery",
      "last_name": "User_1",
      "image": {
        "original": "/paperclip/users/images/001/000/006/original/User.png?1554329366",
        "icon": "/paperclip/users/images/001/000/006/icon/User.png?1554329366",
        "entity_type": "image",
        "complete_json": true
      },
      "is_deleted": null,
      "auth_method": "internal",
      "ldap_group_id": null,
      "user_type": "analytics_developer",
      "entity_type": "user",
      "using_default_image": false,
      "active_license": true,
      "is_siteadmin": false,
      "roles": [
        "data_admin"
      ],
      "email": "chorususer282295@alpinenow.com",
      "title": "Chief Data Scientist",
      "dept": "Corporation Corp., Inc.",
      "notes": "One of our top performers",
      "admin": false,
      "subscribed_to_emails": true,
      "tags": [],
      "deactivated_at": null,
      "complete_json": true
    },
    "tags": [],
    "schema_blacklist": [],
    "data_source_provider": "Greenplum Database",
    "complete_json": true
  }
}