Update environment configuration
curl --request PATCH \
--url https://{organization}.data.credibledata.com/api/v0/environments/{environmentName} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"resource": "<string>",
"name": "<string>",
"readme": "<string>",
"location": "<string>",
"connections": [
{
"resource": "<string>",
"name": "<string>",
"fingerprint": "<string>",
"attributes": {
"dialectName": "<string>",
"isPool": true,
"canPersist": true,
"canStream": true
},
"proxy": {
"type": "ssh",
"ssh": {
"host": "<string>",
"port": 22,
"username": "<string>",
"privateKey": "<string>",
"privateKeyPass": "<string>",
"hostKey": "<string>"
}
},
"postgresConnection": {
"host": "<string>",
"port": 123,
"databaseName": "<string>",
"userName": "<string>",
"password": "<string>",
"connectionString": "<string>"
},
"bigqueryConnection": {
"defaultProjectId": "<string>",
"billingProjectId": "<string>",
"location": "<string>",
"serviceAccountKeyJson": "<string>",
"maximumBytesBilled": "<string>",
"queryTimeoutMilliseconds": "<string>"
},
"snowflakeConnection": {
"account": "<string>",
"username": "<string>",
"password": "<string>",
"privateKey": "<string>",
"privateKeyPass": "<string>",
"warehouse": "<string>",
"database": "<string>",
"schema": "<string>",
"role": "<string>",
"responseTimeoutMilliseconds": 123
},
"trinoConnection": {
"server": "<string>",
"port": 123,
"catalog": "<string>",
"schema": "<string>",
"user": "<string>",
"password": "<string>",
"peakaKey": "<string>"
},
"databricksConnection": {
"host": "<string>",
"path": "<string>",
"token": "<string>",
"oauthClientId": "<string>",
"oauthClientSecret": "<string>",
"defaultCatalog": "<string>",
"defaultSchema": "<string>",
"setupSQL": "<string>"
},
"mysqlConnection": {
"host": "<string>",
"port": 123,
"database": "<string>",
"user": "<string>",
"password": "<string>"
},
"duckdbConnection": {
"attachedDatabases": [
{
"name": "test_connection, _connection, test_connection_1",
"attributes": {
"dialectName": "<string>",
"isPool": true,
"canPersist": true,
"canStream": true
},
"bigqueryConnection": {
"defaultProjectId": "<string>",
"billingProjectId": "<string>",
"location": "<string>",
"serviceAccountKeyJson": "<string>",
"maximumBytesBilled": "<string>",
"queryTimeoutMilliseconds": "<string>"
},
"snowflakeConnection": {
"account": "<string>",
"username": "<string>",
"password": "<string>",
"privateKey": "<string>",
"privateKeyPass": "<string>",
"warehouse": "<string>",
"database": "<string>",
"schema": "<string>",
"role": "<string>",
"responseTimeoutMilliseconds": 123
},
"postgresConnection": {
"host": "<string>",
"port": 123,
"databaseName": "<string>",
"userName": "<string>",
"password": "<string>",
"connectionString": "<string>"
}
}
]
},
"motherduckConnection": {
"accessToken": "<string>",
"database": "<string>"
}
}
],
"packages": [
{
"resource": "<string>",
"name": "<string>",
"description": "<string>",
"location": "<string>",
"explores": [
"<string>"
],
"manifestLocation": "<string>",
"materialization": {
"schedule": "<string>",
"freshness": {
"window": "<string>"
}
}
}
]
}
'import requests
url = "https://{organization}.data.credibledata.com/api/v0/environments/{environmentName}"
payload = {
"resource": "<string>",
"name": "<string>",
"readme": "<string>",
"location": "<string>",
"connections": [
{
"resource": "<string>",
"name": "<string>",
"fingerprint": "<string>",
"attributes": {
"dialectName": "<string>",
"isPool": True,
"canPersist": True,
"canStream": True
},
"proxy": {
"type": "ssh",
"ssh": {
"host": "<string>",
"port": 22,
"username": "<string>",
"privateKey": "<string>",
"privateKeyPass": "<string>",
"hostKey": "<string>"
}
},
"postgresConnection": {
"host": "<string>",
"port": 123,
"databaseName": "<string>",
"userName": "<string>",
"password": "<string>",
"connectionString": "<string>"
},
"bigqueryConnection": {
"defaultProjectId": "<string>",
"billingProjectId": "<string>",
"location": "<string>",
"serviceAccountKeyJson": "<string>",
"maximumBytesBilled": "<string>",
"queryTimeoutMilliseconds": "<string>"
},
"snowflakeConnection": {
"account": "<string>",
"username": "<string>",
"password": "<string>",
"privateKey": "<string>",
"privateKeyPass": "<string>",
"warehouse": "<string>",
"database": "<string>",
"schema": "<string>",
"role": "<string>",
"responseTimeoutMilliseconds": 123
},
"trinoConnection": {
"server": "<string>",
"port": 123,
"catalog": "<string>",
"schema": "<string>",
"user": "<string>",
"password": "<string>",
"peakaKey": "<string>"
},
"databricksConnection": {
"host": "<string>",
"path": "<string>",
"token": "<string>",
"oauthClientId": "<string>",
"oauthClientSecret": "<string>",
"defaultCatalog": "<string>",
"defaultSchema": "<string>",
"setupSQL": "<string>"
},
"mysqlConnection": {
"host": "<string>",
"port": 123,
"database": "<string>",
"user": "<string>",
"password": "<string>"
},
"duckdbConnection": { "attachedDatabases": [
{
"name": "test_connection, _connection, test_connection_1",
"attributes": {
"dialectName": "<string>",
"isPool": True,
"canPersist": True,
"canStream": True
},
"bigqueryConnection": {
"defaultProjectId": "<string>",
"billingProjectId": "<string>",
"location": "<string>",
"serviceAccountKeyJson": "<string>",
"maximumBytesBilled": "<string>",
"queryTimeoutMilliseconds": "<string>"
},
"snowflakeConnection": {
"account": "<string>",
"username": "<string>",
"password": "<string>",
"privateKey": "<string>",
"privateKeyPass": "<string>",
"warehouse": "<string>",
"database": "<string>",
"schema": "<string>",
"role": "<string>",
"responseTimeoutMilliseconds": 123
},
"postgresConnection": {
"host": "<string>",
"port": 123,
"databaseName": "<string>",
"userName": "<string>",
"password": "<string>",
"connectionString": "<string>"
}
}
] },
"motherduckConnection": {
"accessToken": "<string>",
"database": "<string>"
}
}
],
"packages": [
{
"resource": "<string>",
"name": "<string>",
"description": "<string>",
"location": "<string>",
"explores": ["<string>"],
"manifestLocation": "<string>",
"materialization": {
"schedule": "<string>",
"freshness": { "window": "<string>" }
}
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
resource: '<string>',
name: '<string>',
readme: '<string>',
location: '<string>',
connections: [
{
resource: '<string>',
name: '<string>',
fingerprint: '<string>',
attributes: {dialectName: '<string>', isPool: true, canPersist: true, canStream: true},
proxy: {
type: 'ssh',
ssh: {
host: '<string>',
port: 22,
username: '<string>',
privateKey: '<string>',
privateKeyPass: '<string>',
hostKey: '<string>'
}
},
postgresConnection: {
host: '<string>',
port: 123,
databaseName: '<string>',
userName: '<string>',
password: '<string>',
connectionString: '<string>'
},
bigqueryConnection: {
defaultProjectId: '<string>',
billingProjectId: '<string>',
location: '<string>',
serviceAccountKeyJson: '<string>',
maximumBytesBilled: '<string>',
queryTimeoutMilliseconds: '<string>'
},
snowflakeConnection: {
account: '<string>',
username: '<string>',
password: '<string>',
privateKey: '<string>',
privateKeyPass: '<string>',
warehouse: '<string>',
database: '<string>',
schema: '<string>',
role: '<string>',
responseTimeoutMilliseconds: 123
},
trinoConnection: {
server: '<string>',
port: 123,
catalog: '<string>',
schema: '<string>',
user: '<string>',
password: '<string>',
peakaKey: '<string>'
},
databricksConnection: {
host: '<string>',
path: '<string>',
token: '<string>',
oauthClientId: '<string>',
oauthClientSecret: '<string>',
defaultCatalog: '<string>',
defaultSchema: '<string>',
setupSQL: '<string>'
},
mysqlConnection: {
host: '<string>',
port: 123,
database: '<string>',
user: '<string>',
password: '<string>'
},
duckdbConnection: {
attachedDatabases: [
{
name: 'test_connection, _connection, test_connection_1',
attributes: {dialectName: '<string>', isPool: true, canPersist: true, canStream: true},
bigqueryConnection: {
defaultProjectId: '<string>',
billingProjectId: '<string>',
location: '<string>',
serviceAccountKeyJson: '<string>',
maximumBytesBilled: '<string>',
queryTimeoutMilliseconds: '<string>'
},
snowflakeConnection: {
account: '<string>',
username: '<string>',
password: '<string>',
privateKey: '<string>',
privateKeyPass: '<string>',
warehouse: '<string>',
database: '<string>',
schema: '<string>',
role: '<string>',
responseTimeoutMilliseconds: 123
},
postgresConnection: {
host: '<string>',
port: 123,
databaseName: '<string>',
userName: '<string>',
password: '<string>',
connectionString: '<string>'
}
}
]
},
motherduckConnection: {accessToken: '<string>', database: '<string>'}
}
],
packages: [
{
resource: '<string>',
name: '<string>',
description: '<string>',
location: '<string>',
explores: ['<string>'],
manifestLocation: '<string>',
materialization: {schedule: '<string>', freshness: {window: '<string>'}}
}
]
})
};
fetch('https://{organization}.data.credibledata.com/api/v0/environments/{environmentName}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{organization}.data.credibledata.com/api/v0/environments/{environmentName}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'resource' => '<string>',
'name' => '<string>',
'readme' => '<string>',
'location' => '<string>',
'connections' => [
[
'resource' => '<string>',
'name' => '<string>',
'fingerprint' => '<string>',
'attributes' => [
'dialectName' => '<string>',
'isPool' => true,
'canPersist' => true,
'canStream' => true
],
'proxy' => [
'type' => 'ssh',
'ssh' => [
'host' => '<string>',
'port' => 22,
'username' => '<string>',
'privateKey' => '<string>',
'privateKeyPass' => '<string>',
'hostKey' => '<string>'
]
],
'postgresConnection' => [
'host' => '<string>',
'port' => 123,
'databaseName' => '<string>',
'userName' => '<string>',
'password' => '<string>',
'connectionString' => '<string>'
],
'bigqueryConnection' => [
'defaultProjectId' => '<string>',
'billingProjectId' => '<string>',
'location' => '<string>',
'serviceAccountKeyJson' => '<string>',
'maximumBytesBilled' => '<string>',
'queryTimeoutMilliseconds' => '<string>'
],
'snowflakeConnection' => [
'account' => '<string>',
'username' => '<string>',
'password' => '<string>',
'privateKey' => '<string>',
'privateKeyPass' => '<string>',
'warehouse' => '<string>',
'database' => '<string>',
'schema' => '<string>',
'role' => '<string>',
'responseTimeoutMilliseconds' => 123
],
'trinoConnection' => [
'server' => '<string>',
'port' => 123,
'catalog' => '<string>',
'schema' => '<string>',
'user' => '<string>',
'password' => '<string>',
'peakaKey' => '<string>'
],
'databricksConnection' => [
'host' => '<string>',
'path' => '<string>',
'token' => '<string>',
'oauthClientId' => '<string>',
'oauthClientSecret' => '<string>',
'defaultCatalog' => '<string>',
'defaultSchema' => '<string>',
'setupSQL' => '<string>'
],
'mysqlConnection' => [
'host' => '<string>',
'port' => 123,
'database' => '<string>',
'user' => '<string>',
'password' => '<string>'
],
'duckdbConnection' => [
'attachedDatabases' => [
[
'name' => 'test_connection, _connection, test_connection_1',
'attributes' => [
'dialectName' => '<string>',
'isPool' => true,
'canPersist' => true,
'canStream' => true
],
'bigqueryConnection' => [
'defaultProjectId' => '<string>',
'billingProjectId' => '<string>',
'location' => '<string>',
'serviceAccountKeyJson' => '<string>',
'maximumBytesBilled' => '<string>',
'queryTimeoutMilliseconds' => '<string>'
],
'snowflakeConnection' => [
'account' => '<string>',
'username' => '<string>',
'password' => '<string>',
'privateKey' => '<string>',
'privateKeyPass' => '<string>',
'warehouse' => '<string>',
'database' => '<string>',
'schema' => '<string>',
'role' => '<string>',
'responseTimeoutMilliseconds' => 123
],
'postgresConnection' => [
'host' => '<string>',
'port' => 123,
'databaseName' => '<string>',
'userName' => '<string>',
'password' => '<string>',
'connectionString' => '<string>'
]
]
]
],
'motherduckConnection' => [
'accessToken' => '<string>',
'database' => '<string>'
]
]
],
'packages' => [
[
'resource' => '<string>',
'name' => '<string>',
'description' => '<string>',
'location' => '<string>',
'explores' => [
'<string>'
],
'manifestLocation' => '<string>',
'materialization' => [
'schedule' => '<string>',
'freshness' => [
'window' => '<string>'
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{organization}.data.credibledata.com/api/v0/environments/{environmentName}"
payload := strings.NewReader("{\n \"resource\": \"<string>\",\n \"name\": \"<string>\",\n \"readme\": \"<string>\",\n \"location\": \"<string>\",\n \"connections\": [\n {\n \"resource\": \"<string>\",\n \"name\": \"<string>\",\n \"fingerprint\": \"<string>\",\n \"attributes\": {\n \"dialectName\": \"<string>\",\n \"isPool\": true,\n \"canPersist\": true,\n \"canStream\": true\n },\n \"proxy\": {\n \"type\": \"ssh\",\n \"ssh\": {\n \"host\": \"<string>\",\n \"port\": 22,\n \"username\": \"<string>\",\n \"privateKey\": \"<string>\",\n \"privateKeyPass\": \"<string>\",\n \"hostKey\": \"<string>\"\n }\n },\n \"postgresConnection\": {\n \"host\": \"<string>\",\n \"port\": 123,\n \"databaseName\": \"<string>\",\n \"userName\": \"<string>\",\n \"password\": \"<string>\",\n \"connectionString\": \"<string>\"\n },\n \"bigqueryConnection\": {\n \"defaultProjectId\": \"<string>\",\n \"billingProjectId\": \"<string>\",\n \"location\": \"<string>\",\n \"serviceAccountKeyJson\": \"<string>\",\n \"maximumBytesBilled\": \"<string>\",\n \"queryTimeoutMilliseconds\": \"<string>\"\n },\n \"snowflakeConnection\": {\n \"account\": \"<string>\",\n \"username\": \"<string>\",\n \"password\": \"<string>\",\n \"privateKey\": \"<string>\",\n \"privateKeyPass\": \"<string>\",\n \"warehouse\": \"<string>\",\n \"database\": \"<string>\",\n \"schema\": \"<string>\",\n \"role\": \"<string>\",\n \"responseTimeoutMilliseconds\": 123\n },\n \"trinoConnection\": {\n \"server\": \"<string>\",\n \"port\": 123,\n \"catalog\": \"<string>\",\n \"schema\": \"<string>\",\n \"user\": \"<string>\",\n \"password\": \"<string>\",\n \"peakaKey\": \"<string>\"\n },\n \"databricksConnection\": {\n \"host\": \"<string>\",\n \"path\": \"<string>\",\n \"token\": \"<string>\",\n \"oauthClientId\": \"<string>\",\n \"oauthClientSecret\": \"<string>\",\n \"defaultCatalog\": \"<string>\",\n \"defaultSchema\": \"<string>\",\n \"setupSQL\": \"<string>\"\n },\n \"mysqlConnection\": {\n \"host\": \"<string>\",\n \"port\": 123,\n \"database\": \"<string>\",\n \"user\": \"<string>\",\n \"password\": \"<string>\"\n },\n \"duckdbConnection\": {\n \"attachedDatabases\": [\n {\n \"name\": \"test_connection, _connection, test_connection_1\",\n \"attributes\": {\n \"dialectName\": \"<string>\",\n \"isPool\": true,\n \"canPersist\": true,\n \"canStream\": true\n },\n \"bigqueryConnection\": {\n \"defaultProjectId\": \"<string>\",\n \"billingProjectId\": \"<string>\",\n \"location\": \"<string>\",\n \"serviceAccountKeyJson\": \"<string>\",\n \"maximumBytesBilled\": \"<string>\",\n \"queryTimeoutMilliseconds\": \"<string>\"\n },\n \"snowflakeConnection\": {\n \"account\": \"<string>\",\n \"username\": \"<string>\",\n \"password\": \"<string>\",\n \"privateKey\": \"<string>\",\n \"privateKeyPass\": \"<string>\",\n \"warehouse\": \"<string>\",\n \"database\": \"<string>\",\n \"schema\": \"<string>\",\n \"role\": \"<string>\",\n \"responseTimeoutMilliseconds\": 123\n },\n \"postgresConnection\": {\n \"host\": \"<string>\",\n \"port\": 123,\n \"databaseName\": \"<string>\",\n \"userName\": \"<string>\",\n \"password\": \"<string>\",\n \"connectionString\": \"<string>\"\n }\n }\n ]\n },\n \"motherduckConnection\": {\n \"accessToken\": \"<string>\",\n \"database\": \"<string>\"\n }\n }\n ],\n \"packages\": [\n {\n \"resource\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"location\": \"<string>\",\n \"explores\": [\n \"<string>\"\n ],\n \"manifestLocation\": \"<string>\",\n \"materialization\": {\n \"schedule\": \"<string>\",\n \"freshness\": {\n \"window\": \"<string>\"\n }\n }\n }\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://{organization}.data.credibledata.com/api/v0/environments/{environmentName}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"resource\": \"<string>\",\n \"name\": \"<string>\",\n \"readme\": \"<string>\",\n \"location\": \"<string>\",\n \"connections\": [\n {\n \"resource\": \"<string>\",\n \"name\": \"<string>\",\n \"fingerprint\": \"<string>\",\n \"attributes\": {\n \"dialectName\": \"<string>\",\n \"isPool\": true,\n \"canPersist\": true,\n \"canStream\": true\n },\n \"proxy\": {\n \"type\": \"ssh\",\n \"ssh\": {\n \"host\": \"<string>\",\n \"port\": 22,\n \"username\": \"<string>\",\n \"privateKey\": \"<string>\",\n \"privateKeyPass\": \"<string>\",\n \"hostKey\": \"<string>\"\n }\n },\n \"postgresConnection\": {\n \"host\": \"<string>\",\n \"port\": 123,\n \"databaseName\": \"<string>\",\n \"userName\": \"<string>\",\n \"password\": \"<string>\",\n \"connectionString\": \"<string>\"\n },\n \"bigqueryConnection\": {\n \"defaultProjectId\": \"<string>\",\n \"billingProjectId\": \"<string>\",\n \"location\": \"<string>\",\n \"serviceAccountKeyJson\": \"<string>\",\n \"maximumBytesBilled\": \"<string>\",\n \"queryTimeoutMilliseconds\": \"<string>\"\n },\n \"snowflakeConnection\": {\n \"account\": \"<string>\",\n \"username\": \"<string>\",\n \"password\": \"<string>\",\n \"privateKey\": \"<string>\",\n \"privateKeyPass\": \"<string>\",\n \"warehouse\": \"<string>\",\n \"database\": \"<string>\",\n \"schema\": \"<string>\",\n \"role\": \"<string>\",\n \"responseTimeoutMilliseconds\": 123\n },\n \"trinoConnection\": {\n \"server\": \"<string>\",\n \"port\": 123,\n \"catalog\": \"<string>\",\n \"schema\": \"<string>\",\n \"user\": \"<string>\",\n \"password\": \"<string>\",\n \"peakaKey\": \"<string>\"\n },\n \"databricksConnection\": {\n \"host\": \"<string>\",\n \"path\": \"<string>\",\n \"token\": \"<string>\",\n \"oauthClientId\": \"<string>\",\n \"oauthClientSecret\": \"<string>\",\n \"defaultCatalog\": \"<string>\",\n \"defaultSchema\": \"<string>\",\n \"setupSQL\": \"<string>\"\n },\n \"mysqlConnection\": {\n \"host\": \"<string>\",\n \"port\": 123,\n \"database\": \"<string>\",\n \"user\": \"<string>\",\n \"password\": \"<string>\"\n },\n \"duckdbConnection\": {\n \"attachedDatabases\": [\n {\n \"name\": \"test_connection, _connection, test_connection_1\",\n \"attributes\": {\n \"dialectName\": \"<string>\",\n \"isPool\": true,\n \"canPersist\": true,\n \"canStream\": true\n },\n \"bigqueryConnection\": {\n \"defaultProjectId\": \"<string>\",\n \"billingProjectId\": \"<string>\",\n \"location\": \"<string>\",\n \"serviceAccountKeyJson\": \"<string>\",\n \"maximumBytesBilled\": \"<string>\",\n \"queryTimeoutMilliseconds\": \"<string>\"\n },\n \"snowflakeConnection\": {\n \"account\": \"<string>\",\n \"username\": \"<string>\",\n \"password\": \"<string>\",\n \"privateKey\": \"<string>\",\n \"privateKeyPass\": \"<string>\",\n \"warehouse\": \"<string>\",\n \"database\": \"<string>\",\n \"schema\": \"<string>\",\n \"role\": \"<string>\",\n \"responseTimeoutMilliseconds\": 123\n },\n \"postgresConnection\": {\n \"host\": \"<string>\",\n \"port\": 123,\n \"databaseName\": \"<string>\",\n \"userName\": \"<string>\",\n \"password\": \"<string>\",\n \"connectionString\": \"<string>\"\n }\n }\n ]\n },\n \"motherduckConnection\": {\n \"accessToken\": \"<string>\",\n \"database\": \"<string>\"\n }\n }\n ],\n \"packages\": [\n {\n \"resource\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"location\": \"<string>\",\n \"explores\": [\n \"<string>\"\n ],\n \"manifestLocation\": \"<string>\",\n \"materialization\": {\n \"schedule\": \"<string>\",\n \"freshness\": {\n \"window\": \"<string>\"\n }\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{organization}.data.credibledata.com/api/v0/environments/{environmentName}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"resource\": \"<string>\",\n \"name\": \"<string>\",\n \"readme\": \"<string>\",\n \"location\": \"<string>\",\n \"connections\": [\n {\n \"resource\": \"<string>\",\n \"name\": \"<string>\",\n \"fingerprint\": \"<string>\",\n \"attributes\": {\n \"dialectName\": \"<string>\",\n \"isPool\": true,\n \"canPersist\": true,\n \"canStream\": true\n },\n \"proxy\": {\n \"type\": \"ssh\",\n \"ssh\": {\n \"host\": \"<string>\",\n \"port\": 22,\n \"username\": \"<string>\",\n \"privateKey\": \"<string>\",\n \"privateKeyPass\": \"<string>\",\n \"hostKey\": \"<string>\"\n }\n },\n \"postgresConnection\": {\n \"host\": \"<string>\",\n \"port\": 123,\n \"databaseName\": \"<string>\",\n \"userName\": \"<string>\",\n \"password\": \"<string>\",\n \"connectionString\": \"<string>\"\n },\n \"bigqueryConnection\": {\n \"defaultProjectId\": \"<string>\",\n \"billingProjectId\": \"<string>\",\n \"location\": \"<string>\",\n \"serviceAccountKeyJson\": \"<string>\",\n \"maximumBytesBilled\": \"<string>\",\n \"queryTimeoutMilliseconds\": \"<string>\"\n },\n \"snowflakeConnection\": {\n \"account\": \"<string>\",\n \"username\": \"<string>\",\n \"password\": \"<string>\",\n \"privateKey\": \"<string>\",\n \"privateKeyPass\": \"<string>\",\n \"warehouse\": \"<string>\",\n \"database\": \"<string>\",\n \"schema\": \"<string>\",\n \"role\": \"<string>\",\n \"responseTimeoutMilliseconds\": 123\n },\n \"trinoConnection\": {\n \"server\": \"<string>\",\n \"port\": 123,\n \"catalog\": \"<string>\",\n \"schema\": \"<string>\",\n \"user\": \"<string>\",\n \"password\": \"<string>\",\n \"peakaKey\": \"<string>\"\n },\n \"databricksConnection\": {\n \"host\": \"<string>\",\n \"path\": \"<string>\",\n \"token\": \"<string>\",\n \"oauthClientId\": \"<string>\",\n \"oauthClientSecret\": \"<string>\",\n \"defaultCatalog\": \"<string>\",\n \"defaultSchema\": \"<string>\",\n \"setupSQL\": \"<string>\"\n },\n \"mysqlConnection\": {\n \"host\": \"<string>\",\n \"port\": 123,\n \"database\": \"<string>\",\n \"user\": \"<string>\",\n \"password\": \"<string>\"\n },\n \"duckdbConnection\": {\n \"attachedDatabases\": [\n {\n \"name\": \"test_connection, _connection, test_connection_1\",\n \"attributes\": {\n \"dialectName\": \"<string>\",\n \"isPool\": true,\n \"canPersist\": true,\n \"canStream\": true\n },\n \"bigqueryConnection\": {\n \"defaultProjectId\": \"<string>\",\n \"billingProjectId\": \"<string>\",\n \"location\": \"<string>\",\n \"serviceAccountKeyJson\": \"<string>\",\n \"maximumBytesBilled\": \"<string>\",\n \"queryTimeoutMilliseconds\": \"<string>\"\n },\n \"snowflakeConnection\": {\n \"account\": \"<string>\",\n \"username\": \"<string>\",\n \"password\": \"<string>\",\n \"privateKey\": \"<string>\",\n \"privateKeyPass\": \"<string>\",\n \"warehouse\": \"<string>\",\n \"database\": \"<string>\",\n \"schema\": \"<string>\",\n \"role\": \"<string>\",\n \"responseTimeoutMilliseconds\": 123\n },\n \"postgresConnection\": {\n \"host\": \"<string>\",\n \"port\": 123,\n \"databaseName\": \"<string>\",\n \"userName\": \"<string>\",\n \"password\": \"<string>\",\n \"connectionString\": \"<string>\"\n }\n }\n ]\n },\n \"motherduckConnection\": {\n \"accessToken\": \"<string>\",\n \"database\": \"<string>\"\n }\n }\n ],\n \"packages\": [\n {\n \"resource\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"location\": \"<string>\",\n \"explores\": [\n \"<string>\"\n ],\n \"manifestLocation\": \"<string>\",\n \"materialization\": {\n \"schedule\": \"<string>\",\n \"freshness\": {\n \"window\": \"<string>\"\n }\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"resource": "<string>",
"name": "<string>",
"readme": "<string>",
"location": "<string>",
"connections": [
{
"resource": "<string>",
"name": "<string>",
"fingerprint": "<string>",
"attributes": {
"dialectName": "<string>",
"isPool": true,
"canPersist": true,
"canStream": true
},
"proxy": {
"type": "ssh",
"ssh": {
"host": "<string>",
"port": 22,
"username": "<string>",
"privateKey": "<string>",
"privateKeyPass": "<string>",
"hostKey": "<string>"
}
},
"postgresConnection": {
"host": "<string>",
"port": 123,
"databaseName": "<string>",
"userName": "<string>",
"password": "<string>",
"connectionString": "<string>"
},
"bigqueryConnection": {
"defaultProjectId": "<string>",
"billingProjectId": "<string>",
"location": "<string>",
"serviceAccountKeyJson": "<string>",
"maximumBytesBilled": "<string>",
"queryTimeoutMilliseconds": "<string>"
},
"snowflakeConnection": {
"account": "<string>",
"username": "<string>",
"password": "<string>",
"privateKey": "<string>",
"privateKeyPass": "<string>",
"warehouse": "<string>",
"database": "<string>",
"schema": "<string>",
"role": "<string>",
"responseTimeoutMilliseconds": 123
},
"trinoConnection": {
"server": "<string>",
"port": 123,
"catalog": "<string>",
"schema": "<string>",
"user": "<string>",
"password": "<string>",
"peakaKey": "<string>"
},
"databricksConnection": {
"host": "<string>",
"path": "<string>",
"token": "<string>",
"oauthClientId": "<string>",
"oauthClientSecret": "<string>",
"defaultCatalog": "<string>",
"defaultSchema": "<string>",
"setupSQL": "<string>"
},
"mysqlConnection": {
"host": "<string>",
"port": 123,
"database": "<string>",
"user": "<string>",
"password": "<string>"
},
"duckdbConnection": {
"attachedDatabases": [
{
"name": "test_connection, _connection, test_connection_1",
"attributes": {
"dialectName": "<string>",
"isPool": true,
"canPersist": true,
"canStream": true
},
"bigqueryConnection": {
"defaultProjectId": "<string>",
"billingProjectId": "<string>",
"location": "<string>",
"serviceAccountKeyJson": "<string>",
"maximumBytesBilled": "<string>",
"queryTimeoutMilliseconds": "<string>"
},
"snowflakeConnection": {
"account": "<string>",
"username": "<string>",
"password": "<string>",
"privateKey": "<string>",
"privateKeyPass": "<string>",
"warehouse": "<string>",
"database": "<string>",
"schema": "<string>",
"role": "<string>",
"responseTimeoutMilliseconds": 123
},
"postgresConnection": {
"host": "<string>",
"port": 123,
"databaseName": "<string>",
"userName": "<string>",
"password": "<string>",
"connectionString": "<string>"
},
"gcsConnection": {
"keyId": "<string>",
"secret": "<string>"
},
"s3Connection": {
"accessKeyId": "<string>",
"secretAccessKey": "<string>",
"region": "us-east-1",
"endpoint": "<string>",
"sessionToken": "<string>"
},
"azureConnection": {
"sasUrl": "<string>",
"tenantId": "<string>",
"clientId": "<string>",
"clientSecret": "<string>",
"accountName": "<string>",
"fileUrl": "<string>"
}
}
]
},
"motherduckConnection": {
"accessToken": "<string>",
"database": "<string>"
},
"ducklakeConnection": {
"storage": {
"bucketUrl": "<string>",
"s3Connection": {
"accessKeyId": "<string>",
"secretAccessKey": "<string>",
"region": "us-east-1",
"endpoint": "<string>",
"sessionToken": "<string>"
},
"gcsConnection": {
"keyId": "<string>",
"secret": "<string>"
}
},
"catalog": {
"postgresConnection": {
"host": "<string>",
"port": 123,
"databaseName": "<string>",
"userName": "<string>",
"password": "<string>",
"connectionString": "<string>"
}
}
},
"publisherConnection": {
"connectionUri": "<string>",
"accessToken": "<string>"
}
}
],
"packages": [
{
"resource": "<string>",
"name": "<string>",
"description": "<string>",
"location": "<string>",
"explores": [
"<string>"
],
"exploresWarnings": [
"<string>"
],
"warnings": [
{
"model": "<string>",
"target": "<string>",
"message": "<string>"
}
],
"manifestLocation": "<string>",
"materialization": {
"schedule": "<string>",
"freshness": {
"window": "<string>"
}
},
"manifestEntryCount": 123,
"boundManifestUri": "<string>",
"buildPlan": {
"graphs": [
{
"connectionName": "<string>",
"nodes": [
[
{
"sourceID": "<string>",
"dependsOn": [
"<string>"
]
}
]
]
}
],
"sources": {}
}
}
]
}{
"message": "<string>",
"details": "<string>"
}{
"message": "<string>",
"details": "<string>"
}{
"message": "<string>",
"details": "<string>"
}environments
Update environment configuration
Updates the configuration and metadata of an existing environment. This allows you to modify environment settings, update the README, change the location, or update other environment-level properties. The environment must exist and be accessible.
PATCH
/
environments
/
{environmentName}
Update environment configuration
curl --request PATCH \
--url https://{organization}.data.credibledata.com/api/v0/environments/{environmentName} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"resource": "<string>",
"name": "<string>",
"readme": "<string>",
"location": "<string>",
"connections": [
{
"resource": "<string>",
"name": "<string>",
"fingerprint": "<string>",
"attributes": {
"dialectName": "<string>",
"isPool": true,
"canPersist": true,
"canStream": true
},
"proxy": {
"type": "ssh",
"ssh": {
"host": "<string>",
"port": 22,
"username": "<string>",
"privateKey": "<string>",
"privateKeyPass": "<string>",
"hostKey": "<string>"
}
},
"postgresConnection": {
"host": "<string>",
"port": 123,
"databaseName": "<string>",
"userName": "<string>",
"password": "<string>",
"connectionString": "<string>"
},
"bigqueryConnection": {
"defaultProjectId": "<string>",
"billingProjectId": "<string>",
"location": "<string>",
"serviceAccountKeyJson": "<string>",
"maximumBytesBilled": "<string>",
"queryTimeoutMilliseconds": "<string>"
},
"snowflakeConnection": {
"account": "<string>",
"username": "<string>",
"password": "<string>",
"privateKey": "<string>",
"privateKeyPass": "<string>",
"warehouse": "<string>",
"database": "<string>",
"schema": "<string>",
"role": "<string>",
"responseTimeoutMilliseconds": 123
},
"trinoConnection": {
"server": "<string>",
"port": 123,
"catalog": "<string>",
"schema": "<string>",
"user": "<string>",
"password": "<string>",
"peakaKey": "<string>"
},
"databricksConnection": {
"host": "<string>",
"path": "<string>",
"token": "<string>",
"oauthClientId": "<string>",
"oauthClientSecret": "<string>",
"defaultCatalog": "<string>",
"defaultSchema": "<string>",
"setupSQL": "<string>"
},
"mysqlConnection": {
"host": "<string>",
"port": 123,
"database": "<string>",
"user": "<string>",
"password": "<string>"
},
"duckdbConnection": {
"attachedDatabases": [
{
"name": "test_connection, _connection, test_connection_1",
"attributes": {
"dialectName": "<string>",
"isPool": true,
"canPersist": true,
"canStream": true
},
"bigqueryConnection": {
"defaultProjectId": "<string>",
"billingProjectId": "<string>",
"location": "<string>",
"serviceAccountKeyJson": "<string>",
"maximumBytesBilled": "<string>",
"queryTimeoutMilliseconds": "<string>"
},
"snowflakeConnection": {
"account": "<string>",
"username": "<string>",
"password": "<string>",
"privateKey": "<string>",
"privateKeyPass": "<string>",
"warehouse": "<string>",
"database": "<string>",
"schema": "<string>",
"role": "<string>",
"responseTimeoutMilliseconds": 123
},
"postgresConnection": {
"host": "<string>",
"port": 123,
"databaseName": "<string>",
"userName": "<string>",
"password": "<string>",
"connectionString": "<string>"
}
}
]
},
"motherduckConnection": {
"accessToken": "<string>",
"database": "<string>"
}
}
],
"packages": [
{
"resource": "<string>",
"name": "<string>",
"description": "<string>",
"location": "<string>",
"explores": [
"<string>"
],
"manifestLocation": "<string>",
"materialization": {
"schedule": "<string>",
"freshness": {
"window": "<string>"
}
}
}
]
}
'import requests
url = "https://{organization}.data.credibledata.com/api/v0/environments/{environmentName}"
payload = {
"resource": "<string>",
"name": "<string>",
"readme": "<string>",
"location": "<string>",
"connections": [
{
"resource": "<string>",
"name": "<string>",
"fingerprint": "<string>",
"attributes": {
"dialectName": "<string>",
"isPool": True,
"canPersist": True,
"canStream": True
},
"proxy": {
"type": "ssh",
"ssh": {
"host": "<string>",
"port": 22,
"username": "<string>",
"privateKey": "<string>",
"privateKeyPass": "<string>",
"hostKey": "<string>"
}
},
"postgresConnection": {
"host": "<string>",
"port": 123,
"databaseName": "<string>",
"userName": "<string>",
"password": "<string>",
"connectionString": "<string>"
},
"bigqueryConnection": {
"defaultProjectId": "<string>",
"billingProjectId": "<string>",
"location": "<string>",
"serviceAccountKeyJson": "<string>",
"maximumBytesBilled": "<string>",
"queryTimeoutMilliseconds": "<string>"
},
"snowflakeConnection": {
"account": "<string>",
"username": "<string>",
"password": "<string>",
"privateKey": "<string>",
"privateKeyPass": "<string>",
"warehouse": "<string>",
"database": "<string>",
"schema": "<string>",
"role": "<string>",
"responseTimeoutMilliseconds": 123
},
"trinoConnection": {
"server": "<string>",
"port": 123,
"catalog": "<string>",
"schema": "<string>",
"user": "<string>",
"password": "<string>",
"peakaKey": "<string>"
},
"databricksConnection": {
"host": "<string>",
"path": "<string>",
"token": "<string>",
"oauthClientId": "<string>",
"oauthClientSecret": "<string>",
"defaultCatalog": "<string>",
"defaultSchema": "<string>",
"setupSQL": "<string>"
},
"mysqlConnection": {
"host": "<string>",
"port": 123,
"database": "<string>",
"user": "<string>",
"password": "<string>"
},
"duckdbConnection": { "attachedDatabases": [
{
"name": "test_connection, _connection, test_connection_1",
"attributes": {
"dialectName": "<string>",
"isPool": True,
"canPersist": True,
"canStream": True
},
"bigqueryConnection": {
"defaultProjectId": "<string>",
"billingProjectId": "<string>",
"location": "<string>",
"serviceAccountKeyJson": "<string>",
"maximumBytesBilled": "<string>",
"queryTimeoutMilliseconds": "<string>"
},
"snowflakeConnection": {
"account": "<string>",
"username": "<string>",
"password": "<string>",
"privateKey": "<string>",
"privateKeyPass": "<string>",
"warehouse": "<string>",
"database": "<string>",
"schema": "<string>",
"role": "<string>",
"responseTimeoutMilliseconds": 123
},
"postgresConnection": {
"host": "<string>",
"port": 123,
"databaseName": "<string>",
"userName": "<string>",
"password": "<string>",
"connectionString": "<string>"
}
}
] },
"motherduckConnection": {
"accessToken": "<string>",
"database": "<string>"
}
}
],
"packages": [
{
"resource": "<string>",
"name": "<string>",
"description": "<string>",
"location": "<string>",
"explores": ["<string>"],
"manifestLocation": "<string>",
"materialization": {
"schedule": "<string>",
"freshness": { "window": "<string>" }
}
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
resource: '<string>',
name: '<string>',
readme: '<string>',
location: '<string>',
connections: [
{
resource: '<string>',
name: '<string>',
fingerprint: '<string>',
attributes: {dialectName: '<string>', isPool: true, canPersist: true, canStream: true},
proxy: {
type: 'ssh',
ssh: {
host: '<string>',
port: 22,
username: '<string>',
privateKey: '<string>',
privateKeyPass: '<string>',
hostKey: '<string>'
}
},
postgresConnection: {
host: '<string>',
port: 123,
databaseName: '<string>',
userName: '<string>',
password: '<string>',
connectionString: '<string>'
},
bigqueryConnection: {
defaultProjectId: '<string>',
billingProjectId: '<string>',
location: '<string>',
serviceAccountKeyJson: '<string>',
maximumBytesBilled: '<string>',
queryTimeoutMilliseconds: '<string>'
},
snowflakeConnection: {
account: '<string>',
username: '<string>',
password: '<string>',
privateKey: '<string>',
privateKeyPass: '<string>',
warehouse: '<string>',
database: '<string>',
schema: '<string>',
role: '<string>',
responseTimeoutMilliseconds: 123
},
trinoConnection: {
server: '<string>',
port: 123,
catalog: '<string>',
schema: '<string>',
user: '<string>',
password: '<string>',
peakaKey: '<string>'
},
databricksConnection: {
host: '<string>',
path: '<string>',
token: '<string>',
oauthClientId: '<string>',
oauthClientSecret: '<string>',
defaultCatalog: '<string>',
defaultSchema: '<string>',
setupSQL: '<string>'
},
mysqlConnection: {
host: '<string>',
port: 123,
database: '<string>',
user: '<string>',
password: '<string>'
},
duckdbConnection: {
attachedDatabases: [
{
name: 'test_connection, _connection, test_connection_1',
attributes: {dialectName: '<string>', isPool: true, canPersist: true, canStream: true},
bigqueryConnection: {
defaultProjectId: '<string>',
billingProjectId: '<string>',
location: '<string>',
serviceAccountKeyJson: '<string>',
maximumBytesBilled: '<string>',
queryTimeoutMilliseconds: '<string>'
},
snowflakeConnection: {
account: '<string>',
username: '<string>',
password: '<string>',
privateKey: '<string>',
privateKeyPass: '<string>',
warehouse: '<string>',
database: '<string>',
schema: '<string>',
role: '<string>',
responseTimeoutMilliseconds: 123
},
postgresConnection: {
host: '<string>',
port: 123,
databaseName: '<string>',
userName: '<string>',
password: '<string>',
connectionString: '<string>'
}
}
]
},
motherduckConnection: {accessToken: '<string>', database: '<string>'}
}
],
packages: [
{
resource: '<string>',
name: '<string>',
description: '<string>',
location: '<string>',
explores: ['<string>'],
manifestLocation: '<string>',
materialization: {schedule: '<string>', freshness: {window: '<string>'}}
}
]
})
};
fetch('https://{organization}.data.credibledata.com/api/v0/environments/{environmentName}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{organization}.data.credibledata.com/api/v0/environments/{environmentName}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'resource' => '<string>',
'name' => '<string>',
'readme' => '<string>',
'location' => '<string>',
'connections' => [
[
'resource' => '<string>',
'name' => '<string>',
'fingerprint' => '<string>',
'attributes' => [
'dialectName' => '<string>',
'isPool' => true,
'canPersist' => true,
'canStream' => true
],
'proxy' => [
'type' => 'ssh',
'ssh' => [
'host' => '<string>',
'port' => 22,
'username' => '<string>',
'privateKey' => '<string>',
'privateKeyPass' => '<string>',
'hostKey' => '<string>'
]
],
'postgresConnection' => [
'host' => '<string>',
'port' => 123,
'databaseName' => '<string>',
'userName' => '<string>',
'password' => '<string>',
'connectionString' => '<string>'
],
'bigqueryConnection' => [
'defaultProjectId' => '<string>',
'billingProjectId' => '<string>',
'location' => '<string>',
'serviceAccountKeyJson' => '<string>',
'maximumBytesBilled' => '<string>',
'queryTimeoutMilliseconds' => '<string>'
],
'snowflakeConnection' => [
'account' => '<string>',
'username' => '<string>',
'password' => '<string>',
'privateKey' => '<string>',
'privateKeyPass' => '<string>',
'warehouse' => '<string>',
'database' => '<string>',
'schema' => '<string>',
'role' => '<string>',
'responseTimeoutMilliseconds' => 123
],
'trinoConnection' => [
'server' => '<string>',
'port' => 123,
'catalog' => '<string>',
'schema' => '<string>',
'user' => '<string>',
'password' => '<string>',
'peakaKey' => '<string>'
],
'databricksConnection' => [
'host' => '<string>',
'path' => '<string>',
'token' => '<string>',
'oauthClientId' => '<string>',
'oauthClientSecret' => '<string>',
'defaultCatalog' => '<string>',
'defaultSchema' => '<string>',
'setupSQL' => '<string>'
],
'mysqlConnection' => [
'host' => '<string>',
'port' => 123,
'database' => '<string>',
'user' => '<string>',
'password' => '<string>'
],
'duckdbConnection' => [
'attachedDatabases' => [
[
'name' => 'test_connection, _connection, test_connection_1',
'attributes' => [
'dialectName' => '<string>',
'isPool' => true,
'canPersist' => true,
'canStream' => true
],
'bigqueryConnection' => [
'defaultProjectId' => '<string>',
'billingProjectId' => '<string>',
'location' => '<string>',
'serviceAccountKeyJson' => '<string>',
'maximumBytesBilled' => '<string>',
'queryTimeoutMilliseconds' => '<string>'
],
'snowflakeConnection' => [
'account' => '<string>',
'username' => '<string>',
'password' => '<string>',
'privateKey' => '<string>',
'privateKeyPass' => '<string>',
'warehouse' => '<string>',
'database' => '<string>',
'schema' => '<string>',
'role' => '<string>',
'responseTimeoutMilliseconds' => 123
],
'postgresConnection' => [
'host' => '<string>',
'port' => 123,
'databaseName' => '<string>',
'userName' => '<string>',
'password' => '<string>',
'connectionString' => '<string>'
]
]
]
],
'motherduckConnection' => [
'accessToken' => '<string>',
'database' => '<string>'
]
]
],
'packages' => [
[
'resource' => '<string>',
'name' => '<string>',
'description' => '<string>',
'location' => '<string>',
'explores' => [
'<string>'
],
'manifestLocation' => '<string>',
'materialization' => [
'schedule' => '<string>',
'freshness' => [
'window' => '<string>'
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{organization}.data.credibledata.com/api/v0/environments/{environmentName}"
payload := strings.NewReader("{\n \"resource\": \"<string>\",\n \"name\": \"<string>\",\n \"readme\": \"<string>\",\n \"location\": \"<string>\",\n \"connections\": [\n {\n \"resource\": \"<string>\",\n \"name\": \"<string>\",\n \"fingerprint\": \"<string>\",\n \"attributes\": {\n \"dialectName\": \"<string>\",\n \"isPool\": true,\n \"canPersist\": true,\n \"canStream\": true\n },\n \"proxy\": {\n \"type\": \"ssh\",\n \"ssh\": {\n \"host\": \"<string>\",\n \"port\": 22,\n \"username\": \"<string>\",\n \"privateKey\": \"<string>\",\n \"privateKeyPass\": \"<string>\",\n \"hostKey\": \"<string>\"\n }\n },\n \"postgresConnection\": {\n \"host\": \"<string>\",\n \"port\": 123,\n \"databaseName\": \"<string>\",\n \"userName\": \"<string>\",\n \"password\": \"<string>\",\n \"connectionString\": \"<string>\"\n },\n \"bigqueryConnection\": {\n \"defaultProjectId\": \"<string>\",\n \"billingProjectId\": \"<string>\",\n \"location\": \"<string>\",\n \"serviceAccountKeyJson\": \"<string>\",\n \"maximumBytesBilled\": \"<string>\",\n \"queryTimeoutMilliseconds\": \"<string>\"\n },\n \"snowflakeConnection\": {\n \"account\": \"<string>\",\n \"username\": \"<string>\",\n \"password\": \"<string>\",\n \"privateKey\": \"<string>\",\n \"privateKeyPass\": \"<string>\",\n \"warehouse\": \"<string>\",\n \"database\": \"<string>\",\n \"schema\": \"<string>\",\n \"role\": \"<string>\",\n \"responseTimeoutMilliseconds\": 123\n },\n \"trinoConnection\": {\n \"server\": \"<string>\",\n \"port\": 123,\n \"catalog\": \"<string>\",\n \"schema\": \"<string>\",\n \"user\": \"<string>\",\n \"password\": \"<string>\",\n \"peakaKey\": \"<string>\"\n },\n \"databricksConnection\": {\n \"host\": \"<string>\",\n \"path\": \"<string>\",\n \"token\": \"<string>\",\n \"oauthClientId\": \"<string>\",\n \"oauthClientSecret\": \"<string>\",\n \"defaultCatalog\": \"<string>\",\n \"defaultSchema\": \"<string>\",\n \"setupSQL\": \"<string>\"\n },\n \"mysqlConnection\": {\n \"host\": \"<string>\",\n \"port\": 123,\n \"database\": \"<string>\",\n \"user\": \"<string>\",\n \"password\": \"<string>\"\n },\n \"duckdbConnection\": {\n \"attachedDatabases\": [\n {\n \"name\": \"test_connection, _connection, test_connection_1\",\n \"attributes\": {\n \"dialectName\": \"<string>\",\n \"isPool\": true,\n \"canPersist\": true,\n \"canStream\": true\n },\n \"bigqueryConnection\": {\n \"defaultProjectId\": \"<string>\",\n \"billingProjectId\": \"<string>\",\n \"location\": \"<string>\",\n \"serviceAccountKeyJson\": \"<string>\",\n \"maximumBytesBilled\": \"<string>\",\n \"queryTimeoutMilliseconds\": \"<string>\"\n },\n \"snowflakeConnection\": {\n \"account\": \"<string>\",\n \"username\": \"<string>\",\n \"password\": \"<string>\",\n \"privateKey\": \"<string>\",\n \"privateKeyPass\": \"<string>\",\n \"warehouse\": \"<string>\",\n \"database\": \"<string>\",\n \"schema\": \"<string>\",\n \"role\": \"<string>\",\n \"responseTimeoutMilliseconds\": 123\n },\n \"postgresConnection\": {\n \"host\": \"<string>\",\n \"port\": 123,\n \"databaseName\": \"<string>\",\n \"userName\": \"<string>\",\n \"password\": \"<string>\",\n \"connectionString\": \"<string>\"\n }\n }\n ]\n },\n \"motherduckConnection\": {\n \"accessToken\": \"<string>\",\n \"database\": \"<string>\"\n }\n }\n ],\n \"packages\": [\n {\n \"resource\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"location\": \"<string>\",\n \"explores\": [\n \"<string>\"\n ],\n \"manifestLocation\": \"<string>\",\n \"materialization\": {\n \"schedule\": \"<string>\",\n \"freshness\": {\n \"window\": \"<string>\"\n }\n }\n }\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://{organization}.data.credibledata.com/api/v0/environments/{environmentName}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"resource\": \"<string>\",\n \"name\": \"<string>\",\n \"readme\": \"<string>\",\n \"location\": \"<string>\",\n \"connections\": [\n {\n \"resource\": \"<string>\",\n \"name\": \"<string>\",\n \"fingerprint\": \"<string>\",\n \"attributes\": {\n \"dialectName\": \"<string>\",\n \"isPool\": true,\n \"canPersist\": true,\n \"canStream\": true\n },\n \"proxy\": {\n \"type\": \"ssh\",\n \"ssh\": {\n \"host\": \"<string>\",\n \"port\": 22,\n \"username\": \"<string>\",\n \"privateKey\": \"<string>\",\n \"privateKeyPass\": \"<string>\",\n \"hostKey\": \"<string>\"\n }\n },\n \"postgresConnection\": {\n \"host\": \"<string>\",\n \"port\": 123,\n \"databaseName\": \"<string>\",\n \"userName\": \"<string>\",\n \"password\": \"<string>\",\n \"connectionString\": \"<string>\"\n },\n \"bigqueryConnection\": {\n \"defaultProjectId\": \"<string>\",\n \"billingProjectId\": \"<string>\",\n \"location\": \"<string>\",\n \"serviceAccountKeyJson\": \"<string>\",\n \"maximumBytesBilled\": \"<string>\",\n \"queryTimeoutMilliseconds\": \"<string>\"\n },\n \"snowflakeConnection\": {\n \"account\": \"<string>\",\n \"username\": \"<string>\",\n \"password\": \"<string>\",\n \"privateKey\": \"<string>\",\n \"privateKeyPass\": \"<string>\",\n \"warehouse\": \"<string>\",\n \"database\": \"<string>\",\n \"schema\": \"<string>\",\n \"role\": \"<string>\",\n \"responseTimeoutMilliseconds\": 123\n },\n \"trinoConnection\": {\n \"server\": \"<string>\",\n \"port\": 123,\n \"catalog\": \"<string>\",\n \"schema\": \"<string>\",\n \"user\": \"<string>\",\n \"password\": \"<string>\",\n \"peakaKey\": \"<string>\"\n },\n \"databricksConnection\": {\n \"host\": \"<string>\",\n \"path\": \"<string>\",\n \"token\": \"<string>\",\n \"oauthClientId\": \"<string>\",\n \"oauthClientSecret\": \"<string>\",\n \"defaultCatalog\": \"<string>\",\n \"defaultSchema\": \"<string>\",\n \"setupSQL\": \"<string>\"\n },\n \"mysqlConnection\": {\n \"host\": \"<string>\",\n \"port\": 123,\n \"database\": \"<string>\",\n \"user\": \"<string>\",\n \"password\": \"<string>\"\n },\n \"duckdbConnection\": {\n \"attachedDatabases\": [\n {\n \"name\": \"test_connection, _connection, test_connection_1\",\n \"attributes\": {\n \"dialectName\": \"<string>\",\n \"isPool\": true,\n \"canPersist\": true,\n \"canStream\": true\n },\n \"bigqueryConnection\": {\n \"defaultProjectId\": \"<string>\",\n \"billingProjectId\": \"<string>\",\n \"location\": \"<string>\",\n \"serviceAccountKeyJson\": \"<string>\",\n \"maximumBytesBilled\": \"<string>\",\n \"queryTimeoutMilliseconds\": \"<string>\"\n },\n \"snowflakeConnection\": {\n \"account\": \"<string>\",\n \"username\": \"<string>\",\n \"password\": \"<string>\",\n \"privateKey\": \"<string>\",\n \"privateKeyPass\": \"<string>\",\n \"warehouse\": \"<string>\",\n \"database\": \"<string>\",\n \"schema\": \"<string>\",\n \"role\": \"<string>\",\n \"responseTimeoutMilliseconds\": 123\n },\n \"postgresConnection\": {\n \"host\": \"<string>\",\n \"port\": 123,\n \"databaseName\": \"<string>\",\n \"userName\": \"<string>\",\n \"password\": \"<string>\",\n \"connectionString\": \"<string>\"\n }\n }\n ]\n },\n \"motherduckConnection\": {\n \"accessToken\": \"<string>\",\n \"database\": \"<string>\"\n }\n }\n ],\n \"packages\": [\n {\n \"resource\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"location\": \"<string>\",\n \"explores\": [\n \"<string>\"\n ],\n \"manifestLocation\": \"<string>\",\n \"materialization\": {\n \"schedule\": \"<string>\",\n \"freshness\": {\n \"window\": \"<string>\"\n }\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{organization}.data.credibledata.com/api/v0/environments/{environmentName}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"resource\": \"<string>\",\n \"name\": \"<string>\",\n \"readme\": \"<string>\",\n \"location\": \"<string>\",\n \"connections\": [\n {\n \"resource\": \"<string>\",\n \"name\": \"<string>\",\n \"fingerprint\": \"<string>\",\n \"attributes\": {\n \"dialectName\": \"<string>\",\n \"isPool\": true,\n \"canPersist\": true,\n \"canStream\": true\n },\n \"proxy\": {\n \"type\": \"ssh\",\n \"ssh\": {\n \"host\": \"<string>\",\n \"port\": 22,\n \"username\": \"<string>\",\n \"privateKey\": \"<string>\",\n \"privateKeyPass\": \"<string>\",\n \"hostKey\": \"<string>\"\n }\n },\n \"postgresConnection\": {\n \"host\": \"<string>\",\n \"port\": 123,\n \"databaseName\": \"<string>\",\n \"userName\": \"<string>\",\n \"password\": \"<string>\",\n \"connectionString\": \"<string>\"\n },\n \"bigqueryConnection\": {\n \"defaultProjectId\": \"<string>\",\n \"billingProjectId\": \"<string>\",\n \"location\": \"<string>\",\n \"serviceAccountKeyJson\": \"<string>\",\n \"maximumBytesBilled\": \"<string>\",\n \"queryTimeoutMilliseconds\": \"<string>\"\n },\n \"snowflakeConnection\": {\n \"account\": \"<string>\",\n \"username\": \"<string>\",\n \"password\": \"<string>\",\n \"privateKey\": \"<string>\",\n \"privateKeyPass\": \"<string>\",\n \"warehouse\": \"<string>\",\n \"database\": \"<string>\",\n \"schema\": \"<string>\",\n \"role\": \"<string>\",\n \"responseTimeoutMilliseconds\": 123\n },\n \"trinoConnection\": {\n \"server\": \"<string>\",\n \"port\": 123,\n \"catalog\": \"<string>\",\n \"schema\": \"<string>\",\n \"user\": \"<string>\",\n \"password\": \"<string>\",\n \"peakaKey\": \"<string>\"\n },\n \"databricksConnection\": {\n \"host\": \"<string>\",\n \"path\": \"<string>\",\n \"token\": \"<string>\",\n \"oauthClientId\": \"<string>\",\n \"oauthClientSecret\": \"<string>\",\n \"defaultCatalog\": \"<string>\",\n \"defaultSchema\": \"<string>\",\n \"setupSQL\": \"<string>\"\n },\n \"mysqlConnection\": {\n \"host\": \"<string>\",\n \"port\": 123,\n \"database\": \"<string>\",\n \"user\": \"<string>\",\n \"password\": \"<string>\"\n },\n \"duckdbConnection\": {\n \"attachedDatabases\": [\n {\n \"name\": \"test_connection, _connection, test_connection_1\",\n \"attributes\": {\n \"dialectName\": \"<string>\",\n \"isPool\": true,\n \"canPersist\": true,\n \"canStream\": true\n },\n \"bigqueryConnection\": {\n \"defaultProjectId\": \"<string>\",\n \"billingProjectId\": \"<string>\",\n \"location\": \"<string>\",\n \"serviceAccountKeyJson\": \"<string>\",\n \"maximumBytesBilled\": \"<string>\",\n \"queryTimeoutMilliseconds\": \"<string>\"\n },\n \"snowflakeConnection\": {\n \"account\": \"<string>\",\n \"username\": \"<string>\",\n \"password\": \"<string>\",\n \"privateKey\": \"<string>\",\n \"privateKeyPass\": \"<string>\",\n \"warehouse\": \"<string>\",\n \"database\": \"<string>\",\n \"schema\": \"<string>\",\n \"role\": \"<string>\",\n \"responseTimeoutMilliseconds\": 123\n },\n \"postgresConnection\": {\n \"host\": \"<string>\",\n \"port\": 123,\n \"databaseName\": \"<string>\",\n \"userName\": \"<string>\",\n \"password\": \"<string>\",\n \"connectionString\": \"<string>\"\n }\n }\n ]\n },\n \"motherduckConnection\": {\n \"accessToken\": \"<string>\",\n \"database\": \"<string>\"\n }\n }\n ],\n \"packages\": [\n {\n \"resource\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"location\": \"<string>\",\n \"explores\": [\n \"<string>\"\n ],\n \"manifestLocation\": \"<string>\",\n \"materialization\": {\n \"schedule\": \"<string>\",\n \"freshness\": {\n \"window\": \"<string>\"\n }\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"resource": "<string>",
"name": "<string>",
"readme": "<string>",
"location": "<string>",
"connections": [
{
"resource": "<string>",
"name": "<string>",
"fingerprint": "<string>",
"attributes": {
"dialectName": "<string>",
"isPool": true,
"canPersist": true,
"canStream": true
},
"proxy": {
"type": "ssh",
"ssh": {
"host": "<string>",
"port": 22,
"username": "<string>",
"privateKey": "<string>",
"privateKeyPass": "<string>",
"hostKey": "<string>"
}
},
"postgresConnection": {
"host": "<string>",
"port": 123,
"databaseName": "<string>",
"userName": "<string>",
"password": "<string>",
"connectionString": "<string>"
},
"bigqueryConnection": {
"defaultProjectId": "<string>",
"billingProjectId": "<string>",
"location": "<string>",
"serviceAccountKeyJson": "<string>",
"maximumBytesBilled": "<string>",
"queryTimeoutMilliseconds": "<string>"
},
"snowflakeConnection": {
"account": "<string>",
"username": "<string>",
"password": "<string>",
"privateKey": "<string>",
"privateKeyPass": "<string>",
"warehouse": "<string>",
"database": "<string>",
"schema": "<string>",
"role": "<string>",
"responseTimeoutMilliseconds": 123
},
"trinoConnection": {
"server": "<string>",
"port": 123,
"catalog": "<string>",
"schema": "<string>",
"user": "<string>",
"password": "<string>",
"peakaKey": "<string>"
},
"databricksConnection": {
"host": "<string>",
"path": "<string>",
"token": "<string>",
"oauthClientId": "<string>",
"oauthClientSecret": "<string>",
"defaultCatalog": "<string>",
"defaultSchema": "<string>",
"setupSQL": "<string>"
},
"mysqlConnection": {
"host": "<string>",
"port": 123,
"database": "<string>",
"user": "<string>",
"password": "<string>"
},
"duckdbConnection": {
"attachedDatabases": [
{
"name": "test_connection, _connection, test_connection_1",
"attributes": {
"dialectName": "<string>",
"isPool": true,
"canPersist": true,
"canStream": true
},
"bigqueryConnection": {
"defaultProjectId": "<string>",
"billingProjectId": "<string>",
"location": "<string>",
"serviceAccountKeyJson": "<string>",
"maximumBytesBilled": "<string>",
"queryTimeoutMilliseconds": "<string>"
},
"snowflakeConnection": {
"account": "<string>",
"username": "<string>",
"password": "<string>",
"privateKey": "<string>",
"privateKeyPass": "<string>",
"warehouse": "<string>",
"database": "<string>",
"schema": "<string>",
"role": "<string>",
"responseTimeoutMilliseconds": 123
},
"postgresConnection": {
"host": "<string>",
"port": 123,
"databaseName": "<string>",
"userName": "<string>",
"password": "<string>",
"connectionString": "<string>"
},
"gcsConnection": {
"keyId": "<string>",
"secret": "<string>"
},
"s3Connection": {
"accessKeyId": "<string>",
"secretAccessKey": "<string>",
"region": "us-east-1",
"endpoint": "<string>",
"sessionToken": "<string>"
},
"azureConnection": {
"sasUrl": "<string>",
"tenantId": "<string>",
"clientId": "<string>",
"clientSecret": "<string>",
"accountName": "<string>",
"fileUrl": "<string>"
}
}
]
},
"motherduckConnection": {
"accessToken": "<string>",
"database": "<string>"
},
"ducklakeConnection": {
"storage": {
"bucketUrl": "<string>",
"s3Connection": {
"accessKeyId": "<string>",
"secretAccessKey": "<string>",
"region": "us-east-1",
"endpoint": "<string>",
"sessionToken": "<string>"
},
"gcsConnection": {
"keyId": "<string>",
"secret": "<string>"
}
},
"catalog": {
"postgresConnection": {
"host": "<string>",
"port": 123,
"databaseName": "<string>",
"userName": "<string>",
"password": "<string>",
"connectionString": "<string>"
}
}
},
"publisherConnection": {
"connectionUri": "<string>",
"accessToken": "<string>"
}
}
],
"packages": [
{
"resource": "<string>",
"name": "<string>",
"description": "<string>",
"location": "<string>",
"explores": [
"<string>"
],
"exploresWarnings": [
"<string>"
],
"warnings": [
{
"model": "<string>",
"target": "<string>",
"message": "<string>"
}
],
"manifestLocation": "<string>",
"materialization": {
"schedule": "<string>",
"freshness": {
"window": "<string>"
}
},
"manifestEntryCount": 123,
"boundManifestUri": "<string>",
"buildPlan": {
"graphs": [
{
"connectionName": "<string>",
"nodes": [
[
{
"sourceID": "<string>",
"dependsOn": [
"<string>"
]
}
]
]
}
],
"sources": {}
}
}
]
}{
"message": "<string>",
"details": "<string>"
}{
"message": "<string>",
"details": "<string>"
}{
"message": "<string>",
"details": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Name of the environment Standard identifier pattern for resource names
Pattern:
^[a-zA-Z0-9_-]+$Body
application/json
Represents a Malloy environment containing packages, connections, and other resources
Resource path to the environment
Environment name
Environment README content
Environment location, can be an absolute path or URI (e.g. github, s3, gcs, etc.)
List of database connections configured for this environment
Show child attributes
Show child attributes
List of Malloy packages in this environment
Show child attributes
Show child attributes
Response
Returns the environment updated
Represents a Malloy environment containing packages, connections, and other resources
Resource path to the environment
Environment name
Environment README content
Environment location, can be an absolute path or URI (e.g. github, s3, gcs, etc.)
List of database connections configured for this environment
Show child attributes
Show child attributes
List of Malloy packages in this environment
Show child attributes
Show child attributes
Was this page helpful?
⌘I