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/{rangeRef}/DHCPReservations

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

POST /Ranges/{rangeRef}/DHCPReservations

Adds a new DHCP reservation

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 all available report definitions

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 items returned.

query string #/parameters/filterParam
offset

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

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

The number of items 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 items 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 , ServerGroup } #/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 , ServerGroup } #/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 items returned.

query string #/parameters/filterParam
limit

The number of items 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 item.

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 items 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 , ServerGroup } #/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

An optional 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

An optional 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

An optional 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

An optional 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

An optional 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 items returned.

query string #/parameters/filterParam
offset

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

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

The number of items 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 items 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 , ServerGroup } #/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 , ServerGroup } #/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 items returned.

query string #/parameters/filterParam
limit

The number of items 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 item.

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 items 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 , ServerGroup } #/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

An optional 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

An optional 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

An optional 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

An optional 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

An optional 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

An optional 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 items returned.

query string #/parameters/filterParam
offset

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

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

The number of items 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 items 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 , ServerGroup } #/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 items 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 item.

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

The number of items to return.

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

Overrides "offset" and returns a page where "targetRef" is the first item. 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 , ServerGroup } #/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 items returned.

query string #/parameters/filterParam
limit

The number of items 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 item.

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 items 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 , ServerGroup } #/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

An optional 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

An optional 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

An optional 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

An optional 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

An optional 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 items returned.

query string #/parameters/filterParam
offset

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

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

The number of items 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 items 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
errors: object[]

Errors that occurred while processing the change request.

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 , ServerGroup } #/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 , ServerGroup } #/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 items returned.

query string #/parameters/filterParam
limit

The number of items 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 item.

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 items 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 , ServerGroup } #/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

An optional 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

An optional 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

An optional 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

An optional 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

An optional 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 items returned.

query string #/parameters/filterParam
offset

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

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

The number of items 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 items 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 , ServerGroup } #/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 items 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 item.

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

The number of items to return.

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

Overrides "offset" and returns a page where "targetRef" is the first item. 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 , ServerGroup } #/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 items returned.

query string #/parameters/filterParam
limit

The number of items 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 item.

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 items 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 , ServerGroup } #/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

Successful operation.

default

Unexpected error.

Gets all the property definitions for the specified object type

GET /CloudNetworks/{ref}/PropertyDefinitions

Tags: CloudNetworks
ref

An optional 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 /CloudNetworks/{ref}/PropertyDefinitions

Tags: CloudNetworks

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

ref

An optional 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 /CloudNetworks/{ref}/PropertyDefinitions/{property}

Tags: CloudNetworks
property

The name of the custom property definition.

path string
saveComment

Save comment text to associate with the action.

query string
ref

An optional 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 /CloudNetworks/{ref}/PropertyDefinitions/{property}

Tags: CloudNetworks
property

The name of the property.

path string
ref

An optional 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 /CloudNetworks/{ref}/PropertyDefinitions/{property}

Tags: CloudNetworks

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

property

The name of the custom property definition.

path string
ref

An optional 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 service accounts

GET /CloudServiceAccounts

Tags: CloudServiceAccounts
filter

Filtering criteria for the items returned.

query string #/parameters/filterParam
offset

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

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

The number of items 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.

cloudServiceAccounts: object[]

List of cloud service accounts.

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

Total number of items in the result set.

default

Unexpected error.

Adds a new cloud service account

POST /CloudServiceAccounts

Tags: CloudServiceAccounts

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 /CloudServiceAccounts/{cloudRef}

Tags: CloudServiceAccounts
cloudRef

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 , ServerGroup } #/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 service account based on the object reference

GET /CloudServiceAccounts/{cloudRef}

Tags: CloudServiceAccounts
cloudRef

An object reference for the cloud service account.

path string

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

200 OK

Successful operation.

cloudServiceAccount: CloudServiceAccount
default

Unexpected error.

Sets properties for the specified object

PUT /CloudServiceAccounts/{cloudRef}

Tags: CloudServiceAccounts

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

cloudRef

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 a cloud object based on the object reference

GET /CloudServiceAccounts/{cloudRef}/Information

Tags: CloudServiceAccounts

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

The cloud service account to add.

cloudRef

An object reference for the cloud service account.

path string

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

200 OK

Successful operation.

cloudServiceInfo: CloudServiceInfo
default

Unexpected error.

Gets event history

GET /CloudServiceAccounts/{objRef}/History

Tags: CloudServiceAccounts
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 , ServerGroup } #/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 items returned.

query string #/parameters/filterParam
limit

The number of items 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 item.

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 items in the result set.

default

Unexpected error.

Gets access set for the specified object

GET /CloudServiceAccounts/{ref}/Access

Tags: CloudServiceAccounts
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 , ServerGroup } #/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 /CloudServiceAccounts/{ref}/Access

Tags: CloudServiceAccounts

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 /CloudServiceAccounts/{ref}/PropertyDefinitions

Tags: CloudServiceAccounts
ref

An optional 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 /CloudServiceAccounts/{ref}/PropertyDefinitions

Tags: CloudServiceAccounts

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

ref

An optional 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 /CloudServiceAccounts/{ref}/PropertyDefinitions/{property}

Tags: CloudServiceAccounts
property

The name of the custom property definition.

path string
saveComment

Save comment text to associate with the action.

query string
ref

An optional 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 /CloudServiceAccounts/{ref}/PropertyDefinitions/{property}

Tags: CloudServiceAccounts
property

The name of the property.

path string
ref

An optional 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 /CloudServiceAccounts/{ref}/PropertyDefinitions/{property}

Tags: CloudServiceAccounts

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

property

The name of the custom property definition.

path string
ref

An optional reference to an object.

path string

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

204 No Content

Successful operation.

default

Unexpected error.

Gets devices

GET /Devices

Tags: Devices
filter

Filtering criteria for the items returned.

query string #/parameters/filterParam
offset

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

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

The number of items 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.

devices: object[]

List of devices.

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

Total number of items in the result set.

default

Unexpected error.

Adds a new device

POST /Devices

Tags: Devices

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 /Devices/{deviceRef}

Tags: Devices
deviceRef

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 , ServerGroup } #/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 device

GET /Devices/{deviceRef}

Tags: Devices
deviceRef

The object reference for the device.

path string

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

200 OK

Successful operation.

device: Device
default

Unexpected error.

Sets properties for the specified object

PUT /Devices/{deviceRef}

Tags: Devices

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

deviceRef

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 /Devices/{objRef}/History

Tags: Devices
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 , ServerGroup } #/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 items returned.

query string #/parameters/filterParam
limit

The number of items 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 item.

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 items in the result set.

default

Unexpected error.

Gets access set for the specified object

GET /Devices/{ref}/Access

Tags: Devices
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 , ServerGroup } #/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 /Devices/{ref}/Access

Tags: Devices

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 /Devices/{ref}/PropertyDefinitions

Tags: Devices
ref

An optional 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 /Devices/{ref}/PropertyDefinitions

Tags: Devices

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

ref

An optional 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 /Devices/{ref}/PropertyDefinitions/{property}

Tags: Devices
property

The name of the custom property definition.

path string
saveComment

Save comment text to associate with the action.

query string
ref

An optional 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 /Devices/{ref}/PropertyDefinitions/{property}

Tags: Devices
property

The name of the property.

path string
ref

An optional 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 /Devices/{ref}/PropertyDefinitions/{property}

Tags: Devices

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

property

The name of the custom property definition.

path string
ref

An optional 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 object

DELETE /DHCPAddressPools/{dhcpAddressPoolRef}

Tags: DHCPAddressPools
dhcpAddressPoolRef

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 , ServerGroup } #/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 DHCP address pool

GET /DHCPAddressPools/{dhcpAddressPoolRef}

Tags: DHCPAddressPools
dhcpAddressPoolRef

An object reference for the DHCP address pool.

path string

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

200 OK

Successful operation.

dhcpAddressPool: DHCPAddressPool
default

Unexpected error.

Sets properties for the specified object

PUT /DHCPAddressPools/{dhcpAddressPoolRef}

Tags: DHCPAddressPools

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

dhcpAddressPoolRef

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 DHCP address pool permit list for the specified DHCP address pool

GET /DHCPAddressPools/{dhcpAddressPoolRef}/PermitList

Tags: DHCPAddressPools
dhcpAddressPoolRef

An object reference for the DHCP address pool from which to get the address pool permit list.

path string

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

200 OK

Successful operation.

dhcpAddressPoolPermits: object[]

List of DHCP address pool permits.

default

Unexpected error.

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

PUT /DHCPAddressPools/{dhcpAddressPoolRef}/PermitList

Tags: DHCPAddressPools

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

dhcpAddressPoolRef

Reference to the DHCP address pool for which to set the address pool permit list.

path string

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

204 No Content

Successful operation.

default

Unexpected error.

Removes the specified DHCP option definition from the specified DHCP server

DELETE /DHCPAddressPools/{dhcpServerRef}/OptionsDefinitions

Tags: DHCPAddressPools

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

The DHCP option definition to remove.

dhcpServerRef

The DHCP server from which the option definition should be removed.

path string
serviceType

DHCPv4 or DHCPv6, defaults to DHCPv4.

query string , x ∈ { DHCPv4 , DHCPv6 }
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 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)

GET /DHCPAddressPools/{dhcpServerRef}/OptionsDefinitions

Tags: DHCPAddressPools
dhcpServerRef

A reference to the object from which to get the DHCP option definitions.

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 , ServerGroup } #/parameters/objTypeParam
serviceType

DHCPv4 or DHCPv6, defaults to DHCPv4. Only applies to DHCP server.

query string , x ∈ { DHCPv4 , DHCPv6 }

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

200 OK

Successful operation.

dhcpOptionDefinitions: object[]

The option definitions.

default

Unexpected error.

Adds a new DHCP option definition on the specified DHCP server

POST /DHCPAddressPools/{dhcpServerRef}/OptionsDefinitions

Tags: DHCPAddressPools

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

dhcpServerRef

The DHCP server on which the option definition should be added.

path string

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

204 No Content

Successful operation.

default

Unexpected error.

Modifies the specified DHCP option definition on the specified DHCP server

PUT /DHCPAddressPools/{dhcpServerRef}/OptionsDefinitions

Tags: DHCPAddressPools

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

dhcpServerRef

The DHCP server on which the option definition should be modified.

path string

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

204 No Content

Successful operation.

default

Unexpected error.

Gets event history

GET /DHCPAddressPools/{objRef}/History

Tags: DHCPAddressPools
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 , ServerGroup } #/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 items returned.

query string #/parameters/filterParam
limit

The number of items 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 item.

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 items in the result set.

default

Unexpected error.

Gets access set for the specified object

GET /DHCPAddressPools/{ref}/Access

Tags: DHCPAddressPools
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 , ServerGroup } #/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 /DHCPAddressPools/{ref}/Access

Tags: DHCPAddressPools

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 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}/InheritedOptions

Tags: DHCPAddressPools
ref

A reference to the object for which to get inherited DHCP options.

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 , ServerGroup } #/parameters/objTypeParam
policyName

Name of a DHCP server or scope policy to get inherited options for. Only supported on Microsoft servers version 2012 and higher.

query string
serviceType

DHCPv4 or DHCPv6, defaults to DHCPv4.

query string , x ∈ { DHCPv4 , DHCPv6 }

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

200 OK

Successful operation.

inheritedDHCPOptions: object[]

The inherited DHCP options.

default

Unexpected error.

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)

GET /DHCPAddressPools/{ref}/Options

Tags: DHCPAddressPools
ref

A reference to the object from which to get the DHCP options.

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 , ServerGroup } #/parameters/objTypeParam
dhcpPolicyName

Name of a MS DHCP policy if applicable.

query string
serviceType

DHCPv4 or DHCPv6, defaults to DHCPv4.

query string , x ∈ { DHCPv4 , DHCPv6 }

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

200 OK

Successful operation.

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

Ticket used for concurrency. Sent back as part of call to SetDHCPOptions and, if there have been changes made to DHCP options for the object since the ticket was returned, the SetDHCPOptions call will fail.

dhcpOptions: object[]

The DHCP options.

default

Unexpected error.

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)

PUT /DHCPAddressPools/{ref}/Options

Tags: DHCPAddressPools

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

ref

Reference to the object for which to set the DHCP options.

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 /DHCPAddressPools/{ref}/PropertyDefinitions

Tags: DHCPAddressPools
ref

An optional 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 /DHCPAddressPools/{ref}/PropertyDefinitions

Tags: DHCPAddressPools

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

ref

An optional 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 /DHCPAddressPools/{ref}/PropertyDefinitions/{property}

Tags: DHCPAddressPools
property

The name of the custom property definition.

path string
saveComment

Save comment text to associate with the action.

query string
ref

An optional 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 /DHCPAddressPools/{ref}/PropertyDefinitions/{property}

Tags: DHCPAddressPools
property

The name of the property.

path string
ref

An optional 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 /DHCPAddressPools/{ref}/PropertyDefinitions/{property}

Tags: DHCPAddressPools

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

property

The name of the custom property definition.

path string
ref

An optional 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 object

DELETE /DHCPExclusions/{dhcpExclusionRef}

Tags: DHCPExclusions
dhcpExclusionRef

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 , ServerGroup } #/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 DHCP exclusion

GET /DHCPExclusions/{dhcpExclusionRef}

Tags: DHCPExclusions
dhcpExclusionRef

An object reference for the DHCP exclusion.

path string

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

200 OK

Successful operation.

dhcpExclusion: DHCPExclusion
default

Unexpected error.

Sets properties for the specified object

PUT /DHCPExclusions/{dhcpExclusionRef}

Tags: DHCPExclusions

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

dhcpExclusionRef

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 /DHCPExclusions/{objRef}/History

Tags: DHCPExclusions
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 , ServerGroup } #/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 items returned.

query string #/parameters/filterParam
limit

The number of items 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 item.

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 items in the result set.

default

Unexpected error.

Gets access set for the specified object

GET /DHCPExclusions/{ref}/Access

Tags: DHCPExclusions
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 , ServerGroup } #/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 /DHCPExclusions/{ref}/Access

Tags: DHCPExclusions

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 /DHCPExclusions/{ref}/PropertyDefinitions

Tags: DHCPExclusions
ref

An optional 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 /DHCPExclusions/{ref}/PropertyDefinitions

Tags: DHCPExclusions

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

ref

An optional 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 /DHCPExclusions/{ref}/PropertyDefinitions/{property}

Tags: DHCPExclusions
property

The name of the custom property definition.

path string
saveComment

Save comment text to associate with the action.

query string
ref

An optional 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 /DHCPExclusions/{ref}/PropertyDefinitions/{property}

Tags: DHCPExclusions
property

The name of the property.

path string
ref

An optional 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 /DHCPExclusions/{ref}/PropertyDefinitions/{property}

Tags: DHCPExclusions

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

property

The name of the custom property definition.

path string
ref

An optional 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 object

DELETE /DHCPGroups/{dhcpGroupRef}

Tags: DHCPGroups
dhcpGroupRef

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 , ServerGroup } #/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 DHCP group

GET /DHCPGroups/{dhcpGroupRef}

Tags: DHCPGroups
dhcpGroupRef

An object reference for the DHCP group.

path string

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

200 OK

Successful operation.

dhcpGroup: DHCPGroup
default

Unexpected error.

Sets properties for the specified object

PUT /DHCPGroups/{dhcpGroupRef}

Tags: DHCPGroups

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

dhcpGroupRef

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 DHCP option definition from the specified DHCP server

DELETE /DHCPGroups/{dhcpServerRef}/OptionsDefinitions

Tags: DHCPGroups

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

The DHCP option definition to remove.

dhcpServerRef

The DHCP server from which the option definition should be removed.

path string
serviceType

DHCPv4 or DHCPv6, defaults to DHCPv4.

query string , x ∈ { DHCPv4 , DHCPv6 }
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 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)

GET /DHCPGroups/{dhcpServerRef}/OptionsDefinitions

Tags: DHCPGroups
dhcpServerRef

A reference to the object from which to get the DHCP option definitions.

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 , ServerGroup } #/parameters/objTypeParam
serviceType

DHCPv4 or DHCPv6, defaults to DHCPv4. Only applies to DHCP server.

query string , x ∈ { DHCPv4 , DHCPv6 }

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

200 OK

Successful operation.

dhcpOptionDefinitions: object[]

The option definitions.

default

Unexpected error.

Adds a new DHCP option definition on the specified DHCP server

POST /DHCPGroups/{dhcpServerRef}/OptionsDefinitions

Tags: DHCPGroups

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

dhcpServerRef

The DHCP server on which the option definition should be added.

path string

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

204 No Content

Successful operation.

default

Unexpected error.

Modifies the specified DHCP option definition on the specified DHCP server

PUT /DHCPGroups/{dhcpServerRef}/OptionsDefinitions

Tags: DHCPGroups

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

dhcpServerRef

The DHCP server on which the option definition should be modified.

path string

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

204 No Content

Successful operation.

default

Unexpected error.

Gets event history

GET /DHCPGroups/{objRef}/History

Tags: DHCPGroups
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 , ServerGroup } #/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 items returned.

query string #/parameters/filterParam
limit

The number of items 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 item.

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 items in the result set.

default

Unexpected error.

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

GET /DHCPGroups/{ownerRef}/DHCPReservations

Tags: DHCPGroups
ownerRef

A reference to the DHCP server/group/scope owning the reservations. Specifying a DHCP server will only return reservations on a server level, not reservations on scope level.

path string
rangeRef

A reference to the DHCP range the reservations are in.

query 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 , ServerGroup } #/parameters/objTypeParam
filter

Filtering criteria for the items returned.

query string #/parameters/filterParam
offset

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

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

The number of items 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.

dhcpReservations: object[]

List of DHCP reservations.

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

Total number of items in the result set.

default

Unexpected error.

Adds a new DHCP reservation

POST /DHCPGroups/{ownerRef}/DHCPReservations

Tags: DHCPGroups

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

ownerRef

A reference to an object.

path string

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

201 Created

Successful operation. Object created.

ref: ObjRef
default

Unexpected error.

Gets access set for the specified object

