Logo

Command Palette

Search for a command to run...

Servers represent the compute instances in your infrastructure, whether they are cloud servers or your own servers. They contain information about the server's configuration, location, and health status.

Model
uidstring

The unique identifier of the server.

vendor_uidstring

The cloud provider's identifier for this server.

namestring

The name of the server.

addressstring

The external IP address of the server.

distrostring

The Linux distribution running on the server.

distro_versionstring

The version of the Linux distribution.

dns_recordstring

The DNS record associated with this server.

user_namestring

The username for SSH access to this server.

server_typestring

The type of server (BYOS for Bring Your Own Server, or Cloud with provider name).

server_rolesarray

An array of roles assigned to this server (e.g., web, db, docker).

server_group_idinteger

The ID of the server group this server belongs to.

stack_uidstring

The UID of the stack this server belongs to.

has_agentboolean

Whether the Cloud 66 agent is installed on this server.

paramsobject

Additional parameters and metadata for the server.

created_atdatetime

The date and time the server was created, in ISO 8601 format.

updated_atdatetime

The date and time the server was last updated, in ISO 8601 format.

regionstring

The cloud provider region where this server is located.

availability_zonestring

The availability zone within the region.

ext_ipv4string

The external IPv4 address of the server.

int_ipv4string

The internal IPv4 address of the server.

ext_ipv6string

The external IPv6 address of the server, if available.

int_ipv6string

The internal IPv6 address of the server, if available.

health_stateinteger

The health status code of the server.

personal_keyboolean

Whether this server uses personal SSH keys for multi-user access.

has_deploy_gatewayboolean

Whether this server has a deploy gateway configured.

deploy_gateway_addressstring

The address of the deploy gateway, if configured.

deploy_gateway_user_namestring

The username for the deploy gateway, if configured.

Example

{
  "uid": "550e8400-e29b-41d4-a716-446655440001",
  "vendor_uid": "i-0123456789abcdef0",
  "name": "web-server-01",
  "address": "203.0.113.10",
  "distro": "ubuntu",
  "distro_version": "20.04",
  "dns_record": "web-01.example.com",
  "user_name": "cloud66",
  "server_type": "aws",
  "server_roles": [
    "web",
    "docker"
  ],
  "server_group_id": 123,
  "stack_uid": "stack-550e8400-e29b-41d4-a716",
  "has_agent": true,
  "params": {
    "size": "t3.medium",
    "region": "us-east-1",
    "subnet": "subnet-12345"
  },
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-02-15T14:20:00Z",
  "region": "us-east-1",
  "availability_zone": "us-east-1a",
  "ext_ipv4": "203.0.113.10",
  "int_ipv4": "10.0.1.100",
  "ext_ipv6": "2001:db8::1",
  "int_ipv6": "fd00::1",
  "health_state": 1,
  "personal_key": false,
  "has_deploy_gateway": false,
  "deploy_gateway_address": null,
  "deploy_gateway_user_name": null
}
Edit this page