# Reference

> Source: https://developers.cloud66.com/v3/endpoints/reference/

## Cloud Reference Data

URL: https://developers.cloud66.com/v3/endpoints/reference/#clouds
Endpoint: GET /reference/clouds

# Cloud Reference Data

Retrieves reference data for cloud providers, including available server sizes, regions, and basic cloud information. This endpoint provides static reference data used for stack configuration and does not require authentication.

## Supported Cloud Providers

- **aws** - Amazon Web Services
- **azure_rm** - Microsoft Azure Resource Manager
- **digitalocean** - DigitalOcean
- **googlecloud** - Google Cloud Platform
- **hetzner** - Hetzner Cloud
- **linode** - Linode
- **ovh** - OVH Cloud
- **vultr** - Vultr

## Filter Options

### Cloud Information
- `clouds` - Returns array of cloud provider names
- `clouds_full` - Returns cloud names with descriptions

### Server Sizes
- `sizes` - Returns available server sizes (names only)
- `sizes_full` - Returns server sizes with specifications (CPU, RAM, etc.)

### Regions
- `regions` - Returns available regions (IDs only)
- `regions_full` - Returns regions with display names

## Query Examples

### All Cloud Data
```
GET /reference/clouds
```
Returns complete data for all cloud providers.

### Specific Cloud Provider
```
GET /reference/clouds?cloud=aws
```
Returns data only for AWS.

### Filter by Data Type
```
GET /reference/clouds?filter=sizes_full
```
Returns detailed server size information for all clouds.

### Combined Filtering
```
GET /reference/clouds?cloud=googlecloud&filter=regions
```
Returns only region IDs for Google Cloud.

## Response Formats

### Default Response (All Data)
When no filters are specified, returns complete sizes and regions data for all or specified cloud providers.

### Single Cloud Response
When filtering by a specific cloud, the response structure is flattened to show only that cloud's data.

### Filtered Response
When using data type filters, only the requested data type is returned.

<Callout type="info" title="No Authentication Required">
This endpoint provides public reference data and does not require authentication or API keys.
</Callout>

## Error Responses

<ResponseCodes 
  codes={[400]} 
  overrides={{
    400: [
      "Filter can only be one of: clouds, clouds_full, regions, regions_full, sizes, sizes_full",
      "Cloud can only be one of: aws, azure_rm, digitalocean, googlecloud, hetzner, linode, ovh, vultr"
    ]
  }}
/>

**Related models:** Cloud

### Parameters

- `cloud` (string, optional) — Filter by specific cloud provider (aws, azure_rm, digitalocean, googlecloud, hetzner, linode, ovh, vultr)
- `filter` (string, optional) — Filter response data (clouds, clouds_full, regions, regions_full, sizes, sizes_full)

### Response

```json
{
  "aws": {
    "sizes": {
      "t3.micro": "1 vCPU, 1 GB RAM",
      "t3.small": "1 vCPU, 2 GB RAM",
      "t3.medium": "2 vCPUs, 4 GB RAM"
    },
    "regions": {
      "us-east-1": "US East (N. Virginia)",
      "us-west-2": "US West (Oregon)",
      "eu-west-1": "Europe (Ireland)"
    }
  },
  "googlecloud": {
    "sizes": {
      "e2-micro": "1 vCPU, 1 GB RAM",
      "e2-small": "1 vCPU, 2 GB RAM",
      "e2-medium": "1 vCPU, 4 GB RAM"
    },
    "regions": {
      "us-central1": "US Central (Iowa)",
      "europe-west1": "Europe West (Belgium)"
    }
  }
}
```

---

## Nginx Modules Reference

URL: https://developers.cloud66.com/v3/endpoints/reference/#nginx-modules
Endpoint: GET /reference/nginx_modules

# Nginx Modules Reference

Retrieves reference information about available Nginx modules that can be configured in Cloud66 stacks. This endpoint provides static reference data about module capabilities and does not require authentication.

## Use Cases

- **Stack Configuration**: Determine available Nginx modules for web server configuration
- **Feature Planning**: Understand what Nginx capabilities are available
- **Documentation**: Reference module information for configuration guides

## Module Information

Each module entry includes:
- `name` - Human-readable module name
- `description` - Brief description of module functionality
- `version` - Module version information

## Common Nginx Modules

The response typically includes modules for:
- **SSL/TLS Support** - HTTPS and certificate management
- **Geographic IP** - Location-based request handling
- **Real IP Detection** - Proper client IP handling behind proxies
- **Compression** - Content compression modules
- **Security** - Security-related modules
- **Performance** - Caching and optimization modules

<Callout type="info" title="No Authentication Required">
This endpoint provides public reference data about Nginx modules and does not require authentication or API keys.
</Callout>

## Related Configuration

This reference data is typically used when:
- Configuring web servers in stack creation
- Setting up custom Nginx configurations
- Planning stack architecture with specific Nginx features

**Related models:** Stack, Service

### Response

```json
{
  "http_geoip_module": {
    "name": "GeoIP Module",
    "description": "Provides geographic location information based on client IP addresses",
    "version": "1.0"
  },
  "http_ssl_module": {
    "name": "SSL Module", 
    "description": "Enables HTTPS and SSL/TLS support",
    "version": "1.0"
  },
  "http_realip_module": {
    "name": "Real IP Module",
    "description": "Allows changing the client address to value from request header",
    "version": "1.0"
  }
}
```