GET /DHCPGroups/{ref}/Access

Tags: DHCPGroups
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 , ServerGroup } #/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 /DHCPGroups/{ref}/Access

Tags: DHCPGroups

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 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}/InheritedOptions

Tags: DHCPGroups
ref

A reference to the object for which to get inherited DHCP options.

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 , ServerGroup } #/parameters/objTypeParam
policyName

Name of a DHCP server or scope policy to get inherited options for. Only supported on Microsoft servers version 2012 and higher.

query string
serviceType

DHCPv4 or DHCPv6, defaults to DHCPv4.

query string , x ∈ { DHCPv4 , DHCPv6 }

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

200 OK

Successful operation.

inheritedDHCPOptions: object[]

The inherited DHCP options.

default

Unexpected error.

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)

GET /DHCPGroups/{ref}/Options

Tags: DHCPGroups
ref

A reference to the object from which to get the DHCP options.

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 , ServerGroup } #/parameters/objTypeParam
dhcpPolicyName

Name of a MS DHCP policy if applicable.

query string
serviceType

DHCPv4 or DHCPv6, defaults to DHCPv4.

query string , x ∈ { DHCPv4 , DHCPv6 }

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

200 OK

Successful operation.

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

Ticket used for concurrency. Sent back as part of call to SetDHCPOptions and, if there have been changes made to DHCP options for the object since the ticket was returned, the SetDHCPOptions call will fail.

dhcpOptions: object[]

The DHCP options.

default

Unexpected error.

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)

PUT /DHCPGroups/{ref}/Options

Tags: DHCPGroups

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

ref

Reference to the object for which to set the DHCP options.

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 /DHCPGroups/{ref}/PropertyDefinitions

Tags: DHCPGroups
ref

An optional 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 /DHCPGroups/{ref}/PropertyDefinitions

Tags: DHCPGroups

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

ref

An optional 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 /DHCPGroups/{ref}/PropertyDefinitions/{property}

Tags: DHCPGroups
property

The name of the custom property definition.

path string
saveComment

Save comment text to associate with the action.

query string
ref

An optional 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 /DHCPGroups/{ref}/PropertyDefinitions/{property}

Tags: DHCPGroups
property

The name of the property.

path string
ref

An optional 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 /DHCPGroups/{ref}/PropertyDefinitions/{property}

Tags: DHCPGroups

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

property

The name of the custom property definition.

path string
ref

An optional 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 object

DELETE /DHCPReservations/{dhcpReservationRef}

Tags: DHCPReservations
dhcpReservationRef

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 , ServerGroup } #/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 DHCP reservation

GET /DHCPReservations/{dhcpReservationRef}

Tags: DHCPReservations
dhcpReservationRef

An object reference for the DHCP reservation.

path string

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

200 OK

Successful operation.

dhcpReservation: DHCPReservation
default

Unexpected error.

Sets properties for the specified object

PUT /DHCPReservations/{dhcpReservationRef}

Tags: DHCPReservations

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

dhcpReservationRef

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 DHCP option definition from the specified DHCP server

DELETE /DHCPReservations/{dhcpServerRef}/OptionsDefinitions

Tags: DHCPReservations

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

The DHCP option definition to remove.

dhcpServerRef

The DHCP server from which the option definition should be removed.

path string
serviceType

DHCPv4 or DHCPv6, defaults to DHCPv4.

query string , x ∈ { DHCPv4 , DHCPv6 }
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 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)

GET /DHCPReservations/{dhcpServerRef}/OptionsDefinitions

Tags: DHCPReservations
dhcpServerRef

A reference to the object from which to get the DHCP option definitions.

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 , ServerGroup } #/parameters/objTypeParam
serviceType

DHCPv4 or DHCPv6, defaults to DHCPv4. Only applies to DHCP server.

query string , x ∈ { DHCPv4 , DHCPv6 }

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

200 OK

Successful operation.

dhcpOptionDefinitions: object[]

The option definitions.

default

Unexpected error.

Adds a new DHCP option definition on the specified DHCP server

POST /DHCPReservations/{dhcpServerRef}/OptionsDefinitions

Tags: DHCPReservations

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

dhcpServerRef

The DHCP server on which the option definition should be added.

path string

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

204 No Content

Successful operation.

default

Unexpected error.

Modifies the specified DHCP option definition on the specified DHCP server

PUT /DHCPReservations/{dhcpServerRef}/OptionsDefinitions

Tags: DHCPReservations

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

dhcpServerRef

The DHCP server on which the option definition should be modified.

path string

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

204 No Content

Successful operation.

default

Unexpected error.

Gets event history

GET /DHCPReservations/{objRef}/History

Tags: DHCPReservations
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 , ServerGroup } #/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 items returned.

query string #/parameters/filterParam
limit

The number of items 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 item.

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 items in the result set.

default

Unexpected error.

Gets access set for the specified object

GET /DHCPReservations/{ref}/Access

Tags: DHCPReservations
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 , ServerGroup } #/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 /DHCPReservations/{ref}/Access

Tags: DHCPReservations

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 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}/InheritedOptions

Tags: DHCPReservations
ref

A reference to the object for which to get inherited DHCP options.

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 , ServerGroup } #/parameters/objTypeParam
policyName

Name of a DHCP server or scope policy to get inherited options for. Only supported on Microsoft servers version 2012 and higher.

query string
serviceType

DHCPv4 or DHCPv6, defaults to DHCPv4.

query string , x ∈ { DHCPv4 , DHCPv6 }

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

200 OK

Successful operation.

inheritedDHCPOptions: object[]

The inherited DHCP options.

default

Unexpected error.

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)

GET /DHCPReservations/{ref}/Options

Tags: DHCPReservations
ref

A reference to the object from which to get the DHCP options.

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 , ServerGroup } #/parameters/objTypeParam
dhcpPolicyName

Name of a MS DHCP policy if applicable.

query string
serviceType

DHCPv4 or DHCPv6, defaults to DHCPv4.

query string , x ∈ { DHCPv4 , DHCPv6 }

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

200 OK

Successful operation.

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

Ticket used for concurrency. Sent back as part of call to SetDHCPOptions and, if there have been changes made to DHCP options for the object since the ticket was returned, the SetDHCPOptions call will fail.

dhcpOptions: object[]

The DHCP options.

default

Unexpected error.

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)

PUT /DHCPReservations/{ref}/Options

Tags: DHCPReservations

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

ref

Reference to the object for which to set the DHCP options.

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 /DHCPReservations/{ref}/PropertyDefinitions

Tags: DHCPReservations
ref

An optional 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 /DHCPReservations/{ref}/PropertyDefinitions

Tags: DHCPReservations

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

ref

An optional 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 /DHCPReservations/{ref}/PropertyDefinitions/{property}

Tags: DHCPReservations
property

The name of the custom property definition.

path string
saveComment

Save comment text to associate with the action.

query string
ref

An optional 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 /DHCPReservations/{ref}/PropertyDefinitions/{property}

Tags: DHCPReservations
property

The name of the property.

path string
ref

An optional 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 /DHCPReservations/{ref}/PropertyDefinitions/{property}

Tags: DHCPReservations

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

property

The name of the custom property definition.

path string
ref

An optional reference to an object.

path string

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

204 No Content

Successful operation.

default

Unexpected error.

Gets DHCP scopes

GET /DHCPScopes

Tags: DHCPScopes
filter

Filtering criteria for the items returned.

query string #/parameters/filterParam
folderRef

Reference to a folder from which to get scopes.

query string
offset

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

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

The number of items 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.

dhcpScopes: object[]

List of DHCP scopes.

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

Total number of items in the result set.

default

Unexpected error.

Adds a new DHCP scope

POST /DHCPScopes

Tags: DHCPScopes

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 /DHCPScopes/{dhcpScopeRef}

Tags: DHCPScopes
dhcpScopeRef

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 , ServerGroup } #/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 DHCP scope

GET /DHCPScopes/{dhcpScopeRef}

Tags: DHCPScopes
dhcpScopeRef

An object reference for the DHCP scope.

path string

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

200 OK

Successful operation.

dhcpScope: DHCPScope
default

Unexpected error.

Sets properties for the specified object

PUT /DHCPScopes/{dhcpScopeRef}

Tags: DHCPScopes

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

dhcpScopeRef

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 DHCP address pools

GET /DHCPScopes/{dhcpScopeRef}/DHCPAddressPools

Tags: DHCPScopes
dhcpScopeRef

A reference to the scope containing the address pool(s).

path string
filter

Filtering criteria for the items returned.

query string #/parameters/filterParam
offset

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

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

The number of items 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.

dhcpAddressPools: object[]

List of DHCP address pools.

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

Total number of items in the result set.

default

Unexpected error.

Adds a new DHCP address pool

POST /DHCPScopes/{dhcpScopeRef}/DHCPAddressPools

Tags: DHCPScopes

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

dhcpScopeRef

A reference to an object.

path string

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

201 Created

Successful operation. Object created.

ref: ObjRef
default

Unexpected error.

Gets DHCP exclusions

GET /DHCPScopes/{dhcpScopeRef}/DHCPExclusions

Tags: DHCPScopes
dhcpScopeRef

A reference to the scope containing the exclusion(s).

path string
filter

Filtering criteria for the items returned.

query string #/parameters/filterParam
offset

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

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

The number of items 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.

dhcpExclusions: object[]

List of DHCP exclusions.

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

Total number of items in the result set.

default

Unexpected error.

Adds a new DHCP exclusion

POST /DHCPScopes/{dhcpScopeRef}/DHCPExclusions

Tags: DHCPScopes

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

dhcpScopeRef

A reference to an object.

path string

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

201 Created

Successful operation. Object created.

ref: ObjRef
default

Unexpected error.

Gets DHCP leases from the specified DHCP scope

GET /DHCPScopes/{dhcpScopeRef}/Leases

Tags: DHCPScopes
dhcpScopeRef

A reference to the scope containing the leases.

path string
filter

Filtering criteria for the items returned.

query string #/parameters/filterParam
offset

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

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

The number of items 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.

dhcpLeases: object[]

List of DHCP leases.

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

Total number of items in the result set.

default

Unexpected error.

Adds a new DHCP lease

POST /DHCPScopes/{dhcpScopeRef}/Leases

Tags: DHCPScopes

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

dhcpScopeRef

A reference to an object.

path string

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

204 No Content

Successful operation.

default

Unexpected error.

Releases the specified DHCP lease

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

Tags: DHCPScopes
dhcpScopeRef

Reference to the DHCP scope from which the lease should be released.

path string
lease

IP address of the lease.

path 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.

Removes the specified DHCP option definition from the specified DHCP server

DELETE /DHCPScopes/{dhcpServerRef}/OptionsDefinitions

Tags: DHCPScopes

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

The DHCP option definition to remove.

dhcpServerRef

The DHCP server from which the option definition should be removed.

path string
serviceType

DHCPv4 or DHCPv6, defaults to DHCPv4.

query string , x ∈ { DHCPv4 , DHCPv6 }
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 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)

GET /DHCPScopes/{dhcpServerRef}/OptionsDefinitions

Tags: DHCPScopes
dhcpServerRef

A reference to the object from which to get the DHCP option definitions.

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 , ServerGroup } #/parameters/objTypeParam
serviceType

DHCPv4 or DHCPv6, defaults to DHCPv4. Only applies to DHCP server.

query string , x ∈ { DHCPv4 , DHCPv6 }

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

200 OK

Successful operation.

dhcpOptionDefinitions: object[]

The option definitions.

default

Unexpected error.

Adds a new DHCP option definition on the specified DHCP server

POST /DHCPScopes/{dhcpServerRef}/OptionsDefinitions

Tags: DHCPScopes

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

dhcpServerRef

The DHCP server on which the option definition should be added.

path string

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

204 No Content

Successful operation.

default

Unexpected error.

Modifies the specified DHCP option definition on the specified DHCP server

PUT /DHCPScopes/{dhcpServerRef}/OptionsDefinitions

Tags: DHCPScopes

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

dhcpServerRef

The DHCP server on which the option definition should be modified.

path string

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

204 No Content

Successful operation.

default

Unexpected error.

Gets event history

GET /DHCPScopes/{objRef}/History

Tags: DHCPScopes
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 , ServerGroup } #/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 items returned.

query string #/parameters/filterParam
limit

The number of items 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 item.

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 items in the result set.

default

Unexpected error.

Gets next free reservable address from the specified scope

GET /DHCPScopes/{objRef}/NextFreeReservationAddress

Tags: DHCPScopes
objRef

A reference to the scope from which to return the free address.

path string
startAddress

The starting address to use when looking for the next free address.

query string
considerExclusionRange

Determines whether to look for a free address in an excluded range inside the scope.

query boolean

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

200 OK

Successful operation.

address: string

The next reservable IP address in the scope.

default

Unexpected error.

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

GET /DHCPScopes/{ownerRef}/DHCPGroups

Tags: DHCPScopes
ownerRef

A reference to the object containing the DHCP group(s).

path string
filter

Filtering criteria for the items returned.

query string #/parameters/filterParam
offset

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

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

The number of items 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.

dhcpGroups: object[]

List of DHCP groups.

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

Total number of items in the result set.

default

Unexpected error.

Creates a DHCP group

POST /DHCPScopes/{ownerRef}/DHCPGroups

Tags: DHCPScopes

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

ownerRef

A reference to an object.

path string

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

201 Created

Successful operation. Object created.

ref: ObjRef
default

Unexpected error.

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

GET /DHCPScopes/{ownerRef}/DHCPReservations

Tags: DHCPScopes
ownerRef

A reference to the DHCP server/group/scope owning the reservations. Specifying a DHCP server will only return reservations on a server level, not reservations on scope level.

path string
rangeRef

A reference to the DHCP range the reservations are in.

query 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 , ServerGroup } #/parameters/objTypeParam
filter

Filtering criteria for the items returned.

query string #/parameters/filterParam
offset

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

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

The number of items 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.

dhcpReservations: object[]

List of DHCP reservations.

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

Total number of items in the result set.

default

Unexpected error.

Adds a new DHCP reservation

POST /DHCPScopes/{ownerRef}/DHCPReservations

Tags: DHCPScopes

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

ownerRef

A reference to an object.

path string

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

201 Created

Successful operation. Object created.

ref: ObjRef
default

Unexpected error.

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

GET /DHCPScopes/{ownerRef}/Policies

Tags: DHCPScopes
ownerRef

A reference to the DHCP server/scope containing the DHCP policies.

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 , ServerGroup } #/parameters/objTypeParam

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

200 OK

Successful operation.

dhcpPolicies: object[]

The DHCP policies retrieved.

default

Unexpected error.

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

POST /DHCPScopes/{ownerRef}/Policies

Tags: DHCPScopes

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

ownerRef

A reference to the DHCP server/scope to which the DHCP policy should be added.

path string

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

204 No Content

Successful operation.

default

Unexpected error.

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

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

Tags: DHCPScopes
ownerRef

A reference to the DHCP server/scope containing the DHCP policy.

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 , ServerGroup } #/parameters/objTypeParam
dhcpPolicyName

The DHCP policy to remove.

path 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.

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

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

Tags: DHCPScopes

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

ownerRef

A reference to the DHCP server/scope containing the DHCP policies.

path string
dhcpPolicyName

The DHCP policy to modify.

path string

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

204 No Content

Successful operation.

default

Unexpected error.

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

GET /DHCPScopes/{ownerRef}/PolicyEnforcement

Tags: DHCPScopes
ownerRef

A reference to the DHCP server/scope for which the DHCP policy enforcement is set.

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 , ServerGroup } #/parameters/objTypeParam

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

200 OK

Successful operation.

enforcing: boolean

Specifies whether DHCP policies are being enforced.

default

Unexpected error.

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

PUT /DHCPScopes/{ownerRef}/PolicyEnforcement

Tags: DHCPScopes

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

ownerRef

A reference to the DHCP server/scope for which the DHCP policy enforcement is set.

path string

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

204 No Content

Successful operation.

default

Unexpected error.

Gets access set for the specified object

GET /DHCPScopes/{ref}/Access

Tags: DHCPScopes
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 , ServerGroup } #/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 /DHCPScopes/{ref}/Access

Tags: DHCPScopes

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 objects from the folder they are in

DELETE /DHCPScopes/{ref}/Folders

Tags: DHCPScopes
folderRef

Reference to the folder from which the objects should be removed.

query 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 folder that contains the specified object

GET /DHCPScopes/{ref}/Folders

Tags: DHCPScopes
ref

A reference to the object for which to retrieve the containing folder.

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 , ServerGroup } #/parameters/objTypeParam

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

200 OK

Successful operation.

folder: ObjRef
default

Unexpected error.

Removes the specified objects from the folder they are in

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

Tags: DHCPScopes
folderRef

Reference to the folder from which the objects should be removed.

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.

Places the specified objects in the specified folder

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

Tags: DHCPScopes

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

folderRef

Reference to the folder in which the objects should be placed.

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 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/{ref}/InheritedOptions

Tags: DHCPScopes
ref

A reference to the object for which to get inherited DHCP options.

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 , ServerGroup } #/parameters/objTypeParam
policyName

Name of a DHCP server or scope policy to get inherited options for. Only supported on Microsoft servers version 2012 and higher.

query string
serviceType

DHCPv4 or DHCPv6, defaults to DHCPv4.

query string , x ∈ { DHCPv4 , DHCPv6 }

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

200 OK

Successful operation.

inheritedDHCPOptions: object[]

The inherited DHCP options.

default

Unexpected error.

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)

GET /DHCPScopes/{ref}/Options

Tags: DHCPScopes
ref

A reference to the object from which to get the DHCP options.

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 , ServerGroup } #/parameters/objTypeParam
dhcpPolicyName

Name of a MS DHCP policy if applicable.

query string
serviceType

DHCPv4 or DHCPv6, defaults to DHCPv4.

query string , x ∈ { DHCPv4 , DHCPv6 }

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

200 OK

Successful operation.

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

Ticket used for concurrency. Sent back as part of call to SetDHCPOptions and, if there have been changes made to DHCP options for the object since the ticket was returned, the SetDHCPOptions call will fail.

