Skip to main content
PATCH
cURL

Authorizations

x-api-key
string
header
required

API Key authentication. Format: 'x-api-key: api_key'

Path Parameters

slug
string
required

Body

draft
boolean
active
boolean
description
string
connector_config
any
input_tables
object[]
python_execution_cpu
integer
python_execution_memory
integer
trigger
unknown
settings_number_of_retries
integer
settings_retry_delay_seconds
integer
settings_max_consecutive_failures
integer | null

Response

200 - application/json
id
string<uuid>
required
read-only
is_ml_ai_connector
boolean
required
read-only
slug
string
required
read-only
Pattern: ^[-a-zA-Z0-9_]+$
archived
boolean
required
read-only
deleted
boolean
required
read-only
draft
boolean
required
read-only
active
boolean
required
read-only
status
string
required
read-only
deploy_failed
boolean
required
read-only
deploy_failed_reason
string
required
read-only
connector_config
any
required
oauth_type
string
required
read-only

OAuth application to re-authorize this destination with — resolved from the version it is pinned to.

pending_reauthorization
object | null
required

Set when an update of the connector version changes its OAuth application: the customer has until deadline to re-authorize against oauth_type (the NEW application), submitting the config to POST .../version-migration/reauthorize/. Past the deadline (overdue) the destination was moved anyway and re-authorizing is a normal edit. Only on /api/v1/destinations/ itself; null where a destination is nested in another resource.

description
string
required
read-only
input_tables
any[]
required
read-only
input_volumes
any[]
required
read-only
created_at
string<date-time>
required
read-only
updated_at
string<date-time>
required
read-only
python_execution_cpu
integer
required
read-only
python_execution_memory
integer
required
read-only
settings_number_of_retries
integer
required
read-only

The number of times to retry a task in the settings if it fails

settings_retry_delay_seconds
integer
required
read-only

The number of seconds to retry a task in the settings if it fails

settings_max_consecutive_failures
integer | null
required
read-only

The maximum number of consecutive failures allowed before the settings is paused

connector_version
string
required
read-only

Connector version used by this destination (Expandable)

last_run
string
required
read-only

Last Run from this destination (Expandable)

created_by
integer
required
read-only

User that created this destination (Expandable)