ReferenceOrganization Warehouse Credentials
Update warehouse credentials
Update existing warehouse credentials
PATCH/api/v1/org/warehouse-credentials/{credentialsUuid}
Authentication: personal access token. The spec defines an api_key security
scheme — send an Authorization: ApiKey <your-personal-access-token> header
(value format: ApiKey <your key>). A session_cookie scheme (connect.sid)
exists for browser sessions. Operations in this spec declare security: [], an
artifact of the upstream spec generator — authentication is still enforced by the
server.
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
credentialsUuid | string | Yes | the UUID of the warehouse credentials to update |
Request body
{
"credentials": {
"sshTunnelPrivateKey": "string",
"sshTunnelPublicKey": "string",
"sshTunnelUser": "string",
"sshTunnelPort": 0,
"sshTunnelHost": "string",
"useSshTunnel": true,
"awsSsoRoleName": "string",
"awsSsoAccountId": "string",
"awsSsoRegion": "string",
"awsSsoStartUrl": "string",
"assumeRoleExternalId": "string",
"assumeRoleArn": "string",
"sessionToken": "string",
"secretAccessKey": "string",
"accessKeyId": "string",
"dbGroups": [
"string"
],
"autoCreate": true,
"workgroupName": "string",
"clusterIdentifier": "string",
"isServerless": true,
"region": "string",
"authenticationType": "password",
"timeoutSeconds": 0,
"dataTimezone": "string",
"startOfWeek": {},
"ra3Node": true,
"sslmode": "string",
"keepalivesIdle": 0,
"threads": 0,
"schema": "string",
"dbname": "string",
"port": 0,
"requireUserCredentials": true,
"password": "string",
"user": "string",
"host": "string",
"type": "redshift"
},
"description": "string",
"name": "string"
}Responses
200 — Ok
{
"results": {
"credentials": {
"type": "snowflake",
"account": "string",
"requireUserCredentials": true,
"authenticationType": "password",
"role": "string",
"database": "string",
"warehouse": "string",
"schema": "string",
"threads": 0,
"clientSessionKeepAlive": true,
"queryTag": "string",
"accessUrl": "string",
"startOfWeek": {},
"dataTimezone": "string",
"quotedIdentifiersIgnoreCase": true,
"disableTimestampConversion": true,
"timeoutSeconds": 0,
"override": true,
"organizationWarehouseCredentialsUuid": "string"
},
"createdByUserUuid": "string",
"createdAt": "2024-01-01T00:00:00.000Z",
"warehouseType": "bigquery",
"description": "string",
"name": "string",
"organizationUuid": "string",
"organizationWarehouseCredentialsUuid": "string"
},
"status": "ok"
}default — Error
{
"error": {
"data": "string",
"message": "string",
"name": "string",
"statusCode": 0
},
"status": "error"
}