---
title: "Server"
description: "Explore comprehensive server documentation within Gitana's Cluster type, covering properties, methods, and language drivers. (Gitana 4.0)"
product: "Gitana"
version: "4.0"
url: "/documentation/gitana/4.0/reference/types/server"
---

# <a id="top"></a>Server

An Object

1.  [Cluster](/documentation/gitana/4.0/reference/types/cluster.md)
2.  [Server](/documentation/gitana/4.0/reference/types/server.md)

##### Table of Contents

- [Overview](#top "Overview")
- [Parent](#parent "Parent")
- [Properties](#properties "Properties")
- [Methods](#methods "Methods")
- [Schema](#schema "Schema")

> **Note:** Drop in one of our language drivers to accelerate your development.  
> Here are links to some of our popular [Cookbooks](/documentation/gitana/4.0/developers/cookbooks/overview.md) to help you get started!
> 
> - [C#](/documentation/gitana/4.0/developers/cookbooks/csharp.md)
> - [Go](/documentation/gitana/4.0/developers/cookbooks/go.md)
> - [Java](/documentation/gitana/4.0/developers/cookbooks/java.md)
> - [JavaScript](/documentation/gitana/4.0/developers/cookbooks/javascript2.md)
> - [PHP](/documentation/gitana/4.0/developers/cookbooks/php.md)
> - [Python](/documentation/gitana/4.0/developers/cookbooks/python.md)
> - [Ruby](/documentation/gitana/4.0/developers/cookbooks/ruby.md)

## <a id="parent"></a>Parent

This Server is contained within a [Cluster](/documentation/gitana/4.0/reference/types/cluster.md).

## <a id="properties"></a>Properties

The following properties are available:

| Property | Type | Default | Read-Only | Description |
| --- | --- | --- | --- | --- |
| \_doc | string |  | No | The primary ID |
| \_system | object |  | No | Metadata maintained by the system |
| key | string |  | No |  |
| localIP | string |  | No |  |
| localPort | string |  | No |  |

## <a id="methods"></a>Methods

The following methods are available:

- [1 Test](#get-test-1 "1 Test")
- [1 Test](#get-secure-test-1 "1 Test")
- [Read Healthcheck](#get-healthcheck "Read Healthcheck")
- [Read Ping](#get-ping "Read Ping")

### <a id="get-test-1"></a>1 Test

GET /test/1

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| size | false | string |  |
| delay | false | string |  |
| early | false | string |  |

### <a id="get-secure-test-1"></a>1 Test

GET /secure/test/1

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| size | false | string |  |
| delay | false | string |  |
| early | false | string |  |

### <a id="get-healthcheck"></a>Read Healthcheck

GET /healthcheck

#### Parameters

This function has no parameters.

### <a id="get-ping"></a>Read Ping

GET /ping

#### Parameters

This function has no parameters.

## <a id="schema"></a>Schema

```json

{
  "type": "object",
  "extends": "document",
  "container": "cluster",
  "description": "Server",
  "properties": {
    "key": {
      "type": "string"
    },
    "localIP": {
      "type": "string"
    },
    "localPort": {
      "type": "string"
    },
    "_doc": null,
    "_system": null
  },
  "id": "server"
}
```