Retrieve an existing DCV provisioner configuration
Retrieve an existing DCV provisioner configuration based on its name
|
name
string
required |
-
200 The DCV provisioner configuration
application/json_idstring (Internal ID) requiredObject internal ID
namestring requiredUnique name of the DCV provisioner configuration
typestring requiredProvisioner type discriminator
ValueCLOUDFLAREendpointstring requiredCloudflare API endpoint URL
zoneIdMappingsarray of object (ZoneIdMappings) requiredA set of Cloudflare DNS zone ID with regex
Array [
regexstring requiredRegex for mapping
zoneIdstring requiredCloudflare DNS zone ID where TXT records will be provisioned with regex
]
ttlstring | null (FiniteDuration) requiredTTL for DNS TXT records provisioned during DCV challenges
credentialsstring requiredName of the credentials configuration holding the Cloudflare API key
proxystring | nullName of the HTTP proxy configuration to use
timeoutstring | null (FiniteDuration)Request timeout
delegationZonestring | nullDNS zone used for CNAME delegation when provisioning DCV challenges
_idstring (Internal ID) requiredObject internal ID
namestring requiredUnique name of the DCV provisioner configuration
typestring requiredProvisioner type discriminator
ValueAZURE_DNSttlstring | null (FiniteDuration) requiredDNS record cache duration
tenantIdstring requiredAzure Active Directory tenant ID
subscriptionIdstring requiredAzure subscription ID
resourceGroupNamestring requiredAzure resource group containing the DNS zones
endpointstring | nullAzure DNS API endpoint URL override
zoneIdMappingsarray of object (ZoneIdMappings)A set of Azure DNS zone ID with regex
Array [
regexstring requiredRegex for mapping
zoneIdstring requiredCloudflare DNS zone ID where TXT records will be provisioned with regex
]
proxystring | nullName of the HTTP proxy configuration to use
timeoutstring | null (FiniteDuration)Request timeout
credentialsstring | nullName of the credentials configuration holding the Azure client ID and secret
delegationZonestring | nullDNS zone used for CNAME delegation when provisioning DCV challenges
authorityHoststring | nullAzure AD authority host URL override
_idstring (Internal ID) requiredObject internal ID
namestring requiredUnique name of the DCV provisioner configuration
typestring requiredProvisioner type discriminator
ValueEFFICIENT_IPendpointstring requiredEfficientIP SOLIDserver API endpoint URL
ttlstring | null (FiniteDuration) requiredDNS record cache duration
credentialsstring requiredName of the credentials configuration holding the EfficientIP login and password
dnsNamestring requiredName of the DNS server on the SOLIDserver to use for provisioning
zoneIdMappingsarray of object (ZoneIdMappings)A set of DNS zone ID with regex
Array [
regexstring requiredRegex for mapping
zoneIdstring requiredCloudflare DNS zone ID where TXT records will be provisioned with regex
]
proxystring | nullName of the HTTP proxy configuration to use
timeoutstring | null (FiniteDuration)Request timeout
delegationZonestring | nullDNS zone used for CNAME delegation when provisioning DCV challenges
dnsViewstring | nullDNS view to target on the SOLIDserver
_idstring (Internal ID) requiredObject internal ID
namestring requiredUnique name of the DCV provisioner configuration
typestring requiredProvisioner type discriminator
ValuePOWER_DNSendpointstring requiredPowerDNS API endpoint URL
zoneIdMappingsarray of object (ZoneIdMappings) requiredA set of DNS zone ID with regex
Array [
regexstring requiredRegex for mapping
zoneIdstring requiredCloudflare DNS zone ID where TXT records will be provisioned with regex
]
ttlstring | null (FiniteDuration) requiredDNS record cache duration
credentialsstring requiredName of the credentials configuration holding the PowerDNS API key
proxystring | nullName of the HTTP proxy configuration to use
timeoutstring | null (FiniteDuration)Request timeout
delegationZonestring | nullDNS zone used for CNAME delegation when provisioning DCV challenges
_idstring (Internal ID) requiredObject internal ID
namestring requiredUnique name of the DCV provisioner configuration
typestring requiredProvisioner type discriminator
ValueROUTE_53zoneIdMappingsarray of object (ZoneIdMappings) requiredA set of Route 53 hosted zone ID with regex
Array [
regexstring requiredRegex for mapping
zoneIdstring requiredCloudflare DNS zone ID where TXT records will be provisioned with regex
]
ttlstring | null (FiniteDuration) requiredDNS record cache duration
endpointstring | nullRoute 53 API endpoint URL override (for local testing)
proxystring | nullName of the HTTP proxy configuration to use
timeoutstring | null (FiniteDuration)Request timeout
credentialsstring | nullName of the credentials configuration holding the AWS access key ID and secret
delegationZonestring | nullDNS zone used for CNAME delegation when provisioning DCV challenges
regionstring | nullAWS region override
roleArnstring | nullIAM role ARN to assume for cross-account Route 53 access
-
401 Unauthorized request
application/problem+jsonerrorstring requiredThe error code of the problem
ValueSEC-AUTH-001messagestring requiredA short, human-readable summary of the problem type
ValueUnexpected Errortitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueUnexpected Errordetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-002messagestring requiredA short, human-readable summary of the problem type
ValueInvalid credentials or principal does not existtitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueInvalid credentials or principal does not existdetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-003messagestring requiredA short, human-readable summary of the problem type
ValueCertificate is not trustedtitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueCertificate is not trusteddetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-004messagestring requiredA short, human-readable summary of the problem type
ValueCertificate is expiredtitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueCertificate is expireddetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-005messagestring requiredA short, human-readable summary of the problem type
ValueCertificate is revokedtitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueCertificate is revokeddetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-006messagestring requiredA short, human-readable summary of the problem type
ValuePrincipal not authenticatedtitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValuePrincipal not authenticateddetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-007messagestring requiredA short, human-readable summary of the problem type
ValueInvalid Identity Providertitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueInvalid Identity Providerdetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-008messagestring requiredA short, human-readable summary of the problem type
ValueInvalid redirect pathtitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueInvalid redirect pathdetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-009messagestring requiredA short, human-readable summary of the problem type
ValuePrincipal not authenticated or authentication expiredtitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValuePrincipal not authenticated or authentication expireddetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
-
403 Forbidden action
application/problem+jsonerrorstring requiredThe error code of the problem
ValueSEC-PERM-001messagestring requiredA short, human-readable summary of the problem type
ValueInsufficient privilegestitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueInsufficient privilegesdetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueLIC-002messagestring requiredA short, human-readable summary of the problem type
ValueInvalid Licensetitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueInvalid Licensedetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueLIC-004messagestring requiredA short, human-readable summary of the problem type
ValueExpired Licensetitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueExpired Licensedetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
-
404 Not Found
application/problem+jsonerrorstring requiredThe error code of the problem
ValueDCV-PROVISIONER-003messagestring requiredA short, human-readable summary of the problem type
ValueDCV Provisioner not foundtitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueDCV Provisioner not founddetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
-
500 Internal Server error
application/problem+jsonerrorstring requiredThe error code of the problem
ValueDCV-PROVISIONER-001messagestring requiredA short, human-readable summary of the problem type
ValueUnexpected errortitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueUnexpected errordetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-001messagestring requiredA short, human-readable summary of the problem type
ValueUnexpected Errortitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueUnexpected Errordetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueLIC-001messagestring requiredA short, human-readable summary of the problem type
ValueUnexpected errortitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueUnexpected errordetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807