Quick Start Guide

Get up and running with the CloudSync REST API in under five minutes. This guide covers authentication, your first API call, and basic resource management.

Create API Key

Generate credentials in the dashboard

Make First Call

Test with the health check endpoint

Sync Resources

Create your first sync pipeline

# Verify your API key

curl -H "Authorization: Bearer cs_live_abc123" \

https://api.cloudsync.io/v4/health

Endpoint Reference

GET

/v4/resources

List all synced resources with pagination. Supports filtering by type, status, and creation date. Returns up to 100 items per page.

POST

/v4/resources

Create a new resource and initiate sync. Requires resource_type and source_url in the request body. Responds with a sync job ID.

GET

/v4/pipelines/{id}

Retrieve pipeline configuration and execution history. Includes last 50 run summaries with status, duration, and record counts.

DELETE

/v4/resources/{id}

Remove a resource and cancel active syncs. This action is irreversible. Associated pipeline schedules are also deleted.

Authentication

CloudSync uses Bearer token authentication. Include your API key in the Authorization header of every request. Keys are scoped to environments (production, staging, development) and can be rotated without downtime.

Authorization: Bearer cs_live_your_api_key_here

For OAuth 2.0 integrations, CloudSync supports the authorization code flow with PKCE. Tokens expire after 3600 seconds. Refresh tokens are valid for 30 days and support automatic rotation.

Rate Limits

Plan	Requests / min	Burst	Concurrency
Free	60	10	2
Pro	600	100	10
Enterprise	6,000	1,000	50

Official SDKs

Node.js

@cloudsync/node

v4.1.0

Python

cloudsync-python

v4.0.3

go-cloudsync

v4.1.0

Ruby

cloudsync-ruby

v4.0.1