dhcpOptions: object[]

The DHCP options.

default

Unexpected error.

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)

PUT /DHCPScopes/{ref}/Options

Tags: DHCPScopes

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

ref

Reference to the object for which to set the DHCP options.

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 /DHCPScopes/{ref}/PropertyDefinitions

Tags: DHCPScopes
ref

An optional 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 /DHCPScopes/{ref}/PropertyDefinitions

Tags: DHCPScopes

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

ref

An optional 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 /DHCPScopes/{ref}/PropertyDefinitions/{property}

Tags: DHCPScopes
property

The name of the custom property definition.

path string
saveComment

Save comment text to associate with the action.

query string
ref

An optional 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 /DHCPScopes/{ref}/PropertyDefinitions/{property}

Tags: DHCPScopes
property

The name of the property.

path string
ref

An optional 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 /DHCPScopes/{ref}/PropertyDefinitions/{property}

Tags: DHCPScopes

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

property

The name of the custom property definition.

path string
ref

An optional reference to an object.

path string

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

204 No Content

Successful operation.

default

Unexpected error.

Gets DHCP servers

GET /DHCPServers

Tags: DHCPServers
filter

Filtering criteria for the items returned.

query string #/parameters/filterParam
offset

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

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

The number of items 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.

dhcpServers: object[]

List of DHCP servers.

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

Total number of items in the result set.

default

Unexpected error.

Adds a new DHCP server

POST /DHCPServers

Tags: DHCPServers

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

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

201 Created

Successful operation. Object created.

ref: ObjRef
warning: string

Warning message returned if the added DHCP server is e.g. of an old or unknown version.

default

Unexpected error.

Removes the specified object

DELETE /DHCPServers/{dhcpServerRef}

Tags: DHCPServers
dhcpServerRef

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 , ServerGroup } #/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 DHCP server

GET /DHCPServers/{dhcpServerRef}

Tags: DHCPServers
dhcpServerRef

An object reference for the DHCP server.

path string

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

200 OK

Successful operation.

dhcpServer: DHCPServer
default

Unexpected error.

Sets properties for the specified object

PUT /DHCPServers/{dhcpServerRef}

Tags: DHCPServers

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

dhcpServerRef

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 DHCP class names from the specified DHCP server

GET /DHCPServers/{dhcpServerRef}/ClassNames

Tags: DHCPServers
dhcpServerRef

An object reference for the DHCP server.

path string

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

200 OK

Successful operation.

dhcpClassNames: string[]

An array of DHCP class names.

string
default

Unexpected error.

Get all DHCP failover relationships from specified DHCP server

GET /DHCPServers/{dhcpServerRef}/FailoverRelationships

Tags: DHCPServers
dhcpServerRef

An object reference for the DHCP server.

path string

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

200 OK

Successful operation.

dhcpFailoverRelationships: object[]

The DHCP failover relationships retrieved.

default

Unexpected error.

Adds a DHCP failover relationship

POST /DHCPServers/{dhcpServerRef}/FailoverRelationships

Tags: DHCPServers

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

dhcpServerRef

A reference to an object.

path string

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

204 No Content

Successful operation.

default

Unexpected error.

Remove a DHCP failover relationship

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

Tags: DHCPServers

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

An array of DHCP failover relationships to remove.

saveComment

Save comment text to associate with the action.

query string
dhcpServerRef

A reference to an object.

path string
dhcpFailoverRelationshipName path string

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

204 No Content

Successful operation.

default

Unexpected error.

Get a DHCP failover relationship

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

Tags: DHCPServers
dhcpServerRef

An object reference for the DHCP server.

path string
dhcpFailoverRelationshipName

The DHCP failover relationship to retrieve.

path string

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

200 OK

Successful operation.

dhcpFailoverRelationship: DHCPFailoverRelationship
default

Unexpected error.

Removes the specified DHCP option definition from the specified DHCP server

DELETE /DHCPServers/{dhcpServerRef}/OptionsDefinitions

Tags: DHCPServers

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

The DHCP option definition to remove.

dhcpServerRef

The DHCP server from which the option definition should be removed.

path string
serviceType

DHCPv4 or DHCPv6, defaults to DHCPv4.

query string , x ∈ { DHCPv4 , DHCPv6 }
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 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)

GET /DHCPServers/{dhcpServerRef}/OptionsDefinitions

Tags: DHCPServers
dhcpServerRef

A reference to the object from which to get the DHCP option definitions.

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 , ServerGroup } #/parameters/objTypeParam
serviceType

DHCPv4 or DHCPv6, defaults to DHCPv4. Only applies to DHCP server.

query string , x ∈ { DHCPv4 , DHCPv6 }

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

200 OK

Successful operation.

dhcpOptionDefinitions: object[]

The option definitions.

default

Unexpected error.

Adds a new DHCP option definition on the specified DHCP server

POST /DHCPServers/{dhcpServerRef}/OptionsDefinitions

Tags: DHCPServers

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

dhcpServerRef

The DHCP server on which the option definition should be added.

path string

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

204 No Content

Successful operation.

default

Unexpected error.

Modifies the specified DHCP option definition on the specified DHCP server

PUT /DHCPServers/{dhcpServerRef}/OptionsDefinitions

Tags: DHCPServers

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

dhcpServerRef

The DHCP server on which the option definition should be modified.

path string

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

204 No Content

Successful operation.

default

Unexpected error.

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

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

Tags: DHCPServers
dhcpServerRef

An object reference for the DHCP server.

path string
dhcpClassName

The name of the DHCP class for which to retrieve the subclasses.

path string

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

200 OK

Successful operation.

dhcpSubclasses: string[]

An array of DHCP subclasses.

string
default

Unexpected error.

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

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

Tags: DHCPServers

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

dhcpServerRef

Reference to the DHCP server on which the DHCP subclasses should be set.

path string
dhcpClassName

The name of the DHCP class for which the DHCP subclasses should be set.

path string

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

204 No Content

Successful operation.

default

Unexpected error.

Gets DHCP vendor and user classes from the specified DHCP server

GET /DHCPServers/{dhcpServerRef}/VendorAndUserClasses

Tags: DHCPServers
dhcpServerRef

An object reference for the DHCP server.

path string

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

200 OK

Successful operation.

dhcpVendorClasses: object[]

An array of DHCP vendor classes.

dhcpUserClasses: object[]

An array of DHCP user classes.

default

Unexpected error.

Gets event history

GET /DHCPServers/{objRef}/History

Tags: DHCPServers
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 , ServerGroup } #/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 items returned.

query string #/parameters/filterParam
limit

The number of items 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 item.

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 items in the result set.

default

Unexpected error.

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

GET /DHCPServers/{ownerRef}/DHCPGroups

Tags: DHCPServers
ownerRef

A reference to the object containing the DHCP group(s).

path string
filter

Filtering criteria for the items returned.

query string #/parameters/filterParam
offset

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

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

The number of items 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.

dhcpGroups: object[]

List of DHCP groups.

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

Total number of items in the result set.

default

Unexpected error.

Creates a DHCP group

POST /DHCPServers/{ownerRef}/DHCPGroups

Tags: DHCPServers

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

ownerRef

A reference to an object.

path string

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

201 Created

Successful operation. Object created.

ref: ObjRef
default

Unexpected error.

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

GET /DHCPServers/{ownerRef}/DHCPReservations

Tags: DHCPServers
ownerRef

A reference to the DHCP server/group/scope owning the reservations. Specifying a DHCP server will only return reservations on a server level, not reservations on scope level.

path string
rangeRef

A reference to the DHCP range the reservations are in.

query 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 , ServerGroup } #/parameters/objTypeParam
filter

Filtering criteria for the items returned.

query string #/parameters/filterParam
offset

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

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

The number of items 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.

dhcpReservations: object[]

List of DHCP reservations.

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

Total number of items in the result set.

default

Unexpected error.

Adds a new DHCP reservation

POST /DHCPServers/{ownerRef}/DHCPReservations

Tags: DHCPServers

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

ownerRef

A reference to an object.

path string

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

201 Created

Successful operation. Object created.

ref: ObjRef
default

Unexpected error.

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

GET /DHCPServers/{ownerRef}/Policies

Tags: DHCPServers
ownerRef

A reference to the DHCP server/scope containing the DHCP policies.

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 , ServerGroup } #/parameters/objTypeParam

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

200 OK

Successful operation.

dhcpPolicies: object[]

The DHCP policies retrieved.

default

Unexpected error.

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

POST /DHCPServers/{ownerRef}/Policies

Tags: DHCPServers

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

ownerRef

A reference to the DHCP server/scope to which the DHCP policy should be added.

path string

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

204 No Content

Successful operation.

default

Unexpected error.

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

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

Tags: DHCPServers
ownerRef

A reference to the DHCP server/scope containing the DHCP policy.

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 , ServerGroup } #/parameters/objTypeParam
dhcpPolicyName

The DHCP policy to remove.

path 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.

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

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

Tags: DHCPServers

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

ownerRef

A reference to the DHCP server/scope containing the DHCP policies.

path string
dhcpPolicyName

The DHCP policy to modify.

path string

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

204 No Content

Successful operation.

default

Unexpected error.

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

GET /DHCPServers/{ownerRef}/PolicyEnforcement

Tags: DHCPServers
ownerRef

A reference to the DHCP server/scope for which the DHCP policy enforcement is set.

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 , ServerGroup } #/parameters/objTypeParam

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

200 OK

Successful operation.

enforcing: boolean

Specifies whether DHCP policies are being enforced.

default

Unexpected error.

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

PUT /DHCPServers/{ownerRef}/PolicyEnforcement

Tags: DHCPServers

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

ownerRef

A reference to the DHCP server/scope for which the DHCP policy enforcement is set.

path string

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

204 No Content

Successful operation.

default

Unexpected error.

Gets access set for the specified object

GET /DHCPServers/{ref}/Access

Tags: DHCPServers
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 , ServerGroup } #/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 /DHCPServers/{ref}/Access

Tags: DHCPServers

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 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}/InheritedOptions

Tags: DHCPServers
ref

A reference to the object for which to get inherited DHCP options.

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 , ServerGroup } #/parameters/objTypeParam
policyName

Name of a DHCP server or scope policy to get inherited options for. Only supported on Microsoft servers version 2012 and higher.

query string
serviceType

DHCPv4 or DHCPv6, defaults to DHCPv4.

query string , x ∈ { DHCPv4 , DHCPv6 }

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

200 OK

Successful operation.

inheritedDHCPOptions: object[]

The inherited DHCP options.

default

Unexpected error.

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)

GET /DHCPServers/{ref}/Options

Tags: DHCPServers
ref

A reference to the object from which to get the DHCP options.

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 , ServerGroup } #/parameters/objTypeParam
dhcpPolicyName

Name of a MS DHCP policy if applicable.

query string
serviceType

DHCPv4 or DHCPv6, defaults to DHCPv4.

query string , x ∈ { DHCPv4 , DHCPv6 }

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

200 OK

Successful operation.

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

Ticket used for concurrency. Sent back as part of call to SetDHCPOptions and, if there have been changes made to DHCP options for the object since the ticket was returned, the SetDHCPOptions call will fail.

dhcpOptions: object[]

The DHCP options.

default

Unexpected error.

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)

PUT /DHCPServers/{ref}/Options

Tags: DHCPServers

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

ref

Reference to the object for which to set the DHCP options.

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 /DHCPServers/{ref}/PropertyDefinitions

Tags: DHCPServers
ref

An optional 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 /DHCPServers/{ref}/PropertyDefinitions

Tags: DHCPServers

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

ref

An optional 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 /DHCPServers/{ref}/PropertyDefinitions/{property}

Tags: DHCPServers
property

The name of the custom property definition.

path string
saveComment

Save comment text to associate with the action.

query string
ref

An optional 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 /DHCPServers/{ref}/PropertyDefinitions/{property}

Tags: DHCPServers
property

The name of the property.

path string
ref

An optional 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 /DHCPServers/{ref}/PropertyDefinitions/{property}

Tags: DHCPServers

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

property

The name of the custom property definition.

path string
ref

An optional reference to an object.

path string

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

204 No Content

Successful operation.

default

Unexpected error.

Adds multiple new DNS records

POST /DNSRecords

Tags: DNSRecords

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

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

201 Created

Successful operation. Object created.

objRefs: object[]

References to the added DNS records. If a record was not successfully added, the reference returned for that record will be {#0-#0}.

errors: string[]

Error messages. One error message is generated for each record that is not added.

string
default

Unexpected error.

Removes the specified object

DELETE /DNSRecords/{dnsRecordRef}

Tags: DNSRecords
dnsRecordRef

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 , ServerGroup } #/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 DNS record

GET /DNSRecords/{dnsRecordRef}

Tags: DNSRecords
dnsRecordRef

An object reference for the DNS record.

path string

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

200 OK

Successful operation.

dnsRecord: DNSRecord
default

Unexpected error.

Sets properties for the specified object

PUT /DNSRecords/{dnsRecordRef}

Tags: DNSRecords

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

dnsRecordRef

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 object

DELETE /DNSRecords/{dnsRecordRef}/RelatedDNSRecords

Tags: DNSRecords
dnsRecordRef

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 , ServerGroup } #/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 DNS records related to the specified DNS record (which must be either an A or AAAA record)

GET /DNSRecords/{dnsRecordRef}/RelatedDNSRecords

Tags: DNSRecords
dnsRecordRef

An object reference for the DNS address record for which to find associated records.

path string

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

200 OK

Successful operation.

dnsRecords: object[]

An array of records associated with the address record.

default

Unexpected error.

Gets event history

GET /DNSRecords/{objRef}/History

Tags: DNSRecords
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 , ServerGroup } #/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 items returned.

query string #/parameters/filterParam
limit

The number of items 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 item.

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 items in the result set.

default

Unexpected error.

Gets access set for the specified object

GET /DNSRecords/{ref}/Access

Tags: DNSRecords
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 , ServerGroup } #/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 /DNSRecords/{ref}/Access

Tags: DNSRecords

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 /DNSRecords/{ref}/PropertyDefinitions

Tags: DNSRecords
ref

An optional 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 /DNSRecords/{ref}/PropertyDefinitions

Tags: DNSRecords

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

ref

An optional 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 /DNSRecords/{ref}/PropertyDefinitions/{property}

Tags: DNSRecords
property

The name of the custom property definition.

path string
saveComment

Save comment text to associate with the action.

query string
ref

An optional 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 /DNSRecords/{ref}/PropertyDefinitions/{property}

Tags: DNSRecords
property

The name of the property.

path string
ref

An optional 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 /DNSRecords/{ref}/PropertyDefinitions/{property}

Tags: DNSRecords

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

property

The name of the custom property definition.

path string
ref

An optional reference to an object.

path string

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

204 No Content

Successful operation.

default

Unexpected error.

Gets DNS servers

GET /DNSServers

Tags: DNSServers
filter

Filtering criteria for the items returned.

query string #/parameters/filterParam
offset

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

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

The number of items 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.

dnsServers: object[]

List of DNS servers.

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

Total number of items in the result set.

default

Unexpected error.

Adds a new DNS server

POST /DNSServers

Tags: DNSServers

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 /DNSServers/{dnsServerRef}

Tags: DNSServers
dnsServerRef

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 , ServerGroup } #/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 DNS server

GET /DNSServers/{dnsServerRef}

Tags: DNSServers
dnsServerRef

An object reference for the DNS server.

path string

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

200 OK

Successful operation.

dnsServer: DNSServer
default

Unexpected error.

Sets properties for the specified object

PUT /DNSServers/{dnsServerRef}

Tags: DNSServers

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

dnsServerRef

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 AD partitions from the specified DNS server

GET /DNSServers/{dnsServerRef}/ADPartitions

Tags: DNSServers
dnsServerRef

A reference to the DNS server from which to retrieve the Active Directory partitions.

path string

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

200 OK

Successful operation.

adPartitions: string[]

List of Active Directory partitions.

string
default

Unexpected error.

Gets DNS views

GET /DNSServers/{dnsServerRef}/DNSViews

Tags: DNSServers
dnsServerRef

A reference to the DNS server.

path string
filter

Filtering criteria for the items returned.

query string #/parameters/filterParam
offset

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

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

The number of items 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.

dnsViews: object[]

List of DNS server views.

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

Total number of items in the result set.

default

Unexpected error.

Gets DNS zones

GET /DNSServers/{dnsServerRef}/DNSZones

Tags: DNSServers
filter

Filtering criteria for the items returned.

query string #/parameters/filterParam
folderRef

Only return zones within the specified folder.

query string
dnsViewRef

Only return zones within the specified view.

query string
dnsServerRef

Only return zones on the specified server.

path string
targetRef

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

query string
offset

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

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

The number of items 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.

default

Unexpected error.

Gets options for specified DNS server

GET /DNSServers/{dnsServerRef}/Options

Tags: DNSServers
dnsServerRef

An object reference for the DNS server.

path string

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

200 OK

Successful operation.

dnsServerOptions: DNSServerOptions
default

Unexpected error.

Updates server options for the specified DNS server

PUT /DNSServers/{dnsServerRef}/Options

Tags: DNSServers

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

dnsServerRef

An object reference for the DNS server.

path string

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

204 No Content

Successful operation.

default

Unexpected error.

Gets event history

GET /DNSServers/{objRef}/History

Tags: DNSServers
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 , ServerGroup } #/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 items returned.

query string #/parameters/filterParam
limit

The number of items 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 item.

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 items in the result set.

default

Unexpected error.

Gets access set for the specified object

GET /DNSServers/{ref}/Access

Tags: DNSServers
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 , ServerGroup } #/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 /DNSServers/{ref}/Access

Tags: DNSServers

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 /DNSServers/{ref}/PropertyDefinitions

Tags: DNSServers
ref

An optional 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 /DNSServers/{ref}/PropertyDefinitions

Tags: DNSServers

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

ref

An optional 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 /DNSServers/{ref}/PropertyDefinitions/{property}

Tags: DNSServers
property

The name of the custom property definition.

path string
saveComment

Save comment text to associate with the action.

query string
ref

An optional 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 /DNSServers/{ref}/PropertyDefinitions/{property}

