Skip to main content
GET
cURL

Query Parameters

lb_or_gateway_name
string

Load balancer name.

vpc_id
string

VPC_ID.

auth_type
enum<string>

Authentication type.

Available options:
duo_auth,
duo_ldap_auth,
ldap_auth,
none,
okta_auth,
saml_auth
dns
boolean

Modifying a DNS.

okta_url
string

Okta URL.

okta_token
string

Token for API access.

okta_username_suffix
string

Token for API access.

integration_key
string

Duo integration key.

secret_key
string

Duo secret key.

api_hostname
string

API hostname.

duo_push_mode
enum<string>

Duo push mode.

Available options:
auto,
selective,
token
enable_ldap
boolean

Enable LDAP authentication.

ldap_server
string

LDAP server address.

ldap_base_dn
string

Base DN for User entries.

ldap_user_attr
string

Username attribute.

ldap_additional_req
string

Additional requirements.

ldap_enable_tls
enum<string>

Enable TLS authentication. A boolean choice expressed as a string

Available options:
yes,
no
ldap_bind_dn
string

Bind DN.

ldap_password
string

Bind DN password.

ldap_client_cert
string

Client cert in PEM format.

ldap_ca_cert
string

CA cert in PEM format.

ldap_user
string

LDAP user.

action
string

The API action to perform. Required for 7.2 controllers only.

CID
string

The opaque session ID token. Required for 7.2 controllers only.

Response

General v2 API response schema.

A generic API response container for v2 style APIs.

errortype
string

Error type if the API failed.

reason
string

Failure reason if the API failed.

results

API response data

return
boolean

Whether the API returned successfully