Logo

Command Palette

Search for a command to run...

GET/elastic_addresses
List Elastic Addressespublic

Returns all elastic addresses (failover groups) that belong to the authenticated user's account.

Elastic addresses provide high availability by allowing traffic to be switched between primary and secondary stacks during failures or maintenance operations. They are also known as failover groups.

Related Models:ElasticAddressStack

Key Features:

  • High Availability: Automatic traffic switching during failures
  • Maintenance Windows: Manual switching for zero-downtime updates
  • Multi-Cloud Support: Works across different cloud providers
  • Real-time Monitoring: Status tracking for primary and secondary stacks
Response Status Codes
Status CodeDescription
200Success - Returns list of elastic addresses
401Unauthorized - Authentication failed or missing OAuth token
403Forbidden - OAuth token lacks required `public` scope

Request

GET
/elastic_addresses
curl -X GET \
  "https://app.cloud66.com/api/3/elastic_addresses" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

Response

{
  "response": [
    {
      "id": 123,
      "uid": "abc123def456",
      "address": "203.0.113.10",
      "primary_stack": "my-primary-stack",
      "secondary_stack": "my-backup-stack",
      "current_stack": "primary",
      "status": "active",
      "cloud": "AWS",
      "region": "us-east-1",
      "created_at": "2023-01-15T10:30:00Z",
      "updated_at": "2023-01-15T10:30:00Z"
    },
    {
      "id": 124,
      "uid": "def456ghi789",
      "address": "203.0.113.20",
      "primary_stack": "app-prod-cluster",
      "secondary_stack": "app-backup-cluster",
      "current_stack": "secondary",
      "status": "active",
      "cloud": "DigitalOcean",
      "region": "nyc3",
      "created_at": "2023-01-10T14:20:00Z",
      "updated_at": "2023-01-12T09:15:00Z"
    }
  ]
}
POST/elastic_addresses
Create Elastic Addressadmin

Optional Parameters

primary_stack_uid
UID of the primary stack for the failover group
secondary_stack_uid
UID of the secondary/backup stack for the failover group
current_stack
Which stack is currently active ("primary" or "secondary")

Creates a new elastic address (failover group) that provides high availability by allowing traffic to be switched between primary and secondary stacks.

Both stacks must support failover groups and you must have appropriate permissions on both stacks. The stacks cannot be the same and must have DNS configurations.

Related Models:ElasticAddressStack

Validation Rules:

  • Primary and secondary stacks must be different
  • You must have failover group edit permissions on both stacks
  • Stacks must support failover group functionality
  • Stacks cannot be cluster or prepress type
Response Status Codes
Status CodeDescription
200Success - Failover group created successfully
400Bad Request - Invalid stack configuration or validation errors
401Unauthorized - Authentication failed or missing OAuth token
403Forbidden - OAuth token lacks required `admin` scope or insufficient permissions on stacks
422Unprocessable Entity - Cannot create failover group at this time

Request

POST
/elastic_addresses
curl -X POST \
  "https://app.cloud66.com/api/3/elastic_addresses" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

Response

{
  "response": {
    "ok": true,
    "message": "Failover Group created"
  }
}
PUT/elastic_addresses/:uid
Update Elastic Addressadmin

Optional Parameters

uid
Elastic address UID
primary_stack_uid
UID of the primary stack for the failover group
secondary_stack_uid
UID of the secondary/backup stack for the failover group
current_stack
Which stack is currently active ("primary" or "secondary")

Modifies the specified elastic address (failover group) with new stack assignments or current stack settings.

Validates changes against business rules and permissions before applying updates. You must have appropriate permissions on both existing and new stacks.

Related Models:ElasticAddressStack

Update Rules:

  • Primary and secondary stacks must be different
  • You must have failover group edit permissions on all involved stacks
  • New stacks must support failover group functionality
  • DNS updates are automatically triggered after successful update
Response Status Codes
Status CodeDescription
200Success - Failover group updated successfully
400Bad Request - Invalid failover group UID or stack configuration
401Unauthorized - Authentication failed or missing OAuth token
403Forbidden - OAuth token lacks required `admin` scope or insufficient permissions on stacks
422Unprocessable Entity - Issue updating the failover group

Request

PUT
/elastic_addresses/:uid
curl -X PUT \
  "https://app.cloud66.com/api/3/elastic_addresses/:uid" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

Response

{
  "response": {
    "ok": true,
    "message": "Failover Group updated"
  }
}
DELETE/elastic_addresses/:uid
Delete Elastic Addressadmin

Optional Parameters

uid
Elastic address UID

Permanently removes the specified elastic address (failover group) from the system.

Related Models:ElasticAddressStack

The deletion process will:

  1. Verify the failover group is not attached to any stack
  2. Remove the elastic address configuration
  3. Log the deletion event for audit purposes
Response Status Codes
Status CodeDescription
200Success - Failover group deleted successfully
400Bad Request - Invalid failover group UID or failover group is attached to a stack
401Unauthorized - Authentication failed or missing OAuth token
403Forbidden - OAuth token lacks required `admin` scope

Request

DELETE
/elastic_addresses/:uid
curl -X DELETE \
  "https://app.cloud66.com/api/3/elastic_addresses/:uid" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

Response

{
  "response": {
    "ok": true,
    "message": "Failover Group deleted"
  }
}