Tags: DNSServers
property

The name of the property.

path string
ref

An optional 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 /DNSServers/{ref}/PropertyDefinitions/{property}

Tags: DNSServers

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

property

The name of the custom property definition.

path string
ref

An optional reference to an object.

path string

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

204 No Content

Successful operation.

default

Unexpected error.

Gets DNS scopes for the specified object

GET /DNSServers/{ref}/Scopes

Tags: DNSServers
ref

Reference of the DNS Server or DNS zone.

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 , ServerGroup } #/parameters/objTypeParam
cacheScopes

Request the cache scopes on the server.

query boolean
saveComment

Save comment text to associate with the action.

query string

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

200 OK

Successful operation.

dnsScopes: string[]

The DNS scopes.

string
default

Unexpected error.

Gets DNS views

GET /DNSViews

Tags: DNSViews
dnsServerRef

A reference to the DNS server.

query string
filter

Filtering criteria for the items returned.

query string #/parameters/filterParam
offset

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

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

The number of items 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.

dnsViews: object[]

List of DNS server views.

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

Total number of items in the result set.

default

Unexpected error.

Gets specified DNS view

GET /DNSViews/{dnsViewRef}

Tags: DNSViews
dnsViewRef

An object reference for the DNS view.

path string

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

200 OK

Successful operation.

dnsView: DNSView
default

Unexpected error.

Gets DNS zones

GET /DNSViews/{dnsViewRef}/DNSZones

Tags: DNSViews
filter

Filtering criteria for the items returned.

query string #/parameters/filterParam
folderRef

Only return zones within the specified folder.

query string
dnsViewRef

Only return zones within the specified view.

path string
dnsServerRef

Only return zones on the specified server.

query string
targetRef

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

query string
offset

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

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

The number of items 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.

default

Unexpected error.

Gets DNS zones

GET /DNSZones

Tags: DNSZones
filter

Filtering criteria for the items returned.

query string #/parameters/filterParam
folderRef

Only return zones within the specified folder.

query string
dnsViewRef

Only return zones within the specified view.

query string
dnsServerRef

Only return zones on the specified server.

query string
targetRef

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

query string
offset

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

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

The number of items 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.

default

Unexpected error.

Adds a new DNS zone

POST /DNSZones

Tags: DNSZones

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 /DNSZones/GenerateDirectives/{dnsGenerateDirectiveRef}

Tags: DNSZones
dnsGenerateDirectiveRef

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 , ServerGroup } #/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 DNS generate directive

GET /DNSZones/GenerateDirectives/{dnsGenerateDirectiveRef}

Tags: DNSZones
dnsGenerateDirectiveRef

An object reference for the DNS generate directive.

path string

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

200 OK

Successful operation.

dnsGenerateDirective: DNSGenerateDirective
default

Unexpected error.

Removes the specified object

DELETE /DNSZones/{dnsZoneRef}

Tags: DNSZones
dnsZoneRef

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 , ServerGroup } #/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 DNS zone

GET /DNSZones/{dnsZoneRef}

Tags: DNSZones
dnsZoneRef

An object reference for the DNS zone.

path string

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

200 OK

Successful operation.

dnsZone: DNSZone
default

Unexpected error.

Sets properties for the specified object

PUT /DNSZones/{dnsZoneRef}

Tags: DNSZones

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

dnsZoneRef

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 DNS records from the specified DNS zone

GET /DNSZones/{dnsZoneRef}/DNSRecords

Tags: DNSZones
dnsZoneRef

Reference to the zone containing the records.

path string
targetRef

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

query string
filter

Filtering criteria for the items returned.

query string #/parameters/filterParam
hideNonAccessibleHosts

If set to true the resulting set will not contain records for which the user has no access.

query boolean
includeMetaRecords

If set to true will return control directives and comments included in the zone.

query boolean
syncZone

If set to true will synchronize the zone from the server before returning records.

query boolean
offset

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

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

The number of items 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.

default

Unexpected error.

Adds a new DNS record

POST /DNSZones/{dnsZoneRef}/DNSRecords

Tags: DNSZones

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

dnsZoneRef

A reference to an object.

path string

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

201 Created

Successful operation. Object created.

ref: ObjRef
default

Unexpected error.

Gets DNS generate directives from the specified DNS zone

GET /DNSZones/{dnsZoneRef}/GenerateDirectives

Tags: DNSZones
dnsZoneRef

Reference to the zone containing the generate directives.

path string

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

200 OK

Successful operation.

dnsGenerateDirectives: object[]

List of DNS generate directives.

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

Total number of items in the result set.

default

Unexpected error.

Adds a new DNS generate directive

POST /DNSZones/{dnsZoneRef}/GenerateDirectives

Tags: DNSZones

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

dnsZoneRef

An object reference for the DNS zone.

path string

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

201 Created

Successful operation. Object created.

ref: ObjRef
default

Unexpected error.

Gets specified DNS zone

GET /DNSZones/{dnsZoneRef}/KeyStorageProviders

Tags: DNSZones
dnsZoneRef

An object reference for the DNS zone.

path string

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

200 OK

Successful operation.

keyStorageProviders: string[]

Contains a list of storage providers installed on the DNS server.

string
default

Unexpected error.

Gets zone options for the specified DNS zone

GET /DNSZones/{dnsZoneRef}/Options

Tags: DNSZones
dnsZoneRef

An object reference for the DNS zone.

path string

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

200 OK

Successful operation.

dnsZoneOptions: DNSZoneOptions
default

Unexpected error.

Updates zone options for the specified DNS zone

PUT /DNSZones/{dnsZoneRef}/Options

Tags: DNSZones

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

dnsZoneRef

An object reference for the DNS zone.

path string

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

204 No Content

Successful operation.

default

Unexpected error.

Gets event history

GET /DNSZones/{objRef}/History

Tags: DNSZones
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 , ServerGroup } #/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 items returned.

query string #/parameters/filterParam
limit

The number of items 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 item.

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 items in the result set.

default

Unexpected error.

Gets access set for the specified object

GET /DNSZones/{ref}/Access

Tags: DNSZones
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 , ServerGroup } #/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 /DNSZones/{ref}/Access

Tags: DNSZones

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 objects from the folder they are in

DELETE /DNSZones/{ref}/Folders

Tags: DNSZones
folderRef

Reference to the folder from which the objects should be removed.

query 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 folder that contains the specified object

GET /DNSZones/{ref}/Folders

Tags: DNSZones
ref

A reference to the object for which to retrieve the containing folder.

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 , ServerGroup } #/parameters/objTypeParam

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

200 OK

Successful operation.

folder: ObjRef
default

Unexpected error.

Removes the specified objects from the folder they are in

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

Tags: DNSZones
folderRef

Reference to the folder from which the objects should be removed.

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.

Places the specified objects in the specified folder

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

Tags: DNSZones

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

folderRef

Reference to the folder in which the objects should be placed.

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 all the property definitions for the specified object type

GET /DNSZones/{ref}/PropertyDefinitions

Tags: DNSZones
ref

An optional 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 /DNSZones/{ref}/PropertyDefinitions

Tags: DNSZones

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

ref

An optional 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 /DNSZones/{ref}/PropertyDefinitions/{property}

Tags: DNSZones
property

The name of the custom property definition.

path string
saveComment

Save comment text to associate with the action.

query string
ref

An optional 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 /DNSZones/{ref}/PropertyDefinitions/{property}

Tags: DNSZones
property

The name of the property.

path string
ref

An optional 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 /DNSZones/{ref}/PropertyDefinitions/{property}

Tags: DNSZones

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

property

The name of the custom property definition.

path string
ref

An optional reference to an object.

path string

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

204 No Content

Successful operation.

default

Unexpected error.

Gets DNS scopes for the specified object

GET /DNSZones/{ref}/Scopes

Tags: DNSZones
ref

Reference of the DNS Server or DNS zone.

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 , ServerGroup } #/parameters/objTypeParam
cacheScopes

Request the cache scopes on the server.

query boolean
saveComment

Save comment text to associate with the action.

query string

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

200 OK

Successful operation.

dnsScopes: string[]

The DNS scopes.

string
default

Unexpected error.

Gets a list of folders

GET /Folders

Tags: Folders
filter

Filtering criteria for the items returned.

query string #/parameters/filterParam
offset

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

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

The number of items 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.

folders: object[]

List of folders.

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

Total number of items in the result set.

default

Unexpected error.

Adds a new folder

POST /Folders

Tags: Folders

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 /Folders/{folderRef}

Tags: Folders
folderRef

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 , ServerGroup } #/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 folder

GET /Folders/{folderRef}

Tags: Folders
folderRef

An object reference for the folder.

path string

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

200 OK

Successful operation.

folder: Folder
default

Unexpected error.

Sets properties for the specified object

PUT /Folders/{folderRef}

Tags: Folders

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

folderRef

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 all objects in the folder specified

GET /Folders/{folderRef}/Objects

Tags: Folders
folderRef

Reference to the folder.

path string

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

200 OK

Successful operation.

objects: object[]

List of all the objects in the specified folder.

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

Total number of items in the result set.

default

Unexpected error.

Gets event history

GET /Folders/{objRef}/History

Tags: Folders
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 , ServerGroup } #/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 items returned.

query string #/parameters/filterParam
limit

The number of items 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 item.

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 items in the result set.

default

Unexpected error.

Gets access set for the specified object

GET /Folders/{ref}/Access

Tags: Folders
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 , ServerGroup } #/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 /Folders/{ref}/Access

Tags: Folders

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 objects from the folder they are in

DELETE /Folders/{ref}/Folders

Tags: Folders
folderRef

Reference to the folder from which the objects should be removed.

query 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 folder that contains the specified object

GET /Folders/{ref}/Folders

Tags: Folders
ref

A reference to the object for which to retrieve the containing folder.

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 , ServerGroup } #/parameters/objTypeParam

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

200 OK

Successful operation.

folder: ObjRef
default

Unexpected error.

Removes the specified objects from the folder they are in

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

Tags: Folders
folderRef

Reference to the folder from which the objects should be removed.

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.

Places the specified objects in the specified folder

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

Tags: Folders

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

folderRef

Reference to the folder in which the objects should be placed.

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 all the property definitions for the specified object type

GET /Folders/{ref}/PropertyDefinitions

Tags: Folders
ref

An optional 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 /Folders/{ref}/PropertyDefinitions

Tags: Folders

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

ref

An optional 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 /Folders/{ref}/PropertyDefinitions/{property}

Tags: Folders
property

The name of the custom property definition.

path string
saveComment

Save comment text to associate with the action.

query string
ref

An optional 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 /Folders/{ref}/PropertyDefinitions/{property}

Tags: Folders
property

The name of the property.

path string
ref

An optional 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 /Folders/{ref}/PropertyDefinitions/{property}

Tags: Folders

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

property

The name of the custom property definition.

path string
ref

An optional 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 user groups

GET /Groups

Tags: Groups
filter

Filtering criteria for the items returned.

query string #/parameters/filterParam
userRef

Reference to a user from which to get roles.

query string
roleRef

Reference to a role that the group should have.

query string
targetRef

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

query string
offset

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

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

The number of items 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.

default

Unexpected error.

Adds a new user group

POST /Groups

Tags: Groups

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 /Groups/{groupRef}

Tags: Groups
groupRef

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 , ServerGroup } #/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 group object based on the object reference

GET /Groups/{groupRef}

Tags: Groups
groupRef

An object reference for the group.

path string

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

200 OK

Successful operation.

group: Group
default

Unexpected error.

Sets properties for the specified object

PUT /Groups/{groupRef}

Tags: Groups

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

groupRef

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 a list of roles

GET /Groups/{groupRef}/Roles

Tags: Groups
filter

Filtering criteria for the items returned.

query string #/parameters/filterParam
userRef

Reference to a user from which to get roles.

query string
groupRef

Reference to a group from which to get roles.

path string
offset

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

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

The number of items to return.

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

Overrides "offset" and returns a page where "targetRef" is the first item. 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.

Removes a role from a group

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

Tags: Groups
roleRef

A reference to the role to remove.

path string
groupRef

A reference to the group from which the role should be removed.

path 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.

Adds a role to a group

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

Tags: Groups

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

roleRef

A reference to the role to add.

path string
groupRef

A reference to the group to which the role should be added.

path string

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

204 No Content

Successful operation.

default

Unexpected error.

Gets users

GET /Groups/{groupRef}/Users

Tags: Groups
filter

Filtering criteria for the items returned.

query string #/parameters/filterParam
groupRef

Reference to a group from which to get users.

path string
roleRef

Reference to a role that the user should have.

query string
targetRef

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

query string
offset

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

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

The number of items 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.

default

Unexpected error.

Removes a user from a group

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

Tags: Groups
userRef

A reference to the user to remove.

path string
groupRef

A reference to the group from which the user should be removed.

path 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.

Adds a user to a group

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

Tags: Groups

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

userRef

A reference to the user to add.

path string
groupRef

A reference to the group to which the user should be added.

path string

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

204 No Content

Successful operation.

default

Unexpected error.

Gets event history

GET /Groups/{objRef}/History

Tags: Groups
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 , ServerGroup } #/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 items returned.

query string #/parameters/filterParam
limit

The number of items 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 item.

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 items in the result set.

default

Unexpected error.

Gets access set for the specified object

GET /Groups/{ref}/Access

Tags: Groups
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 , ServerGroup } #/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 /Groups/{ref}/Access

Tags: Groups

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 /Groups/{ref}/PropertyDefinitions

Tags: Groups
ref

An optional 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 /Groups/{ref}/PropertyDefinitions

Tags: Groups

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

ref

An optional 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 /Groups/{ref}/PropertyDefinitions/{property}

Tags: Groups
property

The name of the custom property definition.

path string
saveComment

Save comment text to associate with the action.

query string
ref

An optional 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 /Groups/{ref}/PropertyDefinitions/{property}

Tags: Groups
property

The name of the property.

path string
ref

An optional 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 /Groups/{ref}/PropertyDefinitions/{property}

Tags: Groups

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

property

The name of the custom property definition.

path string
ref

An optional reference to an object.

path string

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

204 No Content

Successful operation.

default

Unexpected error.

Gets interfaces

GET /Interfaces

Tags: Interfaces
deviceRef

A reference to the device containing the interfaces.

query string
filter

Filtering criteria for the items returned.

query string #/parameters/filterParam
offset

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

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

The number of items 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.

interfaces: object[]

List of interfaces.

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

Total number of items in the result set.

default

Unexpected error.

Adds a new interface

POST /Interfaces

Tags: Interfaces

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 /Interfaces/{interfaceRef}

Tags: Interfaces
interfaceRef

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 , ServerGroup } #/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 interface

GET /Interfaces/{interfaceRef}

Tags: Interfaces
interfaceRef

The object reference for the interface.

path string

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

200 OK

Successful operation.

interface: Interface
default

Unexpected error.

Sets properties for the specified object

PUT /Interfaces/{interfaceRef}

Tags: Interfaces

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

interfaceRef

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 /Interfaces/{objRef}/History

Tags: Interfaces
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 , ServerGroup } #/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 items returned.

query string #/parameters/filterParam
limit

The number of items 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 item.

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 items in the result set.

default

Unexpected error.

Gets access set for the specified object

GET /Interfaces/{ref}/Access

Tags: Interfaces
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 , ServerGroup } #/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 /Interfaces/{ref}/Access

Tags: Interfaces

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 /Interfaces/{ref}/PropertyDefinitions

Tags: Interfaces
ref

An optional 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 /Interfaces/{ref}/PropertyDefinitions

Tags: Interfaces

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

ref

An optional 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 /Interfaces/{ref}/PropertyDefinitions/{property}

Tags: Interfaces
property

The name of the custom property definition.

path string
saveComment

Save comment text to associate with the action.

query string
ref

An optional 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 /Interfaces/{ref}/PropertyDefinitions/{property}

Tags: Interfaces
property

The name of the property.

path string
ref

An optional 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 /Interfaces/{ref}/PropertyDefinitions/{property}

Tags: Interfaces

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

property

The name of the custom property definition.

path string
ref

An optional 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 object

DELETE /IPAMRecords/{addrRef}

Tags: IPAMRecords
addrRef

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 , ServerGroup } #/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 IPAM record for the specified IP address

GET /IPAMRecords/{addrRef}

Tags: IPAMRecords
addrRef

An object reference for the IPAM record.

path string
requireRangeRef

Reference to a range in which the relevant IP address must reside, otherwise the GetIPAMRecord call will fail.

query string
excludeDHCP

Set to true to exclude DHCP data from result.

query boolean

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

200 OK

Successful operation.

ipamRecord: IPAMRecord
default

Unexpected error.

Sets properties for the specified object

PUT /IPAMRecords/{addrRef}

Tags: IPAMRecords

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

addrRef

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.

Sends an ICMP ping request to the specified address

POST /IPAMRecords/{addrRef}/Ping

Tags: IPAMRecords
addrRef

Reference to the IP address to ping.

path string

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

201 Created

Successful operation. Object created.

default

Unexpected error.

Gets range containing specified IP address

GET /IPAMRecords/{addrRef}/Range

Tags: IPAMRecords
addrRef

A reference to the IP address.

path string

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

200 OK

Successful operation.

range: Range
default

Unexpected error.

Gets event history

GET /IPAMRecords/{objRef}/History

Tags: IPAMRecords
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 , ServerGroup } #/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 items returned.

query string #/parameters/filterParam
limit

The number of items 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 item.

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 items in the result set.

default

Unexpected error.

Gets access set for the specified object

GET /IPAMRecords/{ref}/Access

Tags: IPAMRecords
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 , ServerGroup } #/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 /IPAMRecords/{ref}/Access

Tags: IPAMRecords

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 /IPAMRecords/{ref}/PropertyDefinitions

Tags: IPAMRecords
ref

An optional 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 /IPAMRecords/{ref}/PropertyDefinitions

Tags: IPAMRecords

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

ref

An optional 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 /IPAMRecords/{ref}/PropertyDefinitions/{property}

Tags: IPAMRecords
property

The name of the custom property definition.

path string
saveComment

Save comment text to associate with the action.

