# Server

URL: https://developers.cloud66.com/v3/models/server/

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>
    <ModelProperty name="uid" type="string">
        The unique identifier of the server.
    </ModelProperty>
    <ModelProperty name="vendor_uid" type="string">
        The cloud provider's identifier for this server.
    </ModelProperty>
    <ModelProperty name="name" type="string">
        The name of the server.
    </ModelProperty>
    <ModelProperty name="address" type="string">
        The external IP address of the server.
    </ModelProperty>
    <ModelProperty name="distro" type="string">
        The Linux distribution running on the server.
    </ModelProperty>
    <ModelProperty name="distro_version" type="string">
        The version of the Linux distribution.
    </ModelProperty>
    <ModelProperty name="dns_record" type="string">
        The DNS record associated with this server.
    </ModelProperty>
    <ModelProperty name="user_name" type="string">
        The username for SSH access to this server.
    </ModelProperty>
    <ModelProperty name="server_type" type="string">
        The type of server (BYOS for Bring Your Own Server, or Cloud with provider name).
    </ModelProperty>
    <ModelProperty name="server_roles" type="array">
        An array of roles assigned to this server (e.g., web, db, docker).
    </ModelProperty>
    <ModelProperty name="server_group_id" type="integer">
        The ID of the server group this server belongs to.
    </ModelProperty>
    <ModelProperty name="stack_uid" type="string">
        The UID of the stack this server belongs to.
    </ModelProperty>
    <ModelProperty name="has_agent" type="boolean">
        Whether the Cloud 66 agent is installed on this server.
    </ModelProperty>
    <ModelProperty name="params" type="object">
        Additional parameters and metadata for the server.
    </ModelProperty>
    <ModelProperty name="created_at" type="datetime">
        The date and time the server was created, in ISO 8601 format.
    </ModelProperty>
    <ModelProperty name="updated_at" type="datetime">
        The date and time the server was last updated, in ISO 8601 format.
    </ModelProperty>
    <ModelProperty name="region" type="string">
        The cloud provider region where this server is located.
    </ModelProperty>
    <ModelProperty name="availability_zone" type="string">
        The availability zone within the region.
    </ModelProperty>
    <ModelProperty name="ext_ipv4" type="string">
        The external IPv4 address of the server.
    </ModelProperty>
    <ModelProperty name="int_ipv4" type="string">
        The internal IPv4 address of the server.
    </ModelProperty>
    <ModelProperty name="ext_ipv6" type="string">
        The external IPv6 address of the server, if available.
    </ModelProperty>
    <ModelProperty name="int_ipv6" type="string">
        The internal IPv6 address of the server, if available.
    </ModelProperty>
    <ModelProperty name="health_state" type="integer">
        The health status code of the server.
    </ModelProperty>
    <ModelProperty name="personal_key" type="boolean">
        Whether this server uses personal SSH keys for multi-user access.
    </ModelProperty>
    <ModelProperty name="has_deploy_gateway" type="boolean">
        Whether this server has a deploy gateway configured.
    </ModelProperty>
    <ModelProperty name="deploy_gateway_address" type="string">
        The address of the deploy gateway, if configured.
    </ModelProperty>
    <ModelProperty name="deploy_gateway_user_name" type="string">
        The username for the deploy gateway, if configured.
    </ModelProperty>
</Model>

## Example

```json
{
  "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
}
```