Update destination

Updated on Mar 25, 2026
Published on Mar 18, 2026

Prev Next

Put

/teams/{team_id}/destinations/{destination_id}

Update a destination's details.

Important Notes:

Requires scope dwh_transfers_write
Your account must have dwh.transfer.edit permission. See roles and permissions.

Security

HTTP

Type bearer

Bearer token authentication. Include the token in the Authorization header: Authorization: Bearer <your-token>

Path parameters

team_id

integer (int64) Required

Unique identifier of the team

Minimum1

Maximum9223372036854776000

Example12345

destination_id

integer (int32) Required

Unique identifier for the destination

Minimum1

Maximum2147483647

Example8

Body parameters

Destination configuration changes

{
  "type": "DWH_SNOWFLAKE",
  "display_name": "Updated Snowflake Destination",
  "auth_method": "AUTH_METHOD_KEY_PAIR",
  "fields": {
    "hostname": "updated-domain.my-region.snowflakecomputing.com",
    "warehouse": "PRODUCTION_WH",
    "database_name": "PROD_DB",
    "schema": "PUBLIC",
    "role": "SYSADMIN",
    "username": "PROD_USER"
  }
}

Expand All

object

type

string Required

Destination type (e.g., DWH_SNOWFLAKE, DWH_BIGQUERY)

Max length50

ExampleDWH_SNOWFLAKE

display_name

string Required

Human-readable name for the destination

Max length255

ExampleMy Snowflake Destination

auth_method

string

Authentication method for the destination

Max length100

ExampleAUTH_METHOD_KEY_PAIR

fields

object Required

Destination-specific configuration fields (varies by destination type)

new_password

string

New secret value for credential rotation. Field name varies by auth method (e.g., new_private_key for key-pair auth)

Max length255

Responses

200

Destination updated successfully

Headers

Access-Control-Allow-Origin

string

CORS header

Valid values[ "*" ]

Max length255

Example*

Expand All

object

meta

object (ResponseMeta)

request_id

string

API request ID

Max length50

Pattern^[A-Za-z0-9_-]+$

data

object (DestinationInfo)

integer (int32) | null

Unique identifier for the destination

Minimum1

Maximum2147483647

Example123

display_name

string

Human-readable name for the destination

Max length255

ExampleMy Snowflake Destination

destination_type

object (DestinationType)

type

string

Destination type identifier

Max length50

ExampleDWH_SNOWFLAKE

title

string

Display name for the destination type

Max length255

ExampleSnowflake

icon_url

string (uri)

URL to the destination type icon

Max length2083

Examplehttps://supermetrics.com/icons/snowflake.svg

connection_check_url

string (uri)

URL for connection testing

Max length2083

create_url

string (uri)

URL for creating a destination

Max length2083

update_url_template

string

URL template for updating a destination

Max length2083

app_id

string

Application identifier

Max length50

is_internal

boolean

Whether this is an internal destination type

Defaultfalse

settings

Array of object (DestinationSetupSetting)

Available settings for this destination type

Max items500

object

string

Unique identifier for the setting

Max length100

Examplehostname

label

string | null

Display label for the setting

Max length255

ExampleHostname

value

Current value of the setting (type varies based on input_type)

Examplemyaccount.snowflakecomputing.com

OneOf

string

Max length1000

integer (int32)

integer

Minimum-2147483648

Maximum2147483647

boolean

input_type

string

Type of input control

Max length50

Exampletext

is_required

boolean

Whether this setting is required

Exampletrue

options

Array of object

Available options for select/radio inputs

Max items500

Default[]

object

help_text

string | null

Help text for the setting

Max length1000

help_url

string (uri) | null

URL to additional help documentation

Max length2083

note

string | null

Additional notes about the setting

Max length500

group

string

Group identifier for organizing settings

Max length100

group_label

string

Display label for the group

Max length255

show_for

Array of object

Conditional display rules

Max items200

Default[]

object

string

Max length100

values

Array of string

Max items500

string

Max length100

auth_methods

Array of object (DestinationAuthMethod)

Available authentication methods

Max items50

object

string

Authentication method identifier

Max length100

ExampleAUTH_METHOD_KEY_PAIR

label

string

Display label for the authentication method

Max length255

ExampleKey Pair Authentication

is_default

boolean

Whether this is the default authentication method

Defaultfalse

edit_settings

Array of object (DestinationSetupSetting)

Configuration settings for the destination

Max items500

object

string

Unique identifier for the setting

Max length100

Examplehostname

label

string | null

Display label for the setting

Max length255

ExampleHostname

value

Current value of the setting (type varies based on input_type)

Examplemyaccount.snowflakecomputing.com

OneOf

string

Max length1000

integer (int32)

integer

Minimum-2147483648

Maximum2147483647

boolean

input_type

string

Type of input control

Max length50

Exampletext

is_required

boolean

Whether this setting is required

Exampletrue

options

Array of object

Available options for select/radio inputs

Max items500

Default[]

object

help_text

string | null

Help text for the setting

Max length1000

help_url

string (uri) | null

URL to additional help documentation

Max length2083

note