query string
ref

An optional 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 /IPAMRecords/{ref}/PropertyDefinitions/{property}

Tags: IPAMRecords
property

The name of the property.

path string
ref

An optional 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 /IPAMRecords/{ref}/PropertyDefinitions/{property}

Tags: IPAMRecords

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

property

The name of the custom property definition.

path string
ref

An optional reference to an object.

path string

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

204 No Content

Successful operation.

default

Unexpected error.

Gets ranges

GET /Ranges

Tags: Ranges
filter

Filtering criteria for the items 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.

query string
offset

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

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

The number of items to return.

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

Overrides "offset" and returns a page where "targetRef" is the first item. 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.

Adds a new address range

POST /Ranges

Tags: Ranges

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.

Gets event history

GET /Ranges/{objRef}/History

Tags: Ranges
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 , ServerGroup } #/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 items returned.

query string #/parameters/filterParam
limit

The number of items 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 item.

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 items in the result set.

default

Unexpected error.

Gets subranges of the specified range

GET /Ranges/{parentRef}/Subranges

Tags: Ranges
parentRef

A reference to the range that contains the subranges.

path string
depth

Specifies how many levels of subranges should be retrieved.

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

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

200 OK

Successful operation.

ranges: object[]

List of subranges.

default

Unexpected error.

Removes the specified object

DELETE /Ranges/{rangeRef}

Tags: Ranges
rangeRef

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 , ServerGroup } #/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 range

GET /Ranges/{rangeRef}

Tags: Ranges
rangeRef

An object reference for the IP range.

path string

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

200 OK

Successful operation.

range: Range
default

Unexpected error.

Sets properties for the specified object

PUT /Ranges/{rangeRef}

Tags: Ranges

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

rangeRef

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 specified address range's address blocks

GET /Ranges/{rangeRef}/AddressBlocks

Tags: Ranges
rangeRef

Reference to the address range.

path string

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

200 OK

Successful operation.

addressBlocks: object[]

Address range's address blocks.

default

Unexpected error.

Gets available address blocks within the specified range

GET /Ranges/{rangeRef}/AvailableAddressBlocks

Tags: Ranges
rangeRef

An object reference for the range.

path string
limit

The number of items to return.

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

The minimum size of the address blocks, specified as a subnet mask. Defaults to 24 if neither the mask nor size is specified.

query integer (int64) , { x ∈ ℤ | x ≥ 0 }
size

The minimum size of the address blocks, specified as the number of addresses.

query integer (int64) , { x ∈ ℤ | x ≥ 0 }
ignoreSubnetFlag

Determines whether the subnet flag should be ignored when determining the size of the address blocks.

query boolean
startAddress

The starting address to use when looking for the next available address block. Ignored when mask is not provided.

query string
temporaryClaimTime

If set, claims the returned address blocks for the given time in seconds.

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

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

200 OK

Successful operation.

addressBlocks: object[]

Array of address blocks fulfilling the given criteria.

default

Unexpected error.

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

GET /Ranges/{rangeRef}/DHCPReservations

Tags: Ranges
ownerRef

A reference to the DHCP server/group/scope owning the reservations. Specifying a DHCP server will only return reservations on a server level, not reservations on scope level.

query string
rangeRef

A reference to the DHCP range the reservations are in.

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 , ServerGroup } #/parameters/objTypeParam
filter

Filtering criteria for the items returned.

query string #/parameters/filterParam
offset

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

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

The number of items 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.

dhcpReservations: object[]

List of DHCP reservations.

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

Total number of items in the result set.

default

Unexpected error.

Adds a new DHCP reservation

POST /Ranges/{rangeRef}/DHCPReservations

Tags: Ranges

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

rangeRef

A reference to an object.

path string

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

201 Created

Successful operation. Object created.

ref: ObjRef
default

Unexpected error.

Gets inherit access flag for the specified range

GET /Ranges/{rangeRef}/InheritAccess

Tags: Ranges
rangeRef

A reference to the range.

path string

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

200 OK

Successful operation.

inheritAccess: boolean

Inherit access flag.

default

Unexpected error.

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

GET /Ranges/{rangeRef}/IPAMRecords

Tags: Ranges
rangeRef

A reference to the range containing the addresses. Specified when getting IPAM records from a specific range.

path string
addrRefs

An array of references to the IPAM records to retrieve. Specified when getting specific IPAM records.

query string
includeRelatedDNSRecords

Set to true if IPAM record should include DNS records related to any DNS hosts returned.

query boolean
filter

Filtering criteria for the items returned.

query string #/parameters/filterParam
offset

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

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

The number of items to return.

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

Set to true to exclude DHCP data from result.

query boolean

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

200 OK

Successful operation.

ipamRecords: object[]

List of IPAM records.

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

Total number of items in the result set.

default

Unexpected error.

Gets next free address from the specified range

GET /Ranges/{rangeRef}/NextFreeAddress

Tags: Ranges
rangeRef

A reference to the address range from which to return the free address.

path string
startAddress

The starting address to use when looking for the next free address.

query string
ping

If true the system will ping the address found before returning. If the address responds to a ping request, it is considered to be in use.

query boolean
excludeDHCP

Set to true to exclude DHCP data from result.

query boolean
temporaryClaimTime

If set, claims the next free address for the given time in seconds.

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

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

200 OK

Successful operation.

address: string

The next free IP address in the address range.

default

Unexpected error.

Gets range statistics

GET /Ranges/{rangeRef}/Statistics

Tags: Ranges
rangeRef

A reference to the range.

path string

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

200 OK

Successful operation.

default

Unexpected error.

Gets access set for the specified object

GET /Ranges/{ref}/Access

Tags: Ranges
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 , ServerGroup } #/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 /Ranges/{ref}/Access

Tags: Ranges

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 objects from the folder they are in

DELETE /Ranges/{ref}/Folders

Tags: Ranges
folderRef

Reference to the folder from which the objects should be removed.

query 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 folder that contains the specified object

GET /Ranges/{ref}/Folders

Tags: Ranges
ref

A reference to the object for which to retrieve the containing folder.

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 , ServerGroup } #/parameters/objTypeParam

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

200 OK

Successful operation.

folder: ObjRef
default

Unexpected error.

Removes the specified objects from the folder they are in

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

Tags: Ranges
folderRef

Reference to the folder from which the objects should be removed.

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.

Places the specified objects in the specified folder

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

Tags: Ranges

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

folderRef

Reference to the folder in which the objects should be placed.

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 all the property definitions for the specified object type

GET /Ranges/{ref}/PropertyDefinitions

Tags: Ranges
ref

An optional 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 /Ranges/{ref}/PropertyDefinitions

Tags: Ranges

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

ref

An optional 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 /Ranges/{ref}/PropertyDefinitions/{property}

Tags: Ranges
property

The name of the custom property definition.

path string
saveComment

Save comment text to associate with the action.

query string
ref

An optional 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 /Ranges/{ref}/PropertyDefinitions/{property}

Tags: Ranges
property

The name of the property.

path string
ref

An optional 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 /Ranges/{ref}/PropertyDefinitions/{property}

Tags: Ranges

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

property

The name of the custom property definition.

path string
ref

An optional reference to an object.

path string

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

204 No Content

Successful operation.

default

Unexpected error.

Gets all available report definitions

GET /ReportDefinitions

Tags: ReportDefinitions
filter

Filtering criteria for the items returned.

query string #/parameters/filterParam
offset

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

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

The number of items 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.

reportDefinitions: object[]

A list of report definitions.

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

Total number of items in the result set.

default

Unexpected error.

Adds a new report definition

POST /ReportDefinitions

Tags: ReportDefinitions

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.

Gets event history

GET /ReportDefinitions/{objRef}/History

Tags: ReportDefinitions
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 , ServerGroup } #/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 items returned.

query string #/parameters/filterParam
limit

The number of items 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 item.

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 items in the result set.

default

Unexpected error.

Gets access set for the specified object

GET /ReportDefinitions/{ref}/Access

Tags: ReportDefinitions
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 , ServerGroup } #/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 /ReportDefinitions/{ref}/Access

Tags: ReportDefinitions

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 /ReportDefinitions/{ref}/PropertyDefinitions

Tags: ReportDefinitions
ref

An optional 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 /ReportDefinitions/{ref}/PropertyDefinitions

Tags: ReportDefinitions

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

ref

An optional 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 /ReportDefinitions/{ref}/PropertyDefinitions/{property}

Tags: ReportDefinitions
property

The name of the custom property definition.

path string
saveComment

Save comment text to associate with the action.

query string
ref

An optional 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 /ReportDefinitions/{ref}/PropertyDefinitions/{property}

Tags: ReportDefinitions
property

The name of the property.

path string
ref

An optional 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 /ReportDefinitions/{ref}/PropertyDefinitions/{property}

Tags: ReportDefinitions

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

property

The name of the custom property definition.

path string
ref

An optional 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 object

DELETE /ReportDefinitions/{reportDefinitionRef}

Tags: ReportDefinitions
reportDefinitionRef

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 , ServerGroup } #/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 report definition

GET /ReportDefinitions/{reportDefinitionRef}

Tags: ReportDefinitions
reportDefinitionRef

The reference for the report definition.

path string

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

200 OK

Successful operation.

reportDefinition: ReportDefinition
default

Unexpected error.

Sets properties for the specified object

PUT /ReportDefinitions/{reportDefinitionRef}

Tags: ReportDefinitions

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

reportDefinitionRef

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 list of reporting templates available

GET /Reports

Tags: Reports
filter

Filtering criteria for the items returned.

query string #/parameters/filterParam
offset

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

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

The number of items 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.

reports: object[]

A list of reports.

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

Total number of items in the result set.

default

Unexpected error.

Gets event history

GET /Reports/{objRef}/History

Tags: Reports
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 , ServerGroup } #/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 items returned.

query string #/parameters/filterParam
limit

The number of items 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 item.

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 items in the result set.

default

Unexpected error.

Gets the Report as a file

GET /Reports/{ref}/File

Tags: Reports
ref

A unique reference ID for the object.

path string
contentType

The content type of the result (XML, CSV, JSON, SYLK).

query string , x ∈ { XML , CSV , JSON , SYLK }

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

200 OK

Successful operation.

content: string

The content of the report.

default

Unexpected error.

Return the definition of a reporting template

GET /Reports/{reportRef}

Tags: Reports
reportRef

The reference for the report.

path string
preview

If true the report output will be included.

query boolean

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

200 OK

Successful operation.

report: Report
preview: ReportOutput
default

Unexpected error.

Gets a list of roles

GET /Roles

Tags: Roles
filter

Filtering criteria for the items returned.

query string #/parameters/filterParam
userRef

Reference to a user from which to get roles.

query string
groupRef

Reference to a group from which to get roles.

query string
offset

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

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

The number of items to return.

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

Overrides "offset" and returns a page where "targetRef" is the first item. 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.

Adds a new role

POST /Roles

Tags: Roles

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.

Gets event history

GET /Roles/{objRef}/History

Tags: Roles
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 , ServerGroup } #/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 items returned.

query string #/parameters/filterParam
limit

The number of items 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 item.

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 items in the result set.

default

Unexpected error.

Gets access set for the specified object

GET /Roles/{ref}/Access

Tags: Roles
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 , ServerGroup } #/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 /Roles/{ref}/Access

Tags: Roles

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 /Roles/{ref}/PropertyDefinitions

Tags: Roles
ref

An optional 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 /Roles/{ref}/PropertyDefinitions

Tags: Roles

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

ref

An optional 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 /Roles/{ref}/PropertyDefinitions/{property}

Tags: Roles
property

The name of the custom property definition.

path string
saveComment

Save comment text to associate with the action.

query string
ref

An optional 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 /Roles/{ref}/PropertyDefinitions/{property}

Tags: Roles
property

The name of the property.

path string
ref

An optional 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 /Roles/{ref}/PropertyDefinitions/{property}

Tags: Roles

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

property

The name of the custom property definition.

path string
ref

An optional 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 object

DELETE /Roles/{roleRef}

Tags: Roles
roleRef

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 , ServerGroup } #/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 role object based on the object reference

GET /Roles/{roleRef}

Tags: Roles
roleRef

An object reference for the role.

path string

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

200 OK

Successful operation.

role: Role
default

Unexpected error.

Sets properties for the specified object

PUT /Roles/{roleRef}

Tags: Roles

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

roleRef

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 a list of user groups

GET /Roles/{roleRef}/Groups

Tags: Roles
filter

Filtering criteria for the items returned.

query string #/parameters/filterParam
userRef

Reference to a user from which to get roles.

query string
roleRef

Reference to a role that the group should have.

path string
targetRef

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

query string
offset

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

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

The number of items 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.

default

Unexpected error.

Gets users

GET /Roles/{roleRef}/Users

Tags: Roles
filter

Filtering criteria for the items returned.

query string #/parameters/filterParam
groupRef

Reference to a group from which to get users.

query string
roleRef

Reference to a role that the user should have.

path string
targetRef

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

query string
offset

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

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

The number of items 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.

default

Unexpected error.

Gets users

GET /Users

Tags: Users
filter

Filtering criteria for the items returned.

query string #/parameters/filterParam
groupRef

Reference to a group from which to get users.

query string
roleRef

Reference to a role that the user should have.

query string
targetRef

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

query string
offset

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

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

The number of items 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.

default

Unexpected error.

Adds a new user

POST /Users

Tags: Users

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.

Gets event history

GET /Users/{objRef}/History

Tags: Users
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 , ServerGroup } #/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 items returned.

query string #/parameters/filterParam
limit

The number of items 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 item.

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 items in the result set.

default

Unexpected error.

Gets access set for the specified object

GET /Users/{ref}/Access

Tags: Users
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 , ServerGroup } #/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 /Users/{ref}/Access

Tags: Users

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 /Users/{ref}/PropertyDefinitions

Tags: Users
ref

An optional 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 /Users/{ref}/PropertyDefinitions

Tags: Users

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

ref

An optional 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 /Users/{ref}/PropertyDefinitions/{property}

Tags: Users
property

The name of the custom property definition.

path string
saveComment

Save comment text to associate with the action.

query string
ref

An optional 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 /Users/{ref}/PropertyDefinitions/{property}

Tags: Users
property

The name of the property.

path string
ref

An optional 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 /Users/{ref}/PropertyDefinitions/{property}

Tags: Users

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

property

The name of the custom property definition.

path string
ref

An optional 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 object

DELETE /Users/{userRef}

Tags: Users
userRef

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 , ServerGroup } #/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 user

GET /Users/{userRef}

Tags: Users
userRef

An object reference for the user. Use "." to get the current user.

path string

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

200 OK

Successful operation.

user: User
default

Unexpected error.

Sets properties for the specified object

PUT /Users/{userRef}

Tags: Users

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

userRef

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 a list of user groups

GET /Users/{userRef}/Groups

Tags: Users
filter

Filtering criteria for the items returned.

query string #/parameters/filterParam
userRef

Reference to a user from which to get roles.

path string
roleRef

Reference to a role that the group should have.

query string
targetRef

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

query string
offset

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

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

The number of items 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.

default

Unexpected error.

Gets a list of roles

GET /Users/{userRef}/Roles

Tags: Users
filter

Filtering criteria for the items returned.

query string #/parameters/filterParam
userRef

Reference to a user from which to get roles.

path string
groupRef

Reference to a group from which to get roles.

query string
offset

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

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

The number of items to return.

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

Overrides "offset" and returns a page where "targetRef" is the first item. 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.

Removes a role from a user

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

Tags: Users
roleRef

A reference to the role to remove.

path string
userRef

A reference to the user from which the role should be removed..

path 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.

Adds a role to a user

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

Tags: Users

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

roleRef

A reference to the role to which the user should be added.

path string
userRef

A reference to the user to add.

path string

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

204 No Content

Successful operation.

default

Unexpected error.

Parameter definitions

filterParam filter

Filtering criteria for the items returned.

query string
offsetParam offset

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

query integer (int64) , { x ∈ ℤ | x ≥ 0 }
limitParam limit

The number of items to return.

query integer (int64) , { x ∈ ℤ | x ≥ 0 }
sortByParam sortBy

The name of the field to sort by.

query string
sortOrderParam sortOrder

The sort order to use.

query string , x ∈ { Ascending , Descending }
eventTypeParam 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 }
objTypeParam 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 , ServerGroup }
startDateParam startDate

Date of the first entry to retrieve.

query string (date-time)
endDateParam endDate

Date of the last entry to retrieve.

query string (date-time)

Schema definitions

AccessEntry: object

Contains the name and setting for an access entry relevant to an object.

name: string

The name of the access entry.

access: AccessType

AccessType: string , x ∈ { Unspecified , Allow , Deny }

Defines possible access for an object property.

AddAddressSpace: object

addressSpace: AddressSpace
saveComment: string

Save comment text to associate with the action.

AddADForest: object

adForest: ADForest
saveComment: string

Save comment text to associate with the action.

AddADSite: object

adSite: ADSite
saveComment: string

Save comment text to associate with the action.

AddChangeRequest: object

dnsZoneChanges: object[]

DNS zone change(s).

dnsRecordChanges: object[]

DNS record change(s).

dhcpScopeChanges: object[]

DHCP scope change(s).

dhcpReservationChanges: object[]

DHCP reservation change(s).

dhcpExclusionChanges: object[]

DHCP exclusion change(s).

dhcpAddressPoolChanges: object[]

DHCP address pool change(s).

dhcpOptionChanges: object[]

DHCP options change(s).

rangeChanges: object[]

Range change(s).

configFileChanges: object[]

Configuration file change(s).

customPropertyChanges: object[]

Custom property change(s).

requestDate: string (date-time)

The date and time, when the requested change(s) should be applied, if specified.

customProperties: CustomPropertyMap

The custom properties for the change request.

action: ChangeRequestAction
saveComment: string

Save comment text to associate with the action.

AddCloudNetwork: object

cloudNetwork: CloudNetwork
saveComment: string

Save comment text to associate with the action.

AddCloudServiceAccount: object

cloudServiceAccount: CloudServiceAccount
saveComment: string

Save comment text to associate with the action.

AddDevice: object

