Men & Mice Web Service REST API

This document describes the Men & Mice Web Service REST API

Default request content-types: application/json, application/xml
Default response content-types: application/json, application/xml
Schemes: http, https

Summary

Tag: AddressSpaces

Address Spaces

Operation Description
GET /AddressSpaces

Gets address spaces

POST /AddressSpaces

Adds a new address space

GET /AddressSpaces/{addressSpaceRef}

Gets specified address space

PUT /AddressSpaces/{addressSpaceRef}

Sets properties for the specified object

DELETE /AddressSpaces/{addressSpaceRef}

Removes the specified object

GET /AddressSpaces/{ref}/Access

Gets access set for the specified object

PUT /AddressSpaces/{ref}/Access

Sets access for the specified objects

GET /AddressSpaces/{objRef}/History

Gets event history

GET /AddressSpaces/{ref}/PropertyDefinitions

Gets all the property definitions for the specified object type

POST /AddressSpaces/{ref}/PropertyDefinitions

Adds a new custom property definition

GET /AddressSpaces/{ref}/PropertyDefinitions/{property}

Gets the definition for a specified property of the given object type

PUT /AddressSpaces/{ref}/PropertyDefinitions/{property}

Modifies a custom property definition

DELETE /AddressSpaces/{ref}/PropertyDefinitions/{property}

Removes the specified custom property definition

Tag: ADForests

AD Forests

Operation Description
GET /ADForests

Gets AD forests

POST /ADForests

Adds a new AD forest

GET /ADForests/{adForestRef}

Gets specified AD forest

PUT /ADForests/{adForestRef}

Sets properties for the specified object

DELETE /ADForests/{adForestRef}

Removes the specified object

GET /ADForests/{ref}/Access

Gets access set for the specified object

PUT /ADForests/{ref}/Access

Sets access for the specified objects

GET /ADForests/{objRef}/History

Gets event history

GET /ADForests/{ref}/PropertyDefinitions

Gets all the property definitions for the specified object type

POST /ADForests/{ref}/PropertyDefinitions

Adds a new custom property definition

GET /ADForests/{ref}/PropertyDefinitions/{property}

Gets the definition for a specified property of the given object type

PUT /ADForests/{ref}/PropertyDefinitions/{property}

Modifies a custom property definition

DELETE /ADForests/{ref}/PropertyDefinitions/{property}

Removes the specified custom property definition

Tag: DHCPGroups

DHCP Groups

Operation Description
GET /DHCPGroups/{dhcpGroupRef}

Gets specified DHCP group

PUT /DHCPGroups/{dhcpGroupRef}

Sets properties for the specified object

DELETE /DHCPGroups/{dhcpGroupRef}

Removes the specified object

GET /DHCPGroups/{ref}/Access

Gets access set for the specified object

PUT /DHCPGroups/{ref}/Access

Sets access for the specified objects

GET /DHCPGroups/{ownerRef}/DHCPReservations

Gets DHCP reservations from the specified owner (which must reference a DHCP server, a DHCP group, or a DHCP scope)

POST /DHCPGroups/{ownerRef}/DHCPReservations

Adds a new DHCP reservation

GET /DHCPGroups/{objRef}/History

Gets event history

GET /DHCPGroups/{ref}/InheritedOptions

Gets inherited DHCP options for the specified object (which must reference a DHCP server, a DHCP group, a DHCP scope, a DHCP address pool, or a DHCP reservation)

GET /DHCPGroups/{ref}/Options

Gets DHCP options for the specified object (which must reference a DHCP server, a DHCP group, a DHCP scope, a DHCP address pool, or a DHCP reservation)

PUT /DHCPGroups/{ref}/Options

Sets DHCP options for the specified object (which must reference a DHCP server, a DHCP group, a DHCP scope, a DHCP address pool, or a DHCP reservation)

GET /DHCPGroups/{dhcpServerRef}/OptionsDefinitions

Gets DHCP option definitions for the specified object (which must reference a DHCP server, a DHCP group, a DHCP scope, a DHCP address pool, or a DHCP reservation)

POST /DHCPGroups/{dhcpServerRef}/OptionsDefinitions

Adds a new DHCP option definition on the specified DHCP server

PUT /DHCPGroups/{dhcpServerRef}/OptionsDefinitions

Modifies the specified DHCP option definition on the specified DHCP server

DELETE /DHCPGroups/{dhcpServerRef}/OptionsDefinitions

Removes the specified DHCP option definition from the specified DHCP server

GET /DHCPGroups/{ref}/PropertyDefinitions

Gets all the property definitions for the specified object type

POST /DHCPGroups/{ref}/PropertyDefinitions

Adds a new custom property definition

GET /DHCPGroups/{ref}/PropertyDefinitions/{property}

Gets the definition for a specified property of the given object type

PUT /DHCPGroups/{ref}/PropertyDefinitions/{property}

Modifies a custom property definition

DELETE /DHCPGroups/{ref}/PropertyDefinitions/{property}

Removes the specified custom property definition

Tag: DHCPReservations

DHCP Reservations

Operation Description
GET /DHCPReservations/{dhcpReservationRef}

Gets specified DHCP reservation

PUT /DHCPReservations/{dhcpReservationRef}

Sets properties for the specified object

DELETE /DHCPReservations/{dhcpReservationRef}

Removes the specified object

GET /DHCPReservations/{ref}/Access

Gets access set for the specified object

PUT /DHCPReservations/{ref}/Access

Sets access for the specified objects

GET /DHCPReservations/{objRef}/History

Gets event history

GET /DHCPReservations/{ref}/InheritedOptions

Gets inherited DHCP options for the specified object (which must reference a DHCP server, a DHCP group, a DHCP scope, a DHCP address pool, or a DHCP reservation)

GET /DHCPReservations/{ref}/Options

Gets DHCP options for the specified object (which must reference a DHCP server, a DHCP group, a DHCP scope, a DHCP address pool, or a DHCP reservation)

PUT /DHCPReservations/{ref}/Options

Sets DHCP options for the specified object (which must reference a DHCP server, a DHCP group, a DHCP scope, a DHCP address pool, or a DHCP reservation)

GET /DHCPReservations/{dhcpServerRef}/OptionsDefinitions

Gets DHCP option definitions for the specified object (which must reference a DHCP server, a DHCP group, a DHCP scope, a DHCP address pool, or a DHCP reservation)

POST /DHCPReservations/{dhcpServerRef}/OptionsDefinitions

Adds a new DHCP option definition on the specified DHCP server

PUT /DHCPReservations/{dhcpServerRef}/OptionsDefinitions

Modifies the specified DHCP option definition on the specified DHCP server

DELETE /DHCPReservations/{dhcpServerRef}/OptionsDefinitions

Removes the specified DHCP option definition from the specified DHCP server

GET /DHCPReservations/{ref}/PropertyDefinitions

Gets all the property definitions for the specified object type

POST /DHCPReservations/{ref}/PropertyDefinitions

Adds a new custom property definition

GET /DHCPReservations/{ref}/PropertyDefinitions/{property}

Gets the definition for a specified property of the given object type

PUT /DHCPReservations/{ref}/PropertyDefinitions/{property}

Modifies a custom property definition

DELETE /DHCPReservations/{ref}/PropertyDefinitions/{property}

Removes the specified custom property definition

Tag: DHCPScopes

DHCP Scopes

Operation Description
GET /DHCPScopes

Gets DHCP scopes

POST /DHCPScopes

Adds a new DHCP scope

GET /DHCPScopes/{dhcpScopeRef}

Gets specified DHCP scope

PUT /DHCPScopes/{dhcpScopeRef}

Sets properties for the specified object

DELETE /DHCPScopes/{dhcpScopeRef}

Removes the specified object

GET /DHCPScopes/{ref}/Access

Gets access set for the specified object

PUT /DHCPScopes/{ref}/Access

Sets access for the specified objects

GET /DHCPScopes/{dhcpScopeRef}/DHCPAddressPools

Gets DHCP address pools

POST /DHCPScopes/{dhcpScopeRef}/DHCPAddressPools

Adds a new DHCP address pool

GET /DHCPScopes/{dhcpScopeRef}/DHCPExclusions

Gets DHCP exclusions

POST /DHCPScopes/{dhcpScopeRef}/DHCPExclusions

Adds a new DHCP exclusion

GET /DHCPScopes/{ownerRef}/DHCPGroups

Gets DHCP groups from the specified owner (which must reference either a DHCP server or a DHCP scope)

POST /DHCPScopes/{ownerRef}/DHCPGroups

Creates a DHCP group

GET /DHCPScopes/{ownerRef}/DHCPReservations

Gets DHCP reservations from the specified owner (which must reference a DHCP server, a DHCP group, or a DHCP scope)

POST /DHCPScopes/{ownerRef}/DHCPReservations

Adds a new DHCP reservation

GET /DHCPScopes/{ref}/Folders

Gets the folder that contains the specified object

DELETE /DHCPScopes/{ref}/Folders

Removes the specified objects from the folder they are in

PUT /DHCPScopes/{ref}/Folders/{folderRef}

Places the specified objects in the specified folder

DELETE /DHCPScopes/{ref}/Folders/{folderRef}

Removes the specified objects from the folder they are in

GET /DHCPScopes/{objRef}/History

Gets event history

GET /DHCPScopes/{ref}/InheritedOptions

Gets inherited DHCP options for the specified object (which must reference a DHCP server, a DHCP group, a DHCP scope, a DHCP address pool, or a DHCP reservation)

GET /DHCPScopes/{dhcpScopeRef}/Leases

Gets DHCP leases from the specified DHCP scope

POST /DHCPScopes/{dhcpScopeRef}/Leases

Adds a new DHCP lease

DELETE /DHCPScopes/{dhcpScopeRef}/Leases/{lease}

Releases the specified DHCP lease

GET /DHCPScopes/{objRef}/NextFreeReservationAddress

Gets next free reservable address from the specified scope

GET /DHCPScopes/{ref}/Options

Gets DHCP options for the specified object (which must reference a DHCP server, a DHCP group, a DHCP scope, a DHCP address pool, or a DHCP reservation)

PUT /DHCPScopes/{ref}/Options

Sets DHCP options for the specified object (which must reference a DHCP server, a DHCP group, a DHCP scope, a DHCP address pool, or a DHCP reservation)

GET /DHCPScopes/{dhcpServerRef}/OptionsDefinitions

Gets DHCP option definitions for the specified object (which must reference a DHCP server, a DHCP group, a DHCP scope, a DHCP address pool, or a DHCP reservation)

POST /DHCPScopes/{dhcpServerRef}/OptionsDefinitions

Adds a new DHCP option definition on the specified DHCP server

PUT /DHCPScopes/{dhcpServerRef}/OptionsDefinitions

Modifies the specified DHCP option definition on the specified DHCP server

DELETE /DHCPScopes/{dhcpServerRef}/OptionsDefinitions

