Customer.io
v1.0.0
OpenAPI 3.1.0

Check a collection source

US region

Client Libraries
Shell Curl

Check a collection source

​

Check that a source's credentials can still read its bucket, like after you rotate a key or change the bucket's permissions. Customer.io runs the same check as when you connect the source.

Path Parameters
  • source_id
    Type: string
    required

    The identifier for a collection source (like a bucket in Amazon S3, Google Cloud Storage, or Azure Blob Storage).

Responses
  • application/json
  • 400

    Your plan doesn't include collections.

  • 404

    Your workspace doesn't have a source with this id.

  • 422

    Customer.io can't read the bucket with the source's credentials. The error tells you whether Customer.io couldn't list the bucket or could list it but couldn't read its files.

  • application/json
Request Example for post/v1/collections/sources/{source_id}/check
curl 'https://api.customer.io/v1/collections/sources/{source_id}/check' \
  --request POST \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "readable": true
}

Customer.io can read the bucket.