device: Device
saveComment: string

Save comment text to associate with the action.

AddDHCPAddressPool: object

dhcpAddressPool: DHCPAddressPool
saveComment: string

Save comment text to associate with the action.

AddDHCPExclusion: object

dhcpExclusion: DHCPExclusion
saveComment: string

Save comment text to associate with the action.

AddDHCPFailoverRelationship: object

dhcpFailoverRelationship: DHCPFailoverRelationship
saveComment: string

Save comment text to associate with the action.

AddDHCPGroup: object

dhcpGroup: DHCPGroup
saveComment: string

Save comment text to associate with the action.

AddDHCPLease: object

dhcpLease: DHCPLease

AddDHCPOptionDefinition: object

dhcpOptionDefinition: DHCPOptionDefinition
serviceType: DHCPServiceType
saveComment: string

Save comment text to associate with the action.

AddDHCPPolicy: object

objType: ObjectType
dhcpPolicy: DHCPPolicy
saveComment: string

Save comment text to associate with the action.

AddDHCPReservation: object

dhcpReservation: DHCPReservation
saveComment: string

Save comment text to associate with the action.

AddDHCPScope: object

dhcpScope: DHCPScope
saveComment: string

Save comment text to associate with the action.

AddDHCPServer: object

dhcpServer: DHCPServer
saveComment: string

Save comment text to associate with the action.

AddDNSGenerateDirective: object

dnsGenerateDirective: DNSGenerateDirective
saveComment: string

Save comment text to associate with the action.

AddDNSRecord: object

dnsRecord: DNSRecord
saveComment: string

Save comment text to associate with the action.

placeAfterRef: ObjRef
autoAssignRangeRef: ObjRef
forceOverrideOfNamingConflictCheck: boolean

Set to true to force creation of record regardless of naming conflict check (if enabled in system settings).

AddDNSRecords: object

dnsRecords: object[]

The DNS records to add.

saveComment: string

Save comment text to associate with the action.

autoAssignRangeRef: ObjRef
dnsZoneRef: ObjRef
placeAfterRef: ObjRef
forceOverrideOfNamingConflictCheck: boolean

Set to true to force creation of record regardless of naming conflict check (if enabled in system settings).

AddDNSServer: object

dnsServer: DNSServer
saveComment: string

Save comment text to associate with the action.

AddDNSZone: object

dnsZone: DNSZone
zoneOptions: DNSZoneOptions
masters: string[]

The IP addresses of the master servers if the new zone is not a master zone.

string
saveComment: string

Save comment text to associate with the action.

AddFolder: object

folder: Folder
saveComment: string

Save comment text to associate with the action.

AddGroup: object

group: Group
saveComment: string

Save comment text to associate with the action.

AddInterface: object

interface: Interface
saveComment: string

Save comment text to associate with the action.

AddPropertyDefinition: object

propertyDefinition: PropertyDefinition
saveComment: string

Save comment text to associate with the action.

cloudTags: object[]

Cloud tags associated with the property.

AddRange: object

range: Range
discovery: Discovery
saveComment: string

Save comment text to associate with the action.

AddReportDefinition: object

reportDefinition: ReportDefinition
saveComment: string

Save comment text to associate with the action.

AddressBlock: object

Contains all properties for an address block.

from: string

The starting IP address of the address block.

to: string

The ending IP address of the address block.

AddressSpace: object

Contains all properties for an address space object.

ref: ObjRef
name: string

The name of the address space.

description: string

A description of the address space.

AddRole: object

role: Role
saveComment: string

Save comment text to associate with the action.

AddRoleToGroup: object

saveComment: string

Save comment text to associate with the action.

AddRoleToUser: object

saveComment: string

Save comment text to associate with the action.

AddUser: object

user: User
saveComment: string

Save comment text to associate with the action.

AddUserToGroup: object

saveComment: string

Save comment text to associate with the action.

ADForest: object

Contains all properties for an AD Forest object.

ref: ObjRef
name: string

The name of the AD Forest.

catalogServer: string

Global catalog server to which Micetro connects for retrieving sites and subnets.

userName: string

User name used when connecting to the global catalog server.

password: string

Password used when connecting to the global catalog server.

readOnly: boolean

Determines if the forest is read-only.

ADReplicationOption: object

Active Directory zone replication.

type: ADReplicationType
partition: string

application directory partition to use if type is 'partition'.

ADReplicationType: string , x ∈ { None , To_All_DNS_Servers_In_AD_Forrest , To_All_DNS_Servers_In_AD_Domain , To_All_Domain_Controllers_In_AD_Domain , To_All_Domain_Controllers_In_Specified_Partition , Unavailable }

Defines possible replication types for an AD integrated zone.

ADSite: object

Contains all properties for an AD Site object.

ref: ObjRef
name: string

The name of the AD Site.

description: string

A description of the AD Site.

location: string

The location of the AD Site.

adForestRef: ObjRef

AkamaiLogin: object

Contains all information needed to log into a Akamai account.

host: string

The base hostname (without scheme) for the Akamai account to log into.

clientToken: string

Client Token for the Akamai account to log into.

clientSecret: string

Client Secret for the Akamai account to log into.

accessToken: string

Access Token for the Akamai account to log into.

zonesList: string[]

Deprecated, will be removed in future versions.

string

AllowTransferOption: object

Definition of servers that should be allowed to receive a zone transfer from the DNS server.

allowTo: AllowTransferTo
allowToServers: string[]

List of servers that should be allowed to receive a zone transfer.

string

AllowTransferTo: string , x ∈ { any , none , authoritative , listed }

Possible values for allow-update DNS zone option.

AllowUpdateFrom: string , x ∈ { none , secure , both }

Possible values for allow-update DNS zone option.

ArrayOfColumn: object

col: string

AuthenticationType: string , x ∈ { Internal , AD , ADGroup , RADIUS }

Defines possible authentication types for a user that is logging in.

AWSCloudServiceInfo: object

Contains information about a AWS cloud service account.

regions: object[]

Resource groups within the cloud service account.

AWSLogin: object

Contains all information needed to log into an AWS account.

accessKeyID: string

Access Key ID for the AWS account to log into.

secretAccessKey: string

Secret access key for the AWS account to log into.

AzureCloudServiceInfo: object

Contains information about a Azure cloud service account.

resourceGroups: object[]

Resource groups within the cloud service account.

AzureLogin: object

Contains all information needed to log into an Azure account.

subscriptionID: string

Subscription ID for the Azure account to log into.

tenantID: string

Tenant ID for the Azure account to log into.

clientID: string

Client ID for the Azure account to log into.

clientSecret: string

Client secret for the Azure account to log into.

isGovernment: boolean

Use Azure Government. Defaults to false.

BINDServerListenOn: object

Contains all properties for listen-on option on a BIND DNS server.

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

The port to listen on.

onlyListenOn: string[]

The interfaces to listen on, if specified.

string

BINDServerLogging: object

Contains all properties for BIND DNS server logging.

channels: object[]

BIND DNS server logging channels.

categories: BINDServerLoggingCategories

BINDServerLoggingCategories: object

Contains all properties for BIND DNS server logging categories.

default: string[]

Logging category "default".

string
config: string[]

Logging category "config".

string
queries: string[]

Logging category "queries".

string
update: string[]

Logging category "update".

string
xfer: string[]

Logging category "xfer".

string
notify: string[]

Logging category "notify".

string
security: string[]

Logging category "security".

string
lame: string[]

Logging category "lame".

string
database: string[]

Logging category "database".

string
general: string[]

Logging category "general".

string
resolver: string[]

Logging category "resolver".

string
client: string[]

Logging category "client".

string
network: string[]

Logging category "network".

string
unmatched: string[]

Logging category "unmatched".

string

BINDServerLoggingChannel: object

Contains all properties for a BIND DNS server logging channel.

name: string

The name of the logging channel.

type: BINDServerLoggingChannelType
facility: BINDServerLoggingChannelFacility
severity: string

The logging channel severity.

file: string

The log file name, if type is "File".

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

The maximum log file size, if type is "File".

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

The log file versions, if type is "File".

printCategory: boolean

Specifies whether to print category.

printSeverity: boolean

Specifies whether to print severity.

printTime: boolean

Specifies whether to print time.

BINDServerLoggingChannelFacility: string , x ∈ { Kern , User , Mail , Daemon , Auth , Syslog , LPR , News , UUCP , Cron , Authpriv , FTP , Local0 , Local1 , Local2 , Local3 , Local4 , Local5 , Local6 , Local7 }

Defines the types of BIND DNS server logging channel facilities.

BINDServerLoggingChannelType: string , x ∈ { Null , Stderr , Syslog , File }

Defines the types of BIND DNS server logging channels.

BINDSpecificDNSServerOptions: object

Contains all properties for options specific to a BIND DNS server.

allowTransfer: string[]

Specifies to where it is allowed to answer transfer requests.

string
allowRecursion: string[]

Specifies to where it is allowed to answer recursive queries.

string
listenOn: BINDServerListenOn
listenOnV6: BINDServerListenOn
logging: BINDServerLogging

BINDSpecificDNSZoneOptions: object

Contains all properties for options specific to a BIND DNS zone.

allowQuery: string[]

ACL listing hosts and subnets allowed to query the zone.

string
allowTransfer: string[]

ACL listing hosts and subnets allowed to retrieve a zone transfer.

string
zonefile: string

Location of zone file on disk.

forwarders: string[]

List of forwarders for the zone.

string
serverAddresses: string[]

List of server addresses for the static-stub zone.

string
serverNames: string[]

List of server names for the static-stub zone.

string

ChangeRequest: object

Contains all properties for a change request object.

ref: ObjRef
requester: string

The name of the user that made the change request.

state: ChangeRequestState
objType: ChangeRequestType
action: ChangeRequestAction
creationDate: string (date-time)

The date and time, when the change request was created.

requestDate: string (date-time)

The date and time, when the change request should be applied, if specified.

customProperties: CustomPropertyMap

The custom properties for the change request.

saveComment: string

Save comment text to associate with the action.

processedDate: string (date-time)

The date and time, when the change request was approved or rejected.

dnsZoneChanges: object[]

DNS zone changes associated with the change request.

dnsRecordChanges: object[]

DNS record changes associated with the change request.

dhcpScopeChanges: object[]

DHCP scope changes associated with the change request.

dhcpReservationChanges: object[]

DHCP reservation changes associated with the change request.

dhcpExclusionChanges: object[]

DHCP exclusion changes associated with the change request.

dhcpAddressPoolChanges: object[]

DHCP address pool changes associated with the change request.

dhcpOptionChanges: object[]

DHCP option changes associated with the change request.

rangeChanges: object[]

Range changes associated with the change request.

configFileChanges: object[]

Configuration file changes associated with the change request.

customPropertyChanges: object[]

CustomProperty changes associated with the change request.

ChangeRequestAction: string , x ∈ { Request , Apply , Validate }

Defines how the change request is processed.

ChangeRequestError: object

Describes change request errors in a change request.

ref: ObjRef
message: string

A detailed description of the error.

title: string

An optional name for the error message

description: string

An optional description of the error.

type: ChangeRequestErrorType

ChangeRequestErrorType: string , x ∈ { Error , Warning }

Defines possible change request errors.

ChangeRequestState: string , x ∈ { Pending , Approved , Rejected , Applied , Failed }

Defines possible change request states.

ChangeRequestType: string , x ∈ { Unknown , DNSZone , DHCPScope , DHCPReservation , DHCPAddressPool , DNSRecord , DHCPExclusion , DHCPOption , CustomProperties , Range , ConfigFile }

Defines possible change request types.

ChangeType: string , x ∈ { Add , Modify , Remove }

Defines possible change types.

CloudDeviceInfo: object

Contains all properties for a device as supplied by the cloud provider.

state: string

The state of the cloud device as reported by the cloud provider.

platform: string

The cloud device platform as reported by the cloud provider.

privateDNSName: string

The private DNS name of a cloud device as provided by the cloud provider.

publicIPAddress: string

The public IP address of a cloud device as provided by the cloud provider.

CloudLinkLogin: object

Contains all information needed to connect to a cloud account with cloudlink.

credentials: string

A JSON string containing information required to connect to the cloud account

CloudNetwork: object

Contains all properties for a virtual cloud network object.

ref: ObjRef
name: string

The name of the cloud network.

cloudRef: ObjRef
resourceGroup: string

The resource group for the network to reside in. Applies only to Azure.

region: string

Region or location for the network to be placed in.

addressBlocks: string[]

The address blocks for the network in CIDR notation.

string
customProperties: CustomPropertyMap

The custom properties for the cloud network.

CloudServiceAccount: object

Contains all properties needed for a cloud service account.

ref: ObjRef
name: string

A name for the cloud service account.

type: CloudType
resourceGroups: string[]

Resource groups in the cloud service.

string
regions: string[]

Regions/locations in the cloud service.

string
loginInformation: LoginInformation
configuration: CloudServiceConfiguration
customProperties: CustomPropertyMap

The custom properties for the cloud account.

CloudServiceConfiguration: object

Defines how Micetro connects to a cloud service.

enableIPAM: boolean

Synchronize virtual networks and subnets, when applicable.

enableDNS: boolean

Synchronize DNS service, when applicable.

dnsServerRef: ObjRef

CloudServiceInfo: object

Contains information about the cloud service account.

name: string

The name of the cloud service account.

awsCloudServiceInfo: AWSCloudServiceInfo
azureCloudServiceInfo: AzureCloudServiceInfo

CloudSubnet: object

Contains all properties for a cloud subnet associated with a range.

rangeRef: ObjRef
allocationPools: object[]

Specifies addresses in subnet which should be available for dynamic allocation. If omitted/empty when placing subnet in cloud network, defaults to all addresses in subnet.

CloudTag: object

Contains a reference to a cloud tag.

name: string

The name of the tag.

cloudRef: ObjRef

CloudType: string , x ∈ { Unknown , OpenStack , CloudStack , Azure , AWS , NS1 , Dyn , Akamai , CloudLink }

Defines possible cloud types.

ConfigFile: object

Contains a configuration file

name: string

The type of option file

modificationDate: string

The date and time of last modification

content: string

The option file

ConfigFileChange: object

Contains a configuration file change

state: ChangeRequestState
hasAccess: boolean

Specifies whether the user has access to approve/reject the configuration file change.

ref: ObjRef
configFilesBefore: object[]

The configuration files as they are before the change is made.

configFilesAfter: object[]

The configuration files to change to.

CustomPropertyChange: object

Contains all properties for a custom property change object.

ref: ObjRef
type: ChangeType
state: ChangeRequestState
hasAccess: boolean

Specifies whether the user has access to approve/reject the custom property change.

objType: ObjectType
customPropertiesBefore: CustomPropertyMap

The custom properties as they were before the change (omitted when type is Add).

customPropertiesAfter: CustomPropertyMap

The custom properties as they should be after change has been applied (omitted when type is Remove).

CustomPropertyMap: object

Custom properties as key, value pair

{
"key": "value"
}
object

Device: object

Contains all properties for a device object.

ref: ObjRef
name: string

The name of the device.

customProperties: CustomPropertyMap

The custom properties for the device.

interfaces: object[]

The interfaces on the device.

DHCPAddressPool: object

Contains all properties for a DHCP address pool object.

ref: ObjRef
name: string

The name of the DHCP address pool.

from: string

The start address of the DHCP address pool.

to: string

The end address of the DHCP address pool.

failoverPeer: string

The name of the failover peer if the address pool is on an ISC DHCP server with failover peer(s) defined.

failoverRelationship: string

The name of the failover relationship if the address pool is on an MS DHCP server with failover(s) defined. Read-only property.

role: string

The role of the pool in a redundancy setup.

dhcpScopeRef: ObjRef

DHCPAddressPoolChange: object

Contains all properties for a DHCP address pool change object.

type: ChangeType
state: ChangeRequestState
hasAccess: boolean

Specifies whether the user has access to approve/reject the DHCP address pool change.

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

The index of the DHCP address pool change within the change request which contains the DHCP address pool change.

dhcpAddressPoolBefore: DHCPAddressPool
dhcpAddressPoolAfter: DHCPAddressPool

DHCPAddressPoolPermit: object

Contains all properties for a DHCP address pool permit object.

permit: DHCPAddressPoolPermitType
access: AccessType
className: string

The name of the DHCP class if permit type is MembersOfDHCPClass.

DHCPAddressPoolPermitType: string , x ∈ { Unknown , AllClients , KnownClients , UnknownClients , DynamicBOOTPClients , MembersOfDHCPClass }

Defines the types of DHCP Address Pool permits.

DHCPExclusion: object

Contains all properties for a DHCP exclusion object.

ref: ObjRef
name: string

The name of the DHCP exclusion.

from: string

The start address of the DHCP exclusion.

to: string

The end address of the DHCP exclusion.

dhcpScopeRef: ObjRef

DHCPExclusionChange: object

Contains all properties for a DHCP exclusion change object.

type: ChangeType
state: ChangeRequestState
hasAccess: boolean

Specifies whether the user has access to approve/reject the DHCP exclusion change.

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

The index of the DHCP exclusion change within the change request which contains the DHCP exclusion change.

dhcpExclusionBefore: DHCPExclusion
dhcpExclusionAfter: DHCPExclusion

DHCPFailoverMode: string , x ∈ { LoadBalance , HotStandby }

Defines possible DHCP failover modes.

DHCPFailoverRelationship: object

Defines a DHCP failover relationship.

name: string

The name of the DHCP failover relationship.

primaryServer: string

The primary DHCP server.

secondaryServer: string

The secondary DHCP server.

primaryServerRef: ObjRef
secondaryServerRef: ObjRef
failoverMode: DHCPFailoverMode
failoverServerType: DHCPFailoverServerType
mclt: integer (int64) , { x ∈ ℤ | x ≥ 0 }

Maximum client lead time in seconds.

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

Safe period time in seconds, that the DHCPv4 server will wait before transitioning the server from the COMMUNICATION-INT state to PARTNER-DOWN.

dhcpScopeRefs: object[]

References to DHCP scopes that are associated with the failover relationship.

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

Indicates the ratio of the DHCPv4 client load shared between a primary and secondary server in the failover relationship.