Removes the specified DHCP option definition from the specified DHCP server

GET /DHCPScopes/{ownerRef}/Policies

Get all DHCP policies from the specified owner (which must reference a DHCP server or a DHCP scope)

POST /DHCPScopes/{ownerRef}/Policies

Adds a DHCP policy to the specified owner (which must reference a DHCP server or a DHCP scope)

PUT /DHCPScopes/{ownerRef}/Policies/{dhcpPolicyName}

Modifies the specified DHCP policy on the specified owner (which must reference a DHCP server or a DHCP scope)

DELETE /DHCPScopes/{ownerRef}/Policies/{dhcpPolicyName}

Remove a DHCP policy from the specified owner (which must reference a DHCP server or a DHCP scope)

GET /DHCPScopes/{ownerRef}/PolicyEnforcement

Gets DHCP policy enforcement as set for the specified owner (which must reference a DHCP server or a DHCP scope)

PUT /DHCPScopes/{ownerRef}/PolicyEnforcement

Sets the DHCP policy enforcement for the specified DHCP server or DHCP scope

GET /DHCPScopes/{ref}/PropertyDefinitions

Gets all the property definitions for the specified object type

POST /DHCPScopes/{ref}/PropertyDefinitions

Adds a new custom property definition

GET /DHCPScopes/{ref}/PropertyDefinitions/{property}

Gets the definition for a specified property of the given object type

PUT /DHCPScopes/{ref}/PropertyDefinitions/{property}

Modifies a custom property definition

DELETE /DHCPScopes/{ref}/PropertyDefinitions/{property}

Removes the specified custom property definition

Tag: DHCPServers

DHCP Servers

Operation Description
GET /DHCPServers

Gets DHCP servers

POST /DHCPServers

Adds a new DHCP server

GET /DHCPServers/{dhcpServerRef}

Gets specified DHCP server

PUT /DHCPServers/{dhcpServerRef}

Sets properties for the specified object

DELETE /DHCPServers/{dhcpServerRef}

Removes the specified object

GET /DHCPServers/{ref}/Access

Gets access set for the specified object

PUT /DHCPServers/{ref}/Access

Sets access for the specified objects

GET /DHCPServers/{dhcpServerRef}/ClassNames

Gets DHCP class names from the specified DHCP server

GET /DHCPServers/{ownerRef}/DHCPGroups

Gets DHCP groups from the specified owner (which must reference either a DHCP server or a DHCP scope)

POST /DHCPServers/{ownerRef}/DHCPGroups

Creates a DHCP group

GET /DHCPServers/{ownerRef}/DHCPReservations

Gets DHCP reservations from the specified owner (which must reference a DHCP server, a DHCP group, or a DHCP scope)

POST /DHCPServers/{ownerRef}/DHCPReservations

Adds a new DHCP reservation

GET /DHCPServers/{dhcpServerRef}/FailoverRelationships

Get all DHCP failover relationships from specified DHCP server

POST /DHCPServers/{dhcpServerRef}/FailoverRelationships

Adds a DHCP failover relationship

GET /DHCPServers/{dhcpServerRef}/FailoverRelationships/{dhcpFailoverRelationshipName}

Get a DHCP failover relationship

DELETE /DHCPServers/{dhcpServerRef}/FailoverRelationships/{dhcpFailoverRelationshipName}

Remove a DHCP failover relationship

GET /DHCPServers/{objRef}/History

Gets event history

GET /DHCPServers/{ref}/InheritedOptions

Gets inherited DHCP options for the specified object (which must reference a DHCP server, a DHCP group, a DHCP scope, a DHCP address pool, or a DHCP reservation)

GET /DHCPServers/{ref}/Options

Gets DHCP options for the specified object (which must reference a DHCP server, a DHCP group, a DHCP scope, a DHCP address pool, or a DHCP reservation)

PUT /DHCPServers/{ref}/Options

Sets DHCP options for the specified object (which must reference a DHCP server, a DHCP group, a DHCP scope, a DHCP address pool, or a DHCP reservation)

GET /DHCPServers/{dhcpServerRef}/OptionsDefinitions

Gets DHCP option definitions for the specified object (which must reference a DHCP server, a DHCP group, a DHCP scope, a DHCP address pool, or a DHCP reservation)

POST /DHCPServers/{dhcpServerRef}/OptionsDefinitions

Adds a new DHCP option definition on the specified DHCP server

PUT /DHCPServers/{dhcpServerRef}/OptionsDefinitions

Modifies the specified DHCP option definition on the specified DHCP server

DELETE /DHCPServers/{dhcpServerRef}/OptionsDefinitions

Removes the specified DHCP option definition from the specified DHCP server

GET /DHCPServers/{ownerRef}/Policies

Get all DHCP policies from the specified owner (which must reference a DHCP server or a DHCP scope)

POST /DHCPServers/{ownerRef}/Policies

Adds a DHCP policy to the specified owner (which must reference a DHCP server or a DHCP scope)

PUT /DHCPServers/{ownerRef}/Policies/{dhcpPolicyName}

Modifies the specified DHCP policy on the specified owner (which must reference a DHCP server or a DHCP scope)

DELETE /DHCPServers/{ownerRef}/Policies/{dhcpPolicyName}

Remove a DHCP policy from the specified owner (which must reference a DHCP server or a DHCP scope)

GET /DHCPServers/{ownerRef}/PolicyEnforcement

Gets DHCP policy enforcement as set for the specified owner (which must reference a DHCP server or a DHCP scope)

PUT /DHCPServers/{ownerRef}/PolicyEnforcement

Sets the DHCP policy enforcement for the specified DHCP server or DHCP scope

GET /DHCPServers/{ref}/PropertyDefinitions

Gets all the property definitions for the specified object type

POST /DHCPServers/{ref}/PropertyDefinitions

Adds a new custom property definition

GET /DHCPServers/{ref}/PropertyDefinitions/{property}

Gets the definition for a specified property of the given object type

PUT /DHCPServers/{ref}/PropertyDefinitions/{property}

Modifies a custom property definition

DELETE /DHCPServers/{ref}/PropertyDefinitions/{property}

Removes the specified custom property definition

GET /DHCPServers/{dhcpServerRef}/Subclasses/{dhcpClassName}

Gets DHCP subclasses from the specified DHCP class on the specified DHCP server

PUT /DHCPServers/{dhcpServerRef}/Subclasses/{dhcpClassName}

Sets DHCP subclasses for the specified DHCP class on the specified DHCP server

GET /DHCPServers/{dhcpServerRef}/VendorAndUserClasses

Gets DHCP vendor and user classes from the specified DHCP server

Tag: DNSRecords

DNS Records

Operation Description
POST /DNSRecords

Adds multiple new DNS records

GET /DNSRecords/{dnsRecordRef}

Gets specified DNS record

PUT /DNSRecords/{dnsRecordRef}

Sets properties for the specified object

DELETE /DNSRecords/{dnsRecordRef}

Removes the specified object

GET /DNSRecords/{ref}/Access

Gets access set for the specified object

PUT /DNSRecords/{ref}/Access

Sets access for the specified objects

GET /DNSRecords/{objRef}/History

Gets event history

GET /DNSRecords/{ref}/PropertyDefinitions

Gets all the property definitions for the specified object type

POST /DNSRecords/{ref}/PropertyDefinitions

Adds a new custom property definition

GET /DNSRecords/{ref}/PropertyDefinitions/{property}

Gets the definition for a specified property of the given object type

PUT /DNSRecords/{ref}/PropertyDefinitions/{property}

Modifies a custom property definition

DELETE /DNSRecords/{ref}/PropertyDefinitions/{property}

Removes the specified custom property definition

GET /DNSRecords/{dnsRecordRef}/RelatedDNSRecords

Gets DNS records related to the specified DNS record (which must be either an A or AAAA record)

DELETE /DNSRecords/{dnsRecordRef}/RelatedDNSRecords

Removes the specified object

Tag: DNSServers

DNS Servers

Operation Description
GET /DNSServers

Gets DNS servers

POST /DNSServers

Adds a new DNS server

GET /DNSServers/{dnsServerRef}

Gets specified DNS server

PUT /DNSServers/{dnsServerRef}

Sets properties for the specified object

DELETE /DNSServers/{dnsServerRef}

Removes the specified object

GET /DNSServers/{ref}/Access

Gets access set for the specified object

PUT /DNSServers/{ref}/Access

Sets access for the specified objects

GET /DNSServers/{dnsServerRef}/ADPartitions

Gets AD partitions from the specified DNS server

GET /DNSServers/{dnsServerRef}/DNSViews

Gets DNS views

GET /DNSServers/{dnsServerRef}/DNSZones

Gets DNS zones

GET /DNSServers/{objRef}/History

Gets event history

GET /DNSServers/{dnsServerRef}/Options

Gets options for specified DNS server

PUT /DNSServers/{dnsServerRef}/Options

Updates server options for the specified DNS server

GET /DNSServers/{ref}/PropertyDefinitions

Gets all the property definitions for the specified object type

POST /DNSServers/{ref}/PropertyDefinitions

Adds a new custom property definition

GET /DNSServers/{ref}/PropertyDefinitions/{property}

Gets the definition for a specified property of the given object type

PUT /DNSServers/{ref}/PropertyDefinitions/{property}

Modifies a custom property definition

DELETE /DNSServers/{ref}/PropertyDefinitions/{property}

Removes the specified custom property definition

GET /DNSServers/{ref}/Scopes

Gets DNS scopes for the specified object

Tag: DNSViews

DNS Views

Operation Description
GET /DNSViews

Gets DNS views

GET /DNSViews/{dnsViewRef}

Gets specified DNS view

GET /DNSViews/{dnsViewRef}/DNSZones

Gets DNS zones

Tag: DNSZones

DNS Zones

Operation Description
GET /DNSZones

Gets DNS zones

POST /DNSZones

Adds a new DNS zone

GET /DNSZones/GenerateDirectives/{dnsGenerateDirectiveRef}

Gets specified DNS generate directive

DELETE /DNSZones/GenerateDirectives/{dnsGenerateDirectiveRef}

Removes the specified object

GET /DNSZones/{dnsZoneRef}

Gets specified DNS zone

PUT /DNSZones/{dnsZoneRef}

Sets properties for the specified object

DELETE /DNSZones/{dnsZoneRef}

Removes the specified object

GET /DNSZones/{ref}/Access

Gets access set for the specified object

PUT /DNSZones/{ref}/Access

Sets access for the specified objects

GET /DNSZones/{dnsZoneRef}/DNSRecords

Gets DNS records from the specified DNS zone

POST /DNSZones/{dnsZoneRef}/DNSRecords

Adds a new DNS record

GET /DNSZones/{ref}/Folders

Gets the folder that contains the specified object

DELETE /DNSZones/{ref}/Folders

Removes the specified objects from the folder they are in