string | null

Additional notes about the setting

Max length500

group

string

Group identifier for organizing settings

Max length100

group_label

string

Display label for the group

Max length255

show_for

Array of object

Conditional display rules

Max items200

Default[]

object

string

Max length100

values

Array of string

Max items500

string

Max length100

400

Bad Request - The request was invalid or cannot be served.

Headers

Access-Control-Allow-Origin

string

CORS header

Valid values[ "*" ]

Max length255

Example*

{
  "meta": {
    "request_id": "01892A4D-7586-7000-8000-000000000000"
  },
  "error": {
    "code": "INVALID_PARAMETER",
    "message": "Invalid Parameter",
    "description": "The request contains invalid or malformed parameters."
  }
}

Expand All

object

meta

object (ResponseMeta)

request_id

string

API request ID

Max length50

Pattern^[A-Za-z0-9_-]+$

error

object (Error)

code

string

Error code

Max length100

message

string

Error message

Max length255

description

string

Error description

Max length255

401

Unauthorized - Authentication is required and has failed or has not been provided.

Headers

Access-Control-Allow-Origin

string

CORS header

Valid values[ "*" ]

Max length255

Example*

{
  "meta": {
    "request_id": "019461A0-0000-7000-8000-000000000000"
  },
  "error": {
    "code": "API_KEY_INVALID",
    "message": "Invalid API key",
    "description": "Provided API key was invalid."
  }
}

Expand All

object

meta

object (ResponseMeta)

request_id

string

API request ID

Max length50

Pattern^[A-Za-z0-9_-]+$

error

object (Error)

code

string

Error code

Max length100

message

string

Error message

Max length255

description

string

Error description

Max length255

403

Forbidden - The request is understood, but access is not allowed

Headers

Access-Control-Allow-Origin

string

CORS header

Valid values[ "*" ]

Max length255

Example*

{
  "meta": {
    "request_id": "01892A4D-7586-7000-8000-000000000000"
  },
  "error": {
    "code": "ACCESS_DENIED",
    "message": "Access Denied",
    "description": "You do not have permission to perform this operation."
  }
}

Expand All

object

meta

object (ResponseMeta)

request_id

string

API request ID

Max length50

Pattern^[A-Za-z0-9_-]+$

error

object (Error)

code

string

Error code

Max length100

message

string

Error message

Max length255

description

string

Error description

Max length255

404

Destination not found

Headers

Access-Control-Allow-Origin

string

CORS header

Valid values[ "*" ]

Max length255

Example*

{
  "meta": {
    "request_id": "01892A4D-7586-7000-8000-000000000000"
  },
  "error": {
    "code": "NOT_FOUND",
    "message": "Not Found",
    "description": "The requested destination could not be found or you do not have access to it."
  }
}

Expand All

object

meta

object (ResponseMeta)

request_id

string

API request ID

Max length50

Pattern^[A-Za-z0-9_-]+$

error

object (Error)

code

string

Error code

Max length100

message

string

Error message

Max length255

description

string

Error description

Max length255

422

Invalid destination configuration

Headers

Access-Control-Allow-Origin

string

CORS header

Valid values[ "*" ]

Max length255

Example*

Expand All

object

meta

object (ResponseMeta)

request_id

string

API request ID

Max length50

Pattern^[A-Za-z0-9_-]+$

error

object (Error)

code

string

Error code

Max length100

message

string

Error message

Max length255

description

string

Error description

Max length255

429

Too Many Requests - Rate limit exceeded.

Headers

Retry-After

integer

Number of seconds to wait before making another request

Minimum1

Maximum3600

Access-Control-Allow-Origin

string

CORS header

Valid values[ "*" ]

Max length255

Example*

{
  "meta": {
    "request_id": "019461A0-0000-7000-8000-000000000000"
  },
  "error": {
    "code": "API_ROW_QUOTA_EXCEEDED",
    "message": "Row quota exceeded",
    "description": "You have exceeded your row-quota limit of rows for this month. Please log into Supermetrics Hub at https://hub.supermetrics.com/ and upgrade your plan, or contact our Supermetrics support team."
  }
}

Expand All

object

meta

object (ResponseMeta)

request_id

string

API request ID

Max length50

Pattern^[A-Za-z0-9_-]+$

error

object (Error)

code

string

Error code

Max length100

message

string

Error message

Max length255

description

string

Error description

Max length255

500

Internal Server Error - An error occurred on the server.

Headers

Access-Control-Allow-Origin

string

CORS header

Valid values[ "*" ]

Max length255

Example*

{
  "meta": {
    "request_id": "01892A4D-7586-7000-8000-000000000000"
  },
  "error": {
    "code": "INTERNAL_SERVER_ERROR",
    "message": "Internal Server Error",
    "description": "An unexpected error occurred. Please try again later or contact support."
  }
}

Expand All

object

meta

object (ResponseMeta)

request_id

string

API request ID

Max length50

Pattern^[A-Za-z0-9_-]+$

error

object (Error)

code

string

Error code

Max length100

message

string

Error message

Max length255

description

string

Error description

Max length255

Was this article helpful?