Skip to main content

​
Authentication

Some endpoints such as the recommendations endpoint require authentication. Follow these steps to get started:
1

Obtain an API Key

To use the API, you’ll need an API key. Create an account on costgraph.baselinehq.cloud to obtain your API key.
2

Create Request File

Create a file named rec.json with the following content:
{
  "region": "nyc1",
  "provider": "digitalocean",
  "instance_type": "s-4vcpu-16gb-amd",
  "operating_system": "linux",
  "service": "Droplet",
  "usage_type": "ondemand",
  "availability_zone": "",
  "predicates": {
    "usage_types": ["ondemand"]
  },
  "vm": {
    "cpu_cores": 4,
    "ram_gb": 16
  },
  "usage": {
    "cpu_cores": 3,
    "ram_gb": 5
  }
}
3

Make the Request

Use curl to make the request to the recommendations endpoint:
curl -H 'X-API-KEY: YOUR_API_KEY' \
     -XPOST https://pricing.baselinehq.cloud/recommendations \
     -d@rec.json

​
Using the API Key

Include your API key in the X-API-KEY header of your requests: 
X-API-KEY: YOUR_API_KEY
Replace YOUR_API_KEY with the API key you obtained from the dashboard.

​
Example Usage

Here’s a complete example using curl: 
# Store your API key in an environment variable
export COSTGRAPH_API_KEY="your-api-key"

# Make an authenticated request
curl -H "X-API-KEY $COSTGRAPH_API_KEY" \
     -H "Content-Type: application/json" \
     -XPOST https://pricing.baselinehq.cloud/recommendations \
     -d@rec.json

​
Errors

If authentication fails, you’ll receive a 401 Unauthorized response: 
{
  "error": "Unauthorized",
}