GET /v1/getDeploymentOptions - BlueCat Integrity

GET /v1/getDeploymentOptions - BlueCat Integrity - 9.3.0

Address Manager API Guide

Locale

English

Product name

BlueCat Integrity

Version

9.3.0

Description

Retrieves deployment options for Address Manager DNS and DHCP services.

Note: This API method supports read-only API sessions. For more information on read-only API sessions and a list of API methods that support read-only API session, refer to Read-only API sessions.

Parameters

Name	Description
entityId	Location: query Type: integer (int64) The object ID of the entity to which the DNS or DHCP deployment option is assigned.
optionTypes	Location: query Type: string The type of deployment options. Multiple options can be separated by a \| (pipe) character. This value must be one of the following items: DNSOption DNSRawOption DHCPRawOption DHCPV6RawOption DHCPV4ClientOption DHCPV6ClientOption DHCPServiceOption DHCPV6ServiceOption VendorClientOption Note: Start of Authority (SOA) records can be retrieved using the DNSOption option type. For complete list of Option Types and Object Types constants, refer to Option types and Object types. If Invalid deployment option types or invalid strings are specified, the API execution will fail and return the error message: " Invalid deployment option found ". For example, if the user passes DHCPv6ClientOption for IPv4 networks, it will return this error message as DHCPv6 client options are not a valid for IPv4 networks. If specified as an empty string "", all deployment options for the specified entity will be returned. Depending on the type of DNS deployment option being retrieved, the format of the value might differ. For more information, refer to Reference: Deployment option value formats.
serverId	Location: query Type: integer (int64) The specific server or server group to which options are deployed. The valid values are as follows: >0 —returns only the options that are linked to the specified server ID. <0 —returns all options regardless of the server ID specified. =0 —returns only the options that are linked to all servers.

Name

Description

entityId

Location: query

Type: integer (int64)

The object ID of the entity to which the DNS or DHCP deployment option is assigned.

optionTypes

Location: query

Type: string

The type of deployment options. Multiple options can be separated by a | (pipe) character. This value must be one of the following items:

DNSOption
DNSRawOption
DHCPRawOption
DHCPV6RawOption
DHCPV4ClientOption
DHCPV6ClientOption
DHCPServiceOption
DHCPV6ServiceOption
VendorClientOption

Note: Start of Authority (SOA) records can be retrieved using the DNSOption option type.

For complete list of Option Types and Object Types constants, refer to Option types and Object types.

If Invalid deployment option types or invalid strings are specified, the API execution will fail and return the error message: " Invalid deployment option found ". For example, if the user passes DHCPv6ClientOption for IPv4 networks, it will return this error message as DHCPv6 client options are not a valid for IPv4 networks.
If specified as an empty string "", all deployment options for the specified entity will be returned.
Depending on the type of DNS deployment option being retrieved, the format of the value might differ. For more information, refer to Reference: Deployment option value formats.

serverId

Location: query

Type: integer (int64)

The specific server or server group to which options are deployed. The valid values are as follows:

>0 —returns only the options that are linked to the specified server ID.
<0 —returns all options regardless of the server ID specified.
=0 —returns only the options that are linked to all servers.

Responses

Code	Description
200	Type: Array of APIDeploymentOption Returns all deployment options assigned to the specified object including inherited options from higher level parent objects. If an option is inherited and overridden, then only the overriding option will be returned.