CInP API Documentation for Contractor API¶
Namespace - (root)¶
URL: /api/v1/
API Version: 1.0
Namespace - Auth¶
URL: /api/v1/Auth/
API Version: 2.0
Model - User¶
URL: /api/v1/Auth/User
Not Allowed Verbs: UPDATE, CREATE, LIST, GET, DELETE Action - login ~~~~~~~~~~~~~~
URL: /api/v1/Auth/User(login)
Static: Yes
Return Type¶
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|
String |
Parameters¶
Name |
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|
username |
String |
||||||
password |
String |
Action - logout¶
URL: /api/v1/Auth/User(logout)
Static: Yes
Action - whoami¶
URL: /api/v1/Auth/User(whoami)
Static: Yes
Return Type¶
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|
String |
Action - changePassword¶
URL: /api/v1/Auth/User(changePassword)
Static: Yes
Parameters¶
Name |
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|
password |
String |
Namespace - BluePrint¶
URL: /api/v1/BluePrint/
API Version: 0.1
Model - BluePrint¶
URL: /api/v1/BluePrint/BluePrint
Id Field: name
Not Allowed Verbs: LIST, GET, CREATE, UPDATE, DELETE
BluePrint(name, description, config_values, updated, created)
Fields¶
Name |
Type |
Length |
Default |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|---|
name |
String |
40 |
||||||
description |
String |
200 |
||||||
config_values |
Map |
{} |
||||||
updated |
DateTime |
|||||||
created |
DateTime |
|||||||
script_map |
Map |
Action - getConfig¶
URL: /api/v1/BluePrint/BluePrint(getConfig)
Static: No
Return Type¶
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|
Map |
Model - FoundationBluePrint¶
URL: /api/v1/BluePrint/FoundationBluePrint
Id Field: name
FoundationBluePrint(name, description, config_values, updated, created, blueprint_ptr, foundation_type_list, validation_template, physical_interface_names)
Fields¶
Name |
Type |
Length |
Default |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|---|
name |
String |
40 |
||||||
description |
String |
200 |
||||||
config_values |
Map |
{} |
||||||
updated |
DateTime |
|||||||
created |
DateTime |
|||||||
foundation_type_list |
String |
200 |
[] |
Yes |
||||
validation_template |
Map |
{} |
||||||
physical_interface_names |
String |
200 |
[] |
Yes |
||||
parent_list |
Model |
[] |
Yes |
/api/v1/BluePrint/FoundationBluePrint |
||||
script_map |
Map |
Action - getConfig¶
URL: /api/v1/BluePrint/FoundationBluePrint(getConfig)
Static: No
Return Type¶
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|
Map |
Model - StructureBluePrint¶
URL: /api/v1/BluePrint/StructureBluePrint
Id Field: name
StructureBluePrint(name, description, config_values, updated, created, blueprint_ptr)
Fields¶
Name |
Type |
Length |
Default |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|---|
name |
String |
40 |
||||||
description |
String |
200 |
||||||
config_values |
Map |
{} |
||||||
updated |
DateTime |
|||||||
created |
DateTime |
|||||||
parent_list |
Model |
[] |
Yes |
/api/v1/BluePrint/StructureBluePrint |
||||
foundation_blueprint_list |
Model |
[] |
Yes |
/api/v1/BluePrint/FoundationBluePrint |
||||
script_map |
Map |
Action - getConfig¶
URL: /api/v1/BluePrint/StructureBluePrint(getConfig)
Static: No
Return Type¶
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|
Map |
Model - Script¶
URL: /api/v1/BluePrint/Script
Id Field: name
Script(name, description, script, updated, created)
Fields¶
Name |
Type |
Length |
Default |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|---|
name |
String |
40 |
||||||
description |
String |
200 |
||||||
script |
String |
|||||||
updated |
DateTime |
|||||||
created |
DateTime |
Model - BluePrintScript¶
URL: /api/v1/BluePrint/BluePrintScript
Id Field: id
BluePrintScript(id, blueprint, script, name, updated, created)
List Filters¶
blueprint¶
Name |
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|
blueprint |
Model |
/api/v1/BluePrint/BluePrint |
Fields¶
Name |
Type |
Length |
Default |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|---|
blueprint |
Model |
/api/v1/BluePrint/BluePrint |
||||||
script |
Model |
/api/v1/BluePrint/Script |
||||||
name |
String |
50 |
||||||
updated |
DateTime |
|||||||
created |
DateTime |
|||||||
id |
Integer |
Model - PXE¶
URL: /api/v1/BluePrint/PXE
Id Field: name
PXE(name, boot_script, template, updated, created)
Fields¶
Name |
Type |
Length |
Default |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|---|
name |
String |
50 |
||||||
boot_script |
String |
|||||||
template |
String |
|||||||
updated |
DateTime |
|||||||
created |
DateTime |
Namespace - Site¶
URL: /api/v1/Site/
API Version: 0.1
Model - Site¶
URL: /api/v1/Site/Site
Id Field: name
Site(name, zone, description, parent, config_values, updated, created)
Fields¶
Name |
Type |
Length |
Default |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|---|
name |
String |
40 |
||||||
zone |
Model |
/api/v1/Directory/Zone |
||||||
description |
String |
200 |
||||||
parent |
Model |
/api/v1/Site/Site |
||||||
config_values |
Map |
{} |
||||||
updated |
DateTime |
|||||||
created |
DateTime |
Action - getConfig¶
URL: /api/v1/Site/Site(getConfig)
Static: No
Return Type¶
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|
Map |
Action - getDependencyMap¶
URL: /api/v1/Site/Site(getDependencyMap)
Static: No
Return Type¶
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|
Map |
Namespace - Survey¶
URL: /api/v1/Survey/
API Version: 0.1
Model - Plot¶
URL: /api/v1/Survey/Plot
Id Field: name
Plot(name, corners, parent, updated, created)
Fields¶
Name |
Type |
Length |
Default |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|---|
name |
String |
40 |
||||||
corners |
String |
200 |
||||||
parent |
Model |
/api/v1/Survey/Plot |
||||||
updated |
DateTime |
|||||||
created |
DateTime |
Model - Cartographer¶
URL: /api/v1/Survey/Cartographer
Id Field: identifier
Not Allowed Verbs: CREATE, UPDATE
Cartographer(identifier, foundation, message, info_map, last_checkin, updated, created)
Fields¶
Name |
Type |
Length |
Default |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|---|
identifier |
String |
64 |
||||||
foundation |
Model |
/api/v1/Building/Foundation |
||||||
message |
String |
200 |
||||||
info_map |
Map |
{} |
||||||
last_checkin |
DateTime |
|||||||
updated |
DateTime |
|||||||
created |
DateTime |
Action - assign¶
URL: /api/v1/Survey/Cartographer(assign)
Static: No
Parameters¶
Name |
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|
foundation |
Model |
/api/v1/Building/Foundation |
Action - register¶
URL: /api/v1/Survey/Cartographer(register)
Static: Yes
Parameters¶
Name |
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|
identifier |
String |
Action - lookup¶
URL: /api/v1/Survey/Cartographer(lookup)
Static: No
Return Type¶
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|
Map |
Parameters¶
Name |
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|
info_map |
Map |
Action - setMessage¶
URL: /api/v1/Survey/Cartographer(setMessage)
Static: No
Parameters¶
Name |
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|
message |
String |
Action - done¶
URL: /api/v1/Survey/Cartographer(done)
Static: No
Namespace - Directory¶
URL: /api/v1/Directory/
API Version: 0.1
Model - Zone¶
URL: /api/v1/Directory/Zone
Id Field: id
Zone(id, name, parent, ttl, refresh, retry, expire, minimum, updated, created)
Fields¶
Name |
Type |
Length |
Default |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|---|
name |
String |
100 |
||||||
parent |
Model |
/api/v1/Directory/Zone |
||||||
ttl |
Integer |
3600 |
||||||
refresh |
Integer |
86400 |
||||||
retry |
Integer |
7200 |
||||||
expire |
Integer |
36000 |
||||||
minimum |
Integer |
172800 |
||||||
updated |
DateTime |
|||||||
created |
DateTime |
|||||||
id |
Integer |
|||||||
fqdn |
String |
Model - Entry¶
URL: /api/v1/Directory/Entry
Id Field: id
Entry(id, zone, type, name, priority, weight, port, target, updated, created)
List Filters¶
zone¶
Name |
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|
zone |
Model |
/api/v1/Directory/Zone |
Fields¶
Name |
Type |
Length |
Default |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|---|
zone |
Model |
/api/v1/Directory/Zone |
||||||
type |
String |
20 |
MX, SRV, CNAME, TXT |
|||||
name |
String |
255 |
||||||
priority |
Integer |
|||||||
weight |
Integer |
|||||||
port |
Integer |
|||||||
target |
String |
255 |
||||||
updated |
DateTime |
|||||||
created |
DateTime |
|||||||
id |
Integer |
Namespace - Utilities¶
URL: /api/v1/Utilities/
API Version: 0.1
Model - Networked¶
URL: /api/v1/Utilities/Networked
Id Field: id
Networked(id, hostname, site)
Fields¶
Name |
Type |
Length |
Default |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|---|
hostname |
String |
100 |
||||||
site |
Model |
/api/v1/Site/Site |
||||||
id |
Integer |
Model - AddressBlock¶
URL: /api/v1/Utilities/AddressBlock
Id Field: id
AddressBlock(id, name, site, subnet, prefix, gateway_offset, _max_address, updated, created)
List Filters¶
site¶
Name |
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|
site |
Model |
/api/v1/Site/Site |
Fields¶
Name |
Type |
Length |
Default |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|---|
name |
String |
40 |
||||||
site |
Model |
/api/v1/Site/Site |
||||||
subnet |
String |
|||||||
prefix |
Integer |
|||||||
gateway_offset |
Integer |
|||||||
_max_address |
String |
|||||||
updated |
DateTime |
|||||||
created |
DateTime |
|||||||
id |
Integer |
|||||||
gateway |
String |
|||||||
netmask |
String |
|||||||
size |
String |
|||||||
isIpV4 |
String |
Action - nextAddress¶
URL: /api/v1/Utilities/AddressBlock(nextAddress)
Static: No
Return Type¶
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|
Model |
/api/v1/Utilities/Address |
Parameters¶
Name |
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|
networked |
Model |
/api/v1/Utilities/Networked |
|||||
interface_name |
String |
||||||
is_primary |
Boolean |
Action - usage¶
URL: /api/v1/Utilities/AddressBlock(usage)
Static: No
Return Type¶
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|
Map |
Action - getWithNameSite¶
URL: /api/v1/Utilities/AddressBlock(getWithNameSite)
Static: Yes
Return Type¶
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|
Model |
/api/v1/Utilities/AddressBlock |
Parameters¶
Name |
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|
site |
Model |
/api/v1/Site/Site |
|||||
name |
String |
Model - Network¶
URL: /api/v1/Utilities/Network
Id Field: id
Network(id, name, site, mtu, updated, created)
List Filters¶
site¶
Name |
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|
site |
Model |
/api/v1/Site/Site |
Fields¶
Name |
Type |
Length |
Default |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|---|
name |
String |
40 |
||||||
site |
Model |
/api/v1/Site/Site |
||||||
mtu |
Integer |
|||||||
updated |
DateTime |
|||||||
created |
DateTime |
|||||||
address_block_list |
Model |
[] |
Yes |
/api/v1/Utilities/AddressBlock |
||||
id |
Integer |
Action - getWithNameSite¶
URL: /api/v1/Utilities/Network(getWithNameSite)
Static: Yes
Return Type¶
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|
Model |
/api/v1/Utilities/Network |
Parameters¶
Name |
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|
site |
Model |
/api/v1/Site/Site |
|||||
name |
String |
Model - NetworkAddressBlock¶
URL: /api/v1/Utilities/NetworkAddressBlock
Id Field: id
NetworkAddressBlock(id, network, address_block, vlan, updated, created)
List Filters¶
network¶
Name |
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|
network |
Model |
/api/v1/Utilities/Network |
address_block¶
Name |
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|
address_block |
Model |
/api/v1/Utilities/AddressBlock |
Fields¶
Name |
Type |
Length |
Default |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|---|
network |
Model |
/api/v1/Utilities/Network |
||||||
address_block |
Model |
/api/v1/Utilities/AddressBlock |
||||||
vlan |
Integer |
|||||||
updated |
DateTime |
|||||||
created |
DateTime |
|||||||
id |
Integer |
Model - NetworkInterface¶
URL: /api/v1/Utilities/NetworkInterface
Id Field: id
Not Allowed Verbs: LIST, GET, CREATE, UPDATE, DELETE, CALL
NetworkInterface(id, name, network, updated, created)
Fields¶
Name |
Type |
Length |
Default |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|---|
name |
String |
20 |
||||||
network |
Model |
/api/v1/Utilities/Network |
||||||
updated |
DateTime |
|||||||
created |
DateTime |
|||||||
id |
Integer |
|||||||
type |
String |
Model - RealNetworkInterface¶
URL: /api/v1/Utilities/RealNetworkInterface
Id Field: id
RealNetworkInterface(id, name, network, updated, created, networkinterface_ptr, mac, foundation, is_provisioning, physical_location, link_name, pxe)
List Filters¶
foundation¶
Name |
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|
foundation |
Model |
/api/v1/Building/Foundation |
Fields¶
Name |
Type |
Length |
Default |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|---|
name |
String |
20 |
||||||
network |
Model |
/api/v1/Utilities/Network |
||||||
updated |
DateTime |
|||||||
created |
DateTime |
|||||||
mac |
String |
18 |
||||||
foundation |
Model |
/api/v1/Building/Foundation |
||||||
is_provisioning |
Boolean |
False |
||||||
physical_location |
String |
100 |
||||||
link_name |
String |
100 |
||||||
pxe |
Model |
/api/v1/BluePrint/PXE |
||||||
id |
Integer |
|||||||
type |
String |
Model - AbstractNetworkInterface¶
URL: /api/v1/Utilities/AbstractNetworkInterface
Id Field: id
AbstractNetworkInterface(id, name, network, updated, created, networkinterface_ptr, structure)
List Filters¶
structure¶
Name |
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|
structure |
Model |
/api/v1/Building/Structure |
Fields¶
Name |
Type |
Length |
Default |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|---|
name |
String |
20 |
||||||
network |
Model |
/api/v1/Utilities/Network |
||||||
updated |
DateTime |
|||||||
created |
DateTime |
|||||||
structure |
Model |
/api/v1/Building/Structure |
||||||
id |
Integer |
|||||||
type |
String |
Model - AggregatedNetworkInterface¶
URL: /api/v1/Utilities/AggregatedNetworkInterface
Id Field: networkinterface_ptr
AggregatedNetworkInterface(id, name, network, updated, created, networkinterface_ptr, structure, abstractnetworkinterface_ptr, primary_interface, parameters)
List Filters¶
structure¶
Name |
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|
structure |
Model |
/api/v1/Building/Structure |
Fields¶
Name |
Type |
Length |
Default |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|---|
name |
String |
20 |
||||||
network |
Model |
/api/v1/Utilities/Network |
||||||
updated |
DateTime |
|||||||
created |
DateTime |
|||||||
structure |
Model |
/api/v1/Building/Structure |
||||||
primary_interface |
Model |
/api/v1/Utilities/NetworkInterface |
||||||
parameters |
Map |
{} |
||||||
secondary_interfaces |
Model |
[] |
Yes |
/api/v1/Utilities/NetworkInterface |
||||
networkinterface_ptr |
Model |
/api/v1/Utilities/NetworkInterface |
||||||
type |
String |
Model - BaseAddress¶
URL: /api/v1/Utilities/BaseAddress
Id Field: id
Not Allowed Verbs: LIST, GET, CREATE, UPDATE, DELETE
BaseAddress(id, address_block, offset, updated, created)
Fields¶
Name |
Type |
Length |
Default |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|---|
address_block |
Model |
/api/v1/Utilities/AddressBlock |
||||||
offset |
Integer |
|||||||
updated |
DateTime |
|||||||
created |
DateTime |
|||||||
id |
Integer |
|||||||
type |
String |
|||||||
ip_address |
String |
|||||||
subnet |
String |
|||||||
netmask |
String |
|||||||
prefix |
String |
|||||||
gateway |
String |
Action - lookup¶
URL: /api/v1/Utilities/BaseAddress(lookup)
Static: Yes
Return Type¶
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|
Model |
/api/v1/Utilities/BaseAddress |
Parameters¶
Name |
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|
ip_address |
String |
||||||
site |
Model |
/api/v1/Site/Site |
Model - Address¶
URL: /api/v1/Utilities/Address
Id Field: id
Address(id, address_block, offset, updated, created, baseaddress_ptr, networked, interface_name, alias_index, pointer, is_primary)
List Filters¶
address_block¶
Name |
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|
address_block |
Model |
/api/v1/Utilities/AddressBlock |
structure¶
Name |
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|
structure |
Model |
/api/v1/Building/Structure |
Fields¶
Name |
Type |
Length |
Default |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|---|
address_block |
Model |
/api/v1/Utilities/AddressBlock |
||||||
offset |
Integer |
|||||||
updated |
DateTime |
|||||||
created |
DateTime |
|||||||
networked |
Model |
/api/v1/Utilities/Networked |
||||||
interface_name |
String |
20 |
||||||
alias_index |
Integer |
|||||||
pointer |
Model |
/api/v1/Utilities/Address |
||||||
is_primary |
Boolean |
False |
||||||
id |
Integer |
|||||||
type |
String |
|||||||
ip_address |
String |
|||||||
subnet |
String |
|||||||
netmask |
String |
|||||||
prefix |
String |
|||||||
gateway |
String |
Model - ReservedAddress¶
URL: /api/v1/Utilities/ReservedAddress
Id Field: id
ReservedAddress(id, address_block, offset, updated, created, baseaddress_ptr, reason)
List Filters¶
address_block¶
Name |
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|
address_block |
Model |
/api/v1/Utilities/AddressBlock |
Fields¶
Name |
Type |
Length |
Default |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|---|
address_block |
Model |
/api/v1/Utilities/AddressBlock |
||||||
offset |
Integer |
|||||||
updated |
DateTime |
|||||||
created |
DateTime |
|||||||
reason |
String |
50 |
||||||
id |
Integer |
|||||||
type |
String |
|||||||
ip_address |
String |
|||||||
subnet |
String |
|||||||
netmask |
String |
|||||||
prefix |
String |
|||||||
gateway |
String |
Model - DynamicAddress¶
URL: /api/v1/Utilities/DynamicAddress
Id Field: id
DynamicAddress(id, address_block, offset, updated, created, baseaddress_ptr, pxe)
List Filters¶
address_block¶
Name |
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|
address_block |
Model |
/api/v1/Utilities/AddressBlock |
Fields¶
Name |
Type |
Length |
Default |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|---|
address_block |
Model |
/api/v1/Utilities/AddressBlock |
||||||
offset |
Integer |
|||||||
updated |
DateTime |
|||||||
created |
DateTime |
|||||||
pxe |
Model |
/api/v1/BluePrint/PXE |
||||||
id |
Integer |
|||||||
type |
String |
|||||||
ip_address |
String |
|||||||
subnet |
String |
|||||||
netmask |
String |
|||||||
prefix |
String |
|||||||
gateway |
String |
Namespace - Building¶
URL: /api/v1/Building/
API Version: 0.1
Model - Foundation¶
URL: /api/v1/Building/Foundation
Id Field: locator
Not Allowed Verbs: CREATE
Foundation(locator, site, blueprint, id_map, located_at, built_at, updated, created)
List Filters¶
site¶
Name |
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|
site |
Model |
/api/v1/Site/Site |
todo¶
Name |
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|
site |
Model |
/api/v1/Site/Site |
|||||
has_dependancies |
Boolean |
||||||
foundation_class |
String |
Fields¶
Name |
Type |
Length |
Default |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|---|
locator |
String |
100 |
||||||
site |
Model |
/api/v1/Site/Site |
||||||
blueprint |
Model |
/api/v1/BluePrint/FoundationBluePrint |
||||||
id_map |
Map |
|||||||
located_at |
DateTime |
|||||||
built_at |
DateTime |
|||||||
updated |
DateTime |
|||||||
created |
DateTime |
|||||||
state |
String |
|||||||
type |
String |
|||||||
class_list |
String |
|||||||
structure |
Model |
/api/v1/Building/Structure |
Action - setIdMap¶
URL: /api/v1/Building/Foundation(setIdMap)
Static: No
Return Type¶
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|
String |
Parameters¶
Name |
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|
id_map |
Map |
Action - doCreate¶
URL: /api/v1/Building/Foundation(doCreate)
Static: No
Return Type¶
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|
Integer |
Action - doDestroy¶
URL: /api/v1/Building/Foundation(doDestroy)
Static: No
Return Type¶
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|
Integer |
Action - doJob¶
URL: /api/v1/Building/Foundation(doJob)
Static: No
Return Type¶
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|
Integer |
Parameters¶
Name |
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|
name |
String |
Action - getJob¶
URL: /api/v1/Building/Foundation(getJob)
Static: No
Return Type¶
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|
Model |
/api/v1/Foreman/FoundationJob |
Action - getFoundationTypes¶
URL: /api/v1/Building/Foundation(getFoundationTypes)
Static: Yes
Return Type¶
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|
String |
Yes |
Action - getConfig¶
URL: /api/v1/Building/Foundation(getConfig)
Static: No
Return Type¶
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|
Map |
Action - getInterfaceList¶
URL: /api/v1/Building/Foundation(getInterfaceList)
Static: No
Return Type¶
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|
Map |
Yes |
Model - Structure¶
URL: /api/v1/Building/Structure
Id Field: id
Structure(id, hostname, site, networked_ptr, blueprint, foundation, config_uuid, config_values, built_at, updated, created)
List Filters¶
site¶
Name |
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|
site |
Model |
/api/v1/Site/Site |
Fields¶
Name |
Type |
Length |
Default |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|---|
hostname |
String |
100 |
||||||
site |
Model |
/api/v1/Site/Site |
||||||
blueprint |
Model |
/api/v1/BluePrint/StructureBluePrint |
||||||
foundation |
Model |
/api/v1/Building/Foundation |
||||||
config_uuid |
String |
36 |
<undefined> |
|||||
config_values |
Map |
{} |
||||||
built_at |
DateTime |
|||||||
updated |
DateTime |
|||||||
created |
DateTime |
|||||||
id |
Integer |
|||||||
state |
String |
Action - doCreate¶
URL: /api/v1/Building/Structure(doCreate)
Static: No
Return Type¶
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|
Integer |
Action - doDestroy¶
URL: /api/v1/Building/Structure(doDestroy)
Static: No
Return Type¶
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|
Integer |
Action - doJob¶
URL: /api/v1/Building/Structure(doJob)
Static: No
Return Type¶
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|
Integer |
Parameters¶
Name |
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|
name |
String |
Action - getJob¶
URL: /api/v1/Building/Structure(getJob)
Static: No
Return Type¶
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|
Model |
/api/v1/Foreman/StructureJob |
Action - getConfig¶
URL: /api/v1/Building/Structure(getConfig)
Static: No
Return Type¶
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|
Map |
Action - updateConfig¶
URL: /api/v1/Building/Structure(updateConfig)
Static: No
Return Type¶
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|
Map |
Parameters¶
Name |
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|
config_value_map |
Map |
Action - getWithHostnameSite¶
URL: /api/v1/Building/Structure(getWithHostnameSite)
Static: Yes
Return Type¶
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|
Model |
/api/v1/Building/Structure |
Parameters¶
Name |
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|
site |
Model |
/api/v1/Site/Site |
|||||
hostname |
String |
Model - Complex¶
URL: /api/v1/Building/Complex
Id Field: name
Complex(name, site, description, built_percentage, updated, created)
List Filters¶
site¶
Name |
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|
site |
Model |
/api/v1/Site/Site |
Fields¶
Name |
Type |
Length |
Default |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|---|
name |
String |
40 |
||||||
site |
Model |
/api/v1/Site/Site |
||||||
description |
String |
200 |
||||||
built_percentage |
Integer |
90 |
||||||
updated |
DateTime |
|||||||
created |
DateTime |
|||||||
members |
Model |
[] |
Yes |
/api/v1/Building/Structure |
||||
state |
String |
|||||||
type |
String |
Action - createFoundation¶
URL: /api/v1/Building/Complex(createFoundation)
Static: No
Return Type¶
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|
Model |
/api/v1/Building/Foundation |
Parameters¶
Name |
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|
hostname |
String |
||||||
site |
Model |
/api/v1/Site/Site |
|||||
interface_map_list |
Map |
Yes |
Model - ComplexStructure¶
URL: /api/v1/Building/ComplexStructure
Id Field: id
ComplexStructure(id, complex, structure, updated, created)
List Filters¶
complex¶
Name |
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|
complex |
Model |
/api/v1/Building/Complex |
Fields¶
Name |
Type |
Length |
Default |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|---|
complex |
Model |
/api/v1/Building/Complex |
||||||
structure |
Model |
/api/v1/Building/Structure |
||||||
updated |
DateTime |
|||||||
created |
DateTime |
|||||||
id |
Integer |
Action - getConfig¶
URL: /api/v1/Building/ComplexStructure(getConfig)
Static: No
Return Type¶
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|
Map |
Model - Dependency¶
URL: /api/v1/Building/Dependency
Id Field: id
Dependency(id, structure, dependency, foundation, script_structure, link, create_script_name, destroy_script_name, built_at, updated, created)
List Filters¶
foundation¶
Name |
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|
foundation |
Model |
/api/v1/Building/Foundation |
site¶
Name |
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|
site |
Model |
/api/v1/Site/Site |
Fields¶
Name |
Type |
Length |
Default |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|---|
structure |
Model |
/api/v1/Building/Structure |
||||||
dependency |
Model |
/api/v1/Building/Dependency |
||||||
foundation |
Model |
/api/v1/Building/Foundation |
||||||
script_structure |
Model |
/api/v1/Building/Structure |
||||||
link |
String |
4 |
soft, hard |
|||||
create_script_name |
String |
40 |
||||||
destroy_script_name |
String |
40 |
||||||
built_at |
DateTime |
|||||||
updated |
DateTime |
|||||||
created |
DateTime |
|||||||
id |
Integer |
|||||||
state |
String |
Action - getJob¶
URL: /api/v1/Building/Dependency(getJob)
Static: No
Return Type¶
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|
Model |
/api/v1/Foreman/DependencyJob |
Namespace - Foreman¶
URL: /api/v1/Foreman/
API Version: 0.1
Model - BaseJob¶
URL: /api/v1/Foreman/BaseJob
Id Field: id
Not Allowed Verbs: LIST, GET, CREATE, UPDATE, DELETE
BaseJob(id, site, state, status, message, note, script_runner, script_name, updated, created)
Fields¶
Name |
Type |
Length |
Default |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|---|
site |
Model |
/api/v1/Site/Site |
||||||
state |
String |
10 |
queued, waiting, done, paused, error, aborted |
|||||
status |
Map |
[] |
Yes |
|||||
message |
String |
1024 |
||||||
note |
String |
1024 |
||||||
script_name |
String |
40 |
False |
|||||
updated |
DateTime |
|||||||
created |
DateTime |
|||||||
id |
Integer |
|||||||
can_start |
String |
Action - pause¶
URL: /api/v1/Foreman/BaseJob(pause)
Static: No
Action - resume¶
URL: /api/v1/Foreman/BaseJob(resume)
Static: No
Action - reset¶
URL: /api/v1/Foreman/BaseJob(reset)
Static: No
Action - rollback¶
URL: /api/v1/Foreman/BaseJob(rollback)
Static: No
Action - clearDispatched¶
URL: /api/v1/Foreman/BaseJob(clearDispatched)
Static: No
Action - jobStats¶
URL: /api/v1/Foreman/BaseJob(jobStats)
Static: Yes
Return Type¶
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|
Map |
Parameters¶
Name |
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|
site |
Model |
/api/v1/Site/Site |
Action - jobRunnerVariables¶
URL: /api/v1/Foreman/BaseJob(jobRunnerVariables)
Static: No
Return Type¶
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|
Map |
Action - jobRunnerState¶
URL: /api/v1/Foreman/BaseJob(jobRunnerState)
Static: No
Return Type¶
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|
Map |
Action - signalComplete¶
URL: /api/v1/Foreman/BaseJob(signalComplete)
Static: No
Return Type¶
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|
String |
Parameters¶
Name |
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|
cookie |
String |
Action - signalAlert¶
URL: /api/v1/Foreman/BaseJob(signalAlert)
Static: No
Return Type¶
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|
String |
Parameters¶
Name |
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|
msg |
String |
Action - postMessage¶
URL: /api/v1/Foreman/BaseJob(postMessage)
Static: No
Return Type¶
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|
String |
Parameters¶
Name |
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|
msg |
String |
Model - FoundationJob¶
URL: /api/v1/Foreman/FoundationJob
Id Field: id
Not Allowed Verbs: CREATE, UPDATE, DELETE
FoundationJob(id, site, state, status, message, note, script_runner, script_name, updated, created, basejob_ptr, foundation)
List Filters¶
site¶
Name |
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|
site |
Model |
/api/v1/Site/Site |
Fields¶
Name |
Type |
Length |
Default |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|---|
site |
Model |
/api/v1/Site/Site |
||||||
state |
String |
10 |
queued, waiting, done, paused, error, aborted |
|||||
status |
Map |
[] |
Yes |
|||||
message |
String |
1024 |
||||||
note |
String |
1024 |
||||||
script_name |
String |
40 |
False |
|||||
updated |
DateTime |
|||||||
created |
DateTime |
|||||||
foundation |
Model |
/api/v1/Building/Foundation |
||||||
id |
Integer |
|||||||
can_start |
String |
Action - pause¶
URL: /api/v1/Foreman/FoundationJob(pause)
Static: No
Action - resume¶
URL: /api/v1/Foreman/FoundationJob(resume)
Static: No
Action - reset¶
URL: /api/v1/Foreman/FoundationJob(reset)
Static: No
Action - rollback¶
URL: /api/v1/Foreman/FoundationJob(rollback)
Static: No
Action - jobRunnerVariables¶
URL: /api/v1/Foreman/FoundationJob(jobRunnerVariables)
Static: No
Return Type¶
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|
Map |
Action - jobRunnerState¶
URL: /api/v1/Foreman/FoundationJob(jobRunnerState)
Static: No
Return Type¶
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|
Map |
Model - StructureJob¶
URL: /api/v1/Foreman/StructureJob
Id Field: id
Not Allowed Verbs: CREATE, UPDATE, DELETE
StructureJob(id, site, state, status, message, note, script_runner, script_name, updated, created, basejob_ptr, structure)
List Filters¶
site¶
Name |
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|
site |
Model |
/api/v1/Site/Site |
Fields¶
Name |
Type |
Length |
Default |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|---|
site |
Model |
/api/v1/Site/Site |
||||||
state |
String |
10 |
queued, waiting, done, paused, error, aborted |
|||||
status |
Map |
[] |
Yes |
|||||
message |
String |
1024 |
||||||
note |
String |
1024 |
||||||
script_name |
String |
40 |
False |
|||||
updated |
DateTime |
|||||||
created |
DateTime |
|||||||
structure |
Model |
/api/v1/Building/Structure |
||||||
id |
Integer |
|||||||
can_start |
String |
Action - pause¶
URL: /api/v1/Foreman/StructureJob(pause)
Static: No
Action - resume¶
URL: /api/v1/Foreman/StructureJob(resume)
Static: No
Action - reset¶
URL: /api/v1/Foreman/StructureJob(reset)
Static: No
Action - rollback¶
URL: /api/v1/Foreman/StructureJob(rollback)
Static: No
Action - jobRunnerVariables¶
URL: /api/v1/Foreman/StructureJob(jobRunnerVariables)
Static: No
Return Type¶
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|
Map |
Action - jobRunnerState¶
URL: /api/v1/Foreman/StructureJob(jobRunnerState)
Static: No
Return Type¶
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|
Map |
Model - DependencyJob¶
URL: /api/v1/Foreman/DependencyJob
Id Field: id
Not Allowed Verbs: CREATE, UPDATE, DELETE
DependencyJob(id, site, state, status, message, note, script_runner, script_name, updated, created, basejob_ptr, dependency)
List Filters¶
site¶
Name |
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|
site |
Model |
/api/v1/Site/Site |
Fields¶
Name |
Type |
Length |
Default |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|---|
site |
Model |
/api/v1/Site/Site |
||||||
state |
String |
10 |
queued, waiting, done, paused, error, aborted |
|||||
status |
Map |
[] |
Yes |
|||||
message |
String |
1024 |
||||||
note |
String |
1024 |
||||||
script_name |
String |
40 |
False |
|||||
updated |
DateTime |
|||||||
created |
DateTime |
|||||||
dependency |
Model |
/api/v1/Building/Dependency |
||||||
id |
Integer |
|||||||
can_start |
String |
Action - pause¶
URL: /api/v1/Foreman/DependencyJob(pause)
Static: No
Action - resume¶
URL: /api/v1/Foreman/DependencyJob(resume)
Static: No
Action - reset¶
URL: /api/v1/Foreman/DependencyJob(reset)
Static: No
Action - rollback¶
URL: /api/v1/Foreman/DependencyJob(rollback)
Static: No
Action - jobRunnerVariables¶
URL: /api/v1/Foreman/DependencyJob(jobRunnerVariables)
Static: No
Return Type¶
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|
Map |
Action - jobRunnerState¶
URL: /api/v1/Foreman/DependencyJob(jobRunnerState)
Static: No
Return Type¶
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|
Map |
Model - JobLog¶
URL: /api/v1/Foreman/JobLog
Id Field: id
Not Allowed Verbs: CREATE, UPDATE, DELETE, CALL
JobLog(id, site, job_id, target_id, target_class, target_description, script_name, creator, started_at, finished_at, canceled_by, canceled_at, updated, created)
List Filters¶
site¶
Name |
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|
site |
Model |
/api/v1/Site/Site |
job¶
Name |
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|
job_id |
Integer |
structure¶
Name |
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|
structure |
Model |
/api/v1/Building/Structure |
foundation¶
Name |
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|
foundation |
Model |
/api/v1/Building/Foundation |
dependency¶
Name |
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|
dependency |
Model |
/api/v1/Building/Dependency |
Fields¶
Name |
Type |
Length |
Default |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|---|
site |
Model |
/api/v1/Site/Site |
||||||
job_id |
Integer |
|||||||
target_id |
String |
100 |
||||||
target_class |
String |
50 |
||||||
target_description |
String |
120 |
||||||
script_name |
String |
50 |
||||||
creator |
String |
150 |
||||||
started_at |
DateTime |
|||||||
finished_at |
DateTime |
|||||||
canceled_by |
String |
150 |
||||||
canceled_at |
DateTime |
|||||||
updated |
DateTime |
|||||||
created |
DateTime |
|||||||
id |
Integer |
Namespace - SubContractor¶
URL: /api/v1/SubContractor/
API Version: 0.1
Model - Dispatch¶
URL: /api/v1/SubContractor/Dispatch
Not Allowed Verbs: UPDATE, LIST, GET, CREATE, DELETE Action - getJobs ~~~~~~~~~~~~~~~~
URL: /api/v1/SubContractor/Dispatch(getJobs)
Static: Yes
Return Type¶
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|
Map |
Yes |
Parameters¶
Name |
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|
site |
Model |
/api/v1/Site/Site |
|||||
module_list |
String |
Yes |
|||||
max_jobs |
Integer |
Action - jobResults¶
URL: /api/v1/SubContractor/Dispatch(jobResults)
Static: Yes
Return Type¶
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|
String |
Parameters¶
Name |
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|
job_id |
Integer |
||||||
cookie |
String |
||||||
data |
Map |
Action - jobError¶
URL: /api/v1/SubContractor/Dispatch(jobError)
Static: Yes
Parameters¶
Name |
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|
job_id |
Integer |
||||||
cookie |
String |
||||||
msg |
String |
Model - DHCPd¶
URL: /api/v1/SubContractor/DHCPd
Not Allowed Verbs: UPDATE, LIST, GET, CREATE, DELETE Action - getDynamicPools ~~~~~~~~~~~~~~~~~~~~~~~~
URL: /api/v1/SubContractor/DHCPd(getDynamicPools)
Static: Yes
Return Type¶
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|
Map |
Yes |
Parameters¶
Name |
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|
site |
Model |
/api/v1/Site/Site |
Action - getStaticPools¶
URL: /api/v1/SubContractor/DHCPd(getStaticPools)
Static: Yes
Return Type¶
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|
Map |
Parameters¶
Name |
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|
site |
Model |
/api/v1/Site/Site |
Namespace - PostOffice¶
URL: /api/v1/PostOffice/
API Version: 0.1
Model - FoundationPost¶
URL: /api/v1/PostOffice/FoundationPost
Id Field: id
Not Allowed Verbs: CREATE, UPDATE, DELETE
FoundationPost(id, name, updated, created, foundation)
Fields¶
Name |
Type |
Length |
Default |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|---|
name |
String |
40 |
||||||
updated |
DateTime |
|||||||
created |
DateTime |
|||||||
foundation |
Model |
/api/v1/Building/Foundation |
||||||
id |
Integer |
Model - StructurePost¶
URL: /api/v1/PostOffice/StructurePost
Id Field: id
Not Allowed Verbs: CREATE, UPDATE, DELETE
StructurePost(id, name, updated, created, structure)
Fields¶
Name |
Type |
Length |
Default |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|---|
name |
String |
40 |
||||||
updated |
DateTime |
|||||||
created |
DateTime |
|||||||
structure |
Model |
/api/v1/Building/Structure |
||||||
id |
Integer |
Model - FoundationBox¶
URL: /api/v1/PostOffice/FoundationBox
Id Field: id
FoundationBox(id, url, proxy, type, one_shot, extra_data, expires, updated, created, foundation)
Fields¶
Name |
Type |
Length |
Default |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|---|
url |
String |
2048 |
||||||
proxy |
String |
512 |
||||||
type |
String |
4 |
post, call |
|||||
one_shot |
Boolean |
True |
||||||
extra_data |
Map |
{} |
||||||
expires |
DateTime |
|||||||
updated |
DateTime |
|||||||
created |
DateTime |
|||||||
foundation |
Model |
/api/v1/Building/Foundation |
||||||
id |
Integer |
Action - extend¶
URL: /api/v1/PostOffice/FoundationBox(extend)
Static: No
Parameters¶
Name |
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|
additional_hours |
Integer |
Model - StructureBox¶
URL: /api/v1/PostOffice/StructureBox
Id Field: id
StructureBox(id, url, proxy, type, one_shot, extra_data, expires, updated, created, structure)
Fields¶
Name |
Type |
Length |
Default |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|---|
url |
String |
2048 |
||||||
proxy |
String |
512 |
||||||
type |
String |
4 |
post, call |
|||||
one_shot |
Boolean |
True |
||||||
extra_data |
Map |
{} |
||||||
expires |
DateTime |
|||||||
updated |
DateTime |
|||||||
created |
DateTime |
|||||||
structure |
Model |
/api/v1/Building/Structure |
||||||
id |
Integer |
Action - extend¶
URL: /api/v1/PostOffice/StructureBox(extend)
Static: No
Parameters¶
Name |
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|
additional_hours |
Integer |
Namespace - Records¶
URL: /api/v1/Records/
API Version: 0.1
Model - Recorder¶
URL: /api/v1/Records/Recorder
Not Allowed Verbs: UPDATE, CREATE, LIST, GET, DELETE Action - query ~~~~~~~~~~~~~~
URL: /api/v1/Records/Recorder(query)
Static: Yes
Return Type¶
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|
String |
Yes |
Parameters¶
Name |
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|
group |
String |
Site, BluePrint, Structure, Foundation |
|||||
query |
String |
||||||
fields |
String |
||||||
max_results |
Integer |
Action - queryObjects¶
URL: /api/v1/Records/Recorder(queryObjects)
Static: Yes
Return Type¶
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|
String |
Parameters¶
Name |
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|
group |
String |
Site, BluePrint, Structure, Foundation |
|||||
query |
String |
||||||
max_results |
Integer |
Namespace - VirtualBox¶
URL: /api/v1/VirtualBox/
API Version: 0.1
Plugin for VirtualBox.
Model - VirtualBoxComplex¶
URL: /api/v1/VirtualBox/VirtualBoxComplex
Id Field: name
Complex for VirtualBox. Only one member is allowed. The ip address
for managing the VirtualBox instance comes from the member's primary ip.
Fields¶
Name |
Type |
Length |
Default |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|---|
name |
String |
40 |
||||||
site |
Model |
/api/v1/Site/Site |
||||||
description |
String |
200 |
||||||
built_percentage |
Integer |
90 |
||||||
updated |
DateTime |
|||||||
created |
DateTime |
|||||||
virtualbox_username |
String |
50 |
||||||
virtualbox_password |
String |
50 |
||||||
members |
Model |
[] |
Yes |
/api/v1/Building/Structure |
||||
state |
String |
|||||||
type |
String |
Model - VirtualBoxFoundation¶
URL: /api/v1/VirtualBox/VirtualBoxFoundation
Id Field: locator
Foundation for use with VirtualBoxComplex. Foundation instances are tracked
by the internal VirtualBox Hardware UUID.
List Filters¶
site¶
Name |
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|
site |
Model |
/api/v1/Site/Site |
Fields¶
Name |
Type |
Length |
Default |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|---|
locator |
String |
100 |
||||||
site |
Model |
/api/v1/Site/Site |
||||||
blueprint |
Model |
/api/v1/BluePrint/FoundationBluePrint |
||||||
id_map |
Map |
|||||||
located_at |
DateTime |
|||||||
built_at |
DateTime |
|||||||
updated |
DateTime |
|||||||
created |
DateTime |
|||||||
virtualbox_complex |
Model |
/api/v1/VirtualBox/VirtualBoxComplex |
||||||
virtualbox_uuid |
String |
36 |
||||||
state |
String |
|||||||
type |
String |
|||||||
class_list |
String |
Namespace - LibVirt¶
URL: /api/v1/LibVirt/
API Version: 0.1
Plugin for VirtualBox.
Model - LibVirtComplex¶
URL: /api/v1/LibVirt/LibVirtComplex
Id Field: name
Complex for LibVirt. Only one member is allowed. The ip address
for managing the LibVirt instance comes from the member's primary ip.
Fields¶
Name |
Type |
Length |
Default |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|---|
name |
String |
40 |
||||||
site |
Model |
/api/v1/Site/Site |
||||||
description |
String |
200 |
||||||
built_percentage |
Integer |
90 |
||||||
updated |
DateTime |
|||||||
created |
DateTime |
|||||||
members |
Model |
[] |
Yes |
/api/v1/Building/Structure |
||||
state |
String |
|||||||
type |
String |
Model - LibVirtFoundation¶
URL: /api/v1/LibVirt/LibVirtFoundation
Id Field: locator
Foundation for use with LibVirtComplex. Foundation instances are tracked
by the LibVirt UUID.
List Filters¶
site¶
Name |
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|
site |
Model |
/api/v1/Site/Site |
Fields¶
Name |
Type |
Length |
Default |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|---|
locator |
String |
100 |
||||||
site |
Model |
/api/v1/Site/Site |
||||||
blueprint |
Model |
/api/v1/BluePrint/FoundationBluePrint |
||||||
id_map |
Map |
|||||||
located_at |
DateTime |
|||||||
built_at |
DateTime |
|||||||
updated |
DateTime |
|||||||
created |
DateTime |
|||||||
libvirt_complex |
Model |
/api/v1/LibVirt/LibVirtComplex |
||||||
libvirt_uuid |
String |
36 |
||||||
libvirt_console_type |
String |
6 |
serial |
spice, serial |
||||
state |
String |
|||||||
type |
String |
|||||||
class_list |
String |
Namespace - VCenter¶
URL: /api/v1/VCenter/
API Version: 0.1
Model - VCenterComplex¶
URL: /api/v1/VCenter/VCenterComplex
Id Field: name
VCenterComplex(name, site, description, built_percentage, updated, created, complex_ptr, vcenter_host, vcenter_username, vcenter_password, vcenter_datacenter, vcenter_cluster)
Fields¶
Name |
Type |
Length |
Default |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|---|
name |
String |
40 |
||||||
site |
Model |
/api/v1/Site/Site |
||||||
description |
String |
200 |
||||||
built_percentage |
Integer |
90 |
||||||
updated |
DateTime |
|||||||
created |
DateTime |
|||||||
vcenter_host |
Model |
/api/v1/Building/Structure |
set to VCenter or the ESX host, if ESX host, leave members empty |
|||||
vcenter_username |
String |
50 |
||||||
vcenter_password |
String |
50 |
||||||
vcenter_datacenter |
String |
50 |
set to “ha-datacenter” for ESX hosts |
|||||
vcenter_cluster |
String |
50 |
set to the hostname (ie: “localhost.”) for ESX hosts |
|||||
members |
Model |
[] |
Yes |
/api/v1/Building/Structure |
||||
state |
String |
|||||||
type |
String |
Model - VCenterFoundation¶
URL: /api/v1/VCenter/VCenterFoundation
Id Field: locator
VCenterFoundation(locator, site, blueprint, id_map, located_at, built_at, updated, created, foundation_ptr, vcenter_complex, vcenter_uuid)
List Filters¶
site¶
Name |
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|
site |
Model |
/api/v1/Site/Site |
Fields¶
Name |
Type |
Length |
Default |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|---|
locator |
String |
100 |
||||||
site |
Model |
/api/v1/Site/Site |
||||||
blueprint |
Model |
/api/v1/BluePrint/FoundationBluePrint |
||||||
id_map |
Map |
|||||||
located_at |
DateTime |
|||||||
built_at |
DateTime |
|||||||
updated |
DateTime |
|||||||
created |
DateTime |
|||||||
vcenter_complex |
Model |
/api/v1/VCenter/VCenterComplex |
||||||
vcenter_uuid |
String |
36 |
||||||
state |
String |
|||||||
type |
String |
|||||||
class_list |
String |
Namespace - Docker¶
URL: /api/v1/Docker/
API Version: 0.1
Model - DockerComplex¶
URL: /api/v1/Docker/DockerComplex
Id Field: name
DockerComplex(name, site, description, built_percentage, updated, created, complex_ptr)
Fields¶
Name |
Type |
Length |
Default |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|---|
name |
String |
40 |
||||||
site |
Model |
/api/v1/Site/Site |
||||||
description |
String |
200 |
||||||
built_percentage |
Integer |
90 |
||||||
updated |
DateTime |
|||||||
created |
DateTime |
|||||||
members |
Model |
[] |
Yes |
/api/v1/Building/Structure |
||||
state |
String |
|||||||
type |
String |
Model - DockerFoundation¶
URL: /api/v1/Docker/DockerFoundation
Id Field: locator
DockerFoundation(locator, site, blueprint, id_map, located_at, built_at, updated, created, foundation_ptr, docker_complex, docker_id)
List Filters¶
site¶
Name |
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|
site |
Model |
/api/v1/Site/Site |
Fields¶
Name |
Type |
Length |
Default |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|---|
locator |
String |
100 |
||||||
site |
Model |
/api/v1/Site/Site |
||||||
blueprint |
Model |
/api/v1/BluePrint/FoundationBluePrint |
||||||
id_map |
Map |
|||||||
located_at |
DateTime |
|||||||
built_at |
DateTime |
|||||||
updated |
DateTime |
|||||||
created |
DateTime |
|||||||
docker_complex |
Model |
/api/v1/Docker/DockerComplex |
||||||
docker_id |
String |
64 |
||||||
state |
String |
|||||||
type |
String |
|||||||
class_list |
String |
Model - DockerPort¶
URL: /api/v1/Docker/DockerPort
Id Field: id
DockerPort(id, complex, port, address_offset, foundation, foundation_index, updated, created)
Fields¶
Name |
Type |
Length |
Default |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|---|
complex |
Model |
/api/v1/Docker/DockerComplex |
||||||
port |
Integer |
|||||||
address_offset |
Integer |
|||||||
foundation |
Model |
/api/v1/Docker/DockerFoundation |
||||||
foundation_index |
Integer |
0 |
||||||
updated |
DateTime |
|||||||
created |
DateTime |
|||||||
id |
Integer |
Namespace - IPMI¶
URL: /api/v1/IPMI/
API Version: 0.1
Model - IPMIFoundation¶
URL: /api/v1/IPMI/IPMIFoundation
Id Field: locator
IPMIFoundation(locator, site, blueprint, id_map, located_at, built_at, updated, created, foundation_ptr, ipmi_username, ipmi_password, ipmi_ip_address, ipmi_sol_port, plot)
List Filters¶
site¶
Name |
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|
site |
Model |
/api/v1/Site/Site |
Fields¶
Name |
Type |
Length |
Default |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|---|
locator |
String |
100 |
||||||
site |
Model |
/api/v1/Site/Site |
||||||
blueprint |
Model |
/api/v1/BluePrint/FoundationBluePrint |
||||||
id_map |
Map |
|||||||
located_at |
DateTime |
|||||||
built_at |
DateTime |
|||||||
updated |
DateTime |
|||||||
created |
DateTime |
|||||||
ipmi_username |
String |
50 |
||||||
ipmi_password |
String |
50 |
||||||
ipmi_ip_address |
String |
30 |
||||||
ipmi_sol_port |
String |
7 |
ttyS1 |
console, ttyS0, ttyS1, ttyS2, ttyS3 |
||||
plot |
Model |
/api/v1/Survey/Plot |
||||||
state |
String |
|||||||
type |
String |
|||||||
class_list |
String |
Namespace - Manual¶
URL: /api/v1/Manual/
API Version: 0.1
Model - ManualComplex¶
URL: /api/v1/Manual/ManualComplex
Id Field: name
ManualComplex(name, site, description, built_percentage, updated, created, complex_ptr)
Fields¶
Name |
Type |
Length |
Default |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|---|
name |
String |
40 |
||||||
site |
Model |
/api/v1/Site/Site |
||||||
description |
String |
200 |
||||||
built_percentage |
Integer |
90 |
||||||
updated |
DateTime |
|||||||
created |
DateTime |
|||||||
members |
Model |
[] |
Yes |
/api/v1/Building/Structure |
||||
state |
String |
|||||||
type |
String |
Model - ManualFoundation¶
URL: /api/v1/Manual/ManualFoundation
Id Field: locator
ManualFoundation(locator, site, blueprint, id_map, located_at, built_at, updated, created, foundation_ptr)
List Filters¶
site¶
Name |
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|
site |
Model |
/api/v1/Site/Site |
Fields¶
Name |
Type |
Length |
Default |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|---|
locator |
String |
100 |
||||||
site |
Model |
/api/v1/Site/Site |
||||||
blueprint |
Model |
/api/v1/BluePrint/FoundationBluePrint |
||||||
id_map |
Map |
|||||||
located_at |
DateTime |
|||||||
built_at |
DateTime |
|||||||
updated |
DateTime |
|||||||
created |
DateTime |
|||||||
state |
String |
|||||||
type |
String |
|||||||
class_list |
String |
Model - ManualComplexedFoundation¶
URL: /api/v1/Manual/ManualComplexedFoundation
Id Field: locator
ManualComplexedFoundation(locator, site, blueprint, id_map, located_at, built_at, updated, created, foundation_ptr, complex_host)
List Filters¶
site¶
Name |
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|
site |
Model |
/api/v1/Site/Site |
Fields¶
Name |
Type |
Length |
Default |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|---|
locator |
String |
100 |
||||||
site |
Model |
/api/v1/Site/Site |
||||||
blueprint |
Model |
/api/v1/BluePrint/FoundationBluePrint |
||||||
id_map |
Map |
|||||||
located_at |
DateTime |
|||||||
built_at |
DateTime |
|||||||
updated |
DateTime |
|||||||
created |
DateTime |
|||||||
complex_host |
Model |
/api/v1/Manual/ManualComplex |
||||||
state |
String |
|||||||
type |
String |
|||||||
class_list |
String |
Namespace - Proxmox¶
URL: /api/v1/Proxmox/
API Version: 0.1
Model - ProxmoxComplex¶
URL: /api/v1/Proxmox/ProxmoxComplex
Id Field: name
ProxmoxComplex(name, site, description, built_percentage, updated, created, complex_ptr, proxmox_host, proxmox_username, proxmox_password)
Fields¶
Name |
Type |
Length |
Default |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|---|
name |
String |
40 |
||||||
site |
Model |
/api/v1/Site/Site |
||||||
description |
String |
200 |
||||||
built_percentage |
Integer |
90 |
||||||
updated |
DateTime |
|||||||
created |
DateTime |
|||||||
proxmox_host |
Model |
/api/v1/Building/Structure |
set to Proxmox host |
|||||
proxmox_username |
String |
50 |
||||||
proxmox_password |
String |
50 |
||||||
members |
Model |
[] |
Yes |
/api/v1/Building/Structure |
||||
state |
String |
|||||||
type |
String |
Model - ProxmoxFoundation¶
URL: /api/v1/Proxmox/ProxmoxFoundation
Id Field: locator
ProxmoxFoundation(locator, site, blueprint, id_map, located_at, built_at, updated, created, foundation_ptr, proxmox_complex, proxmox_id)
List Filters¶
site¶
Name |
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|
site |
Model |
/api/v1/Site/Site |
Fields¶
Name |
Type |
Length |
Default |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|---|
locator |
String |
100 |
||||||
site |
Model |
/api/v1/Site/Site |
||||||
blueprint |
Model |
/api/v1/BluePrint/FoundationBluePrint |
||||||
id_map |
Map |
|||||||
located_at |
DateTime |
|||||||
built_at |
DateTime |
|||||||
updated |
DateTime |
|||||||
created |
DateTime |
|||||||
proxmox_complex |
Model |
/api/v1/Proxmox/ProxmoxComplex |
||||||
proxmox_id |
Integer |
|||||||
state |
String |
|||||||
type |
String |
|||||||
class_list |
String |
Namespace - Azure¶
URL: /api/v1/Azure/
API Version: 0.1
Model - AzureComplex¶
URL: /api/v1/Azure/AzureComplex
Id Field: name
AzureComplex(name, site, description, built_percentage, updated, created, complex_ptr, azure_subscription_id, azure_location, azure_resource_group, azure_client_id, azure_password, azure_tenant_id)
Fields¶
Name |
Type |
Length |
Default |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|---|
name |
String |
40 |
||||||
site |
Model |
/api/v1/Site/Site |
||||||
description |
String |
200 |
||||||
built_percentage |
Integer |
90 |
||||||
updated |
DateTime |
|||||||
created |
DateTime |
|||||||
azure_subscription_id |
String |
36 |
||||||
azure_location |
String |
20 |
||||||
azure_resource_group |
String |
90 |
||||||
azure_client_id |
String |
36 |
also called App Id |
|||||
azure_password |
String |
36 |
||||||
azure_tenant_id |
String |
36 |
||||||
members |
Model |
[] |
Yes |
/api/v1/Building/Structure |
||||
state |
String |
|||||||
type |
String |
Model - AzureFoundation¶
URL: /api/v1/Azure/AzureFoundation
Id Field: locator
AzureFoundation(locator, site, blueprint, id_map, located_at, built_at, updated, created, foundation_ptr, azure_complex, azure_resource_name)
List Filters¶
site¶
Name |
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|
site |
Model |
/api/v1/Site/Site |
Fields¶
Name |
Type |
Length |
Default |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|---|
locator |
String |
100 |
||||||
site |
Model |
/api/v1/Site/Site |
||||||
blueprint |
Model |
/api/v1/BluePrint/FoundationBluePrint |
||||||
id_map |
Map |
|||||||
located_at |
DateTime |
|||||||
built_at |
DateTime |
|||||||
updated |
DateTime |
|||||||
created |
DateTime |
|||||||
azure_complex |
Model |
/api/v1/Azure/AzureComplex |
||||||
azure_resource_name |
String |
64 |
||||||
state |
String |
|||||||
type |
String |
|||||||
class_list |
String |
Namespace - AMT¶
URL: /api/v1/AMT/
API Version: 0.1
Model - AMTFoundation¶
URL: /api/v1/AMT/AMTFoundation
Id Field: locator
AMTFoundation(locator, site, blueprint, id_map, located_at, built_at, updated, created, foundation_ptr, amt_username, amt_password, amt_ip_address, plot)
List Filters¶
site¶
Name |
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|
site |
Model |
/api/v1/Site/Site |
Fields¶
Name |
Type |
Length |
Default |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|---|
locator |
String |
100 |
||||||
site |
Model |
/api/v1/Site/Site |
||||||
blueprint |
Model |
/api/v1/BluePrint/FoundationBluePrint |
||||||
id_map |
Map |
|||||||
located_at |
DateTime |
|||||||
built_at |
DateTime |
|||||||
updated |
DateTime |
|||||||
created |
DateTime |
|||||||
amt_username |
String |
50 |
admin |
|||||
amt_password |
String |
50 |
||||||
amt_ip_address |
String |
30 |
||||||
plot |
Model |
/api/v1/Survey/Plot |
||||||
state |
String |
|||||||
type |
String |
|||||||
class_list |
String |
Namespace - Test¶
URL: /api/v1/Test/
API Version: 0.1
Model - TestComplex¶
URL: /api/v1/Test/TestComplex
Id Field: name
TestComplex(name, site, description, built_percentage, updated, created, complex_ptr)
Fields¶
Name |
Type |
Length |
Default |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|---|
name |
String |
40 |
||||||
site |
Model |
/api/v1/Site/Site |
||||||
description |
String |
200 |
||||||
built_percentage |
Integer |
90 |
||||||
updated |
DateTime |
|||||||
created |
DateTime |
|||||||
members |
Model |
[] |
Yes |
/api/v1/Building/Structure |
||||
state |
String |
|||||||
type |
String |
Model - TestFoundation¶
URL: /api/v1/Test/TestFoundation
Id Field: locator
TestFoundation(locator, site, blueprint, id_map, located_at, built_at, updated, created, foundation_ptr, test_delay_variance, test_fail_likelihood)
List Filters¶
site¶
Name |
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|
site |
Model |
/api/v1/Site/Site |
Fields¶
Name |
Type |
Length |
Default |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|---|
locator |
String |
100 |
||||||
site |
Model |
/api/v1/Site/Site |
||||||
blueprint |
Model |
/api/v1/BluePrint/FoundationBluePrint |
||||||
id_map |
Map |
|||||||
located_at |
DateTime |
|||||||
built_at |
DateTime |
|||||||
updated |
DateTime |
|||||||
created |
DateTime |
|||||||
test_delay_variance |
Integer |
30 |
In Seconds |
|||||
test_fail_likelihood |
Integer |
0 |
Likelyhood of failures per 1000, per “run” execution (ie: the longer the delay the more likely), if greater than 9, Unrecoverable errors my happen, 0 to disable |
|||||
state |
String |
|||||||
type |
String |
|||||||
class_list |
String |
Model - TestComplexedFoundation¶
URL: /api/v1/Test/TestComplexedFoundation
Id Field: locator
TestComplexedFoundation(locator, site, blueprint, id_map, located_at, built_at, updated, created, foundation_ptr, complex_host)
List Filters¶
site¶
Name |
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|
site |
Model |
/api/v1/Site/Site |
Fields¶
Name |
Type |
Length |
Default |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|---|
locator |
String |
100 |
||||||
site |
Model |
/api/v1/Site/Site |
||||||
blueprint |
Model |
/api/v1/BluePrint/FoundationBluePrint |
||||||
id_map |
Map |
|||||||
located_at |
DateTime |
|||||||
built_at |
DateTime |
|||||||
updated |
DateTime |
|||||||
created |
DateTime |
|||||||
complex_host |
Model |
/api/v1/Test/TestComplex |
||||||
state |
String |
|||||||
type |
String |
|||||||
class_list |
String |
Namespace - AWS¶
URL: /api/v1/AWS/
API Version: 0.1
Model - AWSEC2Foundation¶
URL: /api/v1/AWS/AWSEC2Foundation
Id Field: locator
AWSEC2Foundation(locator, site, blueprint, id_map, located_at, built_at, updated, created, foundation_ptr, awsec2_instance_id)
List Filters¶
site¶
Name |
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|
site |
Model |
/api/v1/Site/Site |
Fields¶
Name |
Type |
Length |
Default |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|---|
locator |
String |
100 |
||||||
site |
Model |
/api/v1/Site/Site |
||||||
blueprint |
Model |
/api/v1/BluePrint/FoundationBluePrint |
||||||
id_map |
Map |
|||||||
located_at |
DateTime |
|||||||
built_at |
DateTime |
|||||||
updated |
DateTime |
|||||||
created |
DateTime |
|||||||
awsec2_instance_id |
String |
19 |
||||||
state |
String |
|||||||
type |
String |
|||||||
class_list |
String |
Namespace - RedFish¶
URL: /api/v1/RedFish/
API Version: 0.1
Model - RedFishFoundation¶
URL: /api/v1/RedFish/RedFishFoundation
Id Field: locator
RedFishFoundation(locator, site, blueprint, id_map, located_at, built_at, updated, created, foundation_ptr, redfish_username, redfish_password, redfish_ip_address, redfish_sol_port, plot)
List Filters¶
site¶
Name |
Type |
Length |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|
site |
Model |
/api/v1/Site/Site |
Fields¶
Name |
Type |
Length |
Default |
Array |
Choices |
Schemas |
Model |
Doc |
|---|---|---|---|---|---|---|---|---|
locator |
String |
100 |
||||||
site |
Model |
/api/v1/Site/Site |
||||||
blueprint |
Model |
/api/v1/BluePrint/FoundationBluePrint |
||||||
id_map |
Map |
|||||||
located_at |
DateTime |
|||||||
built_at |
DateTime |
|||||||
updated |
DateTime |
|||||||
created |
DateTime |
|||||||
redfish_username |
String |
50 |
||||||
redfish_password |
String |
50 |
||||||
redfish_ip_address |
String |
30 |
||||||
redfish_sol_port |
String |
7 |
ttyS1 |
console, ttyS0, ttyS1, ttyS2, ttyS3 |
||||
plot |
Model |
/api/v1/Survey/Plot |
||||||
state |
String |
|||||||
type |
String |
|||||||
class_list |
String |