Update warehouse credentials

Update existing warehouse credentials

PATCH /api/v1/org/warehouse-credentials/{credentialsUuid}

Error

A valid request URL is required to generate request examples

200

{
  "results": {
    "credentials": {
      "type": "snowflake",
      "account": "<string>",
      "database": "<string>",
      "warehouse": "<string>",
      "schema": "<string>",
      "requireUserCredentials": true,
      "authenticationType": "password",
      "role": "<string>",
      "threads": 123,
      "clientSessionKeepAlive": true,
      "queryTag": "<string>",
      "accessUrl": "<string>",
      "startOfWeek": 0,
      "dataTimezone": "<string>",
      "quotedIdentifiersIgnoreCase": true,
      "disableTimestampConversion": true,
      "timeoutSeconds": 123,
      "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

the updated warehouse credentials

credentials · object

Option 1

Option 2

Option 3

Option 4

Option 5

Option 6

Option 7

Option 8

Option 9

Show child attributes

description · string | null

name · string

Response

200

application/json

Ok

results · object · required

Organization-level warehouse credentials

Show child attributes

status · enum<string> · required

Available options: ok