The following section lists the Address Manager RESTv1 API endpoints in alphabetical order and the equivalent RESTful v2 endpoint that can be used to perform a similar operation to help you migrate your current integrations to use the RESTful v2 API. You can click one of the following links to navigate to the relevant table based on the RESTv1 API endpoint that you are looking for:
A-F API endpoints
RESTv1 API | RESTv2 Endpoint | Notes |
---|---|---|
POST /Services/REST/v1/addACL |
POST
/api/v2/configurations/{collectionId}/accessControlLists |
|
POST /Services/REST/v1/addAccessRight |
POST /api/v2/accessRights |
|
POST /Services/REST/v1/addAliasRecord |
POST
/api/v2/zones/{collectionId}/resourceRecords |
|
POST /Services/REST/v1/addBulkHostRecord |
To be implemented in 9.6 | This will be implemented with POST
/networks/{collectionId}/imports |
POST
/Services/REST/v1/addCustomOptionDefinition |
POST
/api/v2/configurations/{collectionId}/deploymentOptionDefinitions
|
|
POST /Services/REST/v1/addDHCP4Range |
POST
/api/v2/networks/{collectionId}/ranges |
|
POST
/Services/REST/v1/addDHCP4RangeBySize |
POST
/api/v2/networks/{collectionId}/ranges |
|
POST
/Services/REST/v1/addDHCP6ClientDeploymentOption |
POST
/api/v2/{collection}/{collectionId}/deploymentOptions |
|
POST /Services/REST/v1/addDHCP6Range |
POST
/api/v2/networks/{collectionId}/ranges |
|
POST
/Services/REST/v1/addDHCP6RangeBySize |
POST
/api/v2/networks/{collectionId}/ranges |
|
POST
/Services/REST/v1/addDHCP6ServiceDeploymentOption |
POST
/api/v2/{collection}/{collectionId}/deploymentOptions |
|
POST
/Services/REST/v1/addDHCPClientDeploymentOption |
POST
/api/v2/{collection}/{collectionId}/deploymentOptions |
|
POST
/Services/REST/v1/addDHCPDeploymentRole |
POST
/api/v2/{collection}/{collectionId}/deploymentRoles |
|
POST /Services/REST/v1/addDHCPMatchClass |
POST
/api/v2/configurations/{collectionId}/clientClasses |
|
POST
/Services/REST/v1/addDHCPServiceDeploymentOption |
POST
/api/v2/{collection}/{collectionId}/deploymentOptions |
|
POST /Services/REST/v1/addDHCPSubClass |
POST
/api/v2/clientClasses/{collectionId}/subclasses |
|
POST
/Services/REST/v1/addDHCPVendorDeploymentOption |
POST
/api/v2/{collection}/{collectionId}/deploymentOptions |
|
POST
/Services/REST/v1/addDNSDeploymentOption |
POST
/api/v2/{collection}/{collectionId}/deploymentOptions |
|
POST
/Services/REST/v1/addDNSDeploymentRole |
POST /api/v2/deploymentRoles |
|
POST /Services/REST/v1/addDevice |
POST
/api/v2/configurations/{collectionId}/devices |
|
POST /Services/REST/v1/addDeviceInstance
(deprecated) |
or
|
|
POST /Services/REST/v1/addDeviceSubtype |
POST
/api/v2/deviceTypes/{collectionId}/deviceSubtypes |
|
POST /Services/REST/v1/addDeviceType |
POST /api/v2/deviceTypes |
|
POST /Services/REST/v1/addEntity |
|
|
POST /Services/REST/v1/addEnumZone |
|
|
POST /Services/REST/v1/addEnumNumber |
POST /api/v2/zones/{collectionId}/zones |
|
POST
/Services/REST/v1/addExternalHostRecord |
POST
/api/v2/zones/{collectionId}/resourceRecords |
|
POST /Services/REST/v1/addGenericRecord |
POST
/api/v2/zones/{collectionId}/resourceRecords |
|
POST /Services/REST/v1/addHINFORecord |
POST
/api/v2/zones/{collectionId}/resourceRecords |
|
POST /Services/REST/v1/addHostRecord |
POST
/api/v2/zones/{collectionId}/resourceRecords |
|
POST /Services/REST/v1/addIP4BlockByCIDR |
POST
/api/v2/configurations/{collectionId}/blocks |
|
POST
/Services/REST/v1/addIP4BlockByRange |
POST
/api/v2/configurations/{collectionId}/blocks |
|
POST
/Services/REST/v1/addIP4IPGroupByRange |
POST
/api/v2/networks/{collectionId}/ipGroups |
|
POST
/Services/REST/v1/addIP4IPGroupBySize |
POST
/api/v2/networks/{collectionId}/ipGroups |
|
POST /Services/REST/v1/addIP4Network |
POST
/api/v2/blocks/{collectionId}/networks |
|
POST
/Services/REST/v1/addIP4ReconciliationPolicy |
POST
/api/v2/{collection}/{collectionId}/reconciliationPolicies |
|
POST /Services/REST/v1/addIP4Template |
POST
/api/v2/configurations/{collectionId}/templates |
|
POST /Services/REST/v1/addIP6Address |
POST
/api/v2/networks/{collectionId}/addresses |
|
POST
/Services/REST/v1/addIP6BlockByMACAddress |
POST
/api/v2/blocks/{collectionId}/blocks |
|
POST
/Services/REST/v1/addIP6BlockByPrefix |
POST
/api/v2/blocks/{collectionId}/blocks |
|
POST
/Services/REST/v1/addIP6NetworkByPrefix |
POST
/api/v2/blocks/{collectionId}/networks |
|
POST /Services/REST/v1/addMACAddress |
POST
/api/v2/configurations/{collectionId}/macAddresses |
|
POST /Services/REST/v1/addMXRecord |
POST
/api/v2/zones/{collectionId}/resourceRecords |
|
POST /Services/REST/v1/addNAPTRRecord |
POST
/api/v2/zones/{collectionId}/resourceRecords |
|
POST /Services/REST/v1/addParentBlock |
|
POST an
|
POST
/Services/REST/v1/addParentBlockWithProperties |
||
POST
/Services/REST/v1/addRawDeploymentOption |
POST
/api/v2/{collection}/{collectionId}/deploymentOptions |
|
POST /Services/REST/v1/addResourceRecord |
POST
/api/v2/zones/{collectionId}/resourceRecords |
|
POST /Services/REST/v1/addResponsePolicy |
POST
/api/v2/configurations/{collectionId}/responsePolicies |
|
POST
/Services/REST/v1/addResponsePolicyItem |
POST
/api/v2/responsePolicies/{collectionId}/policyItems |
|
POST /Services/REST/v1/addSRVRecord |
POST
/api/v2/zones/{collectionId}/resourceRecords |
|
POST /Services/REST/v1/addServer |
POST
/api/v2/configurations/{collectionId}/servers |
|
POST
/Services/REST/v1/addStartOfAuthority |
POST
/api/v2/{collection}/{collectionId}/deploymentOptions |
|
POST
/Services/REST/v1/addTFTPDeploymentRole |
POST
/api/v2/tftpGroups/{collectionId}/deploymentRoles |
|
POST /Services/REST/v1/addTFTPFile |
POST
/api/v2/{collection}/{collectionId}/files |
|
POST /Services/REST/v1/addTFTPFolder |
POST
/api/v2/{collection}/{collectionId}/files |
|
POST /Services/REST/v1/addTFTPGroup |
POST
/api/v2/configurations/{collectionId}/tftpGroups |
|
POST /Services/REST/v1/addTXTRecord |
POST
/api/v2/zones/{collectionId}/resourceRecords |
|
POST /Services/REST/v1/addTag |
|
|
POST /Services/REST/v1/addTagGroup |
POST /api/v2/tagGroups |
|
POST /Services/REST/v1/addUser |
POST /api/v2/users |
|
POST
/Services/REST/v1/addUserDefinedField |
POST /api/v2/userDefinedFieldDefinitions |
|
POST
/Services/REST/v1/addUserDefinedLink |
POST /api/v2/userDefinedLinkDefinitions |
|
POST /Services/REST/v1/addUserGroup |
POST /api/v2/userGroups |
|
POST
/Services/REST/v1/addVendorOptionDefinition |
POST
/api/v2/vendorProfiles/{collectionId}/deploymentOptionDefinitions
|
|
POST /Services/REST/v1/addVendorProfile |
POST /api/v2/vendorProfiles |
|
POST /Services/REST/v1/addView |
POST
/api/v2/configurations/{collectionId}/views |
|
POST /Services/REST/v1/addZone |
|
|
POST /Services/REST/v1/addZoneTemplate |
|
|
POST /Services/REST/v1/applyIP4NetworkTemplate
(deprecated) |
POST
/api/v2/templates/{collectionId}/templateApplications |
|
POST /Services/REST/v1/applyIP4Template |
POST
/api/v2/templates/{collectionId}/templateApplications |
|
POST /Services/REST/v1/assignIP4Address |
POST
/api/v2/networks/{collectionId}/addresses |
|
POST /Services/REST/v1/assignIP6Address |
POST
/api/v2/networks/{collectionId}/addresses |
|
POST
/Services/REST/v1/assignNextAvailableIP4Address |
POST
/api/v2/networks/{collectionId}/addresses |
|
POST
/Services/REST/v1/assignOrUpdateTemplate |
|
To assign a template, update the
To apply a template, send a |
POST
/Services/REST/v1/associateMACAddressWithPool |
POST
/api/v2/macPools/{collectionId}/macAddresses |
|
POST /Services/REST/v1/breakReplication |
PATCH /api/v2/databases/{id} |
Send request body: {"state": "BREAK"} |
POST /Services/REST/v1/breakXHAPair |
or
|
For PATCH, send request body: {"state":
"BREAK"} |
PUT
/Services/REST/v1/changeStateIP4Address |
PUT /api/v2/addresses/{id} |
|
DELETE /Services/REST/v1/clearIP6Address |
DELETE /api/v2/addresses/{id} |
|
POST
/Services/REST/v1/configureAuditLogExport |
PUT /api/v2/settings/{id} |
|
POST
/Services/REST/v1/configureServerServices |
PUT
/api/v2/servers/{collectionId}/services/{id} |
|
POST
/Services/REST/v1/configureStreamingReplication |
PUT /api/v2/databases/{id} |
|
POST /Services/REST/v1/createXHAPair |
POST
/api/v2/configurations/{collectionId}/servers |
|
GET /Services/REST/v1/customSearch |
GET /api/v2?filter={filter predicate} |
|
DELETE /Services/REST/v1/delete |
|
|
DELETE
/Services/REST/v1/deleteAccessRight |
DELETE /api/v2/accessRights/{id} |
|
DELETE
/Services/REST/v1/deleteDHCP6ClientDeploymentOption |
DELETE /api/v2/deploymentOptions/{id} |
|
DELETE
/Services/REST/v1/deleteDHCP6ServiceDeploymentOption |
DELETE /api/v2/deploymentOptions/{id} |
|
DELETE
/Services/REST/v1/deleteDHCPClientDeploymentOption |
DELETE /api/v2/deploymentOptions/{id} |
|
DELETE
/Services/REST/v1/deleteDHCPDeploymentRole |
DELETE /api/v2/deploymentRoles/{id} |
|
DELETE
/Services/REST/v1/deleteDHCPServiceDeploymentOption |
DELETE /api/v2/deploymentOptions/{id} |
|
DELETE
/Services/REST/v1/deleteDHCPVendorDeploymentOption |
DELETE /api/v2/deploymentOptions/{id} |
|
DELETE
/Services/REST/v1/deleteDNSDeploymentOption |
DELETE /api/v2/deploymentOptions/{id} |
|
DELETE
/Services/REST/v1/deleteDNSDeploymentRole |
DELETE /api/v2/deploymentRoles/{id} |
|
DELETE
/Services/REST/v1/deleteDNSDeploymentRoleForView |
DELETE /api/v2/deploymentRoles/{id} |
|
DELETE /Services/REST/v1/deleteDeviceInstance
(deprecated) |
or
|
|
DELETE
/Services/REST/v1/deleteResponsePolicyItem |
DELETE /api/v2/policyItems/{id} |
|
DELETE
/Services/REST/v1/deleteUserDefinedField |
DELETE
/api/v2/userDefinedFieldDefinitions/{id} |
|
DELETE
/Services/REST/v1/deleteUserDefinedLink |
DELETE
/api/v2/userDefinedLinkDefinitions/{id} |
|
DELETE
/Services/REST/v1/deleteWithOptions |
DELETE /api/v2/{collection}/{id} |
|
PUT /Services/REST/v1/denyMACAddress |
POST
/api/v2/macPools/{collectionId}/macAddresses |
|
POST /Services/REST/v1/deployServer |
POST
/api/v2/servers/{collectionId}/deployments |
|
POST
/Services/REST/v1/deployServerConfig |
POST
/api/v2/servers/{collectionId}/deployments |
Only one service can be deployed at a time |
POST
/Services/REST/v1/deployServerServices |
POST
/api/v2/servers/{collectionId}/deployments |
|
PUT /Services/REST/v1/editXHAPair |
PUT /api/v2/servers/{id} |
|
POST
/Services/REST/v1/establishTrustRelationship |
POST /api/v2/trustRelationships |
|
POST
/Services/REST/v1/failoverReplication |
PATCH
/api/v2/databases/{collectionId)/servers/{id} |
Send request body {"state": "PRIMARY"} |
PUT /Services/REST/v1/failoverXHA |
PATCH /api/v2/servers/{id} |
Send request body: {"state": "FAILOVER"} |
GET
/Services/REST/v1/findResponsePoliciesWithItem |
GET
/policyItems?filter=name:'{fqdn}'&fields=_links.collection |
G-L API endpoints
RESTv1 API | RESTv2 Endpoint | Notes |
---|---|---|
GET /Services/REST/v1/getAccessRight |
GET /api/v2/accessRights/{id} |
|
GET
/Services/REST/v1/getAccessRightsForEntity |
GET
/api/v2/{collection}/{collectionId}/accessRights |
|
GET
/Services/REST/v1/getAccessRightsForUser |
GET
/api/v2/users/{collectionId}/accessRights |
|
GET
/Services/REST/v1/getAliasesByHint |
GET
/api/v2/zones/{collectionId}/resourceRecords?filter=type:'AliasRecord'
|
|
GET
/Services/REST/v1/getAllUsedLocations |
GET example to be provided for 9.6 |
|
GET
/Services/REST/v1/getAuditLogExportStatus |
GET
/api/v2/settings?filter=type:'AuditDataSettings' |
|
GET
/Services/REST/v1/getConfigurationGroups |
GET
/api/v2/configurations?fields=configurationGroup |
|
GET
/Services/REST/v1/getConfigurationSetting |
GET /api/v2/configurations/{id} |
|
GET
/Services/REST/v1/getConfigurationsByGroup |
GET
/api/v2/configurations?filter=configurationGroup:'{name}' |
|
GET
/Services/REST/v1/getDHCP6ClientDeploymentOption |
GET /api/v2/deploymentOptions/{id} |
|
GET
/Services/REST/v1/getDHCP6ServiceDeploymentOption |
GET /api/v2/deploymentOptions/{id} |
|
GET
/Services/REST/v1/getDHCPClientDeploymentOption |
GET /api/v2/deploymentOptions/{id} |
|
GET
/Services/REST/v1/getDHCPDeploymentRole |
GET /api/v2/deploymentRoles/{id} |
|
GET
/Services/REST/v1/getDHCPServiceDeploymentOption |
GET /api/v2/deploymentOptions/{id} |
|
GET
/Services/REST/v1/getDHCPVendorDeploymentOption |
GET /api/v2/deploymentOptions/{id} |
|
GET
/Services/REST/v1/getDNSDeploymentOption |
GET /api/v2/deploymentOptions/{id} |
|
GET
/Services/REST/v1/getDNSDeploymentRole |
GET /api/v2/deploymentRoles/{id} |
|
GET
/Services/REST/v1/getDNSDeploymentRoleForView |
GET
/api/v2/deploymentRoles?filter=serverInterface.id:{interfaceId}
and view.id:{viewId}
|
|
GET
/Services/REST/v1/getDependentRecords |
|
|
GET
/Services/REST/v1/getDeploymentOptions |
GET /api/v2/deploymentOptions |
|
GET
/Services/REST/v1/getDeploymentRoles |
GET /api/v2/deploymentRoles |
|
GET
/Services/REST/v1/getDeploymentTaskStatus |
GET /api/v2/deployments/{id} |
|
GET
/Services/REST/v1/getDiscoveredDevice |
GET
/api/v2/reconciliationPolicies/{collectionId}/discoveredDevices/{id}
|
|
GET
/Services/REST/v1/getDiscoveredDeviceArpEntries |
GET
/api/v2/reconciliationPolicies/{collectionId}/discoveredDevices?filter=type:'DiscoveredARPEntry'
and device.id:{deviceId}
|
|
GET
/Services/REST/v1/getDiscoveredDeviceHosts |
GET
/api/v2/reconciliationPolicies/{collectionId}/discoveredDevices?filter=type:'DiscoveredHost'
and device.id:{deviceId}
|
|
GET
/Services/REST/v1/getDiscoveredDeviceInterfaces |
GET
/api/v2/reconciliationPolicies/{collectionId}/discoveredDevices?filter=type:'DiscoveredInterface'
and device.id:{deviceId}
|
|
GET
/Services/REST/v1/getDiscoveredDeviceMacAddressEntries |
GET
/api/v2/reconciliationPolicies/{collectionId}/discoveredDevices?filter=type:'DiscoveredMACAddress'
and device.id:{deviceId}
|
|
GET
/Services/REST/v1/getDiscoveredDeviceNetworks |
GET
/api/v2/reconciliationPolicies/{collectionId}/discoveredDevices?filter=type:'DiscoveredNetwork'
and device.id:{deviceId}
|
|
GET
/Services/REST/v1/getDiscoveredDeviceVlans |
GET
/api/v2/reconciliationPolicies/{collectionId}/discoveredDevices?filter=type:'DiscoveredVLAN'
and device.id:{deviceId}
|
|
GET
/Services/REST/v1/getDiscoveredDevices |
GET
/api/v2/reconciliationPolicies/{collectionId}/discoveredDevices?filter=type:in('DiscoveredRouter',
'DiscoveredSwitch')
|
|
GET /Services/REST/v1/getEntities |
|
|
GET
/Services/REST/v1/getEntitiesByName |
GET /api/v2?filter=name:'{name}' |
|
GET
/Services/REST/v1/getEntitiesByNameUsingOptions |
GET /api/v2?filter=name:'{name}' |
|
GET
/Services/REST/v1/getEntityByCIDR |
For IPv4 blocks with a configuration parent:
For IPv4 sub blocks with an IPv4 block parent:
For IPv4 networks:
|
|
GET /Services/REST/v1/getEntityById |
GET /api/v2?filter=id:{id} |
|
GET
/Services/REST/v1/getEntityByName |
GET /api/v2?filter=name:'{name}' |
|
GET
/Services/REST/v1/getEntityByPrefix |
For IPv6 blocks with a configuration parent:
For IPv6 sub blocks with an IPv6 block parent:
For IPv6 networks:
|
|
GET
/Services/REST/v1/getEntityByRange |
GET
/api/v2/networks/{collectionId}/ranges?filter=range:'{range}' |
|
GET
/Services/REST/v1/getHostRecordsByHint |
GET
/api/v2/zones/{collectionId}/resourceRecords?filter={filter
predicate}
|
|
GET /Services/REST/v1/getIP4Address |
|
|
GET
/Services/REST/v1/getIP4NetworksByHint |
GET
/api/v2/networks?filter=range:startsWith('{prefix}') |
|
GET /Services/REST/v1/getIP6Address |
|
|
GET
/Services/REST/v1/getIPRangedByIP |
GET
/api/v2/ranges?filter=range:contains('{address}') |
|
GET /Services/REST/v1/getKSK |
GET /api/v2/signingKeys/{id} |
This does not support the formats supported by
/v1/getKSK yet, it will only respond with a
JSON representation of the resource. |
GET
/Services/REST/v1/getLatestMigrationLog |
GET
/api/v2/imports?orderBy=desc(id)&fields=embed(logs) |
|
GET
/Services/REST/v1/getLinkedEntities |
|
|
GET
/Services/REST/v1/getLinkedEntitiesByUDL |
GET
/api/v2/userDefinedLinkDefinitions/{collectionId}/linkedResources
|
|
GET
/Services/REST/v1/getLinkedEntitiesEx |
See GET
/Services/REST/v1/getLinkedEntities |
|
GET
/Services/REST/v1/getLinkedIP4ObjectConflicts |
GET
/api/v2/templats/{id}/conflictingResources |
|
GET
/Services/REST/v1/getLocationByCode |
GET
/api/v2/locations?filter=code:'{code}' |
|
GET /Services/REST/v1/getMACAddress |
GET /api/v2/macAddresses/{id} |
|
GET
/Services/REST/v1/getMACAddressesInPool |
GET
/api/v2/macPools/{collectionId}/macAddresses |
|
GET
/Services/REST/v1/getMaxAllowedRange |
GET example to be provided for 9.5 |
|
GET
/Services/REST/v1/getNetworkLinkedProperties |
GET
/api/v2/networks/{id}/addresses?fields=embed(dependentRecords) |
|
GET
/Services/REST/v1/getNextAvailableIP4Address |
GET
/api/v2/networks/{collectionId}/addresses?filter=state:'UNASSIGNED'
|
|
GET
/Services/REST/v1/getNextAvailableIP4Network |
POST
/api/v2/blocks/{collectionId}/networks |
Set the range field to the value
/<prefix> where
<prefix> is the size of network
desired. |
GET
/Services/REST/v1/getNextAvailableIP6Address |
GET
/api/v2/networks/{collectionId}/address?filter=state:'UNASSIGNED'
|
|
GET
/Services/REST/v1/getNextAvailableIPRange |
|
Set the range field to the value
/<prefix> where
<prefix> is the size of network
desired. |
GET
/Services/REST/v1/getNextAvailableIPRanges |
Will not implement | RESTv2 resources are created individually per request. See
/getNextAvailableIPRange . |
GET
/Services/REST/v1/getNextIP4Address |
GET
/api/v2/networks/{collectionId}/addresses?filter=state:'UNASSIGNED'
|
|
GET /Services/REST/v1/getParent |
Will not implement | The URI of a resource’s collection can be found in its
_links.collection.href field. To receive
resource representations with a _links field,
the request must set its Accept header to
*/* or
application/hal+json . |
GET /Services/REST/v1/getProbeData |
To be implemented in 10.0 | |
GET /Services/REST/v1/getProbeStatus |
To be implemented in 10.0 | |
GET
/Services/REST/v1/getReplicationInfo |
GET
/api/v2/databases/{id}?fields=embed(servers) |
|
GET
/Services/REST/v1/getServerDeploymentRoles |
GET
/api/v2/servers/{collectionId}/deploymentRoles |
|
GET
/Services/REST/v1/getServerForRole |
GET
/api/v2/deploymentRoles/{collectionId}/interfaces |
The NetworkInterface and
PublishedInterface resources have a
server field. |
GET
/Services/REST/v1/getServerServices |
GET
/api/v2/servers/{collectionId}/services |
Service resources returned will depend on supported services
for the DNS/DHCP Server version. The
LicenseServer resource is only returned for
DNS/DHCP Server version 9.5 and greater. |
GET
/Services/REST/v1/getServerServicesConfigurationStatus |
GET
/api/v2/servers/{collectionId}/services/{id} |
|
GET
/Services/REST/v1/getSharedNetworks |
GET
/api/v2/tags/{collectionId}/taggedResources |
|
GET /Services/REST/v1/getSystemInfo |
GET
/api/v2/settings?filter=type:'SystemSettings' |
|
GET
/Services/REST/v1/getTemplateTaskStatus |
GET
/api/v2/templateApplications/{id} |
|
GET
/Services/REST/v1/getUserDefinedFields |
GET
/api/v2/userDefinedFieldDefinitions |
|
GET
/Services/REST/v1/getUserDefinedLink |
GET
/api/v2/userDefinedLinkDefinitions |
|
GET /Services/REST/v1/getZonesByHint |
GET /api/v2/zones?filter={filter
predicate} |
|
GET
/Services/REST/v1/isAddressAllocated |
GET
/api/v2/macAddresses/{collectionId}/addresses |
The /addresses subcollection of
MACAddress resources contains all IP
addresses currently assigned to the MAC address. |
GET
/Services/REST/v1/isMigrationRunning |
GET /api/v2/imports/{id} |
Check state field for the value
RUNNING |
PUT /Services/REST/v1/linkEntities |
|
|
PUT /Services/REST/v1/linkEntitiesEx |
See PUT
/Services/REST/v1/linkEntities |
|
GET /Services/REST/v1/login |
POST /api/v2/sessions |
|
GET
/Services/REST/v1/loginWithOptions |
POST /api/v2/sessions |
|
GET /Services/REST/v1/logout |
PATCH /api/v2/sessions/current |
Send request body: {"state":
"LOGGED_OUT"} |
M-R API endpoints
RESTv1 API | RESTv2 Endpoint | Notes |
---|---|---|
POST
/Services/REST/v1/mergeBlocksWithParent |
POST
/api/v2/{collection}/{collectionId}/merges |
|
POST
/Services/REST/v1/mergeSelectedBlocksOrNetworks |
POST
/api/v2/{collection}/{collectionId}/merges |
|
POST /Services/REST/v1/migrateFile |
PATCH /api/v2/imports/{id} |
Send request body: {"state": "QUEUED"} |
PUT
/Services/REST/v1/moveDeploymentRoles |
POST
/api/v2/servers/{collectionId}/moves |
|
PUT /Services/REST/v1/moveIPObject |
|
|
PUT /Services/REST/v1/moveResourceRecord |
POST
/api/v2/resourceRecords/{collectionId}/moves |
|
POST /Services/REST/v1/quickDeploy |
|
|
POST /Services/REST/v1/reapplyTemplate |
|
|
POST
/Services/REST/v1/reassignIP6Address |
PUT /api/v2/addresses/{id} |
|
POST
/Services/REST/v1/removeTrustRelationship |
DELETE /api/v2/trustRelationships/{id} |
|
PUT /Services/REST/v1/replaceServer |
PUT /api/v2/servers/{id} |
The server must first be disabled using a PATCH
request with {"state": "DISABLED"} |
PUT /Services/REST/v1/resizeRange |
|
Set range field to the new range. |
POST /Services/REST/v1/rolloverTSIGKey |
POST /api/v2/signingKeys/{id} |
Set privateKey to null |
S-Z API endpoints
RESTv1 API | RESTv2 Endpoints | Notes |
---|---|---|
GET /Services/REST/v1/searchByCategory |
Will not implement | Object categories are not well defined. Use the
filter query parameter as a
replacement. |
GET
/Services/REST/v1/searchByObjectTypes |
GET /api/v2?filter=type:'{type}' |
|
POST /Services/REST/v1/selectiveDeploy |
POST /api/v2/deployments |
|
PUT /Services/REST/v1/shareNetwork |
PUT /api/v2/networks/{id} |
Set the sharedNetworkTag field to the resource
of the shared network tag. |
POST /Services/REST/v1/splitIP4Network |
POST
/api/v2/blocks/{collectionId}/splits |
|
PUT /Services/REST/v1/startProbe |
To be implemented in 10.0 | |
POST
/Services/REST/v1/terminateUserSessions |
PATCH /api/v2/sessions/{id} |
Send request body: {"state":
"TERMINATED"} |
POST
/Services/REST/v1/unassignIP4NetworkTemplate |
|
Update the template field of a resource to
null to unassign a template. |
POST
/Services/REST/v1/unassignIP4Template |
|
Update the template field of a resource to
null to unassign a template. |
PUT /Services/REST/v1/unlinkEntities |
|
|
PUT /Services/REST/v1/unlinkEntitiesEx |
See PUT /Services/REST/v1/unlinkEntities |
|
PUT /Services/REST/v1/unshareNetwork |
PUT /api/v2/networks/{id} |
Set sharedNetworkTag to
null . |
PUT /Services/REST/v1/update |
PUT /api/v2/{collection}/{id} |
|
PUT /Services/REST/v1/updateAccessRight |
PUT /api/v2/accessRights/{id} |
|
POST /Services/REST/v1/updateBulkUdf |
To be implemented (TBD) | |
PUT
/Services/REST/v1/updateConfigurationSetting |
PUT /api/v2/configurations/{id} |
|
PUT
/Services/REST/v1/updateDHCP6ClientDeploymentOption |
PUT /api/v2/deploymentRoles/{id} |
|
PUT
/Services/REST/v1/updateDHCP6ServiceDeploymentOption |
PUT /api/v2/deploymentRoles/{id} |
|
PUT
/Services/REST/v1/updateDHCPClientDeploymentOption |
PUT /api/v2/deploymentRoles/{id} |
|
PUT
/Services/REST/v1/updateDHCPDeploymentRole |
PUT /api/v2/deploymentRoles/{id} |
|
PUT
/Services/REST/v1/updateDHCPServiceDeploymentOption |
PUT /api/v2/deploymentOptions/{id} |
|
PUT
/Services/REST/v1/updateDHCPVendorDeploymentOption |
PUT /api/v2/deploymentOptions/{id} |
|
PUT
/Services/REST/v1/updateDNSDeploymentOption |
PUT /api/v2/deploymentOptions/{id} |
|
PUT
/Services/REST/v1/updateDNSDeploymentRole |
PUT /api/v2/deploymentRoles/{id} |
|
PUT
/Services/REST/v1/updateRawDeploymentOption |
PUT /api/v2/deploymentOptions/{id} |
|
PUT
/Services/REST/v1/updateRetentionSettings |
PUT /api/v2/settings/{id} |
|
PUT
/Services/REST/v1/updateUserDefinedField |
PUT
/api/v2/userDefinedFieldDefinitions/{id} |
|
PUT
/Services/REST/v1/updateUserDefinedLink |
PUT
/api/v2/userDefinedLinkDefinitinons/{id} |
|
PUT /Services/REST/v1/updateUserPassword |
PATCH /api/v2/users/{id} |
Send request body: {"password":
"XXXXXXXX"} |
PUT /Services/REST/v1/updateWithOptions |
Option
Option Option |
Set Send a Send a |
POST /Services/REST/v1/uploadDockerImage |
To be implemented for 9.6 | |
POST
/Services/REST/v1/uploadMigrationFile |
POST /api/v2/imports |
|
POST
/Services/REST/v1/uploadResponsePolicyFile |
POST
/api/v2/responsePolicies/{collectionId}/imports |
|
POST /Services/REST/v1/uploadResponsePolicyItems
(deprecated) |
POST
/api/v2/responsePolicies/{collectionId}/imports |