PUT /DNSZones/{ref}/Folders/{folderRef}

Places the specified objects in the specified folder

DELETE /DNSZones/{ref}/Folders/{folderRef}

Removes the specified objects from the folder they are in

GET /DNSZones/{dnsZoneRef}/GenerateDirectives

Gets DNS generate directives from the specified DNS zone

POST /DNSZones/{dnsZoneRef}/GenerateDirectives

Adds a new DNS generate directive

GET /DNSZones/{objRef}/History

Gets event history

GET /DNSZones/{dnsZoneRef}/KeyStorageProviders

Gets specified DNS zone

GET /DNSZones/{dnsZoneRef}/Options

Gets zone options for the specified DNS zone

PUT /DNSZones/{dnsZoneRef}/Options

Updates zone options for the specified DNS zone

GET /DNSZones/{ref}/PropertyDefinitions

Gets all the property definitions for the specified object type

POST /DNSZones/{ref}/PropertyDefinitions

Adds a new custom property definition

GET /DNSZones/{ref}/PropertyDefinitions/{property}

Gets the definition for a specified property of the given object type

PUT /DNSZones/{ref}/PropertyDefinitions/{property}

Modifies a custom property definition

DELETE /DNSZones/{ref}/PropertyDefinitions/{property}

Removes the specified custom property definition

GET /DNSZones/{ref}/Scopes

Gets DNS scopes for the specified object

Tag: Folders

Folders for objects and custom filters

Operation Description
GET /Folders

Gets a list of folders

POST /Folders

Adds a new folder

GET /Folders/{folderRef}

Gets specified folder

PUT /Folders/{folderRef}

Sets properties for the specified object

DELETE /Folders/{folderRef}

Removes the specified object

GET /Folders/{ref}/Access

Gets access set for the specified object

PUT /Folders/{ref}/Access

Sets access for the specified objects

GET /Folders/{ref}/Folders

Gets the folder that contains the specified object

DELETE /Folders/{ref}/Folders

Removes the specified objects from the folder they are in

PUT /Folders/{ref}/Folders/{folderRef}

Places the specified objects in the specified folder

DELETE /Folders/{ref}/Folders/{folderRef}

Removes the specified objects from the folder they are in

GET /Folders/{objRef}/History

Gets event history

GET /Folders/{folderRef}/Objects

Gets all objects in the folder specified

GET /Folders/{ref}/PropertyDefinitions

Gets all the property definitions for the specified object type

POST /Folders/{ref}/PropertyDefinitions

Adds a new custom property definition

GET /Folders/{ref}/PropertyDefinitions/{property}

Gets the definition for a specified property of the given object type

PUT /Folders/{ref}/PropertyDefinitions/{property}

Modifies a custom property definition

DELETE /Folders/{ref}/PropertyDefinitions/{property}

Removes the specified custom property definition

Tag: Groups

User Groups

Operation Description
GET /Groups

Gets a list of user groups

POST /Groups

Adds a new user group

GET /Groups/{groupRef}

Gets a group object based on the object reference

PUT /Groups/{groupRef}

Sets properties for the specified object

DELETE /Groups/{groupRef}

Removes the specified object

GET /Groups/{ref}/Access

Gets access set for the specified object

PUT /Groups/{ref}/Access

Sets access for the specified objects

GET /Groups/{objRef}/History

Gets event history

GET /Groups/{ref}/PropertyDefinitions

Gets all the property definitions for the specified object type

POST /Groups/{ref}/PropertyDefinitions

Adds a new custom property definition

GET /Groups/{ref}/PropertyDefinitions/{property}

Gets the definition for a specified property of the given object type

PUT /Groups/{ref}/PropertyDefinitions/{property}

Modifies a custom property definition

DELETE /Groups/{ref}/PropertyDefinitions/{property}

Removes the specified custom property definition

GET /Groups/{groupRef}/Roles

Gets a list of roles

PUT /Groups/{groupRef}/Roles/{roleRef}

Adds a role to a group

DELETE /Groups/{groupRef}/Roles/{roleRef}

Removes a role from a group

GET /Groups/{groupRef}/Users

Gets users

PUT /Groups/{groupRef}/Users/{userRef}

Adds a user to a group

DELETE /Groups/{groupRef}/Users/{userRef}

Removes a user from a group

AD Site Links

Operation Description
GET /ADSiteLinks

Gets AD site links

POST /ADSiteLinks

Adds a new AD site link

GET /ADSiteLinks/{adSiteLinkRef}

Gets specified AD site link

PUT /ADSiteLinks/{adSiteLinkRef}

Sets properties for the specified object

DELETE /ADSiteLinks/{adSiteLinkRef}

Removes the specified object

GET /ADSiteLinks/{ref}/Access

Gets access set for the specified object

PUT /ADSiteLinks/{ref}/Access

Sets access for the specified objects

GET /ADSiteLinks/{objRef}/History

Gets event history

GET /ADSiteLinks/{ref}/PropertyDefinitions

Gets all the property definitions for the specified object type

POST /ADSiteLinks/{ref}/PropertyDefinitions

Adds a new custom property definition

GET /ADSiteLinks/{ref}/PropertyDefinitions/{property}

Gets the definition for a specified property of the given object type

PUT /ADSiteLinks/{ref}/PropertyDefinitions/{property}

Modifies a custom property definition

DELETE /ADSiteLinks/{ref}/PropertyDefinitions/{property}

Removes the specified custom property definition

Tag: Interfaces

Device Interfaces

Operation Description
GET /Interfaces

Gets interfaces

POST /Interfaces

Adds a new interface

GET /Interfaces/{interfaceRef}

Gets specified interface

PUT /Interfaces/{interfaceRef}

Sets properties for the specified object

DELETE /Interfaces/{interfaceRef}

Removes the specified object

GET /Interfaces/{ref}/Access

Gets access set for the specified object

PUT /Interfaces/{ref}/Access

Sets access for the specified objects

GET /Interfaces/{objRef}/History

Gets event history

GET /Interfaces/{ref}/PropertyDefinitions

Gets all the property definitions for the specified object type

POST /Interfaces/{ref}/PropertyDefinitions

Adds a new custom property definition

GET /Interfaces/{ref}/PropertyDefinitions/{property}

Gets the definition for a specified property of the given object type

PUT /Interfaces/{ref}/PropertyDefinitions/{property}

Modifies a custom property definition

DELETE /Interfaces/{ref}/PropertyDefinitions/{property}

Removes the specified custom property definition

Tag: IPAMRecords

IPAM Records

Operation Description
GET /IPAMRecords/{addrRef}

Gets IPAM record for the specified IP address

PUT /IPAMRecords/{addrRef}

Sets properties for the specified object

DELETE /IPAMRecords/{addrRef}

Removes the specified object

GET /IPAMRecords/{ref}/Access

Gets access set for the specified object

PUT /IPAMRecords/{ref}/Access

Sets access for the specified objects

GET /IPAMRecords/{objRef}/History

Gets event history

POST /IPAMRecords/{addrRef}/Ping

Sends an ICMP ping request to the specified address

GET /IPAMRecords/{ref}/PropertyDefinitions

Gets all the property definitions for the specified object type

POST /IPAMRecords/{ref}/PropertyDefinitions

Adds a new custom property definition

GET /IPAMRecords/{ref}/PropertyDefinitions/{property}

Gets the definition for a specified property of the given object type

PUT /IPAMRecords/{ref}/PropertyDefinitions/{property}

Modifies a custom property definition

DELETE /IPAMRecords/{ref}/PropertyDefinitions/{property}

Removes the specified custom property definition

GET /IPAMRecords/{addrRef}/Range

Gets range containing specified IP address

Tag: Ranges

IP Address Ranges

Operation Description
GET /Ranges

Gets ranges

POST /Ranges

Adds a new address range

GET /Ranges/{rangeRef}

Gets specified range

PUT /Ranges/{rangeRef}

Sets properties for the specified object

DELETE /Ranges/{rangeRef}

Removes the specified object

GET /Ranges/{ref}/Access

Gets access set for the specified object

PUT /Ranges/{ref}/Access

Sets access for the specified objects

GET /Ranges/{rangeRef}/AddressBlocks

Gets specified address range's address blocks

GET /Ranges/{rangeRef}/AvailableAddressBlocks

Gets available address blocks within the specified range

GET /Ranges/{ref}/Folders

Gets the folder that contains the specified object

DELETE /Ranges/{ref}/Folders

Removes the specified objects from the folder they are in

PUT /Ranges/{ref}/Folders/{folderRef}

Places the specified objects in the specified folder

DELETE /Ranges/{ref}/Folders/{folderRef}

Removes the specified objects from the folder they are in

GET /Ranges/{objRef}/History

Gets event history

GET /Ranges/{rangeRef}/InheritAccess

Gets inherit access flag for the specified range

GET /Ranges/{rangeRef}/IPAMRecords

Gets IPAM records from a specific range or for specific IPAM records

GET /Ranges/{rangeRef}/NextFreeAddress

Gets next free address from the specified range

GET /Ranges/{ref}/PropertyDefinitions

Gets all the property definitions for the specified object type

POST /Ranges/{ref}/PropertyDefinitions

Adds a new custom property definition

GET /Ranges/{ref}/PropertyDefinitions/{property}

Gets the definition for a specified property of the given object type

PUT /Ranges/{ref}/PropertyDefinitions/{property}

Modifies a custom property definition

DELETE /Ranges/{ref}/PropertyDefinitions/{property}

Removes the specified custom property definition

GET /Ranges/{rangeRef}/Statistics

Gets range statistics

GET /Ranges/{parentRef}/Subranges

Gets subranges of the specified range

Tag: ReportDefinitions

Report Definitions

Operation Description
GET /ReportDefinitions

Gets list of available report results

POST /ReportDefinitions

Adds a new report definition

GET /ReportDefinitions/{reportDefinitionRef}

Gets specified report definition

PUT /ReportDefinitions/{reportDefinitionRef}

Sets properties for the specified object

DELETE /ReportDefinitions/{reportDefinitionRef}

Removes the specified object

GET /ReportDefinitions/{ref}/Access

Gets access set for the specified object

PUT /ReportDefinitions/{ref}/Access

Sets access for the specified objects

GET /ReportDefinitions/{objRef}/History

Gets event history

GET /ReportDefinitions/{ref}/PropertyDefinitions

Gets all the property definitions for the specified object type

POST /ReportDefinitions/{ref}/PropertyDefinitions

Adds a new custom property definition

GET /ReportDefinitions/{ref}/PropertyDefinitions/{property}

Gets the definition for a specified property of the given object type

PUT /ReportDefinitions/{ref}/PropertyDefinitions/{property}

Modifies a custom property definition

DELETE /ReportDefinitions/{ref}/PropertyDefinitions/{property}

Removes the specified custom property definition

Tag: Reports

Reports

Operation Description
GET /Reports

Gets list of reporting templates available

