Register a new DCV provisioner configuration
Register a new DCV provisioner configuration
DCV provisioner configuration to register
|
name
string
requiredUnique name of the DCV provisioner configuration |
|||
|
type
string
requiredProvisioner type discriminator
Value
CLOUDFLARE
|
|||
|
endpoint
string
requiredCloudflare API endpoint URL |
|||
|
ttl
string | null (FiniteDuration)
requiredTTL for DNS TXT records provisioned during DCV challenges |
|||
|
credentials
string
requiredName of the credentials configuration holding the Cloudflare API key |
|||
|
zoneIdMappings
array of object (ZoneIdMappings)
A set of Cloudflare DNS zone ID with regex |
|||
|
Array [
] |
|||
|
proxy
string | null
Name of the HTTP proxy configuration to use |
|||
|
timeout
string | null (FiniteDuration)
Request timeout |
|||
|
delegationZone
string | null
DNS zone used for CNAME delegation when provisioning DCV challenges |
|||
|
name
string
requiredUnique name of the DCV provisioner configuration |
|||
|
type
string
requiredProvisioner type discriminator
Value
AZURE_DNS
|
|||
|
ttl
string | null (FiniteDuration)
requiredDNS record cache duration |
|||
|
tenantId
string
requiredAzure Active Directory tenant ID |
|||
|
subscriptionId
string
requiredAzure subscription ID |
|||
|
resourceGroupName
string
requiredAzure resource group containing the DNS zones |
|||
|
endpoint
string | null
Azure DNS API endpoint URL override |
|||
|
zoneIdMappings
array of object (ZoneIdMappings)
A set of Azure DNS zone ID with regex |
|||
|
Array [
] |
|||
|
proxy
string | null
Name of the HTTP proxy configuration to use |
|||
|
timeout
string | null (FiniteDuration)
Request timeout |
|||
|
credentials
string | null
Name of the credentials configuration holding the Azure client ID and secret |
|||
|
delegationZone
string | null
DNS zone used for CNAME delegation when provisioning DCV challenges |
|||
|
authorityHost
string | null
Azure AD authority host URL override |
|||
|
name
string
requiredUnique name of the DCV provisioner configuration |
|||
|
type
string
requiredProvisioner type discriminator
Value
EFFICIENT_IP
|
|||
|
endpoint
string
requiredEfficientIP SOLIDserver API endpoint URL |
|||
|
ttl
string | null (FiniteDuration)
requiredDNS record cache duration |
|||
|
credentials
string
requiredName of the credentials configuration holding the EfficientIP login and password |
|||
|
dnsName
string
requiredName of the DNS server on the SOLIDserver to use for provisioning |
|||
|
zoneIdMappings
array of object (ZoneIdMappings)
A set of DNS zone ID with regex |
|||
|
Array [
] |
|||
|
proxy
string | null
Name of the HTTP proxy configuration to use |
|||
|
timeout
string | null (FiniteDuration)
Request timeout |
|||
|
delegationZone
string | null
DNS zone used for CNAME delegation when provisioning DCV challenges |
|||
|
dnsView
string | null
DNS view to target on the SOLIDserver |
|||
|
name
string
requiredUnique name of the DCV provisioner configuration |
|||
|
type
string
requiredProvisioner type discriminator
Value
POWER_DNS
|
|||
|
endpoint
string
requiredPowerDNS API endpoint URL |
|||
|
ttl
string | null (FiniteDuration)
requiredDNS record cache duration |
|||
|
credentials
string
requiredName of the credentials configuration holding the PowerDNS API key |
|||
|
zoneIdMappings
array of object (ZoneIdMappings)
A set of DNS zone ID with regex |
|||
|
Array [
] |
|||
|
proxy
string | null
Name of the HTTP proxy configuration to use |
|||
|
timeout
string | null (FiniteDuration)
Request timeout |
|||
|
delegationZone
string | null
DNS zone used for CNAME delegation when provisioning DCV challenges |
|||
|
name
string
requiredUnique name of the DCV provisioner configuration |
|||
|
type
string
requiredProvisioner type discriminator
Value
ROUTE_53
|
|||
|
ttl
string | null (FiniteDuration)
requiredDNS record cache duration |
|||
|
endpoint
string | null
Route 53 API endpoint URL override (for local testing) |
|||
|
zoneIdMappings
array of object (ZoneIdMappings)
A set of Route 53 hosted zone ID with regex |
|||
|
Array [
] |
|||
|
proxy
string | null
Name of the HTTP proxy configuration to use |
|||
|
timeout
string | null (FiniteDuration)
Request timeout |
|||
|
credentials
string | null
Name of the credentials configuration holding the AWS access key ID and secret |
|||
|
delegationZone
string | null
DNS zone used for CNAME delegation when provisioning DCV challenges |
|||
|
region
string | null
AWS region override |
|||
|
roleArn
string | null
IAM role ARN to assume for cross-account Route 53 access |
|||
-
201 DCV provisioner configuration successfully registered
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
-
400 Bad Request
application/problem+jsonerrorstring requiredThe error code of the problem
ValueDCV-PROVISIONER-002messagestring requiredA short, human-readable summary of the problem type
ValueInvalid DCV Provisionertitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueInvalid DCV Provisionerdetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueDCV-PROVISIONER-004messagestring requiredA short, human-readable summary of the problem type
ValueDCV Provisioner already existstitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueDCV Provisioner already existsdetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
-
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
-
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