OpenGnsys Server REST API

Information about OpenGnsys Server REST API functions.
More information: https://helloreverb.com
Contact Info: hello@helloreverb.com
Version: 1.1.0
BasePath:/rest
Creative Commons 4.0 International
http://creativecommons.org/licenses/by/4.0/

Access

  1. APIKey KeyParamName:Authorization KeyInQuery:false KeyInHeader:true

Methods

[ Jump to Models ]

Table of Contents

  1. get /ous/{ouid}/labs/{labid}/clients/{clientid}
  2. get /ous/{ouid}/labs/{labid}/clients/{clientid}/hardware
  3. get /ous/{ouid}/labs/{labid}/clients/{clientid}/status
  4. get /ous/{ouid}/labs/{labid}/clients
  5. get /ous/{ouid}/labs
  6. get /ous/{ouid}/labs/{labid}
  7. get /ous
  8. get /ous/{ouid}
  9. get /ous/{ouid}/repos
  10. get /ous/{ouid}/repos/{repoid}
  11. post /login
Up 
get /ous/{ouid}/labs/{labid}/clients/{clientid}
(ousOuidLabsLabidClientsClientidGet)
Get a `client` object.

Path parameters

ouid (required)
Path Parameter — OU identificator
labid (required)
Path Parameter — Lab identificator
clientid (required)
Path Parameter — Client identificator

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

inline_response_200_6

Example data