GET /Reports/{reportRef}

Return the definition of a reporting template

GET /Reports/{ref}/File

Gets the Report as a file

GET /Reports/{objRef}/History

Gets event history

Tag: Roles

User and Group Roles

Operation Description
GET /Roles

Gets a list of roles

POST /Roles

Adds a new role

GET /Roles/{roleRef}

Gets a role object based on the object reference

PUT /Roles/{roleRef}

Sets properties for the specified object

DELETE /Roles/{roleRef}

Removes the specified object

GET /Roles/{ref}/Access

Gets access set for the specified object

PUT /Roles/{ref}/Access

Sets access for the specified objects

GET /Roles/{roleRef}/Groups

Gets a list of user groups

GET /Roles/{objRef}/History

Gets event history

GET /Roles/{ref}/PropertyDefinitions

Gets all the property definitions for the specified object type

POST /Roles/{ref}/PropertyDefinitions

Adds a new custom property definition

GET /Roles/{ref}/PropertyDefinitions/{property}

Gets the definition for a specified property of the given object type

PUT /Roles/{ref}/PropertyDefinitions/{property}

Modifies a custom property definition

DELETE /Roles/{ref}/PropertyDefinitions/{property}

Removes the specified custom property definition

GET /Roles/{roleRef}/Users

Gets users

Tag: Users

User Administration

Operation Description
GET /Users

Gets users

POST /Users

Adds a new user

GET /Users/{userRef}

Gets specified user

PUT /Users/{userRef}

Sets properties for the specified object

DELETE /Users/{userRef}

Removes the specified object

GET /Users/{ref}/Access

Gets access set for the specified object

PUT /Users/{ref}/Access

Sets access for the specified objects

GET /Users/{userRef}/Groups

Gets a list of user groups

GET /Users/{objRef}/History

Gets event history

GET /Users/{ref}/PropertyDefinitions

Gets all the property definitions for the specified object type

POST /Users/{ref}/PropertyDefinitions

Adds a new custom property definition

GET /Users/{ref}/PropertyDefinitions/{property}

Gets the definition for a specified property of the given object type

PUT /Users/{ref}/PropertyDefinitions/{property}

Modifies a custom property definition

DELETE /Users/{ref}/PropertyDefinitions/{property}

Removes the specified custom property definition

GET /Users/{userRef}/Roles

Gets a list of roles

PUT /Users/{userRef}/Roles/{roleRef}

Adds a role to a user

DELETE /Users/{userRef}/Roles/{roleRef}

Removes a role from a user

Tag: ADSites

AD Sites

Operation Description
GET /ADSites

Gets AD sites

POST /ADSites

Adds a new AD site

GET /ADSites/{adSiteRef}

Gets specified AD site

PUT /ADSites/{adSiteRef}

Sets properties for the specified object

DELETE /ADSites/{adSiteRef}

Removes the specified object

GET /ADSites/{ref}/Access

Gets access set for the specified object

PUT /ADSites/{ref}/Access

Sets access for the specified objects

GET /ADSites/{objRef}/History

Gets event history

GET /ADSites/{ref}/PropertyDefinitions

Gets all the property definitions for the specified object type

POST /ADSites/{ref}/PropertyDefinitions

Adds a new custom property definition

GET /ADSites/{ref}/PropertyDefinitions/{property}

Gets the definition for a specified property of the given object type

PUT /ADSites/{ref}/PropertyDefinitions/{property}

Modifies a custom property definition

DELETE /ADSites/{ref}/PropertyDefinitions/{property}

Removes the specified custom property definition

GET /ADSites/{adSiteRef}/Ranges

Gets ranges

POST /ADSites/{adSiteRef}/Ranges

Places the specified address ranges in the specified AD site

DELETE /ADSites/{adSiteRef}/Ranges

Removes the specified address ranges from the specified AD site

Tag: ChangeRequests

Change Requests

Operation Description
GET /ChangeRequests

Gets change requests

POST /ChangeRequests

Adds request for change(s)

GET /ChangeRequests/{changeRequestRef}

Gets specified change request

PUT /ChangeRequests/{changeRequestRef}

Sets properties for the specified object

DELETE /ChangeRequests/{changeRequestRef}

Removes the specified object

GET /ChangeRequests/{ref}/Access

Gets access set for the specified object

PUT /ChangeRequests/{ref}/Access

Sets access for the specified objects

GET /ChangeRequests/{objRef}/History

Gets event history

GET /ChangeRequests/{ref}/PropertyDefinitions

Gets all the property definitions for the specified object type

POST /ChangeRequests/{ref}/PropertyDefinitions

Adds a new custom property definition

GET /ChangeRequests/{ref}/PropertyDefinitions/{property}

Gets the definition for a specified property of the given object type

PUT /ChangeRequests/{ref}/PropertyDefinitions/{property}

Modifies a custom property definition

DELETE /ChangeRequests/{ref}/PropertyDefinitions/{property}

Removes the specified custom property definition

Tag: CloudNetworks

Cloud Networks

Operation Description
GET /CloudNetworks

Gets a list of cloud networks

POST /CloudNetworks

Adds a new cloud network

GET /CloudNetworks/{cloudNetworkRef}

Gets a cloud network object based on the object reference

PUT /CloudNetworks/{cloudNetworkRef}

Sets properties for the specified object

DELETE /CloudNetworks/{cloudNetworkRef}

Removes the specified object

GET /CloudNetworks/{ref}/Access

Gets access set for the specified object

PUT /CloudNetworks/{ref}/Access

Sets access for the specified objects

GET /CloudNetworks/{objRef}/History

Gets event history

GET /CloudNetworks/{ref}/PropertyDefinitions

Gets all the property definitions for the specified object type

POST /CloudNetworks/{ref}/PropertyDefinitions

Adds a new custom property definition

GET /CloudNetworks/{ref}/PropertyDefinitions/{property}

Gets the definition for a specified property of the given object type

PUT /CloudNetworks/{ref}/PropertyDefinitions/{property}

Modifies a custom property definition

DELETE /CloudNetworks/{ref}/PropertyDefinitions/{property}

Removes the specified custom property definition

GET /CloudNetworks/{cloudNetworkRef}/Ranges

Gets ranges

POST /CloudNetworks/{cloudNetworkRef}/Ranges

Places the specified subnets in the specified cloud network

DELETE /CloudNetworks/{cloudNetworkRef}/Ranges/{rangeRef}

Removes the specified address ranges from their respective cloud networks

Tag: CloudServiceAccounts

Cloud Integration

Operation Description
GET /CloudServiceAccounts

Gets a list of cloud service accounts

POST /CloudServiceAccounts

Adds a new cloud service account

GET /CloudServiceAccounts/{cloudRef}

Gets a cloud service account based on the object reference

PUT /CloudServiceAccounts/{cloudRef}

Sets properties for the specified object

DELETE /CloudServiceAccounts/{cloudRef}

Removes the specified object

GET /CloudServiceAccounts/{ref}/Access

Gets access set for the specified object

PUT /CloudServiceAccounts/{ref}/Access

Sets access for the specified objects

GET /CloudServiceAccounts/{objRef}/History

Gets event history

GET /CloudServiceAccounts/{cloudRef}/Information

Gets a cloud object based on the object reference

GET /CloudServiceAccounts/{ref}/PropertyDefinitions

Gets all the property definitions for the specified object type

POST /CloudServiceAccounts/{ref}/PropertyDefinitions

Adds a new custom property definition

GET /CloudServiceAccounts/{ref}/PropertyDefinitions/{property}

Gets the definition for a specified property of the given object type

PUT /CloudServiceAccounts/{ref}/PropertyDefinitions/{property}

Modifies a custom property definition

DELETE /CloudServiceAccounts/{ref}/PropertyDefinitions/{property}

Removes the specified custom property definition

Tag: Devices

Connectable Devices

Operation Description
GET /Devices

Gets devices

POST /Devices

Adds a new device

GET /Devices/{deviceRef}

Gets specified device

PUT /Devices/{deviceRef}

Sets properties for the specified object

DELETE /Devices/{deviceRef}

Removes the specified object

GET /Devices/{ref}/Access

Gets access set for the specified object

PUT /Devices/{ref}/Access

Sets access for the specified objects

GET /Devices/{objRef}/History

Gets event history

GET /Devices/{ref}/PropertyDefinitions

Gets all the property definitions for the specified object type

POST /Devices/{ref}/PropertyDefinitions

Adds a new custom property definition

GET /Devices/{ref}/PropertyDefinitions/{property}

Gets the definition for a specified property of the given object type

PUT /Devices/{ref}/PropertyDefinitions/{property}

Modifies a custom property definition

DELETE /Devices/{ref}/PropertyDefinitions/{property}

Removes the specified custom property definition

Tag: DHCPAddressPools

DHCP Address Pools

Operation Description
GET /DHCPAddressPools/{dhcpAddressPoolRef}

Gets specified DHCP address pool

PUT /DHCPAddressPools/{dhcpAddressPoolRef}

Sets properties for the specified object

DELETE /DHCPAddressPools/{dhcpAddressPoolRef}

Removes the specified object

GET /DHCPAddressPools/{ref}/Access

Gets access set for the specified object

PUT /DHCPAddressPools/{ref}/Access

Sets access for the specified objects

GET /DHCPAddressPools/{objRef}/History

Gets event history

GET /DHCPAddressPools/{ref}/InheritedOptions

Gets inherited DHCP options for the specified object (which must reference a DHCP server, a DHCP group, a DHCP scope, a DHCP address pool, or a DHCP reservation)

GET /DHCPAddressPools/{ref}/Options

Gets DHCP options for the specified object (which must reference a DHCP server, a DHCP group, a DHCP scope, a DHCP address pool, or a DHCP reservation)

PUT /DHCPAddressPools/{ref}/Options

Sets DHCP options for the specified object (which must reference a DHCP server, a DHCP group, a DHCP scope, a DHCP address pool, or a DHCP reservation)

GET /DHCPAddressPools/{dhcpServerRef}/OptionsDefinitions

Gets DHCP option definitions for the specified object (which must reference a DHCP server, a DHCP group, a DHCP scope, a DHCP address pool, or a DHCP reservation)

POST /DHCPAddressPools/{dhcpServerRef}/OptionsDefinitions

Adds a new DHCP option definition on the specified DHCP server

PUT /DHCPAddressPools/{dhcpServerRef}/OptionsDefinitions

Modifies the specified DHCP option definition on the specified DHCP server

DELETE /DHCPAddressPools/{dhcpServerRef}/OptionsDefinitions

Removes the specified DHCP option definition from the specified DHCP server

GET /DHCPAddressPools/{dhcpAddressPoolRef}/PermitList

Gets DHCP address pool permit list for the specified DHCP address pool

PUT /DHCPAddressPools/{dhcpAddressPoolRef}/PermitList

Sets DHCP address pool permit list for the specified DHCP address pool

