Errors

Errors

This is a list of all errors that are coded (PB#NUM: …) in Phonebook. The library encodes all of its errors in this format to give more context to the user when an error comes up.

General Error Codes

PB#NumberTitleDescription
PB#0001Provider undefinedPhonebook requires a valid provider to be defined through the PHONEBOOK_PROVIDER environment variable. The list of available provider is available here.
PB#0002DNS Record not found
PB#0003Provider could not delete the DNS record
PB#0100Provider missing informationPhonebook failed to initialized a client for the specified provider, more information can be found in the error message and in the provider’s section.

DNS-01 Solver Specific Error Codes

NumberTitleDescription
PB-SLV-#0001A Challenge DNS Record with type TXT had more than one key associated, this is most likely a bug. File an issue.
PB-SLV-#0002The server accepting challenges could not start due to an error, this is most likely a bug. File an issue.
PB-SLV-#0003Could not parse the label selectorThis is an internal error, if it happens to you, please file an issue.

Provider Specific Error Codes

Azure

NumberTitleDescription
PB-AZ-#0001Azure Client ID Not FoundPhonebook failed to find a valid client ID from a secret or env-var for the azure provider
PB-AZ-#0002Azure Client Secret Not FoundPhonebook failed to find a valid client secret from a secret or env-var for the azure provider
PB-AZ-#0003Azure Tenant ID Not FoundPhonebook failed to find a valid tenant ID from a secret or env-var for the azure provider
PB-AZ-#0004Azure Subscription ID Not FoundPhonebook failed to find a valid subscription ID from a secret or env-var for the azure provider
PB-AZ-#0005Azure Zone Name Not FoundPhonebook failed to find a valid zone name from a secret or env-var for the azure provider
PB-AZ-#0006Azure Resource Group Not FoundPhonebook failed to find a valid resource group from a secret or env-var for the azure provider
PB-AZ-#0007Unable to Create Azure CredentialPhonebook was unable to create an Azure credential using the provided information
PB-AZ-#0008Unable to Create Azure DNS ClientPhonebook was unable to create an Azure DNS client using the provided information
PB-AZ-#0009Failed to Create Resource Record SetPhonebook failed to create a resource record set for Azure DNS
PB-AZ-#0010Failed to Create Azure DNS RecordPhonebook failed to create an Azure DNS record
PB-AZ-#0011Failed to Delete Azure DNS RecordPhonebook failed to delete an Azure DNS record
PB-AZ-#0012CNAME Record Can Only Have One TargetPhonebook attempted to create a CNAME record with multiple targets, which is not allowed
PB-AZ-#0013Invalid MX RecordPhonebook encountered an invalid MX record format
PB-AZ-#0014Invalid SRV RecordPhonebook encountered an invalid SRV record format
PB-AZ-#0015Unsupported Record TypePhonebook encountered an unsupported DNS record type for Azure DNS

AWS

NumberTitleDescription
PB-AWS-#0001Failed to Load AWS ConfigurationPhonebook failed to load the AWS configuration
PB-AWS-#0002Zone ID Not FoundPhonebook failed to find a valid AWS Zone ID from a secret or env-var
PB-AWS-#0003Failed to Create DNS RecordPhonebook failed to create a DNS record in AWS Route 53
PB-AWS-#0004Failed to Delete DNS RecordPhonebook failed to delete a DNS record in AWS Route 53
PB-AWS-#0005Unsupported Record TypePhonebook encountered an unsupported DNS record type for AWS Route 53

Cloudflare

NumberTitleDescription
PB-CF-#0001API Key Not FoundPhonebook failed to find a valid Cloudflare API key from a secret or env-var
PB-CF-#0002Zone ID Not FoundPhonebook failed to find a valid Cloudflare Zone ID from a secret or env-var
PB-CF-#0003Unable to Create Cloudflare ClientPhonebook was unable to create a Cloudflare client using the provided information
PB-CF-#0004Multiple Targets Not SupportedPhonebook attempted to create a DNS record with multiple targets, which is not supported by Cloudflare
Get Started