In the VoIP Spear world, servers are the entities that monitor your endpoints. VoIP Spear maintains a number of servers deployed around the world. Any VoIP Spear user is free to use these "public" servers.
In addition to public servers, some customers run "private" testing servers for their own endpoints. These are Linux, Windows, or Mac workstations which have the VoIP Spear testing software installed and running. Private servers are not usable by all customers.
Please contact us if you would like to set up a private server.
| Field | Description |
|---|---|
| id | An integer that uniquely identifies the server |
| ip_address | IP address or hostname of the server. |
| name | Name of the server. |
| description | Description of the server. |
| private | Indicates if this is a private or public server. |
| last_login_date | The date and time this server last logged into VoIP Spear. |
| last_login_ip | The last IP address from which this server logged in. |
| created_at | The date and time the server was created. |
| deleted_at | The date and time the server was cancelled. If this is null, then the server has not been deleted/cancelled yet. |
{
"id": 1057,
"name": "San Francisco",
"ip_address": "162.243.146.17",
"description": "Public server located in San Francisco, USA.",
"private": false,
"region": "North America",
"version": "4.0.2",
"last_login_date": "2016-10-11 00:59:41",
"last_login_ip": "162.243.146.17",
"created_at": "2013-11-23 16:28:22",
"deleted_at": null,
}
| Action | Method | URL |
|---|---|---|
| List your servers | GET | /servers |
| Show server | GET | /servers/<server_id> |
| Update server | PATCH | /servers/<server_id> |
| Cancel server | DELETE | /servers/<server_id> |
| Re-activate server | PATCH | /servers/<server_id>/activate |
GET /servers/<server_id>/servers
By default, this returns all servers that are accessible by you. However, you may
constrain the results to public servers only (by passing in the parameter public).
You can have private servers returned by passing in parameter private.
| name | Case-insensitive partial match on the name of the server. |
| ip_address | Case-insensitive partial match on IP address (or hostname). |
| private | If included, only private servers will be listed. |
| public | If included, only public servers will be listed. |
GET https://voipspear.com/servers
[
{
"id": 1058,
"name": "New York",
"ip_address": "162.243.87.191",
"description": "public server in New York, USA.",
"private": false,
"region": "North America",
"version": "4.0.4",
"last_login_date": "2016-10-11 00:59:44",
"last_login_ip": "162.243.87.191",
"created_at": "2013-11-23 16:54:17",
"deleted_at": null
},
{
"id": 1060,
"name": "London",
"ip_address": "37.235.54.150",
"description": "VoIP Spear's public server in London, UK.",
"private": false,
"region": "Europe",
"version": "4.0.3",
"last_login_date": "2016-10-11 00:59:39",
"last_login_ip": "37.235.54.150",
"created_at": "2013-12-28 16:25:01",
"deleted_at": null
},
{
"id": 1062,
"name": "Hong Kong",
"ip_address": "158.255.208.62",
"description": "VoIP Spear's public server in Hong Kong.",
"private": false,
"region": "Asia Pacific",
"version": "4.0.2",
"last_login_date": "2016-10-11 00:59:57",
"last_login_ip": "158.255.208.62",
"created_at": "2013-12-29 01:08:34",
"deleted_at": null
}
]
GET /servers/<server_id>
GET https://voipspear.com/servers/1097
{
"id": 1097,
"name": "Miami",
"ip_address": "104.207.145.85",
"description": null,
"private": false,
"region": "North America",
"version": "4.0.2",
"last_login_date": "2016-10-11 00:59:41",
"last_login_ip": "104.207.145.85",
"created_at": "2015-06-06 01:16:10",
"deleted_at": null
}
PATCH /servers/<server_id>
When supplying these arguments, they must be inside a JSON element named "server".
| name | The new name of the server. |
| ip_address | New IP address or FQDN for the server. |
| description | Description for the server. |
PATCH https://voipspear.com/servers/1970 args:{"server":{"name":"Carlos server"}}
{
"id": 1970,
"name": "Carlos server",
"ip_address": "104.207.145.85",
"description": null,
"private": true,
"region": "North America",
"version": "4.0.2",
"last_login_date": "2016-10-11 00:59:41",
"last_login_ip": "104.207.145.85",
"created_at": "2015-06-06 01:16:10",
"deleted_at": null
}
DELETE /servers/<server_id>
DELETE https://voipspear.com/servers/1973
{
"id": 1973,
"name": "North Minnesota",
"ip_address": "14.27.15.85",
"description": null,
"private": true,
"region": "North America",
"version": "4.0.2",
"last_login_date": "2016-10-11 00:59:41",
"last_login_ip": "14.27.15.85",
"created_at": "2015-06-06 01:16:10",
"deleted_at": "2017-03-31 19:01:09"
}
PATCH https://voipspear.com/servers/<server_id>/activate
PATCH https://voipspear.com/servers/1973/activate
{
"id": 1973,
"name": "North Minnesota",
"ip_address": "14.27.15.85",
"description": null,
"private": true,
"region": "North America",
"version": "4.0.2",
"last_login_date": "2016-10-11 00:59:41",
"last_login_ip": "14.27.15.85",
"created_at": "2015-06-06 01:16:10",
"deleted_at": "2017-03-31 19:01:09"
}