sharedSecret: string

The shared secret key associated with this failover relationship.

dhcpServerRef: ObjRef

DHCPFailoverServerType: string , x ∈ { PrimaryServer , SecondaryServer }

Defines the types of DHCP Failover server.

DHCPGroup: object

Contains all properties for a DHCP group object.

ref: ObjRef
name: string

The name of the DHCP group.

parentRef: ObjRef
ownerRef: ObjRef

DHCPLease: object

Contains all properties for a DHCP lease object.

name: string

The name of the lease.

type: string

The DHCP lease type.

mac: string

The MAC address of the host that holds the lease (DHCPv4).

duid: string

The DUID and IAID identifiers of the holder of the lease (DHCPv6).

clientIdentifierType: string

The client identitifer type.

address: string

The IP address of the lease.

lease: string

The expiration date for the lease.

state: string

The state of the lease.

dhcpScopeRef: ObjRef

DHCPOption: object

Contains a single DHCP option value.

option: string

The DHCP option ID.

value: string

The DHCP option value.

DHCPOptionChange: object

Contains all properties for a DHCP option change object.

state: ChangeRequestState
hasAccess: boolean

Specifies whether the user has access to approve/reject the DHCP option change.

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

The index of the DHCP option change within the change request which contains the DHCP option change.

owner: Object
policyName: string

The name of the DHCP policy the options belong to, defaults to an empty string when not using policies or on none MS servers.

dhcpOption: DHCPOption

DHCPOptionClass: object

Contains a definition for a DHCP option class.

name: string

The DHCP option class name.

description: string

The DHCP option class description.

identifier: string

The DHCP option class identifier.

DHCPOptionDefinition: object

Contains a definition for a DHCP option.

option: string

The DHCP option ID.

name: string

The DHCP option name.

type: DHCPOptionType
array: boolean

Determines whether DHCP option is defined as an array.

DHCPOptionType: string , x ∈ { String , HexStr , Boolean , IPAddress , IPv6Address , IPOrHostname , Integer }

Defines the possible data types for DHCP Options

DHCPPolicy: object

Contains all properties for a DHCP policy.

name: string

The name of the DHCP policy.

description: string

A description for the DHCP policy.

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

Specifies the relative order in which the DHCP policy will be processed.

enabled: boolean

Specifies whether the DHCP policy is enabled (default true).

logicalOperator: DHCPPolicyLogicalOperator
ranges: object[]

IP ranges set for the DHCP policy.

conditions: object[]

Conditions set for the DHCP policy.

ddnsSettings: DHCPPolicyDDNSSettings
leaseDuration: DHCPPolicyLeaseDuration

DHCPPolicyComparisonType: string , x ∈ { Equal , NotEqual }

Defines possible DHCP policy comparison types.

DHCPPolicyCondition: object

Contains all properties for a DHCP policy condition.

conditionType: DHCPPolicyConditionType
comparisonType: DHCPPolicyComparisonType
values: string[]

The value(s) to be used for the DHCP policy condition comparison. Each value can end with wildcard character '*'.

string

DHCPPolicyConditionType: string , x ∈ { MACAddress , FQDN , FQDNSingleLabel , VendorClass , UserClass , ClientIdentifier , RelayAgentInformation , RAIAgentCircuitID , RAIAgentRemoteID , RAISubscriberID }

Defines possible DHCP policy condition types.

DHCPPolicyDDNSSettings: object

Contains all properties used when configuring DDNS update for a DHCP Policy

enabled: boolean

Specifies whether the DHCP policy is enabled (default false).

alwaysUpdate: boolean

Specifies if DDNS should always be updated, ignoring DHCP client requested (default false).

discardRecords: boolean

Specifies whether to discard DDNS A and PTR records when lease is deleted (default true).

forceForNoneRequestingClients: boolean

Specifies whether to force a DDNS update for clients that do not request an update (default false).

disablePTRUpdates: boolean

Specifies whether to update DNS PTR records (default false).

useDNSSuffix: boolean

Specifies whether to use a specific DNS suffix when registering clients with DDNS (default false).

dnsSuffix: string

The DNS suffix used to register the client with DDNS

DHCPPolicyLeaseDuration: object

Contains all properties used when configuring a specific lease duration on a DHCP Policy

leaseSetting: DHCPPolicyLeaseDurationType
leaseDuration: integer (int64) , { x ∈ ℤ | x ≥ 0 }

Specifies lease duration in seconds.

DHCPPolicyLeaseDurationType: string , x ∈ { Undefined , Limited , Unlimited }

Possible DHCP Policy lease duration settings.

DHCPPolicyLogicalOperator: string , x ∈ { LogicalOr , LogicalAnd }

Defines possible DHCP policy logical operators.

DHCPPolicyRange: object

Contains all properties for a DHCP policy range.

from: string

The starting IP address of the DHCP policy range.

to: string

The ending IP address of the DHCP policy range.

DHCPRefAndFailoverRelationshipName: object

A DHCP failover relationship to remove.

dhcpServerRef: ObjRef
dhcpFailoverRelationshipName: string

Name of the DHCP failover relationship to remove.

DHCPReservation: object

Contains all properties for a DHCP reservation object.

ref: ObjRef
name: string

The name of the reservation.

clientIdentifier: string

The client identifier used for the reservation (e.g. the MAC address).

reservationMethod: DHCPReservationMethod
addresses: string[]

An array of zero or more IP addresses used for the reservation.

string
type: DHCPReservationType
description: string

Description for the reservation. Only applicable for MS DHCP servers.

ddnsHostName: string

Dynamic DNS host name for reservation. Only applicable for ISC DHCP servers.

filename: string

The "filename" DHCP option. Only applicable for ISC DHCP servers.

serverName: string

The "server-name" DHCP option. Only applicable for ISC DHCP servers.

nextServer: string

The "next-server" ISC DHCP option. Only applicable for ISC DHCP servers.

ownerRef: ObjRef

DHCPReservationChange: object

Contains all properties for a DHCP reservation change object.

type: ChangeType
state: ChangeRequestState
hasAccess: boolean

Specifies whether the user has access to approve/reject the DHCP reservation change.

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

The index of the DHCP reservation change within the change request which contains the DHCP reservation change.

dhcpReservationBefore: DHCPReservation
dhcpReservationAfter: DHCPReservation

DHCPReservationMethod: string , x ∈ { HardwareAddress , ClientIdentifier }

Defines possible DHCP reservation methods.

DHCPReservationType: string , x ∈ { DHCP , BOOTP , BOTH }

Defines possible DHCP reservation types.

DHCPScope: object

Contains all properties for a DHCP scope object.

ref: ObjRef
name: string

The name of the DHCP scope.

rangeRef: ObjRef
dhcpServerRef: ObjRef
superscope: string

The name of the superscope for the DHCP scope. Only applicable for MS DHCP servers.

description: string

A description for the DHCP scope.

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

Number of available addresses in the address pool(s) of the scope.

enabled: boolean

Specifies whether the scope is enabled (default true).

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

Scope preference, only available for Microsoft DHCPv6 servers.

DHCPScopeChange: object

Contains all properties for a DHCP scope change object.

type: ChangeType
state: ChangeRequestState
hasAccess: boolean

Specifies whether the user has access to approve/reject the DHCP scope change.

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

The index of the DHCP scope change within the change request which contains the DHCP scope change.

dhcpScopeBefore: DHCPScope
dhcpScopeAfter: DHCPScope

DHCPServer: object

Contains all properties for a DHCP server object.

ref: ObjRef
name: string

The name of the DHCP server.

proxy: string

The DHCP server controller used to connect to the DHCP server. If not specified it is assumed to be localhost.

address: string

The IP address of the DHCP server.

resolvedAddress: string

The IP address of the DHCP server, if specified, or the IP address retrieved through resolving the name of the DHCP server.

username: string

The login name of the user accessing a Cisco IOS DHCP server. Only applicable for Cisco IOS DHCP servers.

password: string

The password for the user accessing a Cisco IOS DHCP server. Only applicable for Cisco IOS DHCP servers.

enablePassword: string

The password for entering maintenance mode when accessing a Cisco IOS DHCP server. Only applicable for Cisco IOS DHCP servers.

type: DHCPServerType
haMode: HAMode
state: DHCPServerState
security: DHCPServerSecurity
customProperties: CustomPropertyMap

The custom properties for the DHCP server.

enabled: boolean

Specifies whether the DHCP server is enabled.

dhcpv6: boolean

Sets the server as DHCPv6.

DHCPServerSecurity: string , x ∈ { Unknown , Telnet , SSH2 }

Defines possible login methods for Cisco IOS DHCP servers.

DHCPServerState: string , x ∈ { Unknown , OK , Unreachable , Out of date , Updating , Uninitialized , Detached , DHCP Service Down , DHCP Service Impaired }

Defines possible DHCP server states.

DHCPServerType: string , x ∈ { Unknown , MSDHCP , ISC , IOS , KEA DHCPv4 }

Defines possible DHCP server types.

DHCPServiceType: string , x ∈ { DHCPv4 , DHCPv6 }

Define possible DHCP server service types.

Discovery: object

Contains all properties for scheduling. Used for discovery of ranges or scopes.

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

The interval between runs for the schedule.

unit: TimeUnit
enabled: boolean

Determines if the schedule is enabled.

startTime: string (date-time)

The date and time when the schedule should start.

DNSForwarders: string , x ∈ { Off , First , Only }

Defines the types of uses of forwarders for a DNS server.

DNSGenerateDirective: object

Contains all properties for a DNS generate directive.

ref: ObjRef
rangeStart: integer (int64) , { x ∈ ℤ | x ≥ 0 }

The start of the range.

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

The end of the range.

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

The stepping of the range. Defaults to 1.

lhs: string

The owner name of the resource records generated by the directive.

ttl: string

The ttl of the resource records generated by the directive.

class: string

The class of the resource records generated by the directive.

type: DNSRecordType
rhs: string

The data of the resource records generated by the directive.

DNSHost: object

Contains all properties for a DNS host object. A DNS host is an address (A) record and all CNAME, TXT and MX records that are associated with the record.

dnsRecord: DNSRecord
ptrStatus: PTRStatus
relatedRecords: object[]

An array of records associated with the host record.

DNSRecord: object

Contains all properties for a DNS record object.

ref: ObjRef
name: string

The name of the DNS record, either partially or fully qualified.

type: DNSRecordType
ttl: string

Specifies the Time-To-Live of the DNS record.

data: string

Contains the record data in a tab-separated list.

comment: string

Contains the comment string for the record. Note that only records in static DNS zones can have a comment string.

enabled: boolean

Contains true if the record is enabled. If the record is disabled the value is false. Defaults to enabled.

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

The aging timestamp of dynamic records in AD integrated zones. Hours since January 1, 1601, UTC. Providing a non-zero value creates a dynamic record.

dnsZoneRef: ObjRef
customProperties: CustomPropertyMap

The custom properties for the record.

DNSRecordChange: object

Contains all properties for a DNS record change object.

type: DNSRecordChangeType
state: ChangeRequestState
hasAccess: boolean

Specifies whether the user has access to approve/reject the DNS record change.

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

The index of the DNS record change within the change request which contains the DNS record change.

dnsRecordBefore: DNSRecord
dnsRecordAfter: DNSRecord
placeAfterRef: ObjRef

DNSRecordChangeType: string , x ∈ { AddDNSRecord , ModifyDNSRecord , RemoveDNSRecord }

Defines possible DNS record change types.

DNSRecordType: string , x ∈ { Any , Unknown , A , NS , CNAME , SOA , WKS , PTR , HINFO , MX , TXT , SPF , RP , AFSDB , AAAA , LOC , SRV , NAPTR , DNAME , WINS , WINSR , DS , SSHFP , DHCID , CERT , CAA , RRSIG , DNSKEY , NSEC , NSEC3 , NSEC3PARAM , TLSA , Comment , EmptyLine , $GENERATE , $INCLUDE , $TTL }

Defines possible DNS record types.

DNSRootServer: object

Contains all properties for a DNS root server object.

name: string

The name of the DNS root server.

address: string

The IP address of the DNS root server.

DNSSECZoneOptions: object

Contains all properties for options specific to DNSSEC.

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

User NSEC3 over NSEC.

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

Use NSEC3 Opt-Out.

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

Length of the NSEC3 random salt.

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

Number of iterations to use for NSEC3.

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

TTL to use for DS records.

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

TTL to use for DNSKEY records.

DsRecordAlgorithms: DsRecordAlgorithms
MaintainTrustAnchor: MaintainTrustAnchor
Keymaster: string

Name of the Keymaster for this zone (read only).

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

Does the parent zone have a DNSSEC delegation for this zone.

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

Enable automatic update of trust anchors on key rollover (RFC 5011).

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

The time between polling the DNSSEC delegation in the parent zone.

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

The signature inception offset.

NSEC3UserSalt: string

A string to use as NSEC3 salt.

NSEC3CurrentSalt: string

The NSEC3 salt currently being used in the zone (readonly).

NSEC3HashAlgorithm: NSEC3HashAlgorithm

DNSServer: object

Contains all properties for a DNS server object.

ref: ObjRef
name: string

The name of the DNS server.

proxy: string

The DNS server controller used to connect to the DNS server.

address: string

The IP address of the DNS server.

resolvedAddress: string

The IP address of the DNS server, if specified, or the IP address retrieved through resolving the name of the DNS server.

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

The port to use when connecting to the DNS server. Only needed if a non-standard port is used to connect to the server.

type: DNSServerType
adForest: string

The name of the AD Forest with which the DNS server is associated.

state: DNSServerState
customProperties: CustomPropertyMap

The custom properties for the DNS server.

subtype: DNSServerSubtype
enabled: boolean

Specifies whether the DNS server is enabled.

created: string (date-time)

Date when the server was created.

lastModified: string (date-time)

Date when the server was last modified.

DNSServerOptions: object

Contains all properties for a DNS server options object.

serverType: DNSServerType
timestamp: integer (int64) , { x ∈ ℤ | x ≥ 0 }

Timestamp.

useForwarders: DNSForwarders
forwarders: string[]

IP addresses of forwarders, if any.

string
bindSpecific: BINDSpecificDNSServerOptions
msSpecific: MSSpecificDNSServerOptions
additional: CustomPropertyMap

Additional DNS Server options.

DNSServerState: string , x ∈ { Unknown , OK , Unreachable , Out of date , Updating , Uninitialized , Detached , DNS Service Down , DNS Service Impaired }

Defines possible DNS server states.

DNSServerSubtype: string , x ∈ { Unknown , Win2003 , Win2008 , Win2012 , Win2016 , Win2019 , Win2022 , BIND9 , Unbound , Generic , Azure , Route53 , CloudLink , NS1 , Dyn , Akamai }

Defines possible DNS server subtypes.

DNSServerType: string , x ∈ { Unknown , MS , BIND , Unbound , Generic , Azure , Route53 , CloudLink , NS1 , Dyn , Akamai }

Defines possible DNS server types.

DNSView: object

Contains all properties for a DNS view object.

ref: ObjRef
name: string

The name of the DNS view.

dnsServerRef: ObjRef

DNSZone: object

Contains all properties for a DNS zone object.

ref: ObjRef
name: string

The name of the DNS zone.

dnsScopeName: string

The name of the DNS zone scope.

dynamic: boolean

Contains true if the zone is dynamic.

adIntegrated: boolean

Contains true if the zone is Active Directory integrated.

adReplicationType: ADReplicationType
adPartition: string

The AD partition if the zone is Active Directory integrated.

dnsViewRef: ObjRef
dnsViewRefs: object[]

Contains the reference IDs of the DNS views that contain the zone.

sourceZoneRef: ObjRef
authority: string

Contains the name of the DNS server that contains the zone or the string "[Active Directory]" if the zone is AD integrated.

type: DNSZoneType
dnssecSigned: boolean

Contains true if the zone is a DNSSEC signed zone.

kskIDs: string

A comma separated string of IDs of KSKs, starting with active keys, then inactive keys in parenthesis.

zskIDs: string

A comma separated string of IDs of ZSKs, starting with active keys, then inactive keys in parenthesis.

customProperties: CustomPropertyMap

The custom properties for the zone.

created: string (date-time)

Date when the zone was created.

lastModified: string (date-time)

Date when the zone was last modified.

displayName: string

A name that can distinguish the zone from other zone instances with the same name.

folderRef: ObjRef

DNSZoneChange: object

Contains all properties for a DNS zone change object.

type: ChangeType
state: ChangeRequestState
hasAccess: boolean

Specifies whether the user has access to approve/reject the DNS zone change.

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

The index of the DNS zone change within the change request which contains the DNS zone change.

dnsZoneBefore: DNSZone
dnsZoneAfter: DNSZone
options: DNSZoneOptions

DNSZoneOptions: object

Contains all properties for a DNS zone options object.

zonetype: DNSZoneType
timestamp: integer (int64) , { x ∈ ℤ | x ≥ 0 }

Timestamp.

masters: string[]

List of all masters, for slave zones.

string
msSpecific: MSSpecificDNSZoneOptions
bindSpecific: BINDSpecificDNSZoneOptions
dnssec: DNSSECZoneOptions
additional: CustomPropertyMap

Additional DNS Zone options.

DNSZoneType: string , x ∈ { Master , Slave , Hint , Stub , Forward , Include , Static-stub }

Defines possible types for a DNS zone.

DsRecordAlgorithms: string , x ∈ { Unknown , None , SHA-1 , SHA-256 , SHA-1 and SHA-256 , SHA-384 , SHA-1 and SHA-384 , SHA-256 and SHA-384 , All }

Algorithms to use for when creating DS resource records.

DynLogin: object

Contains all information needed to log into a Dyn account.

customerName: string

The Customer Name to use for authenticating with Dyn.

username: string

The username to use for authenticating with Dyn.

password: string

The password to use for authenticating with Dyn.

Error: object

code: integer (int64)
message: string

Event: object

Contains all properties for an event object.

eventType: EventType
objType: ObjectType
objRef: ObjRef
objName: string

Name of the object.

timestamp: string (date-time)

Timestamp of event.

