{
 "apiVersion": "1.0.0",
 "swaggerVersion": "1.2",
 "apis": [
 {
 "path": "/servers",
 "description": "Asterisk servers"
 }
 ]
}

{
 "apiVersion": "1.0.0",
 "swaggerVersion": "1.2",
 "basePath": "https://beacon.asterisk.org:443"
 "resourcePath": "/servers"
 "apis": [
 {
 "path": "/servers"
 "operations": [
 {
 "method": "POST",
 "summary": "Request a new server ID",
 "notes": "This allocates a new server token and returns it to the user for subsequent requests."
 "nickname": "requestServer",
 "type": "ServerToken",
 "parameters": [
 ],
 "responseMessages": [
 {
 "code": 409,
 "message": "Server already exists"
 }
 ]
 }
 ],

 },
 {
 "path": "/servers/{server}"
 "operations": [
 {
 "method": "PUT",
 "summary": "Update a server",
 "notes": "Upon updating a server, a token is returned. If not provided on a subsequent update, the request is rejected. Tokens expire after 48 hours."
 "nickname": "updateServer",
 "type": "Token",
 "parameters": [
 {
 "name": "serverId",
 "description": "The unique ID of the server. Must be a v4 UUID."
 "paramType": "path",
 "required": true,
 "allowMultiple": false,
 "type": "string"
 },
 {
 "name": "tokenId",
 "description": "The current server token."
 "paramType": "query",
 "required": false,
 "allowMultiple": false,
 "type": "string"
 },
 {
 "name": "body",
 "description": "Properties of the server."
 "paramType": "body",
 "required": true,
 "allowMultiple": false,
 "type": "Server"
 },
 ],
 "responseMessages": [
 {
 "code": 400,
 "message": "Invalid parameters for updating a server"
 },
 {
 "code": 401,
 "message": "Invalid token provided"
 }
 ]
 }
 ]
 }
 ],
 "models": {
 "Token": {
 "id": "Token",
 "description": "A time-based token that authorizes a server for a particular resource",
 "required": [
 "id",
 "issued"
 ],
 "properties": {
 "id": {
 "type": "string",
 "description": "UUID uniquely identifying the token"
 },
 "issued": {
 "type": "string",
 "format": "date-time",
 "description": "Timestamp when the token was issued"
 },
 }
 },
 "RunTimeStats": {
 "id": "RunTimeStats",
 "description": "Running time statistics for an Asterisk instance",
 "required": [
 ],
 "properties": {
 "startup_time": {
 "type": "string",
 "format": "date-time",
 "description": "When this instance was started"
 },
 "last_reload_time": {
 "type": "string",
 "format": "date-time",
 "description": "When this instance was last reloaded"
 }
 }
 },
 "CallStats": {
 "id": "CallStats",
 "description": "Running time statistics for an Asterisk instance",
 "required": [
 ],
 "properties": {
 "active": {
 "type": "integer",
 "format": "int32",
 "description": "Number of active calls"
 },
 "processed": {
 "type": "integer",
 "format": "int32",
 "description": "Number of processed calls"
 }
 }
 },
 "AsteriskStats": {
 "id": "AsteriskStats",
 "description": "Statistics for a running instance of Asterisk",
 "required": [
 ],
 "properties": {
 "run_time": {
 "$ref": "RunTimeStats",
 "description": "Statistics on how long Asterisk has been running"
 },
 "calls": {
 "$ref": "CallStats",
 "description": "Statistics on the number of calls processed"
 }
 }
 }
 "AsteriskModule": {
 "id": "AsteriskModule",
 "description": "An Asterisk module",
 "required": [
 "name",
 "description",
 "status"
 ],
 "properties": {
 "name": {
 "type": "string",
 "description": "The name of the module"
 },
 "description": {
 "type": "string",
 "description": "A description of the module"
 },
 "status": {
 "type": "string",
 "description": "The current state of the module"
 },
 "support_level": {
 "type": "string",
 "description": "The support level of the module"
 }
 }
 },
 "AsteriskVersion": {
 "id": "AsteriskVersion",
 "description": "The version of an instance of Asterisk",
 "required": [
 "name",
 "number"
 ],
 "properties": {
 "name": {
 "type": "string",
 "description": "The textual description of the Asterisk version"
 },
 "number": {
 "type": "string",
 "description": "A derived numeric version of the Major.Minor.Patch value of the Asterisk version"
 },
 }
 },
 "Asterisk": {
 "id": "Asterisk",
 "description": "Information about a running instance of Asterisk",
 "required": [
 "version"
 ],
 "properties": {
 "version": {
 "$ref": "AsteriskVersion",
 "description": "The version of Asterisk"
 },
 "modules": {
 "type": "array",
 "items": {
 "$ref": "AsteriskModule"
 },
 "description": "The loaded modules"
 },
 "stats": {
 "$ref": "AsteriskStats",
 "description": "Statistics about the Asterisk instance"
 }
 }
 },
 "OperatingSystem": {
 "id": "OperatingSystem",
 "description": "Information about the machine OS. Note that this is likely only to have meaning on Linux distros",
 "required": [
 ],
 "properties": {
 "sys_name": {
 "type": "string",
 "description": "The system name, e.g., Linux"
 },
 "release": {
 "type": "string",
 "description": "The OS release, e.g., 3.13.0-24-generic"
 },
 "version": {
 "type": "string",
 "description": "The OS version, e.g., #47-Ubuntu SMP Fri May 2 23:30:00 UTC 2014"
 },
 "machine": {
 "type": "string",
 "description": "The machine hardware identifier, e.g., x86_64"
 }
 }
 },
 "Server": {
 "id": "Server",
 "description": "Information regarding a server",
 "required": [
 "id"
 ],
 "properties": {
 "id": {
 "type": "string",
 "description": "UUID uniquely identifying the server"
 },
 "asterisk": {
 "$ref": "Asterisk",
 "description": "Information about Asterisk"
 },
 "operating_system": {
 "$ref": "OperatingSystem",
 "description": "Information about the system OS"
 },
 "private_name": {
 "type": "string",
 "description": "A name for the server that is never displayed on the Asterisk Beacon server. It is provided via configuration for custom use."
 }
  }
 },
 "ServerToken": {
 "id": "ServerToken",
 "description": "A server and a token for the subsequent request that updates the server",
 "required": [
 "token",
 "server"
 ],
 "properties": {
 "token": {
 "$ref": "Token",
 "description": "The token that has just been issued"
 },
 "server": {
 "$ref": "Server",
 "description": "The server that the token is for"
 }
 }
 }
 }
}