GET /DHCPAddressPools/{ref}/PropertyDefinitions

Gets all the property definitions for the specified object type

POST /DHCPAddressPools/{ref}/PropertyDefinitions

Adds a new custom property definition

GET /DHCPAddressPools/{ref}/PropertyDefinitions/{property}

Gets the definition for a specified property of the given object type

PUT /DHCPAddressPools/{ref}/PropertyDefinitions/{property}

Modifies a custom property definition

DELETE /DHCPAddressPools/{ref}/PropertyDefinitions/{property}

Removes the specified custom property definition

Tag: DHCPExclusions

DHCP Exclusions

Operation Description
GET /DHCPExclusions/{dhcpExclusionRef}

Gets specified DHCP exclusion

PUT /DHCPExclusions/{dhcpExclusionRef}

Sets properties for the specified object

DELETE /DHCPExclusions/{dhcpExclusionRef}

Removes the specified object

GET /DHCPExclusions/{ref}/Access

Gets access set for the specified object

PUT /DHCPExclusions/{ref}/Access

Sets access for the specified objects

GET /DHCPExclusions/{objRef}/History

Gets event history

GET /DHCPExclusions/{ref}/PropertyDefinitions

Gets all the property definitions for the specified object type

POST /DHCPExclusions/{ref}/PropertyDefinitions

Adds a new custom property definition

GET /DHCPExclusions/{ref}/PropertyDefinitions/{property}

Gets the definition for a specified property of the given object type

PUT /DHCPExclusions/{ref}/PropertyDefinitions/{property}

Modifies a custom property definition

DELETE /DHCPExclusions/{ref}/PropertyDefinitions/{property}

Removes the specified custom property definition

Security

basicAuth

description: HTTP Basic Authentication. Works over `HTTP` and `HTTPS`

Paths

Gets address spaces

GET /AddressSpaces

Tags: AddressSpaces
filter

Filtering criteria for the records returned.

query string #/parameters/filterParam
offset

Specifies the offset to use when listing the records. A value of 0 starts with the first record.

query integer (int64) , { x ∈ ℤ | x ≥ 0 } #/parameters/offsetParam
limit

The number of records to return.

query integer (int64) , { x ∈ ℤ | x ≥ 0 } #/parameters/limitParam
sortBy

The name of the field to sort by.

query string #/parameters/sortByParam
sortOrder

The sort order to use.

query string , x ∈ { Ascending , Descending } #/parameters/sortOrderParam

Uses default content-types: application/json application/xml

200 OK

Successful operation.

addressSpaces: object[]

List of address spaces.

totalResults: integer (int64) , { x ∈ ℤ | x ≥ 0 }

Total number of records in the result set.

default

Unexpected error.

Adds a new address space

POST /AddressSpaces

Tags: AddressSpaces

Uses default content-types: application/json application/xml

Uses default content-types: application/json application/xml

201 Created

Successful operation. Object created.

ref: ObjRef
default

Unexpected error.

Removes the specified object

DELETE /AddressSpaces/{addressSpaceRef}

Tags: AddressSpaces
addressSpaceRef

Reference to the object that should be removed.

path string
objType

The type of object to retrieve. If not specified, entries for all object types are retrieved.

query string , x ∈ { Unknown , Suite , DNSServer , DHCPServer , DNSZone , DNSView , Range , DHCPScope , IPAddress , DHCPReservation , DHCPAddressPool , DHCPGroup , ADSite , DNSRecord , User , Group , DHCPExclusion , DHCPFailoverPeer , DHCPLease , Device , Interface , Folder , ADSiteLink , AddressSpace , ADForest , ChangeRequest , Appliance , Role , CloudServiceAccount , CloudService , CloudAccountSubscription , CloudNetwork , Superscope } #/parameters/objTypeParam
forceRemoval

If possible, then force removal of object.

query boolean
saveComment

Save comment text to associate with the action.

query string

Uses default content-types: application/json application/xml

204 No Content

Successful operation.

default

Unexpected error.

Gets specified address space

GET /AddressSpaces/{addressSpaceRef}

Tags: AddressSpaces
addressSpaceRef

The object reference for the address space.

path string

Uses default content-types: application/json application/xml

200 OK

Successful operation.

addressSpace: AddressSpace
default

Unexpected error.

Sets properties for the specified object

PUT /AddressSpaces/{addressSpaceRef}

Tags: AddressSpaces

Uses default content-types: application/json application/xml

addressSpaceRef

Reference to the object for which properties should be set.

path string

Uses default content-types: application/json application/xml

204 No Content

Successful operation.

default

Unexpected error.

Gets event history

GET /AddressSpaces/{objRef}/History

Tags: AddressSpaces
eventType

The type of event to retrieve. If not specified, entries for all event types are retrieved.

query string , x ∈ { Unknown , Creation , Modification , Deletion , Refresh , Error , Reference } #/parameters/eventTypeParam
objType

The type of object to retrieve. If not specified, entries for all object types are retrieved.

query string , x ∈ { Unknown , Suite , DNSServer , DHCPServer , DNSZone , DNSView , Range , DHCPScope , IPAddress , DHCPReservation , DHCPAddressPool , DHCPGroup , ADSite , DNSRecord , User , Group , DHCPExclusion , DHCPFailoverPeer , DHCPLease , Device , Interface , Folder , ADSiteLink , AddressSpace , ADForest , ChangeRequest , Appliance , Role , CloudServiceAccount , CloudService , CloudAccountSubscription , CloudNetwork , Superscope } #/parameters/objTypeParam
objRef

If specified, only history entries for the specified object will be retrieved.

path string
username

The login name of the user for which to retrieve history entries. If not specified, entries for all users are retrieved.

query string
startDate

Date of the first entry to retrieve.

query string (date-time) #/parameters/startDateParam
endDate

Date of the last entry to retrieve.

query string (date-time) #/parameters/endDateParam
filter

Filtering criteria for the records returned.

query string #/parameters/filterParam
limit

The number of records to return.

query integer (int64) , { x ∈ ℤ | x ≥ 0 } #/parameters/limitParam
offset

Specifies the offset to use when listing the records. A value of 0 starts with the first record.

query integer (int64) , { x ∈ ℤ | x ≥ 0 } #/parameters/offsetParam
sortBy

The name of the field to sort by.

query string #/parameters/sortByParam
sortOrder

The sort order to use.

query string , x ∈ { Ascending , Descending } #/parameters/sortOrderParam

Uses default content-types: application/json application/xml

200 OK

Successful operation.

events: object[]

List of events.

totalResults: integer (int64) , { x ∈ ℤ | x ≥ 0 }

Total number of records in the result set.

default

Unexpected error.

Gets access set for the specified object

GET /AddressSpaces/{ref}/Access

Tags: AddressSpaces
ref

A reference to the object.

path string
objType

The type of object to retrieve. If not specified, entries for all object types are retrieved.

query string , x ∈ { Unknown , Suite , DNSServer , DHCPServer , DNSZone , DNSView , Range , DHCPScope , IPAddress , DHCPReservation , DHCPAddressPool , DHCPGroup , ADSite , DNSRecord , User , Group , DHCPExclusion , DHCPFailoverPeer , DHCPLease , Device , Interface , Folder , ADSiteLink , AddressSpace , ADForest , ChangeRequest , Appliance , Role , CloudServiceAccount , CloudService , CloudAccountSubscription , CloudNetwork , Superscope } #/parameters/objTypeParam
identityRef

Object reference for a user or group. If specified, the command only retrieves access for the specified user or group.

query string
excludeBuiltinIdentities

Set to true to exclude access for builtin users and groups.

query boolean

Uses default content-types: application/json application/xml

200 OK

Successful operation.

objectAccess: ObjectAccess
default

Unexpected error.

Sets access for the specified objects

PUT /AddressSpaces/{ref}/Access

Tags: AddressSpaces

Uses default content-types: application/json application/xml

ref

A reference to an object.

path string

Uses default content-types: application/json application/xml

204 No Content

Successful operation.

default

Unexpected error.

Gets all the property definitions for the specified object type

GET /AddressSpaces/{ref}/PropertyDefinitions

Tags: AddressSpaces
ref

A reference to an object.

path string

Uses default content-types: application/json application/xml

200 OK

Successful operation.

propertyDefinitions: object[]

List of property definitions for the object.

default

Unexpected error.

Adds a new custom property definition

POST /AddressSpaces/{ref}/PropertyDefinitions

Tags: AddressSpaces

Uses default content-types: application/json application/xml

ref

A reference to an object.

path string

Uses default content-types: application/json application/xml

204 No Content

Successful operation.

default

Unexpected error.

Removes the specified custom property definition

DELETE /AddressSpaces/{ref}/PropertyDefinitions/{property}

Tags: AddressSpaces
property

The name of the custom property definition.

path string
saveComment

Save comment text to associate with the action.

query string
ref

A reference to an object.

path string

Uses default content-types: application/json application/xml

204 No Content

Successful operation.

default

Unexpected error.

Gets the definition for a specified property of the given object type

GET /AddressSpaces/{ref}/PropertyDefinitions/{property}

Tags: AddressSpaces
property

The name of the property.

path string
ref

A reference to an object.

path string

Uses default content-types: application/json application/xml

200 OK

Successful operation.

propertyDefinition: PropertyDefinition
default

Unexpected error.

Modifies a custom property definition

PUT /AddressSpaces/{ref}/PropertyDefinitions/{property}

Tags: AddressSpaces

Uses default content-types: application/json application/xml

property

The name of the custom property definition.

path string
ref

A reference to an object.

path string

Uses default content-types: application/json application/xml

204 No Content

Successful operation.

default

Unexpected error.

Gets AD forests

GET /ADForests

Tags: ADForests
filter

Filtering criteria for the records returned.

query string #/parameters/filterParam
offset

Specifies the offset to use when listing the records. A value of 0 starts with the first record.

query integer (int64) , { x ∈ ℤ | x ≥ 0 } #/parameters/offsetParam
limit

The number of records to return.

query integer (int64) , { x ∈ ℤ | x ≥ 0 } #/parameters/limitParam
sortBy

The name of the field to sort by.

query string #/parameters/sortByParam
sortOrder

The sort order to use.

query string , x ∈ { Ascending , Descending } #/parameters/sortOrderParam

Uses default content-types: application/json application/xml

200 OK

Successful operation.

adForests: object[]

List of AD Forests.

totalResults: integer (int64) , { x ∈ ℤ | x ≥ 0 }

Total number of records in the result set.

default

Unexpected error.

Adds a new AD forest

POST /ADForests

Tags: ADForests

Uses default content-types: application/json application/xml

Uses default content-types: application/json application/xml

201 Created

Successful operation. Object created.

ref: ObjRef
default

Unexpected error.

Removes the specified object

DELETE /ADForests/{adForestRef}

Tags: ADForests
adForestRef

Reference to the object that should be removed.

path string
objType

