Data sources API

Register a data source

POST /api/data_sources

Parameters

Name Description
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
public Are data sources available to all workspaces automatically?
db_name Database on data source to use for initial connection (usually 'postgres')
db_username Username for connection to data source
db_password Password for connection to data source
shared true to allow anyone to connect using these credentials, false to require individuals to enter their own credentials
entity_type The type of data source ('gpdb_data_source', 'oracle_data_source', or 'jdbc_data_source')

Request

Headers

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

Route

POST /api/data_sources

Body

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/"ac44094f90c1311ab1afbb8fabe1d2f8"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: _session_id=eENldzZXRmJ5MG8zMkVldnpKM3VxYlFTa1NEeGxBYWhiU1Z3dk5qNjR3OUdFVVFWSG9SNkd1cXcxWm1OK1UweTlwbnJVQVR6YlZsbUYzTkJvaEk1bnM4WUJoMWxCQmhYdENvMmpVd1dQQUdKa2pkUkJiWm8yQzVaOWM0SE8rRnRzOFhXS2JwVFprUzBSVU1BUnRhU3pKak85blF4bG8vaC9HTFQyREkya3pzelNiQ21aZWZubUl0a3RCaGVPZjYxR1RoTkEyV3JUMlg0ZklLWmNlS2hIanRrV0t1eEpPeUxXa1doV3Rmdk1kemFIUjIrcFVTaG4wREZmbndhMWczZzVCQ05hTnlPOFZiOFpIamtraHRlQXk5MG9ncG9IQXhSazdlazc4ejVIQzNtb2F1eTNUWGp4Qks3aVljK0EzUWNWYmN2SlMvZHFMQ2xtb1JtV3lyaGxqandxK3BhcnBpelh3a3lSOTNtS3Y5UmUzb1E0ZjBkZnV3a2xzclZIcldiYzhBT3plOEUrRlpzRlpJUGJJTG0xM0Q2MUNSQ1FUcUVXQ2xJN3oyUTE2aFdGQWwzZHI0Mi83cTlhYnBvQjVuQi0tU2pnQlVqeUVJd1hWRm9XSFE3dmQ1UT09--a3a9404d0aa6725933d3cde44ea4f15e733ba49e; path=/; HttpOnly
X-Request-Id: 84c16d92-dd87-4ed9-8cd5-eb6a438be4b3
X-Runtime: 5.266679
Content-Length: 1190

Status

201 Created

Body