Getting Started #
Welcome to the DeployInCloud documentation! This guide will help you get started with our cloud support platform. Whether you're a developer, DevOps engineer, or startup founder, we'll show you how to integrate with our services.
Quick Start
Follow these steps to start using DeployInCloud with your AWS infrastructure:
- Sign up — Create your account at DeployInCloud
- Connect your AWS account — We support IAM role-based access
- Start monitoring — Our platform begins analyzing your infrastructure
- Optimize — Get actionable insights and recommendations
You can start with our free 29-day trial — no credit card required.
Prerequisites
- An active AWS account
- AWS IAM permissions for CloudWatch, EC2, S3, and RDS
- Node.js 16+ or Python 3.8+ (for using our SDKs)
Authentication #
DeployInCloud uses API keys for authentication. You can generate API keys from your dashboard. All API requests must include your API key in the header.
API Key Authentication
# Example request with API key
curl -X GET https://api.deployincloud.com/v1/status \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json"
Never share your API keys publicly. Keep them secure in environment variables.
API Reference #
The DeployInCloud API provides programmatic access to your cloud infrastructure management. All endpoints are RESTful and return JSON responses.
Base URL
https://api.deployincloud.com/v1
Deployments
Create a new deployment with the specified configuration.
{
"name": "My App",
"region": "us-east-1",
"instance_type": "t3.medium",
"environment": "production"
}
Retrieve details of a specific deployment.
Monitoring
Get real-time metrics for your cloud resources.
Configure custom alerts for your infrastructure.
Cost Optimization
Get detailed cost analysis and optimization recommendations.
Apply cost optimization recommendations automatically.
Response Format
{
"status": "success",
"data": {
"id": "dep_abc123",
"name": "My App",
"status": "running",
"created_at": "2026-01-15T10:30:00Z"
}
}
Webhooks #
DeployInCloud supports webhooks for real-time event notifications. Configure webhooks to receive updates about deployments, alerts, and cost changes.
Event Types
- deployment.started — A deployment has started
- deployment.completed — A deployment has completed
- deployment.failed — A deployment has failed
- alert.triggered — A monitoring alert was triggered
- cost.optimized — Cost optimization was applied
Webhook payloads are sent as POST requests with a JSON body containing the event details.
SDKs & Tools #
We provide official SDKs for popular programming languages to make integration seamless.
Available SDKs
| Language | Package | Installation |
|---|---|---|
| Node.js | @deployincloud/sdk | npm install @deployincloud/sdk |
| Python | deployincloud | pip install deployincloud |
| Go | github.com/deployincloud/go-sdk | go get github.com/deployincloud/go-sdk |
| Java | com.deployincloud:sdk | Maven/Gradle |
Node.js Example
const { DeployInCloud } = require('@deployincloud/sdk');
const client = new DeployInCloud({
apiKey: 'YOUR_API_KEY'
});
// Get deployment status
const status = await client.getDeployment('dep_abc123');
console.log(status);
Best Practices #
- Use environment variables for API keys and sensitive configuration
- Implement retry logic for API calls with exponential backoff
- Monitor your usage to stay within rate limits (100 requests per minute)
- Set up webhook alerts for critical events
- Version your API by including the version in the URL path
- Use webhooks instead of polling for real-time updates
FAQ #
What is the rate limit for the API?
The default rate limit is 100 requests per minute. If you need a higher limit, contact our support team.
How do I generate an API key?
API keys can be generated from your dashboard under Settings → API Keys.
Do you support multi-region deployments?
Yes, DeployInCloud supports global deployments across all AWS regions.
What data do you collect?
We collect only the data needed to provide cloud support and optimization services. All data is encrypted and stored securely.
Is my data secure?
Absolutely. We are ISO 27001 and SOC 2 certified. All data is encrypted at rest and in transit.
Support #
Need help? We're here for you. Here's how to get support:
- Email: hello@deployincloud.com
- Phone: +91 99444 31488
- WhatsApp: Chat with us
- Response Time: ~15 minutes
Our support team is available 24/7 across 3 continents. We're always awake to help you.