The type of object to retrieve. If not specified, entries for all object types are retrieved.

query string , x ∈ { Unknown , Suite , DNSServer , DHCPServer , DNSZone , DNSView , Range , DHCPScope , IPAddress , DHCPReservation , DHCPAddressPool , DHCPGroup , ADSite , DNSRecord , User , Group , DHCPExclusion , DHCPFailoverPeer , DHCPLease , Device , Interface , Folder , ADSiteLink , AddressSpace , ADForest , ChangeRequest , Appliance , Role , CloudServiceAccount , CloudService , CloudAccountSubscription , CloudNetwork , Superscope } #/parameters/objTypeParam
forceRemoval

If possible, then force removal of object.

query boolean
saveComment

Save comment text to associate with the action.

query string

Uses default content-types: application/json application/xml

204 No Content

Successful operation.

default

Unexpected error.

Gets specified AD forest

GET /ADForests/{adForestRef}

Tags: ADForests
adForestRef

The object reference for the AD Forest.

path string

Uses default content-types: application/json application/xml

200 OK

Successful operation.

adForest: ADForest
default

Unexpected error.

Sets properties for the specified object

PUT /ADForests/{adForestRef}

Tags: ADForests

Uses default content-types: application/json application/xml

adForestRef

Reference to the object for which properties should be set.

path string

Uses default content-types: application/json application/xml

204 No Content

Successful operation.

default

Unexpected error.

Gets event history

GET /ADForests/{objRef}/History

Tags: ADForests
eventType

The type of event to retrieve. If not specified, entries for all event types are retrieved.

query string , x ∈ { Unknown , Creation , Modification , Deletion , Refresh , Error , Reference } #/parameters/eventTypeParam
objType

The type of object to retrieve. If not specified, entries for all object types are retrieved.

query string , x ∈ { Unknown , Suite , DNSServer , DHCPServer , DNSZone , DNSView , Range , DHCPScope , IPAddress , DHCPReservation , DHCPAddressPool , DHCPGroup , ADSite , DNSRecord , User , Group , DHCPExclusion , DHCPFailoverPeer , DHCPLease , Device , Interface , Folder , ADSiteLink , AddressSpace , ADForest , ChangeRequest , Appliance , Role , CloudServiceAccount , CloudService , CloudAccountSubscription , CloudNetwork , Superscope } #/parameters/objTypeParam
objRef

If specified, only history entries for the specified object will be retrieved.

path string
username

The login name of the user for which to retrieve history entries. If not specified, entries for all users are retrieved.

query string
startDate

Date of the first entry to retrieve.

query string (date-time) #/parameters/startDateParam
endDate

Date of the last entry to retrieve.

query string (date-time) #/parameters/endDateParam
filter

Filtering criteria for the records returned.

query string #/parameters/filterParam
limit

The number of records to return.

query integer (int64) , { x ∈ ℤ | x ≥ 0 } #/parameters/limitParam
offset

Specifies the offset to use when listing the records. A value of 0 starts with the first record.

query integer (int64) , { x ∈ ℤ | x ≥ 0 } #/parameters/offsetParam
sortBy

The name of the field to sort by.

query string #/parameters/sortByParam
sortOrder

The sort order to use.

query string , x ∈ { Ascending , Descending } #/parameters/sortOrderParam

Uses default content-types: application/json application/xml

200 OK

Successful operation.

events: object[]

List of events.

totalResults: integer (int64) , { x ∈ ℤ | x ≥ 0 }

Total number of records in the result set.

default

Unexpected error.

Gets access set for the specified object

GET /ADForests/{ref}/Access

Tags: ADForests
ref

A reference to the object.

path string
objType

The type of object to retrieve. If not specified, entries for all object types are retrieved.

query string , x ∈ { Unknown , Suite , DNSServer , DHCPServer , DNSZone , DNSView , Range , DHCPScope , IPAddress , DHCPReservation , DHCPAddressPool , DHCPGroup , ADSite , DNSRecord , User , Group , DHCPExclusion , DHCPFailoverPeer , DHCPLease , Device , Interface , Folder , ADSiteLink , AddressSpace , ADForest , ChangeRequest , Appliance , Role , CloudServiceAccount , CloudService , CloudAccountSubscription , CloudNetwork , Superscope } #/parameters/objTypeParam
identityRef

Object reference for a user or group. If specified, the command only retrieves access for the specified user or group.

query string
excludeBuiltinIdentities

Set to true to exclude access for builtin users and groups.

query boolean

Uses default content-types: application/json application/xml

200 OK

Successful operation.

objectAccess: ObjectAccess
default

Unexpected error.

Sets access for the specified objects

PUT /ADForests/{ref}/Access

Tags: ADForests

Uses default content-types: application/json application/xml

ref

A reference to an object.

path string

Uses default content-types: application/json application/xml

204 No Content

Successful operation.

default

Unexpected error.

Gets all the property definitions for the specified object type

GET /ADForests/{ref}/PropertyDefinitions

Tags: ADForests
ref

A reference to an object.

path string

Uses default content-types: application/json application/xml

200 OK

Successful operation.

propertyDefinitions: object[]

List of property definitions for the object.

default

Unexpected error.

Adds a new custom property definition

POST /ADForests/{ref}/PropertyDefinitions

Tags: ADForests

Uses default content-types: application/json application/xml

ref

A reference to an object.

path string

Uses default content-types: application/json application/xml

204 No Content

Successful operation.

default

Unexpected error.

Removes the specified custom property definition

DELETE /ADForests/{ref}/PropertyDefinitions/{property}

Tags: ADForests
property

The name of the custom property definition.

path string
saveComment

Save comment text to associate with the action.

query string
ref

A reference to an object.

path string

Uses default content-types: application/json application/xml

204 No Content

Successful operation.

default

Unexpected error.

Gets the definition for a specified property of the given object type

GET /ADForests/{ref}/PropertyDefinitions/{property}

Tags: ADForests
property

The name of the property.

path string
ref

A reference to an object.

path string

Uses default content-types: application/json application/xml

200 OK

Successful operation.

propertyDefinition: PropertyDefinition
default

Unexpected error.

Modifies a custom property definition

PUT /ADForests/{ref}/PropertyDefinitions/{property}

Tags: ADForests

Uses default content-types: application/json application/xml

property

The name of the custom property definition.

path string
ref

A reference to an object.

path string

Uses default content-types: application/json application/xml

204 No Content

Successful operation.

default

Unexpected error.

Adds a new AD site link

POST /ADSiteLinks

Tags: ADSiteLinks

Uses default content-types: application/json application/xml

Uses default content-types: application/json application/xml

201 Created

Successful operation. Object created.

ref: ObjRef
default

Unexpected error.

Adds a new custom property definition

POST /ADSiteLinks/{ref}/PropertyDefinitions

Tags: ADSiteLinks

Uses default content-types: application/json application/xml

ref

A reference to an object.

path string

Uses default content-types: application/json application/xml

204 No Content

Successful operation.

default

Unexpected error.

Gets AD sites

GET /ADSites

Tags: ADSites
filter

Filtering criteria for the records returned.

query string #/parameters/filterParam
offset

Specifies the offset to use when listing the records. A value of 0 starts with the first record.

query integer (int64) , { x ∈ ℤ | x ≥ 0 } #/parameters/offsetParam
limit

The number of records to return.

query integer (int64) , { x ∈ ℤ | x ≥ 0 } #/parameters/limitParam
sortBy

The name of the field to sort by.

query string #/parameters/sortByParam
sortOrder

The sort order to use.

query string , x ∈ { Ascending , Descending } #/parameters/sortOrderParam

Uses default content-types: application/json application/xml

200 OK

Successful operation.

adSites: object[]

List of AD Sites.

totalResults: integer (int64) , { x ∈ ℤ | x ≥ 0 }

Total number of records in the result set.

default

Unexpected error.

Adds a new AD site

POST /ADSites

Tags: ADSites

Uses default content-types: application/json application/xml

Uses default content-types: application/json application/xml

201 Created

Successful operation. Object created.

ref: ObjRef
default

Unexpected error.

Removes the specified object

DELETE /ADSites/{adSiteRef}

Tags: ADSites
adSiteRef

Reference to the object that should be removed.

path string
objType

The type of object to retrieve. If not specified, entries for all object types are retrieved.

query string , x ∈ { Unknown , Suite , DNSServer , DHCPServer , DNSZone , DNSView , Range , DHCPScope , IPAddress , DHCPReservation , DHCPAddressPool , DHCPGroup , ADSite , DNSRecord , User , Group , DHCPExclusion , DHCPFailoverPeer , DHCPLease , Device , Interface , Folder , ADSiteLink , AddressSpace , ADForest , ChangeRequest , Appliance , Role , CloudServiceAccount , CloudService , CloudAccountSubscription , CloudNetwork , Superscope } #/parameters/objTypeParam
forceRemoval

If possible, then force removal of object.

query boolean
saveComment

Save comment text to associate with the action.

query string

Uses default content-types: application/json application/xml

204 No Content

Successful operation.

default

Unexpected error.

Gets specified AD site

GET /ADSites/{adSiteRef}

Tags: ADSites
adSiteRef

The object reference for the AD Site.

path string

Uses default content-types: application/json application/xml

200 OK

Successful operation.

adSite: ADSite
default

Unexpected error.

Sets properties for the specified object

PUT /ADSites/{adSiteRef}

Tags: ADSites

Uses default content-types: application/json application/xml

adSiteRef

Reference to the object for which properties should be set.

path string

Uses default content-types: application/json application/xml

204 No Content

Successful operation.

default

Unexpected error.

Removes the specified address ranges from the specified AD site

DELETE /ADSites/{adSiteRef}/Ranges

Tags: ADSites
adSiteRef

Reference to the AD site from which the address ranges should be removed.

path string
rangeRefs

References to the address ranges that should be removed from the AD site.

query string
saveComment

Save comment text to associate with the action.

query string

Uses default content-types: application/json application/xml

204 No Content

Successful operation.

default

Unexpected error.

Gets ranges

GET /ADSites/{adSiteRef}/Ranges

Tags: ADSites
filter

Filtering criteria for the records returned.

query string #/parameters/filterParam
folderRef

Reference to a folder from which to get ranges.

query string
adSiteRef

Reference to an AD Site from which to get ranges.

path string
cloudNetworkRef

Reference to a cloud network from which to get ranges.

query string
offset

Specifies the offset to use when listing the records. A value of 0 starts with the first record.

query integer (int64) , { x ∈ ℤ | x ≥ 0 } #/parameters/offsetParam
limit

The number of records to return.

query integer (int64) , { x ∈ ℤ | x ≥ 0 } #/parameters/limitParam
targetRef

Overrides "offset" and returns a page where "targetRef" is the first record. If target is not found with the given filter, "offset" is not overwritten.

query string
sortBy

The name of the field to sort by.

query string #/parameters/sortByParam
sortOrder