Content-Type: application/json
{
  "image" : "aeiou",
  "routerip" : "aeiou",
  "boottype" : "aeiou",
  "ip" : "aeiou",
  "repo" : {
    "id" : ""
  },
  "netdriver" : "aeiou",
  "netiface" : "aeiou",
  "mac" : "aeiou",
  "serialno" : "aeiou",
  "netmask" : "aeiou",
  "name" : "aeiou",
  "id" : "",
  "validation" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response inline_response_200_6
Up 
get /ous/{ouid}/labs/{labid}/clients/{clientid}/hardware
(ousOuidLabsLabidClientsClientidHardwareGet)
Get the hardware definition of a `client` object.

Path parameters

ouid (required)
Path Parameter — OU identificator
labid (required)
Path Parameter — Lab identificator
clientid (required)
Path Parameter — Client identificator

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

inline_response_200_7

Example data

Content-Type: application/json
{
  "name" : "aeiou",
  "id" : "",
  "hardware" : [ {
    "description" : "aeiou",
    "type" : "aeiou"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response inline_response_200_7
Up 
get /ous/{ouid}/labs/{labid}/clients/{clientid}/status
(ousOuidLabsLabidClientsClientidStatusGet)
Get execution status of a `client`

Path parameters

ouid (required)
Path Parameter — OU identificator
labid (required)
Path Parameter — Lab identificator
clientid (required)
Path Parameter — Client identificator

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

inline_response_200_8

Example data

Content-Type: application/json
{
  "ip" : "aeiou",
  "id" : "",
  "status" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response inline_response_200_8
Up 
get /ous/{ouid}/labs/{labid}/clients
(ousOuidLabsLabidClientsGet)
Get all `client` objects defined in an `lab`.

Path parameters

ouid (required)
Path Parameter — OU identificator
labid (required)
Path Parameter — Lab identificator

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

array[inline_response_200_5]

Example data

Content-Type: application/json
[ {
  "ou" : {
    "id" : ""
  },
  "name" : "aeiou",
  "id" : "",
  "lab" : ""
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response
Up 
get /ous/{ouid}/labs
(ousOuidLabsGet)
Get all `lab` objects defined in an `OU`.

Path parameters

ouid (required)
Path Parameter — OU identificator

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

array[inline_response_200_3]

Example data

Content-Type: application/json
[ {
  "ou" : {
    "id" : ""
  },
  "name" : "aeiou",
  "id" : "",
  "inremotepc" : true
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response
Up 
get /ous/{ouid}/labs/{labid}
(ousOuidLabsLabidGet)
Get a `lab` object.

Path parameters

ouid (required)
Path Parameter — OU identificator
labid (required)
Path Parameter — laboratory identificator

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

inline_response_200_4

Example data

Content-Type: application/json
{
  "image" : "aeiou",
  "routerip" : "aeiou",
  "mcastport" : "",
  "proxyurl" : "aeiou",
  "dns" : "aeiou",
  "mcastmode" : "aeiou",
  "description" : "aeiou",
  "inremotepc" : true,
  "ntp" : "aeiou",
  "mcastspeed" : "",
  "capacity" : "",
  "defclients" : "",
  "mcastip" : "aeiou",
  "projector" : true,
  "netmask" : "aeiou",
  "p2ptime" : "",
  "name" : "aeiou",
  "p2pmode" : "aeiou",
  "location" : "aeiou",
  "id" : "",
  "board" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response inline_response_200_4
Up 
get /ous
(ousGet)
Gets all `OU` objects.

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

array[inline_response_200_1]

Example data

Content-Type: application/json
[ {
  "name" : "aeiou",
  "id" : ""
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response
Up 
get /ous/{ouid}
(ousOuidGet)
Get an `OU` object.

Path parameters

ouid (required)
Path Parameter — Organization Unit identificator

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

inline_response_200_2

Example data

Content-Type: application/json
{
  "name" : "aeiou",
  "description" : "aeiou",
  "id" : ""
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response inline_response_200_2
Up 
get /ous/{ouid}/repos
(ousOuidReposGet)
Get all `repo` objects defined in an `OU`.

Path parameters

ouid (required)
Path Parameter — OU identificator

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

array[inline_response_200_9]

Example data

Content-Type: application/json
[ {
  "ou" : {
    "id" : ""
  },
  "name" : "aeiou",
  "id" : ""
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response
Up 
get /ous/{ouid}/repos/{repoid}
(ousOuidReposRepoidGet)
Get a `repo` object.

Path parameters

ouid (required)
Path Parameter — OU identificator
repoid (required)
Path Parameter — repository identificator

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

inline_response_200_10

Example data

Content-Type: application/json
{
  "ip" : "aeiou",
  "name" : "aeiou",
  "description" : "aeiou",
  "id" : ""
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful response inline_response_200_10
Up 
post /login
(loginPost)
Check user login and returns his/her API key.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

authdata (required)
Body Parameter — JSON authentication data

Return type

inline_response_200

Example data

Content-Type: application/json
{
  "apikey" : "aeiou",
  "userid" : ""
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful login inline_response_200

400

Missing parameters

500

Authentication error
Up

Models

[ Jump to Methods ]

Table of Contents

  1. authdata
  2. inline_response_200
  3. inline_response_200_1
  4. inline_response_200_10
  5. inline_response_200_2
  6. inline_response_200_3
  7. inline_response_200_4
  8. inline_response_200_5
  9. inline_response_200_6
  10. inline_response_200_6_repo
  11. inline_response_200_7
  12. inline_response_200_7_hardware
  13. inline_response_200_8
  14. inline_response_200_9
  15. ousouidlabs_ou

authdata Up

username (optional)
String
password (optional)
String

inline_response_200 Up

userid (optional)
Integer
apikey (optional)
String

inline_response_200_1 Up

id (optional)
Integer
name (optional)
String

inline_response_200_10 Up

id (optional)
Integer repository id
name (optional)
String repository name
description (optional)
String repository description
ip (optional)
String repository IP address

inline_response_200_2 Up

id (optional)
Integer
name (optional)
String
description (optional)
String

inline_response_200_3 Up

id (optional)
Integer
name (optional)
String
inremotepc (optional)
Boolean
ou (optional)
ousouidlabs_ou

inline_response_200_4 Up

id (optional)
Integer laboratory identificator
name (optional)
String laboratory name
location (optional)
String laboratory location
description (optional)
String laboratory description
inremotepc (optional)
Boolean check if this lab will be included in Remote PC Project
capacity (optional)
Integer maximum number of people in the lab
defclients (optional)
Integer number of defined clients in the lab
projector (optional)
Boolean check if this lab has a projector
board (optional)
Boolean check if this lab has an electronic board
routerip (optional)
String lab router IP address
netmask (optional)
String network mask to use in the lab
ntp (optional)
String NTP server IP address
dns (optional)
String DNS server IP address
proxyurl (optional)
String Proxy server URL
mcastmode (optional)
String Multicast protocol mode (\"full-duplex\", \"half-duplex\").
mcastip (optional)
String Multicast IP address
mcastport (optional)
Integer Multicast port
mcastspeed (optional)
Integer Multicast speed (in Mbps)
p2pmode (optional)
String Bittorrent connection type (\"peer\", \"leecher\". \"seeder\").
p2ptime (optional)
Integer Bittorrent connection extra time (in s.)
image (optional)
String Lab's picture file

inline_response_200_5 Up

id (optional)
Integer
name (optional)
String
ou (optional)
ousouidlabs_ou
lab (optional)
ousouidlabs_ou

inline_response_200_6 Up

id (optional)
Integer client id
name (optional)
String client name
serialno (optional)
String client serial number
netiface (optional)
String main network interface
netdriver (optional)
String client MAC address (kernel module)
mac (optional)
String client MAC address
ip (optional)
String client IP address
netmask (optional)
String subnet mask address
routerip (optional)
String network router IP address
repo (optional)
inline_response_200_6_repo
validation (optional)
Boolean boot validation flag
boottype (optional)
String boot template type
image (optional)
String client's picture file

inline_response_200_6_repo Up

id (optional)
Integer

inline_response_200_7 Up

id (optional)
Integer client id
name (optional)
String client name
hardware (optional)
array[inline_response_200_7_hardware] hardware components

inline_response_200_7_hardware Up

type (optional)
String hardware component type
description (optional)
String hardware component description

inline_response_200_8 Up

id (optional)
Integer client id
ip (optional)
String client IP address
status (optional)
String execution status

inline_response_200_9 Up

id (optional)
Integer
name (optional)
String
ou (optional)
ousouidlabs_ou

ousouidlabs_ou Up

id (optional)
Integer