Introduction
Organization APIs
- Users
- Invitations
- Workspaces
Workspace APIs
- Syncs
- Sync Management Links
- Sync Runs
- Destination Types
- Destinations
- Destination Connect Links
- Source Types
- Sources
- GETList sources
- POSTCreate a new source
- GETFetch source
- PATCHUpdate source
- DELDelete source
- Objects
- Models
- Topics
- Tables
- Segments
- Projects
- GET
- Source Connect Links
- Segment Management Links
- Webhooks
Sources
Update source
Update certain values of a source
PATCH
/
sources
/
{source_id}
curl --request PATCH \
--url https://app.getcensus.com/api/v1/sources/{source_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"connection": {
"label": "Acme Inc. Snowflake",
"credentials": {
"hostname": "<instance>.<region>.redshift.amazonaws.com,",
"port": "5439,",
"user": "redshift_user,",
"password": "redshift_password,",
"database": "demo"
}
}
}'
{
"status": "updated",
"data": {
"id": 4,
"name": "Snowflake - xxxxxxx.us-east-1",
"label": "Acme Inc. Snowflake",
"type": "snowflake",
"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": "2023-11-07T05:31:56Z",
"connection_details": {
"account": "xxxxxxx.us-east-1,",
"user": "DEV,",
"warehouse": "TEST,",
"use_keypair": false
}
}
}
Authorizations
Bearer token for the current workspace. Can be retrieved from the Workspace's settings page.
Path Parameters
ID of the source to update
Body
application/json
Response
200 - application/json
Successfully updated the source
The response is of type object
.
Was this page helpful?
curl --request PATCH \
--url https://app.getcensus.com/api/v1/sources/{source_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"connection": {
"label": "Acme Inc. Snowflake",
"credentials": {
"hostname": "<instance>.<region>.redshift.amazonaws.com,",
"port": "5439,",
"user": "redshift_user,",
"password": "redshift_password,",
"database": "demo"
}
}
}'
{
"status": "updated",
"data": {
"id": 4,
"name": "Snowflake - xxxxxxx.us-east-1",
"label": "Acme Inc. Snowflake",
"type": "snowflake",
"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": "2023-11-07T05:31:56Z",
"connection_details": {
"account": "xxxxxxx.us-east-1,",
"user": "DEV,",
"warehouse": "TEST,",
"use_keypair": false
}
}
}
Assistant
Responses are generated using AI and may contain mistakes.