The sort order to use.

query string , x ∈ { Ascending , Descending } #/parameters/sortOrderParam

Uses default content-types: application/json application/xml

200 OK

Successful operation.

default

Unexpected error.

Places the specified address ranges in the specified AD site

POST /ADSites/{adSiteRef}/Ranges

Tags: ADSites

Uses default content-types: application/json application/xml

adSiteRef

Reference to the AD site in which the address ranges should be placed.

path string

Uses default content-types: application/json application/xml

204 No Content

Successful operation.

default

Unexpected error.

Gets event history

GET /ADSites/{objRef}/History

Tags: ADSites
eventType

The type of event to retrieve. If not specified, entries for all event types are retrieved.

query string , x ∈ { Unknown , Creation , Modification , Deletion , Refresh , Error , Reference } #/parameters/eventTypeParam
objType

The type of object to retrieve. If not specified, entries for all object types are retrieved.

query string , x ∈ { Unknown , Suite , DNSServer , DHCPServer , DNSZone , DNSView , Range , DHCPScope , IPAddress , DHCPReservation , DHCPAddressPool , DHCPGroup , ADSite , DNSRecord , User , Group , DHCPExclusion , DHCPFailoverPeer , DHCPLease , Device , Interface , Folder , ADSiteLink , AddressSpace , ADForest , ChangeRequest , Appliance , Role , CloudServiceAccount , CloudService , CloudAccountSubscription , CloudNetwork , Superscope } #/parameters/objTypeParam
objRef

If specified, only history entries for the specified object will be retrieved.

path string
username

The login name of the user for which to retrieve history entries. If not specified, entries for all users are retrieved.

query string
startDate

Date of the first entry to retrieve.

query string (date-time) #/parameters/startDateParam
endDate

Date of the last entry to retrieve.

query string (date-time) #/parameters/endDateParam
filter

Filtering criteria for the records returned.

query string #/parameters/filterParam
limit

The number of records to return.

query integer (int64) , { x ∈ ℤ | x ≥ 0 } #/parameters/limitParam
offset

Specifies the offset to use when listing the records. A value of 0 starts with the first record.

query integer (int64) , { x ∈ ℤ | x ≥ 0 } #/parameters/offsetParam
sortBy

The name of the field to sort by.

query string #/parameters/sortByParam
sortOrder

The sort order to use.

query string , x ∈ { Ascending , Descending } #/parameters/sortOrderParam

Uses default content-types: application/json application/xml

200 OK

Successful operation.

events: object[]

List of events.

totalResults: integer (int64) , { x ∈ ℤ | x ≥ 0 }

Total number of records in the result set.

default

Unexpected error.

Gets access set for the specified object

GET /ADSites/{ref}/Access

Tags: ADSites
ref

A reference to the object.

path string
objType

The type of object to retrieve. If not specified, entries for all object types are retrieved.

query string , x ∈ { Unknown , Suite , DNSServer , DHCPServer , DNSZone , DNSView , Range , DHCPScope , IPAddress , DHCPReservation , DHCPAddressPool , DHCPGroup , ADSite , DNSRecord , User , Group , DHCPExclusion , DHCPFailoverPeer , DHCPLease , Device , Interface , Folder , ADSiteLink , AddressSpace , ADForest , ChangeRequest , Appliance , Role , CloudServiceAccount , CloudService , CloudAccountSubscription , CloudNetwork , Superscope } #/parameters/objTypeParam
identityRef

Object reference for a user or group. If specified, the command only retrieves access for the specified user or group.

query string
excludeBuiltinIdentities

Set to true to exclude access for builtin users and groups.

query boolean

Uses default content-types: application/json application/xml

200 OK

Successful operation.

objectAccess: ObjectAccess
default

Unexpected error.

Sets access for the specified objects

PUT /ADSites/{ref}/Access

Tags: ADSites

Uses default content-types: application/json application/xml

ref

A reference to an object.

path string

Uses default content-types: application/json application/xml

204 No Content

Successful operation.

default

Unexpected error.

Gets all the property definitions for the specified object type

GET /ADSites/{ref}/PropertyDefinitions

Tags: ADSites
ref

A reference to an object.

path string

Uses default content-types: application/json application/xml

200 OK

Successful operation.

propertyDefinitions: object[]

List of property definitions for the object.

default

Unexpected error.

Adds a new custom property definition

POST /ADSites/{ref}/PropertyDefinitions

Tags: ADSites

Uses default content-types: application/json application/xml

ref

A reference to an object.

path string

Uses default content-types: application/json application/xml

204 No Content

Successful operation.

default

Unexpected error.

Removes the specified custom property definition

DELETE /ADSites/{ref}/PropertyDefinitions/{property}

Tags: ADSites
property

The name of the custom property definition.

path string
saveComment

Save comment text to associate with the action.

query string
ref

A reference to an object.

path string

Uses default content-types: application/json application/xml

204 No Content

Successful operation.

default

Unexpected error.

Gets the definition for a specified property of the given object type

GET /ADSites/{ref}/PropertyDefinitions/{property}

Tags: ADSites
property

The name of the property.

path string
ref

A reference to an object.

path string

Uses default content-types: application/json application/xml

200 OK

Successful operation.

propertyDefinition: PropertyDefinition
default

Unexpected error.

Modifies a custom property definition

PUT /ADSites/{ref}/PropertyDefinitions/{property}

Tags: ADSites

Uses default content-types: application/json application/xml

property

The name of the custom property definition.

path string
ref

A reference to an object.

path string

Uses default content-types: application/json application/xml

204 No Content

Successful operation.

default

Unexpected error.

Gets change requests

GET /ChangeRequests

Tags: ChangeRequests
includeChanges

Specifies whether changes should be included in the result.

query boolean
includeProcessedRequests

Specifies whether change requests that have already been processed should be included in the result.

query boolean
filter

Filtering criteria for the records returned.

query string #/parameters/filterParam
offset

Specifies the offset to use when listing the records. A value of 0 starts with the first record.

query integer (int64) , { x ∈ ℤ | x ≥ 0 } #/parameters/offsetParam
limit

The number of records to return.

query integer (int64) , { x ∈ ℤ | x ≥ 0 } #/parameters/limitParam
sortBy

The name of the field to sort by.

query string #/parameters/sortByParam
sortOrder

The sort order to use.

query string , x ∈ { Ascending , Descending } #/parameters/sortOrderParam

Uses default content-types: application/json application/xml

200 OK

Successful operation.

changeRequests: object[]

List of change requests.

totalResults: integer (int64) , { x ∈ ℤ | x ≥ 0 }

Total number of records in the result set.

default

Unexpected error.

Adds request for change(s)

POST /ChangeRequests

Tags: ChangeRequests

Uses default content-types: application/json application/xml

Uses default content-types: application/json application/xml

201 Created

Successful operation. Object created.

ref: ObjRef
default

Unexpected error.

Removes the specified object

DELETE /ChangeRequests/{changeRequestRef}

Tags: ChangeRequests
changeRequestRef

Reference to the object that should be removed.

path string
objType

The type of object to retrieve. If not specified, entries for all object types are retrieved.

query string , x ∈ { Unknown , Suite , DNSServer , DHCPServer , DNSZone , DNSView , Range , DHCPScope , IPAddress , DHCPReservation , DHCPAddressPool , DHCPGroup , ADSite , DNSRecord , User , Group , DHCPExclusion , DHCPFailoverPeer , DHCPLease , Device , Interface , Folder , ADSiteLink , AddressSpace , ADForest , ChangeRequest , Appliance , Role , CloudServiceAccount , CloudService , CloudAccountSubscription , CloudNetwork , Superscope } #/parameters/objTypeParam
forceRemoval

If possible, then force removal of object.

query boolean
saveComment

Save comment text to associate with the action.

query string

Uses default content-types: application/json application/xml

204 No Content

Successful operation.

default

Unexpected error.

Gets specified change request

GET /ChangeRequests/{changeRequestRef}

Tags: ChangeRequests
changeRequestRef

An object reference for the change request.

path string

Uses default content-types: application/json application/xml

200 OK

Successful operation.

changeRequest: ChangeRequest
default

Unexpected error.

Sets properties for the specified object

PUT /ChangeRequests/{changeRequestRef}

Tags: ChangeRequests

Uses default content-types: application/json application/xml

changeRequestRef

Reference to the object for which properties should be set.

path string

Uses default content-types: application/json application/xml

204 No Content

Successful operation.

default

Unexpected error.

Gets event history

GET /ChangeRequests/{objRef}/History

Tags: ChangeRequests
eventType

The type of event to retrieve. If not specified, entries for all event types are retrieved.

query string , x ∈ { Unknown , Creation , Modification , Deletion , Refresh , Error , Reference } #/parameters/eventTypeParam
objType

The type of object to retrieve. If not specified, entries for all object types are retrieved.

query string , x ∈ { Unknown , Suite , DNSServer , DHCPServer , DNSZone , DNSView , Range , DHCPScope , IPAddress , DHCPReservation , DHCPAddressPool , DHCPGroup , ADSite , DNSRecord , User , Group , DHCPExclusion , DHCPFailoverPeer , DHCPLease , Device , Interface , Folder , ADSiteLink , AddressSpace , ADForest , ChangeRequest , Appliance , Role , CloudServiceAccount , CloudService , CloudAccountSubscription , CloudNetwork , Superscope } #/parameters/objTypeParam
objRef

If specified, only history entries for the specified object will be retrieved.

path string
username

The login name of the user for which to retrieve history entries. If not specified, entries for all users are retrieved.

query string
startDate

Date of the first entry to retrieve.

query string (date-time) #/parameters/startDateParam
endDate

Date of the last entry to retrieve.

query string (date-time) #/parameters/endDateParam
filter

Filtering criteria for the records returned.

query string #/parameters/filterParam
limit

The number of records to return.

query integer (int64) , { x ∈ ℤ | x ≥ 0 } #/parameters/limitParam
offset

Specifies the offset to use when listing the records. A value of 0 starts with the first record.

query integer (int64) , { x ∈ ℤ | x ≥ 0 } #/parameters/offsetParam
sortBy

The name of the field to sort by.

query string #/parameters/sortByParam
sortOrder

The sort order to use.

query string , x ∈ { Ascending , Descending } #/parameters/sortOrderParam

Uses default content-types: application/json application/xml

200 OK

Successful operation.

events: object[]

List of events.

totalResults: integer (int64) , { x ∈ ℤ | x ≥ 0 }

Total number of records in the result set.

default

Unexpected error.

Gets access set for the specified object

GET /ChangeRequests/{ref}/Access

Tags: ChangeRequests
ref

A reference to the object.

path string
objType

The type of object to retrieve. If not specified, entries for all object types are retrieved.

