Update source

Update certain values of a source

Request schema

Path parameters

source_id

integerrequired

ID of the source to update

Header parameters

Authorization

stringrequired

HTTP: basicAuth

HTTP AuthorizationScheme: basic

Request

connection

object

Contains the information for the connection.

name

string

An optional label that can be assigned to the source for better categorization or identification.

example:

Acme Inc. Snowflake

label

string | null

DEPRECATED: Use 'name' instead. An optional label that can be assigned to the source for better categorization or identification.

example:

Acme Inc. Snowflake

warehouse_writeback_retention_in_days

integer

Number of days to retain warehouse writeback data. When set, automatically enables sync logs for this source. Only supported for certain source types, see supports_warehouse_writeback field in the Source Types endpoint. Only supported for sources with Advanced sync engine. Requires the sync logs feature to be included in your organization's plan.

minimum:

example:

credentials

object

Credentials that should be associated with this source (e.g. hostname, port)

property name *

undefined

additional property

Http + 1.1

PATCH

https://app.getcensus.com/api/v1/sources/{source_id}

PATCH /api/v1/sources/{source_id} HTTP/1.1
Authorization: Bearer REPLACE_BEARER_TOKEN
Content-Type: application/json
Host: app.getcensus.com
Content-Length: 356

{
  "connection": {
    "name": "Acme Inc. Snowflake",
    "label": "Acme Inc. Snowflake",
    "warehouse_writeback_retention_in_days": 7,
    "credentials": {
      "hostname": "..redshift.amazonaws.com,",
      "port": "5439,",
      "user": "redshift_user,",
      "password": "redshift_password,",
      "database": "demo"
    }
  }
}

Responses

200

Successfully updated the source

`200`

status

string

Outcome of the operation.

enum:

"success""updated""created""not_found""error"

data

object

integer

The unique identifier of the source.

example:

name

string

An optional label that can be assigned to the source for better categorization or identification.

example:

Acme Inc. Snowflake

label

string | null

DEPRECATED: Use 'name' instead. An optional label that can be assigned to the source for better categorization or identification.

example:

Acme Inc. Snowflake

type

string

The type of the data source. A valid type is the service_name of a source type returned from the /source_types endpoint, where the source type is marked as creatable_via_api.

example:

snowflake

sync_engine

string

The sync engine type for this source.

enum:

"basic""advanced"

created_at

string

When the connection was created

format:

date-time

example:

2023-07-22T23:42:47.239Z

last_test_results

object

steps

array

An ordered array of steps representing the results of the last connection test. If one step fails then we won't surface details on later steps.

step

stringrequired

The name of the step in the connection test process.

example:

Verify connectivity

error

object

message

string | null

The error message associated with the step, if any.

status

stringrequired

The status of the step.

enum:

"running""success""failed""warning"

last_test_succeeded

boolean | null

Indicates if the last connection test to this source was successful.

example:

true

last_tested_at

string | null

Timestamp of when the last connection test was conducted on this source.

format:

date-time

connection_details

undefined

Detailed configuration and information for connecting to this source.

property name *

undefined

additional property

warehouse_writeback_retention_in_days

integer

minimum:

example:

{
  "status": "updated",
  "data": {
    "id": 4,
    "name": "Acme Inc. Snowflake",
    "label": "Acme Inc. Snowflake",
    "type": "snowflake",
    "sync_engine": "basic",
    "created_at": "2023-07-22T23:42:47.239Z",
    "last_test_results": {
      "steps": [
        {
          "step": "Verify connectivity",
          "error": {
            "message": "string"
          },
          "status": "success"
        }
      ]
    },
    "last_test_succeeded": true,
    "last_tested_at": "2019-08-24T14:15:22Z",
    "connection_details": {
      "account": "xxxxxxx.us-east-1,",
      "user": "DEV,",
      "warehouse": "TEST,",
      "use_keypair": false
    },
    "warehouse_writeback_retention_in_days": 7
  }
}