username: string

Name of the user associated with the event.

saveComment: string

Save comment provided along with the event.

eventText: string

Description of the event.

EventType: string , x ∈ { Unknown , Creation , Modification , Deletion , Refresh , Error , Reference }

Defines possible event types.

FieldDefinition: object

Contains the property definition for a field.

name: string

The name of the field.

title: string

A human readable description of the field.

type: FieldType
pickList: string[]

An array of possible values.

string
objectType: ObjectType

FieldType: string , x ∈ { String , Enum , Integer , Boolean , IPAddress , Ref , DateTime , Duration }

Defines the possible data types for a field.

Folder: object

Contains all properties for a folder object.

ref: ObjRef
name: string

The name of the folder.

contentType: ObjectType
parentRef: ObjRef
filter: string

Filter string to apply to folder contents.

GetDNSRecordsResponse: object

dnsRecords: object[]

List of records.

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

Offset of page returned when "targetRef" is specified and found.

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

Total number of items in the result set.

GetDNSZonesResponse: object

dnsZones: object[]

List of zones.

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

Offset of page returned when "targetRef" is specified and found.

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

Total number of items in the result set.

GetGroupsResponse: object

groups: object[]

List of groups.

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

Offset of page returned when "targetRef" is specified and found.

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

Total number of items in the result set.

GetRangesResponse: object

ranges: object[]

List of ranges.

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

Offset of page returned when "targetRef" is specified and found.

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

Total number of items in the result set.

GetRangeStatisticsResponse: object

used: string

Number of used addresses in the address range.

free: string

Number of free addresses in the address range.

numInSubranges: string

Number of addresses in range allocated to subranges.

percentInSubranges: string

Percent of range allocated to subranges.

GetRolesResponse: object

roles: object[]

List of roles.

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

Offset of page returned when "targetRef" is specified and found.

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

Total number of items in the result set.

GetUsersResponse: object

users: object[]

Array of users.

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

Offset of page returned when "targetRef" is specified and found.

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

Total number of items in the result set.

Group: object

Contains all properties for a user group object.

ref: ObjRef
name: string

The name of the group.

description: string

A description for the group.

adIntegrated: boolean

Contains true if the group is Active Directory integrated.

builtIn: boolean

Indicates a system built in role (read only property).

groupMembers: object[]

An array of references to the users in the group.

roles: object[]

An array of references to the roles the group has.

HAMode: string , x ∈ { none , hot-standby , load-balancing , passive-backup }

Defines possible High-Availability modes.

IdentityAccess: object

Contains access entries for a specific user or group.

identityRef: ObjRef
identityName: string

The name of the user or group for which the access applies.

general: boolean

Read-only. True if the identity is a general role.

inherited: boolean

Read-only. True if the permissions are inherited from the role access. False when set explicitly on the object.

accessEntries: object[]

The access entries for the user or group.

Interface: object

Contains all properties for an interface object.

ref: ObjRef
name: string

The name of the interface.

clientIdentifier: string

The client identifier for the interface.

addresses: string[]

The addresses for the interface.

string
customProperties: CustomPropertyMap

The custom properties for the interface.

deviceRef: ObjRef

IPAddressDiscoveryType: string , x ∈ { None , Ping , ARP , Lease , Custom }

Defines possible IP address discovery types.

IPAMRecord: object

Contains all properties for an IPAM record object.

addrRef: ObjRef
address: string

The IP address.

claimed: boolean

Contains true if the record has the Claimed flag set.

dnsHosts: object[]

List of DNS hosts associated with the address.

dhcpReservations: object[]

List of DHCP reservations associated with the address.

dhcpLeases: object[]

List of DHCP leases associated with the address.

discoveryType: IPAddressDiscoveryType
lastSeenDate: string

The date when the address was last seen during IP address discovery.

lastDiscoveryDate: string

The date when the system last performed IP address discovery for this IP address.

lastKnownClientIdentifier: string

The MAC address associated with the IP address discovery info.

device: string

The device associated with the record.

interface: string

The interface associated with the record.

ptrStatus: PTRStatus
extraneousPTR: boolean

Contains true if there are extraneous PTR records for the record.

customProperties: CustomPropertyMap

The custom properties for the IPAM record.

state: IPAMRecordState
holdInfo: IPAMRecordHoldInfo
usage: integer (int64) , { x ∈ ℤ | x ≥ 0 }

IP address usage bitmask.

cloudDeviceInfo: CloudDeviceInfo

IPAMRecordHoldInfo: object

Contains information about who holds the otherwise free IP and for how long.

expiryTime: string (date-time)

The date and time when the temporary hold expires.

username: string

The user who claimed the IP temporarily.

IPAMRecordState: string , x ∈ { Free , Assigned , Claimed , Pending , Held }

Defines possible IPAM record states.

LoginInformation: object

Information needed logging into a cloud service.

openStackLogin: OpenStackLogin
azureLogin: AzureLogin
awsLogin: AWSLogin
ns1Login: NS1Login
dynLogin: DynLogin
akamaiLogin: AkamaiLogin
cloudLinkLogin: CloudLinkLogin

MaintainTrustAnchor: string , x ∈ { Unknown , None , DNSKEY }

Possible DNS resource record sets to maintain trust anchors for.

ModifyDHCPOptionDefinition: object

dhcpOptionDefinition: DHCPOptionDefinition
serviceType: DHCPServiceType
saveComment: string

Save comment text to associate with the action.

ModifyDHCPPolicy: object

objType: ObjectType
dhcpPolicy: DHCPPolicy
saveComment: string

Save comment text to associate with the action.

ModifyPropertyDefinition: object

propertyDefinition: PropertyDefinition
updateExisting: boolean

Should objects be updated with the new value.

saveComment: string

Save comment text to associate with the action.

cloudTags: object[]

Cloud tags associated with the property.

MSDNSServerLogging: object

Contains all properties for MS DNS server logging.

file: string

The log file name.

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

The maximum log file size.

filter: string[]

IP addresses on which to filter.

string
logLevel: MSDNSServerLogLevel

MSDNSServerLogLevel: object

Contains all properties for MS DNS server loglevel.

outgoing: boolean

Log outgoing. If not logged, incoming must be logged.

incoming: boolean

Log incoming. If not logged, outgoing must be logged.

tcp: boolean

Log TCP. If not logged, udp must be logged.

udp: boolean

Log UDP. If not logged, tcp must be logged.

queries: boolean

Log queries. If not logged, updates and/or notifications must be logged.

updates: boolean

Log updates. If not logged, queries and/or notifications must be logged.

notifications: boolean

Log notifications. If not logged, queries and/or updates must be logged.

request: boolean

Log request. If not logged, response must be logged.

response: boolean

Log response. If not logged, request must be logged.

details: boolean

Log details.

MSSpecificDNSServerOptions: object

Contains all properties for options specific to a MS DNS server.

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

Forwarder timeout.

listenOn: string[]

The interfaces to listen on, if specified.

string
disableRecursion: boolean

Specifies whether recursion should be disabled.

bindSecondaries: boolean

Specifies whether to use BIND secondaries.

failIfBadData: boolean

Specifies whether to fail when encountering bad data.

roundRobin: boolean

Specifies whether to use round robin.

netmaskOrdering: boolean

Specifies whether to use netmask ordering.

secureCache: boolean

Specifies whether to use a secure cache.

nameCheck: boolean

Specifies whether to perform name check.

bootMethod: string

Boot method.

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

Specifies how old a record can get before it is scavenged.

rootServers: object[]

Root servers.

logging: MSDNSServerLogging

MSSpecificDNSZoneOptions: object

Contains all properties for options specific to a MS DNS zone.

notify: NotifyOption
allowTransferData: AllowTransferOption
allowUpdate: AllowUpdateFrom
scavenge: ScavengeOption
replication: ADReplicationOption
forwarders: string[]

List of forwarders for the zone.

string

NetworkAuthority: object

Describes what servers or virtual networks are authoritative for the network.

name: string

Describes the network authority relationship as a string of authoritative object names.

type: string

The type of object authoritative for the network.

subtype: NetworkAuthoritySourceSubtype
sources: object[]

Objects that can be considered authoritative for the network.

NetworkAuthoritySource: object

A source of authority for a network.

name: string

The name of the object that is authoritative for the network, for instance a DHCP server or a cloud service.

type: string

The type of object authoritative for the network. Currently always set to 'Scope'

ref: ObjRef
enabled: boolean

Indicates whether the instance is enabled and/or available on the source.

NetworkAuthoritySourceSubtype: string , x ∈ { Scope , Split , Failover , High availability }

Possible types of network authority sources.

NetworkDiscoveryInfo: object

Contains Network Discovery Info.

routerName: string

The name of the router.

gateway: string

The IP address of the gateway.

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

The interface ID.

interfaceName: string

The interface name.

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

The VLAN ID for the interface.

interfaceDescription: string

The interface description.

VRFName: string

The VRF name assigned to the interface.

NotifyOption: object

Definition of servers that should be notified of changes to a DNS zone.

authoritative: boolean

Notify authoritative servers.

alsoNotify: string[]

List of other servers to notify.

string

NS1Login: object

Contains all information needed to log into a NS1 account.

apiKey: string

API Key to use for authenticating with NS1.

NSEC3HashAlgorithm: string , x ∈ { Unknown , SHA-1 }

Possible values for NSEC3 hash algorithm.

Object: object

Contains information about a generic object.

ref: ObjRef
objType: ObjectType
name: string

The name of the object.

ObjectAccess: object

Contains information about an object access entry.

ref: ObjRef
name: string

The name of the object.

identityAccess: object[]

An array of access entries for different users and groups for the object.

ObjectType: 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 , ServerGroup }

Defines possible object types.

ObjRef: string

A reference to an object.

OpenStackLogin: object

Contains all information needed to log into an OpenStack account.

serverNode: string

The server node with which to communicate.

username: string

The username to use for authenticating with OpenStack.

password: string

The password to use for authenticating with OpenStack.

httpsRequired: boolean

Is HTTPS required for communicating with server node.

PingResponse: object

alive: boolean

Determines whether the host responded to the ping request.

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

The response time in milliseconds.

lastSeenDate: string

A timestamp indicating the last time seen.

PlaceInADSite: object

rangeRefs: object[]

References to the address ranges that should be placed in the AD site.

location: string

Location property to be set for AD subnet.

description: string

Description property to be set for AD subnet.

saveComment: string

Save comment text to associate with the action.

PlaceInCloudNetwork: object

cloudSubnets: object[]

The subnets that should be placed in the cloud network.

saveComment: string

Save comment text to associate with the action.

PlaceInFolder: object

saveComment: string

Save comment text to associate with the action.

Property: object

Contains a single property entry for an object.

name: string

The name of the property.

value: string

The value of the property.

PropertyDefinition: object

Contains the property definition for a property.

name: string

The name of the property.

type: PropertyType
system: boolean

Contains true if the property is system defined.

mandatory: boolean

Determines if the property is mandatory.

readOnly: boolean

Determines if the property is read-only.

multiLine: boolean

Determines if the property is multi-line.

defaultValue: string

Contains the default value for the property.

listItems: string[]

Contains the list items if the property is an enumeration.

string
parentProperty: string

Name of the parent property.

cloudTags: object[]

Associated cloud tags

PropertyType: string , x ∈ { String , HexStr , Boolean , IPAddress , Integer }

Defines the possible data types for a custom property.

PTRStatus: string , x ∈ { Unknown , OK , Verify }

Defines possible status types for PTR records.

Range: object

Contains all properties for a range object.

ref: ObjRef
name: string

The CIDR of the range, or from-to address range.

from: string

The starting IP address of the range.

to: string

The ending IP address of the range.

parentRef: ObjRef
adSiteRef: ObjRef
adSiteDisplayName: string

The display name of the AD site to which the range belongs.

childRanges: object[]

An array of child ranges of the range.

isLeaf: boolean

Determines if the range has any child ranges.

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

Number of child ranges.

dhcpScopes: object[]

An array of scopes associated with the range.

authority: NetworkAuthority
subnet: boolean

Determines if the range is defined as a subnet.

locked: boolean

Determines if the range should be locked.

autoAssign: boolean

Determines if it should be possible to automatically assign IP addresses from the range.

hasSchedule: boolean

Determines if a discovery schedule has been set for the range.

hasMonitor: boolean

Determines if monitoring is enabled for the range.

customProperties: CustomPropertyMap

The custom properties for the range.

inheritAccess: boolean

Should this range inherit its access bits from its parent range?.

isContainer: boolean

Set to true to create a container instead of a range.

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

Utilization percentage for the range.

hasRogueAddresses: boolean

If this range is a container, then this field will indicate whether there are rogue addresses in the container.

cloudNetworkRef: ObjRef
cloudAllocationPools: object[]

Addresses in range which should be available for dynamic allocation in the cloud.

discoveredProperties: object[]

Network discovery information.

created: string (date-time)

Date when the range was created.

lastModified: string (date-time)

Date when the range was last modified.

folderRef: ObjRef

RangeChange: object

Contains all properties for a range change object.

type: ChangeType
state: ChangeRequestState
hasAccess: boolean

Specifies whether the user has access to approve/reject the range change.

rangeBefore: Range
rangeAfter: Range

Region: object

Contains information about a region.

name: string

The name of the region.

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

Number of VPCs in the region.

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

Number of zones in the region.

Report: object

Contains information about a Report.

ref: ObjRef
reportDefinitionRef: string

A reference for the report definition.

title: string

The title of the report.

startTime: string

The time when the report was started .

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

The number of items returned.

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

The running time in milliseconds.

ReportCategory: string , x ∈ { Unknown , DNS , DHCP , IPAM , User , General }

Defines the possible categories of a report.

ReportDefinition: object

Contains information about a report definition.

ref: ObjRef
title: string

The report title.

description: string

A description of the report.

help: string

Instructions for the user on how to use the report.

type: ReportType
category: ReportCategory
sourceName: string

The reporting source.

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

The maximum number of records to return.

filter: string

The report filter.

columns: string[]

An optional array of columns for output. If not specified all columns will be returned

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

The maximum number of reports to keep. By default 0 meaning keep all reports.

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

The maximum number of days to keep a report. By default 0 meaning keep all reports.

scheduled: boolean

True if the report is scheduled to be run.

nextRun: string (date-time)

The time the report will run if scheduled.

script: string

Name of script to run on results from a scheduled run.

ReportOutput: object

Contains report output.

columns: object[]

An array of output fields.

rows: object[]

The result of a report.

ReportType: string , x ∈ { Base , Standard , User }

Defines possible report types.

ResourceGroup: object

Contains information about a resource group.

name: string

The name of the resource group.

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

Number of VPCs in the resource group.

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

Number of zones in the resource group.

Role: object

Contains all properties for a role object.

ref: ObjRef
name: string

The name of the role.

type: RoleType
description: string

A description for the role.

builtIn: boolean

Indicates a system built in role.

users: object[]

An array of references to users that have the role.

groups: object[]

An array of references to groups that have the role.

access: object[]

Role Access for every object type with access.

RoleAccess: object

All access bits for a role

objType: ObjectType
general: boolean

Read-only. True if this role is applied to all objects of this type, in general.

accessEntries: object[]

The access flags for the role

RoleType: string , x ∈ { General , Specific , Legacy }

The type of the Role

ScavengeOption: object

Scavenge stale resource records.

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

The time between the most recent refresh of a record timestamp and the moment when the timestamp may be refreshed again.

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

The time between the earliest moment when a record timestamp can be refreshed and the earliest moment when the record can be scavenged. The refresh interval must be longer than the maximum record refresh period.

SetDHCPAddressPoolPermitList: object

dhcpAddressPoolPermits: object[]

The DHCP address pool permit list to set.

saveComment: string

Save comment text to associate with the action.

SetDHCPOptions: object

objType: ObjectType
ticket: integer (int64) , { x ∈ ℤ | x ≥ 0 }

Ticket used for concurrency. Returned by GetDHCPOptions command and, if there have been changes made to DHCP options for the object since the ticket was returned, the SetDHCPOptions call will fail.

dhcpOptions: object[]

The DHCP options to set.

dhcpPolicyName: string

Name of MS DHCP policy if applicable.

serviceType: DHCPServiceType
saveComment: string

Save comment text to associate with the action.

SetDHCPPolicyEnforcement: object

objType: ObjectType
enforce: boolean

Specifies whether DHCP policies should be enforced.

saveComment: string

Save comment text to associate with the action.

SetDHCPSubclasses: object

dhcpSubclasses: string[]

The DHCP subclasses to set.

string
saveComment: string

Save comment text to associate with the action.

SetDNSServerOptions: object

dnsServerOptions: DNSServerOptions
saveComment: string

Save comment text to associate with the action.

SetDNSZoneOptions: object

dnsZoneOptions: DNSZoneOptions
saveComment: string

Save comment text to associate with the action.

SetObjectAccess: object

identityAccess: object[]

The access to set for the objects.

addRoles: object[]

Roles to add to the access of the objects.

removeRoles: object[]

Roles to remove from the access of the objects.

objType: ObjectType
saveComment: string

Save comment text to associate with the action.

SetProperties: object

ref: ObjRef
objType: ObjectType
saveComment: string

Save comment text to associate with the action.

deleteUnspecified: boolean

Set to true if properties that are not explicitly set should be cleared. Default value is false.

properties: CustomPropertyMap

The properties and property values that should be set for the object.

SourcedDHCPOptions: object

Contains DHCP options from a single source.

source: Object
dhcpOptions: object[]

The DHCP options.

TimeUnit: string , x ∈ { Minutes , Hours , Days , Weeks , Months }

Defines possible time units.

User: object

Contains all properties for a user object.

ref: ObjRef
name: string

The login name of the user.

password: string

The user password.

fullName: string

The full name of the user.

externalID: string

The external authentication ID of the user. Distinguished name for AD user.

description: string

The description for the user.

email: string

The users email address.

lastLogin: string (date-time)

The date and time of the last login for this user.

authenticationType: AuthenticationType
groups: object[]

The groups the user is a member of.

roles: object[]

The roles the user is directly associated to.

groupRoles: object[]

The roles the user has through his group membership.