query string , x ∈ { Unknown , Suite , DNSServer , DHCPServer , DNSZone , DNSView , Range , DHCPScope , IPAddress , DHCPReservation , DHCPAddressPool , DHCPGroup , ADSite , DNSRecord , User , Group , DHCPExclusion , DHCPFailoverPeer , DHCPLease , Device , Interface , Folder , ADSiteLink , AddressSpace , ADForest , ChangeRequest , Appliance , Role , CloudServiceAccount , CloudService , CloudAccountSubscription , CloudNetwork , Superscope } #/parameters/objTypeParam
identityRef

Object reference for a user or group. If specified, the command only retrieves access for the specified user or group.

query string
excludeBuiltinIdentities

Set to true to exclude access for builtin users and groups.

query boolean

Uses default content-types: application/json application/xml

200 OK

Successful operation.

objectAccess: ObjectAccess
default

Unexpected error.

Sets access for the specified objects

PUT /ChangeRequests/{ref}/Access

Tags: ChangeRequests

Uses default content-types: application/json application/xml

ref

A reference to an object.

path string

Uses default content-types: application/json application/xml

204 No Content

Successful operation.

default

Unexpected error.

Gets all the property definitions for the specified object type

GET /ChangeRequests/{ref}/PropertyDefinitions

Tags: ChangeRequests
ref

A reference to an object.

path string

Uses default content-types: application/json application/xml

200 OK

Successful operation.

propertyDefinitions: object[]

List of property definitions for the object.

default

Unexpected error.

Adds a new custom property definition

POST /ChangeRequests/{ref}/PropertyDefinitions

Tags: ChangeRequests

Uses default content-types: application/json application/xml

ref

A reference to an object.

path string

Uses default content-types: application/json application/xml

204 No Content

Successful operation.

default

Unexpected error.

Removes the specified custom property definition

DELETE /ChangeRequests/{ref}/PropertyDefinitions/{property}

Tags: ChangeRequests
property

The name of the custom property definition.

path string
saveComment

Save comment text to associate with the action.

query string
ref

A reference to an object.

path string

Uses default content-types: application/json application/xml

204 No Content

Successful operation.

default

Unexpected error.

Gets the definition for a specified property of the given object type

GET /ChangeRequests/{ref}/PropertyDefinitions/{property}

Tags: ChangeRequests
property

The name of the property.

path string
ref

A reference to an object.

path string

Uses default content-types: application/json application/xml

200 OK

Successful operation.

propertyDefinition: PropertyDefinition
default

Unexpected error.

Modifies a custom property definition

PUT /ChangeRequests/{ref}/PropertyDefinitions/{property}

Tags: ChangeRequests

Uses default content-types: application/json application/xml

property

The name of the custom property definition.

path string
ref

A reference to an object.

path string

Uses default content-types: application/json application/xml

204 No Content

Successful operation.

default

Unexpected error.

Gets a list of cloud networks

GET /CloudNetworks

Tags: CloudNetworks
filter

Filtering criteria for the records returned.

query string #/parameters/filterParam
offset

Specifies the offset to use when listing the records. A value of 0 starts with the first record.

query integer (int64) , { x ∈ ℤ | x ≥ 0 } #/parameters/offsetParam
limit

The number of records to return.

query integer (int64) , { x ∈ ℤ | x ≥ 0 } #/parameters/limitParam
sortBy

The name of the field to sort by.

query string #/parameters/sortByParam
sortOrder

The sort order to use.

query string , x ∈ { Ascending , Descending } #/parameters/sortOrderParam

Uses default content-types: application/json application/xml

200 OK

Successful operation.

cloudNetworks: object[]

List of cloud networks.

totalResults: integer (int64) , { x ∈ ℤ | x ≥ 0 }

Total number of records in the result set.

default

Unexpected error.

Adds a new cloud network

POST /CloudNetworks

Tags: CloudNetworks

Uses default content-types: application/json application/xml

Uses default content-types: application/json application/xml

201 Created

Successful operation. Object created.

ref: ObjRef
default

Unexpected error.

Removes the specified object

DELETE /CloudNetworks/{cloudNetworkRef}

Tags: CloudNetworks
cloudNetworkRef

Reference to the object that should be removed.

path string
objType

The type of object to retrieve. If not specified, entries for all object types are retrieved.

query string , x ∈ { Unknown , Suite , DNSServer , DHCPServer , DNSZone , DNSView , Range , DHCPScope , IPAddress , DHCPReservation , DHCPAddressPool , DHCPGroup , ADSite , DNSRecord , User , Group , DHCPExclusion , DHCPFailoverPeer , DHCPLease , Device , Interface , Folder , ADSiteLink , AddressSpace , ADForest , ChangeRequest , Appliance , Role , CloudServiceAccount , CloudService , CloudAccountSubscription , CloudNetwork , Superscope } #/parameters/objTypeParam
forceRemoval

If possible, then force removal of object.

query boolean
saveComment

Save comment text to associate with the action.

query string

Uses default content-types: application/json application/xml

204 No Content

Successful operation.

default

Unexpected error.

Gets a cloud network object based on the object reference

GET /CloudNetworks/{cloudNetworkRef}

Tags: CloudNetworks
cloudNetworkRef

An object reference for the cloud network.

path string

Uses default content-types: application/json application/xml

200 OK

Successful operation.

cloudNetwork: CloudNetwork
default

Unexpected error.

Sets properties for the specified object

PUT /CloudNetworks/{cloudNetworkRef}

Tags: CloudNetworks

Uses default content-types: application/json application/xml

cloudNetworkRef

Reference to the object for which properties should be set.

path string

Uses default content-types: application/json application/xml

204 No Content

Successful operation.

default

Unexpected error.

Gets ranges

GET /CloudNetworks/{cloudNetworkRef}/Ranges

Tags: CloudNetworks
filter

Filtering criteria for the records returned.

query string #/parameters/filterParam
folderRef

Reference to a folder from which to get ranges.

query string
adSiteRef

Reference to an AD Site from which to get ranges.

query string
cloudNetworkRef

Reference to a cloud network from which to get ranges.

path string
offset

Specifies the offset to use when listing the records. A value of 0 starts with the first record.

query integer (int64) , { x ∈ ℤ | x ≥ 0 } #/parameters/offsetParam
limit

The number of records to return.

query integer (int64) , { x ∈ ℤ | x ≥ 0 } #/parameters/limitParam
targetRef

Overrides "offset" and returns a page where "targetRef" is the first record. If target is not found with the given filter, "offset" is not overwritten.

query string
sortBy

The name of the field to sort by.

query string #/parameters/sortByParam
sortOrder

The sort order to use.

query string , x ∈ { Ascending , Descending } #/parameters/sortOrderParam

Uses default content-types: application/json application/xml

200 OK

Successful operation.

default

Unexpected error.

Places the specified subnets in the specified cloud network

POST /CloudNetworks/{cloudNetworkRef}/Ranges

Tags: CloudNetworks

Uses default content-types: application/json application/xml

cloudNetworkRef

Reference to the cloud network in which the subnets should be placed.

path string

Uses default content-types: application/json application/xml

204 No Content

Successful operation.

default

Unexpected error.

Removes the specified address ranges from their respective cloud networks

DELETE /CloudNetworks/{cloudNetworkRef}/Ranges/{rangeRef}

Tags: CloudNetworks
rangeRefs

References to the address ranges that should be removed from cloud networks.

query string
saveComment

Save comment text to associate with the action.

query string
cloudNetworkRef

A reference to an object.

path string
rangeRef

A reference to an object.

path string

Uses default content-types: application/json application/xml

204 No Content

Successful operation.

default

Unexpected error.

Gets event history

GET /CloudNetworks/{objRef}/History

Tags: CloudNetworks
eventType

The type of event to retrieve. If not specified, entries for all event types are retrieved.

query string , x ∈ { Unknown , Creation , Modification , Deletion , Refresh , Error , Reference } #/parameters/eventTypeParam
objType

The type of object to retrieve. If not specified, entries for all object types are retrieved.

query string , x ∈ { Unknown , Suite , DNSServer , DHCPServer , DNSZone , DNSView , Range , DHCPScope , IPAddress , DHCPReservation , DHCPAddressPool , DHCPGroup , ADSite , DNSRecord , User , Group , DHCPExclusion , DHCPFailoverPeer , DHCPLease , Device , Interface , Folder , ADSiteLink , AddressSpace , ADForest , ChangeRequest , Appliance , Role , CloudServiceAccount , CloudService , CloudAccountSubscription , CloudNetwork , Superscope } #/parameters/objTypeParam
objRef

If specified, only history entries for the specified object will be retrieved.

path string
username

The login name of the user for which to retrieve history entries. If not specified, entries for all users are retrieved.

query string
startDate

Date of the first entry to retrieve.

query string (date-time) #/parameters/startDateParam
endDate

Date of the last entry to retrieve.

query string (date-time) #/parameters/endDateParam
filter

Filtering criteria for the records returned.

query string #/parameters/filterParam
limit

The number of records to return.

query integer (int64) , { x ∈ ℤ | x ≥ 0 } #/parameters/limitParam
offset

Specifies the offset to use when listing the records. A value of 0 starts with the first record.

query integer (int64) , { x ∈ ℤ | x ≥ 0 } #/parameters/offsetParam
sortBy

The name of the field to sort by.

query string #/parameters/sortByParam
sortOrder

The sort order to use.

query string , x ∈ { Ascending , Descending } #/parameters/sortOrderParam

Uses default content-types: application/json application/xml

200 OK

Successful operation.

events: object[]

List of events.

totalResults: integer (int64) , { x ∈ ℤ | x ≥ 0 }

Total number of records in the result set.

default

Unexpected error.

Gets access set for the specified object

GET /CloudNetworks/{ref}/Access

Tags: CloudNetworks
ref

A reference to the object.

path string
objType

The type of object to retrieve. If not specified, entries for all object types are retrieved.

query string , x ∈ { Unknown , Suite , DNSServer , DHCPServer , DNSZone , DNSView , Range , DHCPScope , IPAddress , DHCPReservation , DHCPAddressPool , DHCPGroup , ADSite , DNSRecord , User , Group , DHCPExclusion , DHCPFailoverPeer , DHCPLease , Device , Interface , Folder , ADSiteLink , AddressSpace , ADForest , ChangeRequest , Appliance , Role , CloudServiceAccount , CloudService , CloudAccountSubscription , CloudNetwork , Superscope } #/parameters/objTypeParam
identityRef

Object reference for a user or group. If specified, the command only retrieves access for the specified user or group.

query string
excludeBuiltinIdentities

Set to true to exclude access for builtin users and groups.

query boolean

Uses default content-types: application/json application/xml

200 OK

Successful operation.

objectAccess: ObjectAccess
default

Unexpected error.

Sets access for the specified objects

PUT /CloudNetworks/{ref}/Access

Tags: CloudNetworks

Uses default content-types: application/json application/xml

ref

A reference to an object.

path string

Uses default content-types: application/json application/xml

204 No Content