Skip to main content
PATCH
/
api
/
v1
/
org
/
warehouse-credentials
/
{credentialsUuid}
Update warehouse credentials
curl --request PATCH \
  --url http://api/v1/org/warehouse-credentials/{credentialsUuid} \
  --header 'Content-Type: application/json' \
  --data '
{
  "credentials": {
    "sshTunnelPrivateKey": "<string>",
    "sshTunnelPublicKey": "<string>",
    "sshTunnelUser": "<string>",
    "sshTunnelPort": 123,
    "sshTunnelHost": "<string>",
    "useSshTunnel": true,
    "timeoutSeconds": 123,
    "startOfWeek": 0,
    "ra3Node": true,
    "sslmode": "<string>",
    "keepalivesIdle": 123,
    "threads": 123,
    "schema": "<string>",
    "dbname": "<string>",
    "port": 123,
    "requireUserCredentials": true,
    "password": "<string>",
    "user": "<string>",
    "host": "<string>",
    "type": "redshift"
  },
  "description": "<string>",
  "name": "<string>"
}
'
{
  "results": {
    "credentials": {
      "type": "snowflake",
      "account": "<string>",
      "requireUserCredentials": true,
      "authenticationType": "password",
      "role": "<string>",
      "database": "<string>",
      "warehouse": "<string>",
      "schema": "<string>",
      "threads": 123,
      "clientSessionKeepAlive": true,
      "queryTag": "<string>",
      "accessUrl": "<string>",
      "startOfWeek": 0,
      "quotedIdentifiersIgnoreCase": true,
      "override": true,
      "organizationWarehouseCredentialsUuid": "<string>"
    },
    "createdByUserUuid": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "warehouseType": "bigquery",
    "description": "<string>",
    "name": "<string>",
    "organizationUuid": "<string>",
    "organizationWarehouseCredentialsUuid": "<string>"
  },
  "status": "ok"
}

Path Parameters

​
credentialsUuid
string
required

the UUID of the warehouse credentials to update

Body

application/json

the updated warehouse credentials

​
credentials
object
  • Option 1
  • Option 2
  • Option 3
  • Option 4
  • Option 5
  • Option 6
  • Option 7
​
description
string | null
​
name
string

Response

Ok

​
results
object
required

Organization-level warehouse credentials

​
status
enum<string>
required
Available options:
ok