{
"openapi" : "3.0.1",
"info" : {
"title" : "user-api-gateway",
"version" : "1.0.0",
"x-logo" : {
"url" : "https://cdn.eurodns.com/images/showcase/assets/LOGO-WHITE-BG.png",
"altText" : "Logo"
}
},
"servers" : [ {
"url" : "https://rest-api.eurodns.com"
} ],
"security" : [ {
"X-APP-ID" : [ ],
"X-API-KEY" : [ ]
} ],
"tags" : [ {
"name" : "DasService",
"x-displayName" : "Domains Availability"
}, {
"name" : "TldService",
"x-displayName" : "Top-Level Domains"
}, {
"name" : "DomainService",
"x-displayName" : "Domains"
}, {
"name" : "DnsProvider",
"x-displayName" : "DNS Zones"
}, {
"name" : "ContactProfileService",
"x-displayName" : "Contact Profiles"
}, {
"name" : "NameserverProfileService",
"x-displayName" : "Nameserver Profiles"
}, {
"name" : "ContactValidationService",
"x-displayName" : "Contact Validation"
}, {
"name" : "SubscriptionService",
"x-displayName" : "Subscriptions"
}, {
"name" : "SslSubscriptionService",
"x-displayName" : "SSL subscriptions"
}, {
"name" : "AcmeSslSubscriptionService",
"x-displayName" : "ACME SSL subscriptions"
}, {
"name" : "EmailSubscriptionService",
"x-displayName" : "Email subscriptions"
}, {
"name" : "PremiumDnsSubscriptionService",
"x-displayName" : "Premium DNS subscriptions"
}, {
"name" : "MicrosoftSubscriptionService",
"x-displayName" : "Microsoft subscriptions"
}, {
"name" : "HttpsRedirectService",
"x-displayName" : "HTTPS redirect subscriptions"
}, {
"name" : "AccountService",
"x-displayName" : "Accounts"
}, {
"name" : "OrderService",
"x-displayName" : "Orders"
}, {
"name" : "InvoiceService",
"x-displayName" : "Invoices"
}, {
"name" : "CustomerInvoiceProfileService",
"x-displayName" : "Invoice Profiles"
} ],
"paths" : {
"/accounts/prepaid-balance" : {
"get" : {
"tags" : [ "AccountService" ],
"summary" : "Obtaining your prepaid account balance",
"description" : "Depending on the actions you perform with your API account, a fee will be debited from your prepaid account. Use the following request to obtain your current balance.",
"operationId" : "getPrepaidAccountBalance",
"responses" : {
"default" : {
"description" : "Request error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorResponse"
}
}
}
},
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PrepaidBalance"
}
}
}
}
}
}
},
"/dns-zones/{domain-name}" : {
"get" : {
"tags" : [ "DnsProvider" ],
"summary" : "Get DNS Zone",
"description" : "Returns a DNS Zone with its DNS records, URL forwards and mail forwards.
You may then make changes (e.g. adding, updating and removing records) to the DNS Zone and use it with the Validate or Save operations.",
"operationId" : "getDnsZone",
"parameters" : [ {
"name" : "domain-name",
"in" : "path",
"description" : "a domain name (e.g. example.com)",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DnsZonePage"
}
}
}
}
}
},
"put" : {
"tags" : [ "DnsProvider" ],
"summary" : "Save DNS Zone",
"description" : "Takes a DNS Zone and Save any changes on DNS records.
If the changes made to the DNS Zone are not valid, the operation replies with a 400 Bad Request. Use the Validate operation to get a detailed Validation report.",
"operationId" : "saveDnsZone",
"parameters" : [ {
"name" : "domain-name",
"in" : "path",
"description" : "a domain name (e.g. example.com)",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DnsZonePage"
}
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "No Content"
}
}
}
},
"/dns-zones/{domain-name}/check" : {
"post" : {
"tags" : [ "DnsProvider" ],
"summary" : "Validate DNS Zone",
"description" : "Takes a DNS zone and validate any changes on DNS records, URL forwards and mail forwards.
Returns the updated DNS Zone with a detailed Validation report.
This operation does not apply any changes made to the DNS Zone, use the Save operation instead.",
"operationId" : "checkDnsZone",
"parameters" : [ {
"name" : "domain-name",
"in" : "path",
"description" : "a domain name (e.g. example.com)",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DnsZonePage"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DnsZonePage"
}
}
}
}
}
}
},
"/dns-zones/{domain-name}/snapshots" : {
"get" : {
"tags" : [ "DnsProvider" ],
"summary" : "List DNS Zone Snapshots",
"operationId" : "listDnsZoneSnapshots",
"parameters" : [ {
"name" : "domain-name",
"in" : "path",
"description" : "a domain name (e.g. example.com)",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/DnsZoneSnapshotItem"
}
}
}
}
}
}
}
},
"/dns-zones/{domain-name}/snapshots/{id}" : {
"get" : {
"tags" : [ "DnsProvider" ],
"summary" : "Get DNS Zone Snapshot ",
"operationId" : "getSnapShot",
"parameters" : [ {
"name" : "domain-name",
"in" : "path",
"description" : "a domain name (e.g. example.com)",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "id of Zone Snapshot to return",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DnsZoneSnapshotPage"
}
}
}
}
}
}
},
"/dns-zones/{domain-name}/dnssec-status" : {
"get" : {
"tags" : [ "DnsProvider" ],
"summary" : "Get DNS Zone DNSSEC status",
"description" : "Returns the current DNSSEC Status of a DNS Zone. If zone is signed, the DNSSEC keys will be returned as well.",
"operationId" : "getDnssecStatus",
"parameters" : [ {
"name" : "domain-name",
"in" : "path",
"description" : "a domain name (e.g. example.com)",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DnsZoneDnssecStatus"
}
}
}
}
}
}
},
"/dns-zones/{domain-name}/dns-records" : {
"post" : {
"tags" : [ "DnsProvider" ],
"summary" : "Add DNS records",
"description" : "Add one or more DNS records to the zone and save the changes.",
"operationId" : "addDnsRecords",
"parameters" : [ {
"name" : "domain-name",
"in" : "path",
"description" : "a domain name (e.g. example.com)",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/DnsRecord"
}
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DnsZonePage"
}
}
}
}
}
}
},
"/dns-zones/{domain-name}/dns-records/{record-id}" : {
"delete" : {
"tags" : [ "DnsProvider" ],
"summary" : "Delete a DNS record",
"description" : "Delete a DNS record from the zone and save the changes.",
"operationId" : "deleteDnsRecord",
"parameters" : [ {
"name" : "domain-name",
"in" : "path",
"description" : "a domain name (e.g. example.com)",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string"
}
}, {
"name" : "record-id",
"in" : "path",
"description" : "a Dns record id",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DnsZonePage"
}
}
}
}
}
}
},
"/dns-zones/{domain-name}/sign" : {
"post" : {
"tags" : [ "DnsProvider" ],
"summary" : "Sign DNS Zone",
"description" : "Sign DNS Zone. If the domain is registered with us, please sign the domain instead using the appropriate command.",
"operationId" : "signZone",
"parameters" : [ {
"name" : "domain-name",
"in" : "path",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "No Content"
}
}
}
},
"/dns-zones/{domain-name}/unsign" : {
"post" : {
"tags" : [ "DnsProvider" ],
"summary" : "Unsign DNS Zone",
"description" : "Unsign DNS Zone. If the domain is registered with us, please unsign the domain instead using the appropriate command.",
"operationId" : "unsignZone",
"parameters" : [ {
"name" : "domain-name",
"in" : "path",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "No Content"
}
}
}
},
"/zone-profiles" : {
"get" : {
"tags" : [ "DnsProvider" ],
"summary" : "List DNS Zone Profiles",
"operationId" : "listZoneProfiles",
"parameters" : [ {
"name" : "pagination-page",
"in" : "header",
"description" : "Page number for Pagination",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "pagination-size",
"in" : "header",
"description" : "Number of results per page for Pagination. If pagination-size = -1, results are returned in one page",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "pagination-sortfield",
"in" : "header",
"description" : "Field name for result sorting",
"required" : false,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string",
"enum" : [ "id", "name" ]
}
}, {
"name" : "pagination-sortorder",
"in" : "header",
"description" : "Field Sort direction",
"required" : false,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string",
"enum" : [ "asc", "desc" ]
}
}, {
"name" : "name",
"in" : "query",
"description" : "zone profile name",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"headers" : {
"pagination-page" : {
"description" : "The current page number",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
},
"pagination-size" : {
"description" : "The number of items per page",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
},
"pagination-count" : {
"description" : "The total number of items",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
},
"pagination-sortfield" : {
"description" : "The field used for sorting",
"required" : false,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string",
"enum" : [ "id", "name" ]
}
},
"pagination-sortorder" : {
"description" : "The sort order",
"required" : false,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string"
}
}
},
"content" : {
"application/json" : {
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ZoneProfile"
}
}
}
}
}
}
},
"post" : {
"tags" : [ "DnsProvider" ],
"summary" : "Create DNS Zone Profile",
"operationId" : "createZoneProfile",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ZoneProfilePage"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ZoneProfilePage"
}
}
}
}
}
}
},
"/zone-profiles/{id}" : {
"get" : {
"tags" : [ "DnsProvider" ],
"summary" : "Get DNS Zone Profile",
"operationId" : "getProfile",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "id of zone profile to return",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ZoneProfilePage"
}
}
}
}
}
},
"put" : {
"tags" : [ "DnsProvider" ],
"summary" : "Save DNS Zone Profile",
"operationId" : "updateUserAPiZoneProfile",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "id of zone profile to update",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ZoneProfilePage"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ZoneProfilePage"
}
}
}
}
}
},
"delete" : {
"tags" : [ "DnsProvider" ],
"summary" : "Delete DNS Zone Profile",
"operationId" : "deleteZoneProfile",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "id of zone profile to delete",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
} ],
"responses" : {
"204" : {
"description" : "No Content"
}
}
}
},
"/zone-profiles/check" : {
"post" : {
"tags" : [ "DnsProvider" ],
"summary" : "Validate DNS Zone Profile",
"operationId" : "checkZoneProfile",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ZoneProfilePage"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ZoneProfilePage"
}
}
}
}
}
}
},
"/domains/{domain-name}/sign" : {
"post" : {
"tags" : [ "DomainService" ],
"summary" : "Sign domain",
"operationId" : "signDomain",
"parameters" : [ {
"name" : "domain-name",
"in" : "path",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "No Content"
}
}
}
},
"/domains/{domain-name}/unsign" : {
"post" : {
"tags" : [ "DomainService" ],
"summary" : "Unsign domain",
"operationId" : "unsignDomain",
"parameters" : [ {
"name" : "domain-name",
"in" : "path",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "No Content"
}
}
}
},
"/domains/{domain-name}" : {
"get" : {
"tags" : [ "DomainService" ],
"summary" : "Get domain",
"description" : "Get a domain by name",
"operationId" : "getDomain",
"parameters" : [ {
"name" : "domain-name",
"in" : "path",
"description" : "The exact domain name",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Domain"
}
}
}
}
}
}
},
"/domains/search" : {
"post" : {
"tags" : [ "DomainService" ],
"summary" : "Search domains",
"description" : "Search domains with a search term and search filters",
"operationId" : "searchDomains",
"parameters" : [ {
"name" : "pagination-page",
"in" : "header",
"description" : "Page number for Pagination",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "pagination-size",
"in" : "header",
"description" : "Number of results per page for Pagination. If pagination-size = -1, results are returned in one page",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "pagination-sortfield",
"in" : "header",
"description" : "Field name for result sorting",
"required" : false,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string",
"enum" : [ "CREATION_DATE", "DOMAIN_NAME", "EXPIRATION_DATE", "FOLDER", "LAST_UPDATE_DATE", "REACTIVATE_UNTIL", "RENEWABLE_FROM", "RENEWABLE_UNTIL", "RENEWAL_METHOD", "TLD_NAME" ]
}
}, {
"name" : "pagination-sortorder",
"in" : "header",
"description" : "Field Sort direction",
"required" : false,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string",
"enum" : [ "asc", "desc" ]
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DomainSearchRequest"
}
}
}
},
"responses" : {
"200" : {
"description" : "OK",
"headers" : {
"pagination-page" : {
"description" : "The current page number",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
},
"pagination-size" : {
"description" : "The number of items per page",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
},
"pagination-count" : {
"description" : "The total number of items",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
},
"pagination-sortfield" : {
"description" : "The field used for sorting",
"required" : false,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string"
}
},
"pagination-sortorder" : {
"description" : "The sort order",
"required" : false,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string"
}
}
},
"content" : {
"application/json" : {
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/DomainSearchResult"
}
}
}
}
}
}
}
},
"/tlds/{id}" : {
"get" : {
"tags" : [ "TldService" ],
"summary" : "Get a TLD",
"description" : "Takes an `id` of TLD.
Returns a TLD which contains all information relative to the TLD matching the specified `id`.",
"operationId" : "getTld",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "id of TLD to return",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
} ],
"responses" : {
"200" : {
"description" : "TLD which has the specified ID",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Tld"
}
}
}
},
"default" : {
"description" : "Error message relative to TLD retrieving",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/tlds" : {
"get" : {
"tags" : [ "TldService" ],
"summary" : "List TLDs",
"description" : "Takes filters (`tld-name`).
Returns a list of TLDs (matching specified filters) which each contains all information relative to the TLD.",
"operationId" : "listTld",
"parameters" : [ {
"name" : "pagination-page",
"in" : "header",
"description" : "Page number for Pagination",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "pagination-size",
"in" : "header",
"description" : "Number of results per page for Pagination. If pagination-size = -1, results are returned in one page",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "tld-name",
"in" : "query",
"description" : "filter by TLD name",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "List of all TLDs matching specified filters",
"headers" : {
"pagination-page" : {
"description" : "The current page number",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
},
"pagination-size" : {
"description" : "The number of items per page",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
},
"pagination-count" : {
"description" : "The total number of items",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
},
"pagination-sortfield" : {
"description" : "The field used for sorting",
"required" : false,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string"
}
},
"pagination-sortorder" : {
"description" : "The sort order",
"required" : false,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string"
}
}
},
"content" : {
"application/json" : {
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/Tld"
}
}
}
}
},
"default" : {
"description" : "Error message relative to TLD list retrieving",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/invoices/{id}" : {
"get" : {
"tags" : [ "InvoiceService" ],
"summary" : "Get an invoice",
"description" : "Get the full details of an invoice, containing the invoice lines details.",
"operationId" : "getInvoice",
"parameters" : [ {
"name" : "id",
"in" : "path",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
} ],
"responses" : {
"default" : {
"description" : "Request error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorResponse"
}
}
}
},
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Invoice"
}
}
}
}
}
}
},
"/invoices" : {
"get" : {
"tags" : [ "InvoiceService" ],
"summary" : "Search for invoices",
"description" : "Search for all invoices matching the provided parameters.",
"operationId" : "getInvoices",
"parameters" : [ {
"name" : "pagination-page",
"in" : "header",
"required" : false,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "pagination-size",
"in" : "header",
"required" : false,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "pagination-sortfield",
"in" : "header",
"required" : false,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string"
}
}, {
"name" : "pagination-sortorder",
"in" : "header",
"required" : false,
"style" : "simple",
"explode" : false,
"schema" : {
"$ref" : "#/components/schemas/SortOrder"
}
}, {
"name" : "created-after",
"in" : "query",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"description" : "The invoice creation date start range.",
"format" : "date-time"
}
}, {
"name" : "created-before",
"in" : "query",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"description" : "The invoice creation date end range.",
"format" : "date-time"
}
}, {
"name" : "invoice-type",
"in" : "query",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"$ref" : "#/components/schemas/InvoiceType"
}
}, {
"name" : "invoice-statuses",
"in" : "query",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/InvoiceStatus"
}
}
}, {
"name" : "cip-id",
"in" : "query",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "integer",
"description" : "The unique identifier of the invoice profile used to generate the invoices.",
"format" : "int32"
}
}, {
"name" : "invoice-ids",
"in" : "query",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "array",
"description" : "The list of unique invoice identifiers.",
"items" : {
"type" : "integer",
"format" : "int32"
}
}
}, {
"name" : "related-invoice-id",
"in" : "query",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "integer",
"description" : "The related invoice identifier.\nEdited invoices, credit notes and corrective invoices are created based on this invoice.",
"format" : "int32"
}
}, {
"name" : "order-ids",
"in" : "query",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "array",
"description" : "The identifier of orders related to the invoices.",
"items" : {
"type" : "integer",
"format" : "int32"
}
}
}, {
"name" : "invoice-numbers",
"in" : "query",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "array",
"description" : "The list of invoice numbers.",
"items" : {
"type" : "string"
}
}
} ],
"responses" : {
"default" : {
"description" : "Request error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorResponse"
}
}
}
},
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/Invoice"
}
}
}
}
}
}
}
},
"/customer-invoice-profiles/{cip-id}" : {
"get" : {
"tags" : [ "CustomerInvoiceProfileService" ],
"summary" : "Get an invoice profile",
"description" : "Get the details of an invoice profile.",
"operationId" : "getCustomerInvoiceProfile",
"parameters" : [ {
"name" : "cip-id",
"in" : "path",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
} ],
"responses" : {
"default" : {
"description" : "Request error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorResponse"
}
}
}
},
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CustomerInvoiceProfile"
}
}
}
}
}
}
},
"/customer-invoice-profiles" : {
"get" : {
"tags" : [ "CustomerInvoiceProfileService" ],
"summary" : "Search for invoice profiles",
"description" : "Search for all invoice profiles matching the provided parameters.",
"operationId" : "getCustomerInvoiceProfiles",
"parameters" : [ {
"name" : "pagination-page",
"in" : "header",
"required" : false,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "pagination-size",
"in" : "header",
"required" : false,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "pagination-sortfield",
"in" : "header",
"required" : false,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string"
}
}, {
"name" : "pagination-sortorder",
"in" : "header",
"required" : false,
"style" : "simple",
"explode" : false,
"schema" : {
"$ref" : "#/components/schemas/SortOrder"
}
}, {
"name" : "default-profile",
"in" : "query",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "boolean",
"description" : "The invoice profile default status."
}
}, {
"name" : "active",
"in" : "query",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "boolean",
"description" : "The invoice profile active status.\nInactive invoice profiles are not selectable by users when placing orders and should only be used for keeping track of past invoices."
}
}, {
"name" : "profile-name",
"in" : "query",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"description" : "The display name of the invoice profile."
}
}, {
"name" : "first-name",
"in" : "query",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"description" : "The invoice profile first name."
}
}, {
"name" : "last-name",
"in" : "query",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"description" : "The invoice profile last name."
}
}, {
"name" : "email",
"in" : "query",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"description" : "The invoice profile email address."
}
}, {
"name" : "company-name",
"in" : "query",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"description" : "The invoice profile company name."
}
}, {
"name" : "country-code",
"in" : "query",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"description" : "The invoice profile country code."
}
}, {
"name" : "city",
"in" : "query",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"description" : "The invoice profile city."
}
}, {
"name" : "term-matching-mode",
"in" : "query",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"description" : "The match mode to apply on the given `profile-name`, `first-name`, `last-name`, `company-name`, `city` or `email` field.",
"default" : "STARTS_WITH",
"enum" : [ "EQUALS", "NOT_EQUALS", "CONTAINS", "STARTS_WITH", "ENDS_WITH", "NOT_CONTAINS" ]
}
} ],
"responses" : {
"default" : {
"description" : "Request error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorResponse"
}
}
}
},
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/CustomerInvoiceProfile"
}
}
}
}
}
}
}
},
"/contact-profiles" : {
"get" : {
"tags" : [ "ContactProfileService" ],
"summary" : "List contact profiles",
"description" : "Get a list of contact profiles matching specified optional filters.",
"operationId" : "getContactProfiles",
"parameters" : [ {
"name" : "pagination-page",
"in" : "header",
"required" : false,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "pagination-size",
"in" : "header",
"required" : false,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "pagination-sortfield",
"in" : "header",
"required" : false,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string"
}
}, {
"name" : "pagination-sortorder",
"in" : "header",
"required" : false,
"style" : "simple",
"explode" : false,
"schema" : {
"$ref" : "#/components/schemas/SortOrder"
}
}, {
"name" : "type",
"in" : "query",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"$ref" : "#/components/schemas/ContactType"
}
}, {
"name" : "is-org",
"in" : "query",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "boolean"
}
}, {
"name" : "is-admin",
"in" : "query",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "boolean"
}
}, {
"name" : "is-tech",
"in" : "query",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "boolean"
}
}, {
"name" : "is-billing",
"in" : "query",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "boolean"
}
} ],
"responses" : {
"default" : {
"description" : "Request error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorResponse"
}
}
}
},
"200" : {
"description" : "Successful response returning a list of matching contact profiles.",
"content" : {
"application/json" : {
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ContactProfile"
}
}
}
}
}
}
},
"post" : {
"tags" : [ "ContactProfileService" ],
"summary" : "Create a contact profile",
"description" : "Create a new contact profile with given input data.",
"operationId" : "createContactProfile",
"parameters" : [ {
"name" : "lang",
"in" : "query",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "Data of the Contact profile to create.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ContactProfile"
}
}
},
"required" : true
},
"responses" : {
"default" : {
"description" : "Request error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorResponse"
}
}
}
},
"200" : {
"description" : "Successful response returning the created contact profile with it's assigned ID.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ContactProfile"
}
}
}
}
}
}
},
"/contact-profiles/{id}" : {
"get" : {
"tags" : [ "ContactProfileService" ],
"summary" : "Get a contact profile",
"description" : "Get all information relative to the contact profile with specified ID.",
"operationId" : "getContactProfile",
"parameters" : [ {
"name" : "id",
"in" : "path",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
} ],
"responses" : {
"default" : {
"description" : "Request error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorResponse"
}
}
}
},
"200" : {
"description" : "Successful response returning the contact profile details.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ContactProfile"
}
}
}
}
}
},
"put" : {
"tags" : [ "ContactProfileService" ],
"summary" : "Update a contact profile",
"description" : "Update changes on the corresponding contact profile.
All fields should be given even if value not changed, otherwise it will be considered as empty value if allowed.",
"operationId" : "updateContactProfile",
"parameters" : [ {
"name" : "id",
"in" : "path",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "lang",
"in" : "query",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "Data of the Contact profile to update.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ContactProfile"
}
}
},
"required" : true
},
"responses" : {
"default" : {
"description" : "Request error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorResponse"
}
}
}
},
"200" : {
"description" : "Successful response returning the updated contact profile details.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ContactProfile"
}
}
}
}
}
},
"delete" : {
"tags" : [ "ContactProfileService" ],
"summary" : "Delete a contact profile",
"description" : "Delete the specified contact profile.",
"operationId" : "deleteContactProfile",
"parameters" : [ {
"name" : "id",
"in" : "path",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
} ],
"responses" : {
"default" : {
"description" : "Request error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorResponse"
}
}
}
},
"200" : {
"description" : "Deletion success"
}
}
}
},
"/contact-profiles/{id}/default-status" : {
"put" : {
"tags" : [ "ContactProfileService" ],
"summary" : "Set contact profile default states.",
"description" : "Set the specified contact profile as default contact for the types specified in the request body.",
"operationId" : "setAsDefaultContactProfile",
"parameters" : [ {
"name" : "id",
"in" : "path",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
} ],
"requestBody" : {
"description" : "True flags for all wanted contact types for which the contact profile should be the default one. All fields are optional, only put a TRUE boolean value on the ones you want.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ContactProfileDefaultStatus"
}
}
},
"required" : true
},
"responses" : {
"default" : {
"description" : "Request error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorResponse"
}
}
}
},
"200" : {
"description" : "Successful response returning the current applied contact profile default status.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ContactProfileDefaultStatus"
}
}
}
}
}
}
},
"/orders/{id}" : {
"get" : {
"tags" : [ "OrderService" ],
"summary" : "Get an order",
"description" : "Get the full details of an order, containing the order lines details.",
"operationId" : "getOrder",
"parameters" : [ {
"name" : "id",
"in" : "path",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
} ],
"responses" : {
"default" : {
"description" : "Request error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorResponse"
}
}
}
},
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Order"
}
}
}
}
}
}
},
"/orders" : {
"get" : {
"tags" : [ "OrderService" ],
"summary" : "Search for orders",
"description" : "Search for all orders matching the provided parameters.",
"operationId" : "getOrders",
"parameters" : [ {
"name" : "pagination-page",
"in" : "header",
"required" : false,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "pagination-size",
"in" : "header",
"required" : false,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "pagination-sortfield",
"in" : "header",
"required" : false,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string"
}
}, {
"name" : "pagination-sortorder",
"in" : "header",
"required" : false,
"style" : "simple",
"explode" : false,
"schema" : {
"$ref" : "#/components/schemas/SortOrder"
}
}, {
"name" : "statuses",
"in" : "query",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/OrderStatus"
}
}
}, {
"name" : "orders-ids",
"in" : "query",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "array",
"description" : "The list of order identifiers.",
"items" : {
"type" : "integer",
"format" : "int32"
}
}
}, {
"name" : "order-line-ids",
"in" : "query",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "array",
"description" : "The list of order line id related to the orders.",
"items" : {
"type" : "integer",
"format" : "int32"
}
}
}, {
"name" : "delivery-in-progress",
"in" : "query",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "boolean",
"description" : "The delivery status of the orders. An order delivery is considered in progress once the order payment has been processed but no all order lines are delivered yet."
}
}, {
"name" : "term",
"in" : "query",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"description" : "The search term allowing to search orders based on the description of its order lines."
}
}, {
"name" : "start-date",
"in" : "query",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"description" : "The parameter allowing to search orders after the given date",
"format" : "date-time"
}
}, {
"name" : "end-date",
"in" : "query",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"description" : "The parameter allowing to search orders before the given date",
"format" : "date-time"
}
} ],
"responses" : {
"default" : {
"description" : "Request error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorResponse"
}
}
}
},
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/Order"
}
}
}
}
}
}
}
},
"/nameserver-profiles" : {
"get" : {
"tags" : [ "NameserverProfileService" ],
"summary" : "List nameserver profiles",
"description" : "Get a list of nameserver profiles matching specified optional filters.",
"operationId" : "getNameserverProfiles",
"parameters" : [ {
"name" : "pagination-page",
"in" : "header",
"required" : false,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "pagination-size",
"in" : "header",
"required" : false,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "pagination-sortfield",
"in" : "header",
"required" : false,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string"
}
}, {
"name" : "pagination-sortorder",
"in" : "header",
"required" : false,
"style" : "simple",
"explode" : false,
"schema" : {
"$ref" : "#/components/schemas/SortOrder"
}
}, {
"name" : "default",
"in" : "query",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "boolean"
}
}, {
"name" : "deletable",
"in" : "query",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "boolean"
}
}, {
"name" : "include-nameservers",
"in" : "query",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "boolean"
}
} ],
"responses" : {
"default" : {
"description" : "Request error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorResponse"
}
}
}
},
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/NameserverProfile"
}
}
}
}
}
}
},
"post" : {
"tags" : [ "NameserverProfileService" ],
"summary" : "Create a nameserver profile",
"description" : "Create a new nameserver profile with given input data.",
"operationId" : "createNameserverProfile",
"parameters" : [ {
"name" : "lang",
"in" : "query",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NameserverProfile"
}
}
},
"required" : true
},
"responses" : {
"default" : {
"description" : "Request error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorResponse"
}
}
}
},
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NameserverProfile"
}
}
}
}
}
}
},
"/nameserver-profiles/{id}" : {
"get" : {
"tags" : [ "NameserverProfileService" ],
"summary" : "Get a nameserver profile",
"description" : "Get all information relative to the nameserver profile with specified ID.",
"operationId" : "getNameserverProfile",
"parameters" : [ {
"name" : "id",
"in" : "path",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
} ],
"responses" : {
"default" : {
"description" : "Request error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorResponse"
}
}
}
},
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NameserverProfile"
}
}
}
}
}
},
"put" : {
"tags" : [ "NameserverProfileService" ],
"summary" : "Update a nameserver profile",
"description" : "Update changes on the corresponding nameserver profile.
All fields should be given even if value not changed, otherwise it will be considered as empty value if allowed.",
"operationId" : "updateNameserverProfile",
"parameters" : [ {
"name" : "id",
"in" : "path",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "lang",
"in" : "query",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NameserverProfile"
}
}
},
"required" : true
},
"responses" : {
"default" : {
"description" : "Request error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorResponse"
}
}
}
},
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NameserverProfile"
}
}
}
}
}
},
"delete" : {
"tags" : [ "NameserverProfileService" ],
"summary" : "Delete a nameserver profile",
"description" : "Delete the specified nameserver profile.",
"operationId" : "deleteNameserverProfile",
"parameters" : [ {
"name" : "id",
"in" : "path",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
} ],
"responses" : {
"default" : {
"description" : "Request error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorResponse"
}
}
}
},
"200" : {
"description" : "Success"
}
}
}
},
"/das/available-domain-names" : {
"post" : {
"tags" : [ "DasService" ],
"summary" : "Get domains availability",
"description" : "Takes a list of domain names to check and get them back with each domain name current availability state.",
"operationId" : "getAvailabilities",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetDomainsAvailability"
}
}
},
"required" : true
},
"responses" : {
"default" : {
"description" : "Request error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorResponse"
}
}
}
},
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/DomainsAvailability"
}
}
}
}
}
}
}
},
"/email-subscriptions" : {
"get" : {
"tags" : [ "EmailSubscriptionService" ],
"summary" : "Search for email subscriptions",
"description" : "Get email subscriptions matching search parameters",
"operationId" : "getEmailSubscriptions",
"parameters" : [ {
"name" : "pagination-page",
"in" : "header",
"required" : false,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "pagination-size",
"in" : "header",
"required" : false,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "pagination-sortfield",
"in" : "header",
"required" : false,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string"
}
}, {
"name" : "pagination-sortorder",
"in" : "header",
"required" : false,
"style" : "simple",
"explode" : false,
"schema" : {
"$ref" : "#/components/schemas/SortOrder"
}
}, {
"name" : "subscription-status",
"in" : "query",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"$ref" : "#/components/schemas/SubscriptionStatus"
}
}, {
"name" : "domain-name",
"in" : "query",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"description" : "The domain name the email subscription(s) you search for are related to"
}
}, {
"name" : "user-name",
"in" : "query",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"default" : {
"description" : "Request error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SubscriptionErrorResponse"
}
}
}
},
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/EmailSubscription"
}
}
}
}
}
}
}
},
"/email-subscriptions/{id}/aliases/{alias}" : {
"post" : {
"tags" : [ "EmailSubscriptionService" ],
"summary" : "Create mailbox alias",
"description" : "Create an alias of the mailbox attached to the given email subscription.\n\nThe alias must be a full email address (`localpart@domain`) respecting the following rules:\n- it must contain exactly one `@` character\n- the local part must not be empty and may only contain lowercase letters (`a-z`), digits (`0-9`), dots (`.`), underscores (`_`) and hyphens (`-`)\n- the `+` character is not allowed\n- the domain part must match the domain of the email subscription\n- the whole alias must not exceed 255 characters\n- the alias must not already exist and must differ from the mailbox address itself\n",
"operationId" : "createAlias",
"parameters" : [ {
"name" : "id",
"in" : "path",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "alias",
"in" : "path",
"description" : "Alias email address to create (lowercase, no `+` character, same domain as the subscription)",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string"
},
"example" : "contact@example.com"
} ],
"responses" : {
"default" : {
"description" : "Request error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SubscriptionErrorResponse"
}
}
}
},
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/EmailSubscription"
}
}
}
}
}
},
"delete" : {
"tags" : [ "EmailSubscriptionService" ],
"summary" : "Delete mailbox alias",
"description" : "Delete an alias of the mailbox attached to the given email subscription",
"operationId" : "deleteAlias",
"parameters" : [ {
"name" : "id",
"in" : "path",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "alias",
"in" : "path",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"default" : {
"description" : "Request error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SubscriptionErrorResponse"
}
}
}
},
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/EmailSubscription"
}
}
}
}
}
}
},
"/premium-dns-subscriptions" : {
"get" : {
"tags" : [ "PremiumDnsSubscriptionService" ],
"summary" : "Search for Premium DNS subscriptions",
"description" : "Search and return the Premium DNS subscriptions matching the given search parameters",
"operationId" : "getPremiumDnsSubscriptions",
"parameters" : [ {
"name" : "pagination-page",
"in" : "header",
"required" : false,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "pagination-size",
"in" : "header",
"required" : false,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "pagination-sortfield",
"in" : "header",
"required" : false,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string"
}
}, {
"name" : "pagination-sortorder",
"in" : "header",
"required" : false,
"style" : "simple",
"explode" : false,
"schema" : {
"$ref" : "#/components/schemas/SortOrder"
}
}, {
"name" : "subscription-status",
"in" : "query",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"$ref" : "#/components/schemas/SubscriptionStatus"
}
}, {
"name" : "domain-name",
"in" : "query",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"description" : "The domain name the Premium DNS subscription(s) you search for are related to"
}
} ],
"responses" : {
"default" : {
"description" : "Request error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SubscriptionErrorResponse"
}
}
}
},
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/PremiumDnsSubscription"
}
}
}
}
}
}
}
},
"/premium-dns-subscriptions/{subscription-id}" : {
"get" : {
"tags" : [ "PremiumDnsSubscriptionService" ],
"summary" : "Get Premium DNS subscription details",
"description" : "Get the Premium DNS subscription with given ID.",
"operationId" : "getPremiumDnsSubscription",
"parameters" : [ {
"name" : "subscription-id",
"in" : "path",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
} ],
"responses" : {
"default" : {
"description" : "Request error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SubscriptionErrorResponse"
}
}
}
},
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PremiumDnsSubscription"
}
}
}
}
}
},
"delete" : {
"tags" : [ "PremiumDnsSubscriptionService" ],
"summary" : "Delete Premium DNS subscription",
"description" : "Schedule the deletion of the Premium DNS subscription with given ID.",
"operationId" : "deletePremiumDnsSubscription",
"parameters" : [ {
"name" : "subscription-id",
"in" : "path",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
} ],
"responses" : {
"default" : {
"description" : "Request error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SubscriptionErrorResponse"
}
}
}
},
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PremiumDnsSubscription"
}
}
}
}
}
}
},
"/premium-dns-subscriptions/create" : {
"post" : {
"tags" : [ "PremiumDnsSubscriptionService" ],
"summary" : "Create a Premium DNS subscription",
"description" : "Order the provisioning of a Premium DNS subscription.",
"operationId" : "createPremiumDnsSubscription",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CreatePremiumDnsSubscription"
}
}
},
"required" : true
},
"responses" : {
"default" : {
"description" : "Request error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SubscriptionErrorResponse"
}
}
}
},
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PremiumDnsSubscription"
}
}
}
}
}
}
},
"/premium-dns-subscriptions/{subscription-id}/renew" : {
"post" : {
"tags" : [ "PremiumDnsSubscriptionService" ],
"summary" : "Renew a Premium DNS subscription",
"description" : "Order the renewal of a Premium DNS subscription.",
"operationId" : "renewPremiumDnsSubscription",
"parameters" : [ {
"name" : "subscription-id",
"in" : "path",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RenewPremiumDnsSubscription"
}
}
},
"required" : true
},
"responses" : {
"default" : {
"description" : "Request error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SubscriptionErrorResponse"
}
}
}
},
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PremiumDnsSubscription"
}
}
}
}
}
}
},
"/premium-dns-subscriptions/{subscription-id}/upgrade" : {
"post" : {
"tags" : [ "PremiumDnsSubscriptionService" ],
"summary" : "Upgrade Premium DNS subscription",
"description" : "Upgrade the Premium DNS subscription with given ID.",
"operationId" : "upgradePremiumDnsSubscription",
"parameters" : [ {
"name" : "subscription-id",
"in" : "path",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpgradePremiumDnsSubscription"
}
}
},
"required" : true
},
"responses" : {
"default" : {
"description" : "Request error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SubscriptionErrorResponse"
}
}
}
},
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PremiumDnsSubscription"
}
}
}
}
}
}
},
"/premium-dns-subscriptions/{subscription-id}/downgrade" : {
"post" : {
"tags" : [ "PremiumDnsSubscriptionService" ],
"summary" : "Downgrade Premium DNS subscription",
"description" : "Downgrade the Premium DNS subscription with given ID.",
"operationId" : "downgradePremiumDnsSubscription",
"parameters" : [ {
"name" : "subscription-id",
"in" : "path",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DowngradePremiumDnsSubscription"
}
}
},
"required" : true
},
"responses" : {
"default" : {
"description" : "Request error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SubscriptionErrorResponse"
}
}
}
},
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PremiumDnsSubscription"
}
}
}
}
}
}
},
"/subscriptions" : {
"get" : {
"tags" : [ "SubscriptionService" ],
"summary" : "Search for subscriptions",
"description" : "Search for subscriptions according to search parameters",
"operationId" : "getSubscriptions",
"parameters" : [ {
"name" : "pagination-page",
"in" : "header",
"required" : false,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "pagination-size",
"in" : "header",
"required" : false,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "pagination-sortfield",
"in" : "header",
"required" : false,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string"
}
}, {
"name" : "pagination-sortorder",
"in" : "header",
"required" : false,
"style" : "simple",
"explode" : false,
"schema" : {
"$ref" : "#/components/schemas/SortOrder"
}
}, {
"name" : "subscription-status",
"in" : "query",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"$ref" : "#/components/schemas/SubscriptionStatus"
}
}, {
"name" : "subscription-types",
"in" : "query",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/SubscriptionType"
}
}
}, {
"name" : "domain-name",
"in" : "query",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"description" : "The domain name the subscription(s) you search for are related to"
}
}, {
"name" : "auto-renew-enabled",
"in" : "query",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "boolean"
}
} ],
"responses" : {
"default" : {
"description" : "Request error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SubscriptionErrorResponse"
}
}
}
},
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/Subscription"
}
}
}
}
}
}
}
},
"/ssl-subscriptions" : {
"get" : {
"tags" : [ "SslSubscriptionService" ],
"summary" : "Search SSL subscriptions",
"description" : "Get SSL subscriptions matching search parameters.",
"operationId" : "getSslSubscriptions",
"parameters" : [ {
"name" : "pagination-page",
"in" : "header",
"required" : false,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "pagination-size",
"in" : "header",
"required" : false,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "pagination-sortfield",
"in" : "header",
"required" : false,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string"
}
}, {
"name" : "pagination-sortorder",
"in" : "header",
"required" : false,
"style" : "simple",
"explode" : false,
"schema" : {
"$ref" : "#/components/schemas/SortOrder"
}
}, {
"name" : "subscription-status",
"in" : "query",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"$ref" : "#/components/schemas/SubscriptionStatus"
}
}, {
"name" : "common-name",
"in" : "query",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"description" : "The common name of an SSL certificate of the subscription."
}
}, {
"name" : "san-name",
"in" : "query",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"description" : "The SAN name of an SSL certificate of the subscription."
}
}, {
"name" : "renewable",
"in" : "query",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "boolean",
"description" : "The renewal capacity of the SSL subscription."
}
} ],
"responses" : {
"default" : {
"description" : "Request error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SubscriptionErrorResponse"
}
}
}
},
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/SslSubscription"
}
}
}
}
}
}
}
},
"/ssl-subscriptions/{subscription-id}" : {
"get" : {
"tags" : [ "SslSubscriptionService" ],
"summary" : "Get an SSL subscription",
"description" : "Get the detailed data of an SSL subscription.
",
"operationId" : "getSslSubscription",
"parameters" : [ {
"name" : "subscription-id",
"in" : "path",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
} ],
"responses" : {
"default" : {
"description" : "Request error
403: FORBIDDEN_ACTION - You do not have access to this subscription.
404: SUBSCRIPTION_DELETED - Your subscription has been deleted.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SubscriptionErrorResponse"
}
}
}
},
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SslSubscription"
}
}
}
}
}
}
},
"/ssl-subscriptions/{subscription-id}/ssl-certificates/{certificate-id}" : {
"get" : {
"tags" : [ "SslSubscriptionService" ],
"summary" : "Get an SSL certificate",
"description" : "Get the detailed data of an SSL certificate.",
"operationId" : "getSslCertificate",
"parameters" : [ {
"name" : "subscription-id",
"in" : "path",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "certificate-id",
"in" : "path",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
} ],
"responses" : {
"default" : {
"description" : "Request error
403: FORBIDDEN_ACTION - You do not have access to this certificate.
404: CERTIFICATE_DELETED - Your certificate has been deleted.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SubscriptionErrorResponse"
}
}
}
},
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SslCertificate"
}
}
}
}
}
}
},
"/ssl-subscriptions/create" : {
"post" : {
"tags" : [ "SslSubscriptionService" ],
"summary" : "Create an SSL subscription",
"description" : "Order the provisioning of an SSL subscription.",
"operationId" : "createSslSubscription",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CreateSslSubscription"
}
}
},
"required" : true
},
"responses" : {
"default" : {
"description" : "Request error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SubscriptionErrorResponse"
}
}
}
},
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SslSubscription"
}
}
}
}
}
}
},
"/ssl-subscriptions/{subscription-id}/renew" : {
"post" : {
"tags" : [ "SslSubscriptionService" ],
"summary" : "Renew an SSL subscription",
"description" : "Order the renewal of an SSL subscription.",
"operationId" : "renewSslSubscription",
"parameters" : [ {
"name" : "subscription-id",
"in" : "path",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RenewSslSubscription"
}
}
},
"required" : true
},
"responses" : {
"default" : {
"description" : "Request error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SubscriptionErrorResponse"
}
}
}
},
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SslSubscription"
}
}
}
}
}
}
},
"/ssl-subscriptions/{subscription-id}/upgrade-quantity" : {
"post" : {
"tags" : [ "SslSubscriptionService" ],
"summary" : "Upgrade the SAN quantity of a multi-domain SSL subscription",
"description" : "Order the quantity upgrade of an existing SSL subscription.
At least one of the san quantity field must be provided and be positive.
The subscription total SAN quantity cannot exceed 250.
This operation is only allowed for multi-domain products.",
"operationId" : "upgradeSslSubscriptionQuantity",
"parameters" : [ {
"name" : "subscription-id",
"in" : "path",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpgradeSslSubscriptionQuantity"
}
}
},
"required" : true
},
"responses" : {
"default" : {
"description" : "Request error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SubscriptionErrorResponse"
}
}
}
},
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SslSubscription"
}
}
}
}
}
}
},
"/ssl-subscriptions/{subscription-id}/ssl-certificates/{certificate-id}/reissue" : {
"post" : {
"tags" : [ "SslSubscriptionService" ],
"summary" : "Reissue an SSL certificate",
"description" : "Reissue an SSL certificate of the provided subscription.",
"operationId" : "reissueSslCertificate",
"parameters" : [ {
"name" : "subscription-id",
"in" : "path",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "certificate-id",
"in" : "path",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ReissueSslSubscription"
}
}
},
"required" : true
},
"responses" : {
"default" : {
"description" : "Request error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SubscriptionErrorResponse"
}
}
}
},
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SslCertificate"
}
}
}
}
}
}
},
"/ssl-subscriptions/{subscription-id}/ssl-certificates/{certificate-id}/sans/{san-name}/validation" : {
"get" : {
"tags" : [ "SslSubscriptionService" ],
"summary" : "Get the validation information of an SSL certificate",
"description" : "Get the validation data needed to validate the SSL certificate SAN of given subscription.",
"operationId" : "getSslValidation",
"parameters" : [ {
"name" : "subscription-id",
"in" : "path",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "certificate-id",
"in" : "path",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "san-name",
"in" : "path",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"default" : {
"description" : "Request error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SubscriptionErrorResponse"
}
}
}
},
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SslValidation"
},
"examples" : {
"URL" : {
"summary" : "URL validation",
"value" : {
"allowedApprovers" : [ "example.com" ],
"approver" : "http://example.com",
"fileValidationUrls" : [ "http://example.com/.well-known/pki-validation/F1F451D015E4E4E3C669303F43347176.txt" ],
"securityToken" : "BD0C5C0DAB1C8C852F2BABC64D7D23BB419769C216526B6B95F6D505B9B78EAF\nsectigo.com\n.79zaxiy0bwjnpcgqlsgt",
"sslVerificationMethod" : "URL",
"sslVerificationStatus" : "PENDING"
}
},
"DNS" : {
"summary" : "DNS validation",
"value" : {
"allowedApprovers" : [ "example.com", "www.example.com" ],
"approver" : "example.com",
"securityToken" : "_f1f451d015e4e4e3c669303f43347176.example.com CNAME bd0c5c0dab1c8c852f2babc64d7d23bb.419769c216526b6b95f6d505b9b78eaf.79zaxiy0bwjnpcgqlsgt.comodoca.com.",
"sslVerificationMethod" : "DNS",
"sslVerificationStatus" : "NOT_VERIFIED"
}
},
"EMAIL" : {
"summary" : "EMAIL validation",
"value" : {
"allowedApprovers" : [ "admin@www.example.com", "administrator@www.example.com", "hostmaster@www.example.com", "postmaster@www.example.com", "webmaster@www.example.com", "admin@example.com", "administrator@example.com", "hostmaster@example.com", "postmaster@example.com", "webmaster@example.com" ],
"approver" : "webmaster@www.example.com",
"sslVerificationMethod" : "EMAIL",
"sslVerificationStatus" : "VERIFIED"
}
}
}
}
}
}
}
},
"put" : {
"tags" : [ "SslSubscriptionService" ],
"summary" : "Update the validation information of an SSL certificate",
"description" : "Update the validation method and approver used to validate the SSL certificate SAN of given subscription.",
"operationId" : "updateSslValidationApprover",
"parameters" : [ {
"name" : "subscription-id",
"in" : "path",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "certificate-id",
"in" : "path",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "san-name",
"in" : "path",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SslValidationApprover"
}
}
},
"required" : true
},
"responses" : {
"default" : {
"description" : "Request error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SubscriptionErrorResponse"
}
}
}
},
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SslValidation"
}
}
}
}
}
}
},
"/ssl-subscriptions/{subscription-id}/ssl-certificates/{certificate-id}/sans/{san-name}/resend-validation-email" : {
"post" : {
"tags" : [ "SslSubscriptionService" ],
"summary" : "Resend the SSL certificate validation email",
"description" : "Resend the validation email used to validate the SSL certificate SAN of given subscription.",
"operationId" : "resendSslApproverEmail",
"parameters" : [ {
"name" : "subscription-id",
"in" : "path",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "certificate-id",
"in" : "path",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "san-name",
"in" : "path",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"default" : {
"description" : "Request error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SubscriptionErrorResponse"
}
}
}
},
"204" : {
"description" : "Success"
}
}
}
},
"/ssl-subscriptions/{subscription-id}/ssl-certificates/{certificate-id}/cancel" : {
"post" : {
"tags" : [ "SslSubscriptionService" ],
"summary" : "Cancel an SSL certificate validation process",
"description" : "Cancel the validation of a pending SSL certificate of the provided subscription.",
"operationId" : "cancelSslCertificate",
"parameters" : [ {
"name" : "subscription-id",
"in" : "path",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "certificate-id",
"in" : "path",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
} ],
"responses" : {
"default" : {
"description" : "Request error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SubscriptionErrorResponse"
}
}
}
},
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SslCertificate"
}
}
}
}
}
}
},
"/ssl-subscriptions/{subscription-id}/ssl-certificates/{certificate-id}/sans/{san-name}/cancel" : {
"post" : {
"tags" : [ "SslSubscriptionService" ],
"summary" : "Cancel an SSL certificate SAN validation process",
"description" : "Cancel the SSL certificate SAN of the provided subscription. It will be deleted from the certificate.",
"operationId" : "cancelSslSan",
"parameters" : [ {
"name" : "subscription-id",
"in" : "path",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "certificate-id",
"in" : "path",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "san-name",
"in" : "path",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"default" : {
"description" : "Request error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SubscriptionErrorResponse"
}
}
}
},
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SslCertificate"
}
}
}
}
}
}
},
"/ssl-subscriptions/{subscription-id}/ssl-certificates/{certificate-id}/revoke" : {
"post" : {
"tags" : [ "SslSubscriptionService" ],
"summary" : "Revoke an SSL certificate",
"description" : "Revoke an SSL certificate of the provided subscription.",
"operationId" : "revokeSslCertificate",
"parameters" : [ {
"name" : "subscription-id",
"in" : "path",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "certificate-id",
"in" : "path",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
} ],
"responses" : {
"default" : {
"description" : "Request error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SubscriptionErrorResponse"
}
}
}
},
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SslCertificate"
}
}
}
}
}
}
},
"/acme-ssl-subscriptions/create" : {
"post" : {
"tags" : [ "AcmeSslSubscriptionService" ],
"summary" : "Create an ACME SSL subscription",
"description" : "Order the provisioning of an ACME SSL subscription.
Select the number of domains you want to secure and decide whether you need a wildcard to protect subdomains. You can adjust your subscription as your domain portfolio evolves.",
"operationId" : "createAcmeSslSubscription",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CreateAcmeSslSubscription"
}
}
},
"required" : true
},
"responses" : {
"default" : {
"description" : "Request error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SubscriptionErrorResponse"
}
}
}
},
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AcmeSslSubscription"
}
}
}
}
}
}
},
"/acme-ssl-subscriptions" : {
"get" : {
"tags" : [ "AcmeSslSubscriptionService" ],
"summary" : "Search ACME SSL subscriptions",
"description" : "Get ACME SSL subscriptions matching search parameters.",
"operationId" : "getAcmeSslSubscriptions",
"parameters" : [ {
"name" : "pagination-page",
"in" : "header",
"required" : false,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "pagination-size",
"in" : "header",
"required" : false,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "pagination-sortfield",
"in" : "header",
"required" : false,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string"
}
}, {
"name" : "pagination-sortorder",
"in" : "header",
"required" : false,
"style" : "simple",
"explode" : false,
"schema" : {
"$ref" : "#/components/schemas/SortOrder"
}
}, {
"name" : "subscription-status",
"in" : "query",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"$ref" : "#/components/schemas/SubscriptionStatus"
}
}, {
"name" : "domain-name",
"in" : "query",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"description" : "The domain name of an ACME SSL domain of the subscription.\nSearches both domains and wildcards"
}
}, {
"name" : "renewable",
"in" : "query",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "boolean",
"description" : "The renewal capacity of the ACME SSL subscription."
}
} ],
"responses" : {
"default" : {
"description" : "Request error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SubscriptionErrorResponse"
}
}
}
},
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/AcmeSslSubscription"
}
}
}
}
}
}
}
},
"/acme-ssl-subscriptions/{subscription-id}" : {
"get" : {
"tags" : [ "AcmeSslSubscriptionService" ],
"summary" : "Get an ACME SSL subscription",
"description" : "Get the detailed data of an ACME SSL subscription.
",
"operationId" : "getAcmeSslSubscription",
"parameters" : [ {
"name" : "subscription-id",
"in" : "path",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
} ],
"responses" : {
"default" : {
"description" : "Request error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SubscriptionErrorResponse"
}
}
}
},
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AcmeSslSubscription"
}
}
}
}
}
},
"delete" : {
"tags" : [ "AcmeSslSubscriptionService" ],
"summary" : "Delete an ACME SSL subscription",
"description" : "Request deletion of an ACME SSL subscription.
The deletion process can be canceled with the `Cancel the deletion of an ACME SSL subscription` flow.",
"operationId" : "deleteAcmeSslSubscription",
"parameters" : [ {
"name" : "subscription-id",
"in" : "path",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
} ],
"responses" : {
"default" : {
"description" : "Request error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SubscriptionErrorResponse"
}
}
}
},
"200" : {
"description" : "Success"
}
}
}
},
"/acme-ssl-subscriptions/{subscription-id}/cancel-deletion" : {
"post" : {
"tags" : [ "AcmeSslSubscriptionService" ],
"summary" : "Cancel the deletion of an ACME SSL subscription",
"description" : "Request cancellation of the ACME SSL subscription deletion process.",
"operationId" : "cancelAcmeSslSubscriptionDeletion",
"parameters" : [ {
"name" : "subscription-id",
"in" : "path",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
} ],
"responses" : {
"default" : {
"description" : "Request error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SubscriptionErrorResponse"
}
}
}
},
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AcmeSslSubscription"
}
}
}
}
}
}
},
"/acme-ssl-subscriptions/{subscription-id}/renew" : {
"post" : {
"tags" : [ "AcmeSslSubscriptionService" ],
"summary" : "Renew an ACME SSL subscription",
"description" : "Order the renewal of an ACME SSL subscription.",
"operationId" : "renewAcmeSslSubscription",
"parameters" : [ {
"name" : "subscription-id",
"in" : "path",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RenewAcmeSslSubscription"
}
}
},
"required" : true
},
"responses" : {
"default" : {
"description" : "Request error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SubscriptionErrorResponse"
}
}
}
},
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AcmeSslSubscription"
}
}
}
}
}
}
},
"/acme-ssl-subscriptions/{subscription-id}/upgrade-quantity" : {
"post" : {
"tags" : [ "AcmeSslSubscriptionService" ],
"summary" : "Upgrade the quantity of an ACME SSL subscription",
"description" : "Order the quantity upgrade of an existing ACME SSL subscription.
At least one of the domain or wildcard quantity field must be provided and be positive.
The subscription domain quantity and wildcard quantity cannot each exceed 200.",
"operationId" : "upgradeAcmeSslSubscriptionQuantity",
"parameters" : [ {
"name" : "subscription-id",
"in" : "path",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpgradeAcmeSslSubscriptionQuantity"
}
}
},
"required" : true
},
"responses" : {
"default" : {
"description" : "Request error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SubscriptionErrorResponse"
}
}
}
},
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AcmeSslSubscription"
}
}
}
}
}
}
},
"/acme-ssl-subscriptions/{subscription-id}/domains" : {
"put" : {
"tags" : [ "AcmeSslSubscriptionService" ],
"summary" : "Update the domain names of an ACME SSL subscription",
"description" : "Provide the full list of domain names and wildcards of your ACME SSL certificate.
The units of removed domain names or wildcards will not be added back to your overall quota.
Only `CONFIGURED` domain names or wildcards can be removed.
Adding a domain again will use a new unit from your remaining quota.",
"operationId" : "updateAcmeSslSubscriptionDomains",
"parameters" : [ {
"name" : "subscription-id",
"in" : "path",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateAcmeSslDomains"
}
}
},
"required" : true
},
"responses" : {
"default" : {
"description" : "Request error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorResponse"
}
}
}
},
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AcmeSslSubscription"
}
}
}
}
}
}
},
"/acme-ssl-subscriptions/{subscription-id}/accounts" : {
"get" : {
"tags" : [ "AcmeSslSubscriptionService" ],
"summary" : "Get the ACME SSL subscription accounts",
"description" : "List the accounts and their external account binding (EAB) details.",
"operationId" : "getAcmeSslAccounts",
"parameters" : [ {
"name" : "subscription-id",
"in" : "path",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
} ],
"responses" : {
"default" : {
"description" : "Request error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorResponse"
}
}
}
},
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/AcmeSslAccount"
}
}
}
}
}
}
}
},
"/acme-ssl-subscriptions/{subscription-id}/accounts/{account-id}/suspend" : {
"post" : {
"tags" : [ "AcmeSslSubscriptionService" ],
"summary" : "Suspend an ACME account",
"description" : "Suspend one of the accounts linked to an ACME SSL subscription.
A suspended account can be reinstated.
This action is useful when you want to prevent ACME accounts from being used to request certificates without fully deactivating them.",
"operationId" : "suspendAcmeSslAccount",
"parameters" : [ {
"name" : "subscription-id",
"in" : "path",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "account-id",
"in" : "path",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"default" : {
"description" : "Request error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorResponse"
}
}
}
},
"200" : {
"description" : "Success",
"content" : { }
}
}
}
},
"/acme-ssl-subscriptions/{subscription-id}/accounts/{account-id}/reinstate" : {
"post" : {
"tags" : [ "AcmeSslSubscriptionService" ],
"summary" : "Reinstate an ACME account",
"description" : "Suspended accounts linked to an ACME SSL subscription can be reinstated.
This action is useful when you want to allow previously suspended ACME accounts to request certificates again.",
"operationId" : "reinstateAcmeSslAccount",
"parameters" : [ {
"name" : "subscription-id",
"in" : "path",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "account-id",
"in" : "path",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"default" : {
"description" : "Request error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorResponse"
}
}
}
},
"200" : {
"description" : "Success",
"content" : { }
}
}
}
},
"/acme-ssl-subscriptions/{subscription-id}/accounts/{account-id}/deactivate" : {
"post" : {
"tags" : [ "AcmeSslSubscriptionService" ],
"summary" : "Deactivate an ACME account",
"description" : "This action is useful when you want to prevent ACME accounts from ever being used to request certificates again.
This operation is final, deactivated accounts cannot be restored.",
"operationId" : "deactivateAcmeSslAccount",
"parameters" : [ {
"name" : "subscription-id",
"in" : "path",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "account-id",
"in" : "path",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"default" : {
"description" : "Request error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorResponse"
}
}
}
},
"200" : {
"description" : "Success",
"content" : { }
}
}
}
},
"/acme-ssl-subscriptions/{subscription-id}/organisation-profiles" : {
"get" : {
"tags" : [ "AcmeSslSubscriptionService" ],
"summary" : "Get the ACME SSL subscription organisation profiles",
"description" : "Get the detailed data of the organisation profiles of a subscription.",
"operationId" : "getAcmeSslSubscriptionOrganisationProfiles",
"parameters" : [ {
"name" : "subscription-id",
"in" : "path",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
} ],
"responses" : {
"default" : {
"description" : "Request error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorResponse"
}
}
}
},
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/AcmeSslOrganisationProfile"
}
}
}
}
}
}
}
},
"/acme-ssl-subscriptions/{subscription-id}/organisation-profiles/{organisation-profile-id}" : {
"put" : {
"tags" : [ "AcmeSslSubscriptionService" ],
"summary" : "Update an ACME SSL organisation profile",
"description" : "Update the details of the organisation profile of a subscription.",
"operationId" : "updateAcmeSslSubscriptionOrganisationProfile",
"parameters" : [ {
"name" : "subscription-id",
"in" : "path",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "organisation-profile-id",
"in" : "path",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AcmeSslOrganisationProfile"
}
}
},
"required" : true
},
"responses" : {
"default" : {
"description" : "Request error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorResponse"
}
}
}
},
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AcmeSslOrganisationProfile"
}
}
}
}
}
}
},
"/acme-ssl-subscriptions/{subscription-id}/organisation-profiles/{organisation-profile-id}/cancel-validation" : {
"post" : {
"tags" : [ "AcmeSslSubscriptionService" ],
"summary" : "Cancel the validation of an organisation profile",
"description" : "Request the cancellation of an ongoing organisation profile validation process",
"operationId" : "cancelAcmeSslSubscriptionOrganisationProfileValidation",
"parameters" : [ {
"name" : "subscription-id",
"in" : "path",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "organisation-profile-id",
"in" : "path",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
} ],
"responses" : {
"default" : {
"description" : "Request error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorResponse"
}
}
}
},
"200" : {
"description" : "Success"
}
}
}
},
"/microsoft-subscriptions" : {
"get" : {
"tags" : [ "MicrosoftSubscriptionService" ],
"summary" : "Search for microsoft subscriptions",
"description" : "Get microsoft subscriptions matching search parameters",
"operationId" : "getMicrosoftSubscriptions",
"parameters" : [ {
"name" : "pagination-page",
"in" : "header",
"required" : false,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "pagination-size",
"in" : "header",
"required" : false,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "pagination-sortfield",
"in" : "header",
"required" : false,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string"
}
}, {
"name" : "pagination-sortorder",
"in" : "header",
"required" : false,
"style" : "simple",
"explode" : false,
"schema" : {
"$ref" : "#/components/schemas/SortOrder"
}
}, {
"name" : "subscription-status",
"in" : "query",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"$ref" : "#/components/schemas/SubscriptionStatus"
}
}, {
"name" : "microsoft-domain",
"in" : "query",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"description" : "The domain name the microsoft subscription(s) you search for are related to"
}
}, {
"name" : "account-label",
"in" : "query",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"description" : "The account label the microsoft subscription(s) you search for are related to"
}
} ],
"responses" : {
"default" : {
"description" : "Request error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SubscriptionErrorResponse"
}
}
}
},
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/MicrosoftSubscription"
}
}
}
}
}
}
}
},
"/microsoft-subscriptions/{id}" : {
"get" : {
"tags" : [ "MicrosoftSubscriptionService" ],
"summary" : "Get current details of a microsoft subscription",
"description" : "Get microsoft subscription from its ID",
"operationId" : "getMicrosoftSubscription",
"parameters" : [ {
"name" : "id",
"in" : "path",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
} ],
"responses" : {
"default" : {
"description" : "Request error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SubscriptionErrorResponse"
}
}
}
},
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/MicrosoftSubscription"
}
}
}
}
}
}
},
"/email-subscriptions/{id}" : {
"get" : {
"tags" : [ "EmailSubscriptionService" ],
"summary" : "Get current details of an email subscription",
"description" : "Get email subscription from its ID",
"operationId" : "getEmailSubscription",
"parameters" : [ {
"name" : "id",
"in" : "path",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
} ],
"responses" : {
"default" : {
"description" : "Request error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SubscriptionErrorResponse"
}
}
}
},
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/EmailSubscription"
}
}
}
}
}
},
"delete" : {
"tags" : [ "EmailSubscriptionService" ],
"summary" : "Delete an email subscription",
"description" : "Request deletion of an email subscription",
"operationId" : "deleteEmailSubscription",
"parameters" : [ {
"name" : "id",
"in" : "path",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
} ],
"responses" : {
"default" : {
"description" : "Request error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SubscriptionErrorResponse"
}
}
}
},
"200" : {
"description" : "Success"
}
}
}
},
"/email-subscriptions/{id}/catch-all" : {
"post" : {
"tags" : [ "EmailSubscriptionService" ],
"summary" : "Activate catch-all feature",
"description" : "Activates the catch-all feature for a given email subscription (all emails sent to a non-existing email address will be redirected to the email address of the mailbox attached to the subscription)",
"operationId" : "createCatchall",
"parameters" : [ {
"name" : "id",
"in" : "path",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
} ],
"responses" : {
"default" : {
"description" : "Request error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SubscriptionErrorResponse"
}
}
}
},
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/EmailSubscription"
}
}
}
}
}
},
"delete" : {
"tags" : [ "EmailSubscriptionService" ],
"summary" : "Deactivate catch-all feature",
"description" : "Deactivates the catch-all feature for a given email subscription (all emails sent to a non-existing email address will be lost)",
"operationId" : "deleteCatchall",
"parameters" : [ {
"name" : "id",
"in" : "path",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
} ],
"responses" : {
"default" : {
"description" : "Request error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SubscriptionErrorResponse"
}
}
}
},
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/EmailSubscription"
}
}
}
}
}
}
},
"/email-subscriptions/{id}/password" : {
"put" : {
"tags" : [ "EmailSubscriptionService" ],
"summary" : "Update a mailbox password",
"description" : "Change the password of the mailbox attached to the given email subscription",
"operationId" : "updateEmailPassword",
"parameters" : [ {
"name" : "id",
"in" : "path",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/EmailPassword"
}
}
},
"required" : true
},
"responses" : {
"default" : {
"description" : "Request error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SubscriptionErrorResponse"
}
}
}
},
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/EmailSubscription"
}
}
}
}
}
}
},
"/https-redirect-subscriptions/create" : {
"post" : {
"tags" : [ "HttpsRedirectService" ],
"summary" : "Create a HTTPS redirect subscription",
"description" : "Order the provisioning of a HTTPS redirect subscription.",
"operationId" : "createHttpsRedirectSubscription",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CreateHttpsRedirectSubscription"
}
}
},
"required" : true
},
"responses" : {
"default" : {
"description" : "Request error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SubscriptionErrorResponse"
}
}
}
},
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/HttpsRedirectSubscription"
}
}
}
}
}
}
},
"/https-redirect-subscriptions/{subscription-id}" : {
"get" : {
"tags" : [ "HttpsRedirectService" ],
"summary" : "Get current details of a HTTPS redirect subscription",
"description" : "Get HTTPS redirect subscription from its ID",
"operationId" : "getHttpsRedirectSubscription",
"parameters" : [ {
"name" : "subscription-id",
"in" : "path",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
} ],
"responses" : {
"default" : {
"description" : "Request error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SubscriptionErrorResponse"
}
}
}
},
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/HttpsRedirectSubscription"
}
}
}
}
}
},
"delete" : {
"tags" : [ "HttpsRedirectService" ],
"summary" : "Delete a HTTPS redirect subscription",
"description" : "Schedule the deletion of the HTTPS redirect subscription with given ID.",
"operationId" : "deleteHttpsRedirectSubscription",
"parameters" : [ {
"name" : "subscription-id",
"in" : "path",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
} ],
"responses" : {
"default" : {
"description" : "Request error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SubscriptionErrorResponse"
}
}
}
},
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/HttpsRedirectSubscription"
}
}
}
}
}
}
},
"/https-redirect-subscriptions/{subscription-id}/renew" : {
"post" : {
"tags" : [ "HttpsRedirectService" ],
"summary" : "Renew a HTTPS redirect subscription",
"description" : "Order the renewal of a HTTPS redirect subscription.",
"operationId" : "renewHttpsRedirectSubscription",
"parameters" : [ {
"name" : "subscription-id",
"in" : "path",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RenewHttpsRedirectSubscription"
}
}
},
"required" : true
},
"responses" : {
"default" : {
"description" : "Request error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SubscriptionErrorResponse"
}
}
}
},
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/HttpsRedirectSubscription"
}
}
}
}
}
}
},
"/premium-dns-subscriptions/reactivate" : {
"post" : {
"tags" : [ "PremiumDnsSubscriptionService" ],
"summary" : "Reactivate a Premium DNS subscription",
"description" : "Order the reactivation of an Premium DNS subscription.",
"operationId" : "reactivatePremiumDnsSubscription",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ReactivatePremiumDnsSubscription"
}
}
},
"required" : true
},
"responses" : {
"default" : {
"description" : "Request error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SubscriptionErrorResponse"
}
}
}
},
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PremiumDnsSubscription"
}
}
}
}
}
}
},
"/subscriptions/{subscription-id}/autorenew-settings" : {
"put" : {
"tags" : [ "SubscriptionService" ],
"summary" : "Update subscription auto-renew settings",
"description" : "Update the auto-renewal settings (activation and duration) of a subscription",
"operationId" : "updateSubscriptionAutorenewSettings",
"parameters" : [ {
"name" : "subscription-id",
"in" : "path",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SubscriptionAutoRenewSettings"
}
}
},
"required" : true
},
"responses" : {
"default" : {
"description" : "Request error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SubscriptionErrorResponse"
}
}
}
},
"200" : {
"description" : "Success",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Subscription"
}
}
}
}
}
}
},
"/contact-validations/resend-email" : {
"post" : {
"tags" : [ "ContactValidationService" ],
"summary" : "Resend contact validation email",
"description" : "Send an email containing a link to validate the related contacts.",
"operationId" : "resendContactValidationsEmails",
"requestBody" : {
"description" : "List of contacts to validate.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ResendContactValidationsEmails"
}
}
},
"required" : true
},
"responses" : {
"default" : {
"description" : "Request error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorResponse"
}
}
}
},
"200" : {
"description" : "Successful response returning a list of contact validation details for all sent emails.",
"content" : {
"application/json" : {
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ContactValidation"
}
}
}
}
}
}
}
}
},
"components" : {
"schemas" : {
"AcmeAccountStatus" : {
"type" : "string",
"description" : "The current status of the ACME account.",
"enum" : [ "ABANDONED", "DEACTIVATED", "EXPIRED", "INVALID", "PENDING", "PROCESSING", "REVOKED", "SUSPENDED", "VALID" ]
},
"Invoice" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "integer",
"description" : "The unique identifier of the invoice.",
"format" : "int32"
},
"invoiceNumber" : {
"type" : "string",
"description" : "The unique invoice number used in all communications with the related user."
},
"date" : {
"type" : "string",
"description" : "The invoice creation date.",
"format" : "date-time"
},
"generationDate" : {
"type" : "string",
"description" : "The invoice PDF generation date.",
"format" : "date-time"
},
"invoiceType" : {
"$ref" : "#/components/schemas/InvoiceType"
},
"invoiceStatus" : {
"$ref" : "#/components/schemas/InvoiceStatus"
},
"customerInvoiceProfileId" : {
"type" : "integer",
"description" : "The unique identifier of the invoice profile used to generate this invoice.",
"format" : "int32"
},
"relatedInvoiceId" : {
"type" : "integer",
"description" : "The unique identifier of the invoice linked to this invoice.",
"format" : "int32"
},
"poNumber" : {
"type" : "string",
"description" : "The P.O. number used generating the invoice."
},
"invoiceLines" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/InvoiceLine"
}
},
"amountTaxExcluded" : {
"type" : "object",
"properties" : {
"value" : {
"type" : "number"
},
"currencyCode" : {
"type" : "string"
}
},
"description" : "The invoice amount, excluding taxes."
},
"amountTax" : {
"type" : "object",
"properties" : {
"value" : {
"type" : "number"
},
"currencyCode" : {
"type" : "string"
}
},
"description" : "The invoice tax amount."
},
"amount" : {
"type" : "object",
"properties" : {
"value" : {
"type" : "number"
},
"currencyCode" : {
"type" : "string"
}
},
"description" : "The invoice total amount, including taxes."
},
"amountToPay" : {
"type" : "object",
"properties" : {
"value" : {
"type" : "number"
},
"currencyCode" : {
"type" : "string"
}
},
"description" : "The invoice amount left to pay."
},
"amountAlreadyPaid" : {
"type" : "object",
"properties" : {
"value" : {
"type" : "number"
},
"currencyCode" : {
"type" : "string"
}
},
"description" : "The invoice amount already paid."
},
"amountDiscount" : {
"type" : "object",
"properties" : {
"value" : {
"type" : "number"
},
"currencyCode" : {
"type" : "string"
}
},
"description" : "The amount of the discount applied to the invoice."
}
}
},
"SslSubscription" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "integer",
"description" : "The unique id of the subscription",
"format" : "int32"
},
"subscriptionType" : {
"$ref" : "#/components/schemas/SubscriptionType"
},
"deliveryDate" : {
"type" : "string",
"description" : "The delivery date of the subscription",
"format" : "date-time"
},
"expirationDate" : {
"type" : "string",
"description" : "The date the subscription will expire",
"format" : "date-time"
},
"updateDate" : {
"type" : "string",
"description" : "The date of the last subscription update",
"format" : "date-time"
},
"subscriptionStatus" : {
"$ref" : "#/components/schemas/SubscriptionStatus"
},
"active" : {
"type" : "boolean",
"description" : "Tells if the service behind the subscription is effectively active or not."
},
"autoRenewSettings" : {
"$ref" : "#/components/schemas/SubscriptionAutoRenewSettings"
},
"domainName" : {
"type" : "string",
"description" : "The domain name the subscription is attached to"
},
"productDescription" : {
"type" : "string",
"description" : "The description of the product the subscription is attached to"
},
"renewable" : {
"type" : "boolean",
"description" : "Defines if the subscription can be renewed."
},
"upgradable" : {
"type" : "boolean",
"description" : "Defines if the subscription can be upgraded."
},
"downgradable" : {
"type" : "boolean",
"description" : "Defines if the subscription can be downgraded."
},
"commonName" : {
"type" : "string",
"description" : "The SSL subscription common name."
},
"multiDomain" : {
"type" : "boolean",
"description" : "Defines if the SSL subscription is linked to multi-domain certificates."
},
"multiDomainSanQuantity" : {
"type" : "integer",
"description" : "Defines the quantity of SANs linked to the SSL subscription. Only applicable for multi-domain subscriptions.",
"format" : "int32"
},
"multiDomainSanWildcardQuantity" : {
"type" : "integer",
"description" : "Defines the quantity of wildcard SANs linked to the SSL subscription. Only applicable for multi-domain subscriptions.",
"format" : "int32"
},
"revoked" : {
"type" : "boolean",
"description" : "Defines if the current SSL certificate of the subscription has been revoked."
},
"certificates" : {
"type" : "array",
"description" : "The list of SSL certificates of the subscription. Cancelled, revoked and expired certificates are excluded.",
"items" : {
"$ref" : "#/components/schemas/SslCertificate"
}
}
}
},
"DnsZoneSnapshotItem" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "integer",
"description" : "(read only) the zone snapshot identifier",
"nullable" : true
},
"createdAt" : {
"type" : "string",
"description" : "(read only) Creation date of the snapshot",
"format" : "date-time",
"nullable" : true
},
"zoneName" : {
"type" : "string",
"description" : "(read only) the zone name",
"nullable" : true
}
}
},
"AutoSslDomainStatus" : {
"type" : "string",
"description" : "The status of the ACME SSL domain.",
"enum" : [ "CANCELLED", "CONFIGURATION_ERROR", "CONFIGURED", "DELETION_ERROR", "DELETED", "NOT_CONFIGURED", "PENDING_CONFIGURATION", "PENDING_UPDATE", "TERMINATED", "TO_CONFIGURE", "TO_DELETE" ]
},
"AcmeSslAccount" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"description" : "The unique identifier of the ACME account"
},
"status" : {
"$ref" : "#/components/schemas/AcmeAccountStatus"
},
"ipAddress" : {
"type" : "string",
"description" : "The IP address of the account"
},
"lastActivity" : {
"type" : "string",
"description" : "The last activity date of the account"
},
"userAgent" : {
"type" : "string",
"description" : "The user agent of the account"
},
"serverDescription" : {
"type" : "string",
"description" : "The server description"
},
"serverUrl" : {
"type" : "string",
"description" : "The ACME directory URL"
},
"eabKid" : {
"type" : "string",
"description" : "Your unique public account key identifier (base64url-encoded). It tells the ACME server which specific customer or policy profile to associate with the registration."
},
"eabHmacKey" : {
"type" : "string",
"description" : "Your secret authentication key (base64url-encoded). It proves you are authorized to use the service and bind the account"
}
}
},
"PremiumSubscriptionProduct" : {
"type" : "string",
"description" : "The Premium DNS product to order",
"example" : "ANYCAST_DNS_PLUS",
"enum" : [ "ANYCAST_DNS", "ANYCAST_DNS_PLUS" ]
},
"SslValidationApprover" : {
"required" : [ "verificationMethod" ],
"type" : "object",
"properties" : {
"verificationMethod" : {
"$ref" : "#/components/schemas/SslVerificationMethod"
},
"approver" : {
"type" : "string",
"description" : "The new SSL certificate validation approver to use.
It must be part of the 'allowedApprovers' list you can get using the 'Get the validation information of an SSL certificate' operation."
}
},
"description" : "The SSL certificate validation approver update data."
},
"RegionGroup" : {
"type" : "string",
"enum" : [ "GTLD", "NGTLD", "CCTLD" ]
},
"SubscriptionType" : {
"type" : "string",
"description" : "The type of the subscription",
"enum" : [ "MICROSOFT", "EMAIL", "PREMIUM_DNS", "HOSTING", "HTTPS_REDIRECT", "SSL", "ACME_SSL", "WHOIS_PRIVACY" ]
},
"DomainsAvailability" : {
"type" : "object",
"properties" : {
"domainName" : {
"type" : "string"
},
"available" : {
"type" : "boolean"
}
}
},
"Subscription" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "integer",
"description" : "The unique id of the subscription",
"format" : "int32"
},
"subscriptionType" : {
"$ref" : "#/components/schemas/SubscriptionType"
},
"deliveryDate" : {
"type" : "string",
"description" : "The delivery date of the subscription",
"format" : "date-time"
},
"expirationDate" : {
"type" : "string",
"description" : "The date the subscription will expire",
"format" : "date-time"
},
"updateDate" : {
"type" : "string",
"description" : "The date of the last subscription update",
"format" : "date-time"
},
"subscriptionStatus" : {
"$ref" : "#/components/schemas/SubscriptionStatus"
},
"active" : {
"type" : "boolean",
"description" : "Tells if the service behind the subscription is effectively active or not."
},
"autoRenewSettings" : {
"$ref" : "#/components/schemas/SubscriptionAutoRenewSettings"
},
"domainName" : {
"type" : "string",
"description" : "The domain name the subscription is attached to"
},
"productDescription" : {
"type" : "string",
"description" : "The description of the product the subscription is attached to"
},
"renewable" : {
"type" : "boolean",
"description" : "Defines if the subscription can be renewed."
},
"upgradable" : {
"type" : "boolean",
"description" : "Defines if the subscription can be upgraded."
},
"downgradable" : {
"type" : "boolean",
"description" : "Defines if the subscription can be downgraded."
}
}
},
"SslBusinessInfo" : {
"required" : [ "businessCategory", "city", "countryCode" ],
"type" : "object",
"properties" : {
"countryCode" : {
"type" : "string",
"description" : "The business country code (ISO 3166-1 alpha-2).",
"example" : "US"
},
"city" : {
"type" : "string",
"description" : "The business city.",
"example" : "Boston"
},
"state" : {
"type" : "string",
"description" : "The business state when relevant.",
"example" : "Massachusetts"
},
"iarn" : {
"type" : "string",
"description" : "The business IARN."
},
"businessCategory" : {
"$ref" : "#/components/schemas/BusinessCategory"
}
},
"description" : "The SSL certificate business information required when provisioning an EXTENDED certificate."
},
"ContactProfileDefaultStatus" : {
"type" : "object",
"properties" : {
"org" : {
"type" : "boolean"
},
"admin" : {
"type" : "boolean"
},
"tech" : {
"type" : "boolean"
},
"billing" : {
"type" : "boolean"
}
}
},
"SslVerificationEmailAddress" : {
"type" : "string",
"description" : "Required when using the 'EMAIL' verification method.
The username of the SSL certificate verification email address.
An email will be sent to the selected address on the CSR domain name or SAN host name if the 'EMAIL' verification method has been selected during the certificate configuration.
For example, if you select 'ADMIN' while validating an SSL certificate on 'subdomain.example.com', a validation email will be sent to 'admin@example.com'.
Once the certificate validation has begun, the validation method or selected email address can be updated via the 'Update the validation information of an SSL certificate' operation",
"example" : "ADMIN",
"enum" : [ "ADMIN", "ADMINISTRATOR", "HOSTMASTER", "POSTMASTER", "WEBMASTER" ]
},
"CustomerInvoiceProfile" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "integer",
"description" : "The unique identifier of the invoice profile.",
"format" : "int32"
},
"cipType" : {
"$ref" : "#/components/schemas/CipType"
},
"profileName" : {
"type" : "string",
"description" : "The display name of the invoice profile."
},
"firstName" : {
"type" : "string",
"description" : "The invoice profile first name."
},
"lastName" : {
"type" : "string",
"description" : "The invoice profile last name."
},
"companyName" : {
"type" : "string",
"description" : "The invoice profile company name."
},
"street" : {
"type" : "string",
"description" : "The invoice profile address."
},
"zipCode" : {
"type" : "string",
"description" : "The invoice profile zip code."
},
"city" : {
"type" : "string",
"description" : "The invoice profile city."
},
"state" : {
"type" : "string",
"description" : "The invoice profile state."
},
"countryCode" : {
"type" : "string",
"description" : "The invoice profile country code."
},
"phone" : {
"type" : "string",
"description" : "The invoice profile phone number."
},
"fax" : {
"type" : "string",
"description" : "The invoice profile fax number."
},
"email" : {
"type" : "string",
"description" : "The invoice profile email address.\nAll communications regarding orders using this invoice profile will be made on that address."
},
"vat" : {
"type" : "string",
"description" : "The invoice profile VAT number."
},
"tin" : {
"type" : "string",
"description" : "The invoice profile TIN."
},
"active" : {
"type" : "boolean",
"description" : "The invoice profile active status.\nInactive invoice profiles are not selectable by users when placing orders and should only be used for keeping track of past orders."
},
"defaultProfile" : {
"type" : "boolean",
"description" : "The invoice profile default status. When true, this invoice profile will be used by default for any placed order."
},
"recurringPoNumber" : {
"type" : "string",
"description" : "The invoice saved PO number."
},
"electronicInvoicingId" : {
"type" : "string",
"description" : "The electronic invoicing ID."
}
}
},
"UrlForwardType" : {
"type" : "string",
"description" : "Forward mode: iframe, http 301 redirect or http 302 redirect",
"enum" : [ "FRAME", "HTTP301", "HTTP302" ]
},
"ContactValidation" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "integer",
"format" : "int32"
},
"userId" : {
"type" : "integer",
"format" : "int32"
},
"email" : {
"type" : "string"
},
"requestDate" : {
"$ref" : "#/components/schemas/LocalDateTime"
},
"validationDate" : {
"$ref" : "#/components/schemas/LocalDateTime"
},
"expirationDate" : {
"$ref" : "#/components/schemas/LocalDateTime"
},
"lastReminderDate" : {
"$ref" : "#/components/schemas/LocalDateTime"
},
"validationStatus" : {
"$ref" : "#/components/schemas/ValidationStatus"
}
}
},
"AcmeSslSubscription" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "integer",
"description" : "The unique id of the subscription",
"format" : "int32"
},
"subscriptionType" : {
"$ref" : "#/components/schemas/SubscriptionType"
},
"deliveryDate" : {
"type" : "string",
"description" : "The delivery date of the subscription",
"format" : "date-time"
},
"expirationDate" : {
"type" : "string",
"description" : "The date the subscription will expire",
"format" : "date-time"
},
"updateDate" : {
"type" : "string",
"description" : "The date of the last subscription update",
"format" : "date-time"
},
"subscriptionStatus" : {
"$ref" : "#/components/schemas/SubscriptionStatus"
},
"active" : {
"type" : "boolean",
"description" : "Tells if the service behind the subscription is effectively active or not."
},
"autoRenewSettings" : {
"$ref" : "#/components/schemas/SubscriptionAutoRenewSettings"
},
"domainName" : {
"type" : "string",
"description" : "The domain name the subscription is attached to"
},
"productDescription" : {
"type" : "string",
"description" : "The description of the product the subscription is attached to"
},
"renewable" : {
"type" : "boolean",
"description" : "Defines if the subscription can be renewed."
},
"upgradable" : {
"type" : "boolean",
"description" : "Defines if the subscription can be upgraded."
},
"downgradable" : {
"type" : "boolean",
"description" : "Defines if the subscription can be downgraded."
},
"acmeSslDomains" : {
"type" : "array",
"description" : "The list of domains of the subscription.",
"items" : {
"$ref" : "#/components/schemas/AcmeSslDomain"
}
},
"domainQuantity" : {
"type" : "integer",
"description" : "The number of domains of the subscription.",
"format" : "int32"
},
"wildcardQuantity" : {
"type" : "integer",
"description" : "The number of wildcard domains of the subscription.",
"format" : "int32"
},
"remainingDomainQuantity" : {
"type" : "integer",
"description" : "The number of available domains of the subscription.",
"format" : "int32"
},
"remainingWildcardQuantity" : {
"type" : "integer",
"description" : "The number of available wildcard domains of the subscription.",
"format" : "int32"
}
}
},
"SslVerificationStatus" : {
"type" : "string",
"enum" : [ "VERIFIED", "PENDING", "NOT_VERIFIED" ]
},
"AcmeSslOrganisationProfile" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "integer",
"description" : "Unique identifier of this organisation profile.",
"format" : "int32"
},
"organisationName" : {
"type" : "string",
"description" : "Legal, registered name of the organisation as it should appear on the certificate."
},
"organisationalUnitName" : {
"type" : "string",
"description" : "Name of the department or unit within the organisation (e.g. \"IT Department\"). Optional and not included in modern browser UI, but may still be validated by the certificate authority."
},
"address1" : {
"type" : "string",
"description" : "First line of the organisation's registered address (street address)."
},
"address2" : {
"type" : "string",
"description" : "Second line of the organisation's address, if additional address information is required."
},
"address3" : {
"type" : "string",
"description" : "Third line of the organisation's address, if additional address information is required."
},
"city" : {
"type" : "string",
"description" : "City in which the organisation is located."
},
"state" : {
"type" : "string",
"description" : "State, province, or region in which the organisation is located."
},
"postalCode" : {
"type" : "string",
"description" : "Postal or ZIP code of the organisation's address."
},
"country" : {
"type" : "string",
"description" : "Two-letter ISO 3166-1 alpha-2 country code in which the organisation is registered."
},
"applicantFirstName" : {
"type" : "string",
"description" : "First name of the applicant who is authorised to request the certificate on behalf of the organisation."
},
"applicantLastName" : {
"type" : "string",
"description" : "Last name of the applicant who is authorised to request the certificate on behalf of the organisation."
},
"applicantEmail" : {
"type" : "string",
"description" : "Email address of the applicant, used by the certificate authority for validation correspondence."
},
"applicantPhone" : {
"type" : "string",
"description" : "Phone number of the applicant, used by the certificate authority to verify the validation request."
},
"status" : {
"$ref" : "#/components/schemas/OrganisationProfileStatus"
}
},
"description" : "The organisation that will be associated with this SSL.
IMPORTANT: New organisation profiles or updates to profiles require manual validation by the certificate authority, which takes at least 48 hours. Validation starts after activation, and the ORGANISATION certificate can only be issued once validation is complete.
Only provide the organisation profile for `ORGANISATION` subscription product."
},
"ContactValidationMethod" : {
"type" : "string",
"enum" : [ "EMAIL", "NIS2" ]
},
"OrderStatus" : {
"type" : "string",
"description" : "The order payment status.\n- CART: no payment attempts were made.\n- CREDIT_LINE: an invoice will be sent in relation to the order.\n- EXPIRED_CART: no payment attempts were made and the cart end of life has been reached.\n- FRAUD: a payment attempt was flagged as potentially fraudulent.\n- NO_CHARGE: no payment required.\n- PAID: a payment has been accepted and completed.\n- PENDING_PAYMENT: a payment attempt has been initiated.\n- QUOTE: a payment is required to process the quote\n- QUOTE_AUTHORIZATION: an authorization approver needs to validate the quote.\n- REFUSED: a payment attempt has been declined.\n",
"enum" : [ "CART", "PAID", "CREDIT_LINE", "PENDING_PAYMENT", "REFUSED", "NO_CHARGE", "FRAUD", "QUOTE", "EXPIRED_CART", "QUOTE_AUTHORIZATION" ]
},
"SslStatus" : {
"type" : "string",
"description" : "The SSL certificate status.",
"enum" : [ "ACTIVE", "WAITING_FOR_VALIDATION", "ERROR", "INITIAL", "DRAFT", "REVOKED", "EXPIRED", "APPLICATION", "TO_CANCEL", "CANCELLED", "WAITING_FOR_REVOCATION", "VALIDATED", "PHISHING_CHECK", "TRANSFERRED" ]
},
"OrderLine" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "integer",
"description" : "The unique identifier of the order line.",
"format" : "int32"
},
"type" : {
"$ref" : "#/components/schemas/OrderLineType"
},
"additionalType" : {
"$ref" : "#/components/schemas/AdditionalOrderLineType"
},
"invoiced" : {
"type" : "boolean",
"description" : "The invoicing status. Invoices are sent to the email address of the linked order invoice profile."
},
"delivered" : {
"type" : "boolean",
"description" : "The delivery status of the order line. When the order line is delivered, you may expect the related ordered product to be available."
},
"dateDelivered" : {
"type" : "string",
"description" : "The order line delivery date. See 'delivered'",
"format" : "date-time"
},
"amountTaxExcluded" : {
"type" : "object",
"properties" : {
"value" : {
"type" : "number"
},
"currencyCode" : {
"type" : "string"
}
},
"description" : "The order line amount, excluding taxes."
},
"amountDiscountUnit" : {
"type" : "object",
"properties" : {
"value" : {
"type" : "number"
},
"currencyCode" : {
"type" : "string"
}
},
"description" : "The order line discount amount to be deducted from the initial price."
},
"vatRate" : {
"type" : "number",
"description" : "The order line applied VAT rate, based on the related order invoice profile."
},
"quantity" : {
"type" : "integer",
"description" : "The related ordered product quantity.",
"format" : "int32"
},
"description" : {
"type" : "string",
"description" : "The order line description."
},
"orderId" : {
"type" : "integer",
"description" : "The unique identifier of the related order.",
"format" : "int32"
},
"duration" : {
"type" : "number",
"description" : "The duration of the order line."
},
"durationUnit" : {
"type" : "string",
"description" : "The duration unit of the order line.",
"example" : "MONTH",
"enum" : [ "YEAR", "MONTH", "DAY", "HOUR", "MINUTE", "SECOND", "TRIMESTER", "SEMESTER", "EURO", "DOLLAR", "CHARACTER", "DUMMY" ]
},
"deliveryStatus" : {
"$ref" : "#/components/schemas/OrderLineDeliveryStatus"
},
"domainName" : {
"type" : "string",
"description" : "An optional domain name linked to the order line."
}
}
},
"DomainContact" : {
"type" : "object",
"properties" : {
"firstName" : {
"type" : "string",
"description" : "The contact first name",
"nullable" : true
},
"lastName" : {
"type" : "string",
"description" : "The contact last name",
"nullable" : true
},
"company" : {
"type" : "string",
"description" : "The contact company name",
"nullable" : true
},
"address1" : {
"type" : "string",
"description" : "The contact first address line",
"nullable" : true
},
"address2" : {
"type" : "string",
"description" : "The contact second address line",
"nullable" : true
},
"address3" : {
"type" : "string",
"description" : "The contact third address line",
"nullable" : true
},
"city" : {
"type" : "string",
"description" : "The contact city name",
"nullable" : true
},
"zipCode" : {
"type" : "string",
"description" : "The contact zip code",
"nullable" : true
},
"countryCode" : {
"type" : "string",
"description" : "The contact country code",
"nullable" : true
},
"email" : {
"type" : "string",
"description" : "The contact email address",
"nullable" : true
},
"phone" : {
"type" : "string",
"description" : "The contact phone number",
"nullable" : true
},
"fax" : {
"type" : "string",
"description" : "The contact fax number",
"nullable" : true
}
},
"description" : "The domain contact information"
},
"SslVerificationMethod" : {
"type" : "string",
"description" : "The SSL certificate domain ownership validation method.
- When selecting EMAIL, an email will be sent by the SSL certificate provider to the address provided during the certificate registration.
- When selecting URL, a security token will need to be uploaded to your website and a crawler will verify its presence.
- When selecting DNS, a DNS record will need to be added to the domain's zone records and a crawler will verify its presence. Sectigo only validates CNAME records while GlobalSign only validates TXT records.",
"enum" : [ "EMAIL", "URL", "DNS" ]
},
"CreatePremiumDnsSubscription" : {
"type" : "object",
"properties" : {
"subscriptionProduct" : {
"$ref" : "#/components/schemas/PremiumSubscriptionProduct"
},
"domainName" : {
"type" : "string",
"description" : "The domain name on which the Premium DNS subscription will be provisioned."
},
"zoneProfileId" : {
"type" : "integer",
"description" : "The id of the zone profile to apply, if any. The zone profile will not be applied if the domain is currently on our nameservers",
"format" : "int32"
},
"durationUnit" : {
"$ref" : "#/components/schemas/DurationUnitName"
},
"duration" : {
"type" : "number",
"description" : "The Premium DNS subscription duration in the provided unit name."
}
},
"description" : "The input data to order an Premium DNS subscription."
},
"SslSubscriptionProduct" : {
"type" : "string",
"description" : "The SSL certificate product to order",
"example" : "SECTIGO_DV",
"enum" : [ "SECTIGO_INSTANT_DV", "SECTIGO_INSTANT_DV_WILDCARD", "SECTIGO_DV", "SECTIGO_DV_WILDCARD", "SECTIGO_DV_MULTI_DOMAIN", "SECTIGO_OV", "SECTIGO_OV_WILDCARD", "SECTIGO_OV_MULTI_DOMAIN", "SECTIGO_EV", "SECTIGO_EV_MULTI_DOMAIN", "GLOBALSIGN_ALPHA", "GLOBALSIGN_ALPHA_WILDCARD", "GLOBALSIGN_DV", "GLOBALSIGN_DV_WILDCARD", "GLOBALSIGN_OV", "GLOBALSIGN_OV_WILDCARD", "GLOBALSIGN_EV" ]
},
"SslCsr" : {
"type" : "object",
"properties" : {
"encodedCsr" : {
"type" : "string",
"description" : "The encoded CSR data."
},
"commonName" : {
"type" : "string",
"description" : "The CSR common name."
},
"domainName" : {
"type" : "string",
"description" : "The CSR domain name."
},
"email" : {
"type" : "string",
"description" : "The CSR email address."
},
"locality" : {
"type" : "string",
"description" : "The CSR locality."
},
"organization" : {
"type" : "string",
"description" : "The CSR organization."
},
"organizationUnit" : {
"type" : "string",
"description" : "The CSR organization unit."
},
"state" : {
"type" : "string",
"description" : "The CSR state."
},
"countryCode" : {
"type" : "string",
"description" : "The CSR country code (ISO 3166-1 alpha-2)."
},
"keyLength" : {
"type" : "integer",
"description" : "The CSR key length.",
"format" : "int32"
},
"signatureAlgorithm" : {
"$ref" : "#/components/schemas/SignatureAlgorithm"
}
},
"description" : "The SSL certificate CSR."
},
"ContactProfile" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "integer",
"format" : "int32"
},
"contactType" : {
"$ref" : "#/components/schemas/ContactType"
},
"profileName" : {
"type" : "string"
},
"companyName" : {
"type" : "string"
},
"firstName" : {
"type" : "string"
},
"lastName" : {
"type" : "string"
},
"address1" : {
"type" : "string"
},
"address2" : {
"type" : "string"
},
"address3" : {
"type" : "string"
},
"zipCode" : {
"type" : "string"
},
"city" : {
"type" : "string"
},
"countryCode" : {
"type" : "string"
},
"email" : {
"type" : "string"
},
"phone" : {
"type" : "string"
},
"fax" : {
"type" : "string"
},
"isOrg" : {
"type" : "boolean"
},
"isAdmin" : {
"type" : "boolean"
},
"isTech" : {
"type" : "boolean"
},
"isBilling" : {
"type" : "boolean"
}
}
},
"DurationUnitName" : {
"type" : "string",
"description" : "The time unit the product will last for",
"example" : "MONTH",
"enum" : [ "YEAR", "MONTH" ]
},
"DnsZoneDnssecStatus" : {
"type" : "object",
"properties" : {
"zoneName" : {
"type" : "string",
"nullable" : true
},
"status" : {
"$ref" : "#/components/schemas/DnssecStatus"
},
"dnssecKeyDtoArray" : {
"type" : "array",
"nullable" : true,
"items" : {
"$ref" : "#/components/schemas/DnsZoneDnssecKey"
}
}
}
},
"MailForward" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "integer",
"description" : "(read only) the Mail forward record identifier.",
"nullable" : true
},
"source" : {
"type" : "string",
"description" : "Left part of the Email address to forward from. Use `*` to create a Catch-All rule",
"nullable" : true
},
"destination" : {
"type" : "string",
"description" : "Email address to forward to.",
"nullable" : true
},
"updated" : {
"type" : "boolean",
"description" : "(read only) Indicates whether the Mail forward has been modified by the user or the server during the Validate operation.",
"nullable" : true
}
}
},
"ZoneError" : {
"type" : "object",
"properties" : {
"message" : {
"type" : "string",
"description" : "Message describing the error of conflict between records."
},
"records" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/DnsRecord"
}
},
"urlForwards" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/UrlForward"
}
},
"mailForwards" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/MailForward"
}
},
"severity" : {
"$ref" : "#/components/schemas/Severity"
}
}
},
"MicrosoftSubscription" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "integer",
"description" : "The unique id of the subscription",
"format" : "int32"
},
"subscriptionType" : {
"$ref" : "#/components/schemas/SubscriptionType"
},
"deliveryDate" : {
"type" : "string",
"description" : "The delivery date of the subscription",
"format" : "date-time"
},
"expirationDate" : {
"type" : "string",
"description" : "The date the subscription will expire",
"format" : "date-time"
},
"updateDate" : {
"type" : "string",
"description" : "The date of the last subscription update",
"format" : "date-time"
},
"subscriptionStatus" : {
"$ref" : "#/components/schemas/SubscriptionStatus"
},
"active" : {
"type" : "boolean",
"description" : "Tells if the service behind the subscription is effectively active or not."
},
"autoRenewSettings" : {
"$ref" : "#/components/schemas/SubscriptionAutoRenewSettings"
},
"domainName" : {
"type" : "string",
"description" : "The domain name the subscription is attached to"
},
"productDescription" : {
"type" : "string",
"description" : "The description of the product the subscription is attached to"
},
"renewable" : {
"type" : "boolean",
"description" : "Defines if the subscription can be renewed."
},
"upgradable" : {
"type" : "boolean",
"description" : "Defines if the subscription can be upgraded."
},
"downgradable" : {
"type" : "boolean",
"description" : "Defines if the subscription can be downgraded."
},
"accountLabel" : {
"type" : "string",
"description" : "The account label of your subscription, also used as Microsoft tenant name"
},
"licencesCount" : {
"type" : "integer",
"description" : "The number of ordered licences",
"format" : "int32"
},
"microsoftDomain" : {
"type" : "string",
"description" : "The microsoft domain related to your subscription, for instance example.onmicrosoft.com"
}
}
},
"Amount" : {
"type" : "object",
"properties" : {
"value" : {
"type" : "number"
},
"currencyCode" : {
"type" : "string"
}
},
"description" : "Amount representation with its value and related currency code."
},
"SslRequestorContact" : {
"required" : [ "email", "firstName", "jobTitle", "lastName", "organization", "organizationUnit", "phone" ],
"type" : "object",
"properties" : {
"organization" : {
"type" : "string",
"description" : "The SSL certificate contact organization."
},
"firstName" : {
"type" : "string",
"description" : "The SSL certificate contact firstname."
},
"lastName" : {
"type" : "string",
"description" : "The SSL certificate contact lastname."
},
"jobTitle" : {
"type" : "string",
"description" : "The SSL certificate contact job title."
},
"phone" : {
"type" : "string",
"description" : "The SSL certificate contact phone number."
},
"email" : {
"type" : "string",
"description" : "The SSL certificate contact email address."
},
"organizationUnit" : {
"type" : "string",
"description" : "The SSL certificate contact organization unit."
}
},
"description" : "The SSL certificate contact information required when provisioning an EXTENDED certificate."
},
"CreateHttpsRedirectSubscription" : {
"type" : "object",
"properties" : {
"subscriptionProduct" : {
"$ref" : "#/components/schemas/HttpsRedirectSubscriptionProduct"
},
"domainName" : {
"type" : "string",
"description" : "The domain name on which the HTTPS redirect subscription will be provisioned."
},
"durationUnit" : {
"$ref" : "#/components/schemas/DurationUnitName"
},
"duration" : {
"type" : "number",
"description" : "The HTTPS redirect subscription duration in the provided unit name."
}
},
"description" : "The input data to order a HTTPS redirect subscription."
},
"DnsRecordType" : {
"type" : "string",
"description" : "Type of Record (per defined in RFCs 1035, 3596, 2782, 4408, 6844).
`APEX`: APEX Alias record\na.k.a. ANAME for Address-specific DNS Name Redirection.
`MAIL`, `URL`: pseudo Record types for Mail and URL forward\nRecords.",
"enum" : [ "A", "AAAA", "CNAME", "MX", "NS", "PTR", "SOA", "SRV", "TXT", "SPF", "CAA", "APEX", "TLSA", "MAIL", "URL", "SVCB", "HTTPS", "DS" ]
},
"ZoneValidationReport" : {
"type" : "object",
"properties" : {
"isValid" : {
"type" : "boolean",
"description" : "Indicates whether changes posted to the Validate operation are valid.",
"nullable" : true
},
"recordErrors" : {
"type" : "array",
"description" : "Validation errors on DNS Records (independently from other records in the zone).",
"nullable" : true,
"items" : {
"$ref" : "#/components/schemas/RecordError"
}
},
"urlForwardErrors" : {
"type" : "array",
"description" : "Validation errors on URL forward Records (independently from other records in the zone).",
"nullable" : true,
"items" : {
"$ref" : "#/components/schemas/UrlForwardError"
}
},
"mailForwardErrors" : {
"type" : "array",
"description" : "Validation errors on Mail forward Records (independently from other records in the zone).",
"nullable" : true,
"items" : {
"$ref" : "#/components/schemas/MailForwardError"
}
},
"zoneErrors" : {
"type" : "array",
"description" : "Errors at DNS Zone level, triggered when there are records conflicting between each others.",
"nullable" : true,
"items" : {
"$ref" : "#/components/schemas/ZoneError"
}
}
},
"description" : "the validation report, only present on responses from the Validate operation"
},
"TermMatchField" : {
"type" : "string",
"default" : "DOMAIN_NAME",
"enum" : [ "DOMAIN_NAME", "FOLDER", "CONTACTS", "OWNER_CONTACT", "ADMIN_CONTACT", "TECHNICAL_CONTACT", "BILLING_CONTACT", "NAMESERVERS", "COMMENT", "TLD" ]
},
"ErrorResponse" : {
"type" : "object",
"properties" : {
"errors" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"code" : {
"$ref" : "#/components/schemas/ErrorCode"
},
"title" : {
"type" : "string"
}
}
}
}
}
},
"ValidationStatus" : {
"type" : "string",
"enum" : [ "UNNECESSARY", "UNVALIDATED", "PENDING", "VALIDATED", "VALIDATION_EXPIRE_SOON", "VALIDATION_IS_EXPIRED", "ERROR" ]
},
"SslCertificate" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "integer",
"description" : "The SSL certificate identifier.",
"format" : "int32"
},
"sslType" : {
"$ref" : "#/components/schemas/SslType"
},
"csr" : {
"$ref" : "#/components/schemas/SslCsr"
},
"pkcs7Certificate" : {
"type" : "string",
"description" : "The SSL certificate PKCS #7 value."
},
"x509CaCertificates" : {
"type" : "array",
"description" : "The intermediate and root certificates' X.509 values.
Sorted from the first intermediate certificate to the root certificate",
"items" : {
"type" : "string"
}
},
"x509Certificate" : {
"type" : "string",
"description" : "The end-user SSL certificate X.509 value."
},
"sslContacts" : {
"type" : "array",
"description" : "The SSL certificate contacts.",
"items" : {
"$ref" : "#/components/schemas/SslContact"
}
},
"outlookWebAccess" : {
"type" : "boolean",
"description" : "Unified Communication Cert Option, allows 'owa' subdomain to be added for free.
Available for 'domain', 'extended' and 'organization' certificates."
},
"mail" : {
"type" : "boolean",
"description" : "Unified Communication Cert Option, allows 'mail' subdomain to be added for free.
Available for 'domain', 'extended' and 'organization' certificates."
},
"autodiscover" : {
"type" : "boolean",
"description" : "Unified Communication Cert Option, allows 'autodiscover' subdomain to be added for free.
Available for 'domain', 'extended' and 'organization' certificates."
},
"startDate" : {
"type" : "string",
"description" : "The SSL certificate start date.",
"format" : "date-time"
},
"endDate" : {
"type" : "string",
"description" : "The SSL certificate end date.",
"format" : "date-time"
},
"organizationInfo" : {
"$ref" : "#/components/schemas/SslOrganizationInfo"
},
"extendedRequestor" : {
"$ref" : "#/components/schemas/SslContact"
},
"extendedApprover" : {
"$ref" : "#/components/schemas/SslContact"
},
"extendedSigner" : {
"$ref" : "#/components/schemas/SslContact"
},
"sslBusinessInfo" : {
"$ref" : "#/components/schemas/SslBusinessInfo"
},
"sans" : {
"type" : "array",
"description" : "The SSL certificate SANs.",
"items" : {
"$ref" : "#/components/schemas/SslSan"
}
},
"status" : {
"$ref" : "#/components/schemas/SslStatus"
},
"action" : {
"$ref" : "#/components/schemas/OrderSslAction"
},
"description" : {
"type" : "string",
"description" : "The SSL certificate description."
},
"validationRequired" : {
"type" : "boolean",
"description" : "Defines if the SSL certificate validation is required."
},
"cancellable" : {
"type" : "boolean",
"description" : "Defines if the SSL certificate validation process can be cancelled.
ISSUE and RENEW actions can be cancelled for 7 days during the validation process (status WAITING_FOR_VALIDATION).
Once the SSL certificate has been delivered, cancellation is no longer possible."
},
"revocable" : {
"type" : "boolean",
"description" : "Defines if the SSL certificate can be revoked."
},
"reissuable" : {
"type" : "boolean",
"description" : "Defines if the SSL certificate can be reissued.
A certificate can be reissued if all the following conditions are matched:
- the certificate is not expired
- the certificate does not have a pending operation
- the subscription does not already have a pending reissue
- the Sectigo certificate has not be revoked (does not apply to GlobalSign)"
},
"authorityRootCertificateLink" : {
"type" : "string",
"description" : "A link to the SSL certificate root certificate. The root certificates can also be found in the 'x509CaCertificates' field."
},
"pending" : {
"type" : "boolean",
"description" : "Defines if the SSL certificate has a pending action.
It includes validation, cancellation and revocation actions."
},
"canReissueAfterRevocation" : {
"type" : "boolean",
"description" : "Defines if the SSL certificate can be reissued after it is revoked."
}
}
},
"ZoneProfile" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "integer",
"description" : "(read only) the zone snapshot identifier.",
"nullable" : true
},
"name" : {
"type" : "string",
"description" : "(read only) the zone name",
"nullable" : true
}
}
},
"SslValidation" : {
"type" : "object",
"properties" : {
"sslVerificationMethod" : {
"$ref" : "#/components/schemas/SslVerificationMethod"
},
"allowedApprovers" : {
"type" : "array",
"description" : "The list of allowed approvers selectable during the certificate SAN validation.",
"items" : {
"type" : "string"
}
},
"approver" : {
"type" : "string",
"description" : "The selected verification approver used during the certificate SAN validation."
},
"securityToken" : {
"type" : "string",
"description" : "The validation security token."
},
"fileValidationUrls" : {
"type" : "array",
"description" : "The list of allowed URLs to use during a certificate SAN validation of 'URL' type.",
"items" : {
"type" : "string"
}
},
"sslVerificationStatus" : {
"$ref" : "#/components/schemas/SslVerificationStatus"
}
},
"description" : "The SSL certificate data used to prove domain ownership of a certificate."
},
"SslSan" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string",
"description" : "The SAN name."
},
"sslVerificationMethod" : {
"$ref" : "#/components/schemas/SslVerificationMethod"
},
"sslVerificationStatus" : {
"$ref" : "#/components/schemas/SslVerificationStatus"
},
"securityToken" : {
"type" : "string",
"description" : "The validation security token to set during a DNS or URL validation."
},
"securityTokenList" : {
"type" : "string",
"description" : "The list of allowed domains selectable during the certificate SAN validation."
},
"verificationApprover" : {
"type" : "string",
"description" : "The selected verification approver used during the certificate SAN validation."
},
"isWildCard" : {
"type" : "boolean",
"description" : "Explicit whereas the SAN is a wildcard or not."
},
"isCommonName" : {
"type" : "boolean",
"description" : "Explicit whereas the SAN is the common name of the SSL certificate or not."
}
},
"description" : "The SSL certificate SAN information."
},
"InvoiceStatus" : {
"type" : "string",
"description" : "The invoice status\n- CANCELLED: the invoice has been cancelled and should no longer be considered.\n- INTERNAL: the invoice is being processed by our system.\n- PAID: the invoice has been payed. No other operation is expected on this invoice.\n- PARTIALLY_PAID: the invoice has been partially paid, but the payment did not cover the invoice full price. Another payment is expected to cover the due leftover amount.\n- PARTIALLY_REIMBURSED: the invoice was paid, and then partially reimbursed, but the reimbursement did not cover the invoice full price. Another reimbursement is expected to cover the invoice paid amount.\n- PENDING_PARTIAL_PAYMENT: a payment not covering the full invoice price has been initiated, but has yet to be completed.\n- PENDING_PAYMENT: a payment covering the full invoice price has been initiated, but has yet to be completed.\n- PENDING_REIMBURSEMENT: a reimbursement has been initiated, but has yet to be completed.\n- REIMBURSED: the invoice has been reimbursed in its full paid amount.\n- TO_PAY: the invoice is outstanding and needs to be paid.\n- TO_REIMBURSE: the invoice reimbursement has not been initiated yet.\n- WAITING_PO_NUMBER: the invoice requires a P.O. number to be provided before being processed.\n\n",
"enum" : [ "INTERNAL", "TO_PAY", "NOT_TO_PAY", "WAITING_PO_NUMBER", "PENDING_PAYMENT", "PENDING_PARTIAL_PAYMENT", "PARTIALLY_PAID", "PAID", "TO_REIMBURSE", "PENDING_REIMBURSEMENT", "PARTIALLY_REIMBURSED", "REIMBURSED", "CANCELLED" ]
},
"ContactType" : {
"type" : "string",
"enum" : [ "PRIVATE_PERSON", "COMPANY", "ORGANISATION", "PUBLIC_BODY" ]
},
"DnsZoneSnapshotPage" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "integer",
"description" : "(read only) the zone snapshot identifier.",
"nullable" : true
},
"zoneName" : {
"type" : "string",
"description" : "(read only) the zone name",
"nullable" : true
},
"createdAt" : {
"type" : "string",
"description" : "(read only) the snapshot creation date",
"format" : "date-time",
"nullable" : true
},
"records" : {
"type" : "array",
"nullable" : true,
"items" : {
"$ref" : "#/components/schemas/DnsRecord"
}
},
"urlForwards" : {
"type" : "array",
"nullable" : true,
"items" : {
"$ref" : "#/components/schemas/UrlForward"
}
},
"mailForwards" : {
"type" : "array",
"nullable" : true,
"items" : {
"$ref" : "#/components/schemas/MailForward"
}
}
}
},
"CreateAcmeSslSubscription" : {
"required" : [ "subscriptionProduct" ],
"type" : "object",
"properties" : {
"subscriptionProduct" : {
"$ref" : "#/components/schemas/AcmeSslSubscriptionProduct"
},
"domainNames" : {
"maxItems" : 200,
"type" : "array",
"description" : "The list of domain names.
Note: The \"www\" sub-domain is included for free (e.g., domain.com also covers www.domain.com)",
"items" : {
"type" : "string"
}
},
"wildcards" : {
"maxItems" : 200,
"type" : "array",
"description" : "The list of wildcard domain names.
Note: The base domain is included with each wildcard for free (e.g., *.domain.com also covers domain.com)",
"items" : {
"type" : "string"
}
},
"organisationProfile" : {
"$ref" : "#/components/schemas/AcmeSslOrganisationProfile"
},
"skipUseAvailableToken" : {
"type" : "boolean",
"description" : "When set to true, the API will always purchase a new token instead of activating an existing one.
For ACME SSL tokens, only tokens matching the exact quantity of domain names and wildcards will be reused.",
"default" : false
},
"durationUnit" : {
"type" : "string",
"description" : "The time unit the product will last for",
"enum" : [ "YEAR" ]
},
"duration" : {
"type" : "number",
"description" : "The ACME SSL subscription duration in years. Allowed values: 1.0, 2.0, 3.0."
}
},
"description" : "The input data to order an ACME SSL subscription.
The number of ordered and billed domain names or wildcards is directly derived from their respective fields."
},
"SslApproverContact" : {
"required" : [ "email", "firstName", "jobTitle", "lastName", "organization", "organizationUnit", "phone" ],
"type" : "object",
"properties" : {
"organization" : {
"type" : "string",
"description" : "The SSL certificate contact organization."
},
"firstName" : {
"type" : "string",
"description" : "The SSL certificate contact firstname."
},
"lastName" : {
"type" : "string",
"description" : "The SSL certificate contact lastname."
},
"jobTitle" : {
"type" : "string",
"description" : "The SSL certificate contact job title."
},
"phone" : {
"type" : "string",
"description" : "The SSL certificate contact phone number."
},
"email" : {
"type" : "string",
"description" : "The SSL certificate contact email address."
},
"organizationUnit" : {
"type" : "string",
"description" : "The SSL certificate contact organization unit."
}
},
"description" : "The SSL certificate contact information used when provisioning an EXTENDED certificate. When not provided, the 'requestor' contact will also be used as 'approver'."
},
"SslSignerContact" : {
"required" : [ "email", "firstName", "jobTitle", "lastName", "organization", "organizationUnit", "phone" ],
"type" : "object",
"properties" : {
"organization" : {
"type" : "string",
"description" : "The SSL certificate contact organization."
},
"firstName" : {
"type" : "string",
"description" : "The SSL certificate contact firstname."
},
"lastName" : {
"type" : "string",
"description" : "The SSL certificate contact lastname."
},
"jobTitle" : {
"type" : "string",
"description" : "The SSL certificate contact job title."
},
"phone" : {
"type" : "string",
"description" : "The SSL certificate contact phone number."
},
"email" : {
"type" : "string",
"description" : "The SSL certificate contact email address."
},
"organizationUnit" : {
"type" : "string",
"description" : "The SSL certificate contact organization unit."
}
},
"description" : "The SSL certificate contact information used when provisioning an EXTENDED certificate. When not provided, the 'requestor' contact will also be used as 'signer'."
},
"ProxyStatus" : {
"type" : "string",
"description" : "Proxy activation status for a record. (A, AAAA, CNAME and APEX records only)",
"enum" : [ "ON", "OFF", "PENDING_ON" ]
},
"SignatureAlgorithm" : {
"type" : "string",
"enum" : [ "ECC", "RSA" ]
},
"DomainNameserver" : {
"type" : "object",
"properties" : {
"fqdn" : {
"type" : "string",
"description" : "The fully qualified domain name (FQDN), e.g., ns1.example.com"
}
}
},
"AcmeSslSubscriptionProduct" : {
"type" : "string",
"description" : "The Acme SSL certificate product to order.\n- DOMAIN: Most basic SSL certificates for businesses that want control over the domain. They are quick to issue and are ideal for personal websites or blogs.\n- ORGANISATION: Provide an extra layer of trust by validating the organization's identity behind the domain. Best suited for websites where credibility is essential.",
"example" : "DOMAIN",
"enum" : [ "DOMAIN", "ORGANISATION" ]
},
"DomainSearchRequest" : {
"type" : "object",
"properties" : {
"term" : {
"type" : "string",
"description" : "The search term used to filter out results in combination with the `termMatchingMode` and `termMatchFields` parameters",
"nullable" : true
},
"termMatchingMode" : {
"$ref" : "#/components/schemas/TermMatchingMode"
},
"termMatchFields" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/TermMatchField"
}
},
"tldName" : {
"type" : "string",
"description" : "The exact TLD name of a domain",
"nullable" : true
},
"active" : {
"type" : "boolean",
"description" : "If `true`, only non expired domains will be included",
"nullable" : true
},
"renewable" : {
"type" : "boolean",
"description" : "If `true`, only renewable domains will be included",
"nullable" : true
},
"reactivable" : {
"type" : "boolean",
"description" : "If `true`, only reactivable domains will be included",
"nullable" : true
},
"dnssecActivated" : {
"type" : "boolean",
"description" : "If `true`, only domains with an active DNSSEC protection will be included",
"nullable" : true
},
"pendingModification" : {
"type" : "boolean",
"description" : "If `true`, only domains with an ongoing operation will be included",
"nullable" : true
},
"useOurNameservers" : {
"type" : "boolean",
"description" : "If `true`, only domains using our nameserver configuration will be included",
"nullable" : true
},
"whoisPrivacy" : {
"type" : "boolean",
"description" : "If `true`, only domains where domain privacy is activated will be included",
"nullable" : true
},
"premiumDns" : {
"type" : "boolean",
"description" : "If `true`, only domains using our premium DNS solution will be included",
"nullable" : true
},
"premium" : {
"type" : "boolean",
"description" : "If `true`, only premium domains will be included",
"nullable" : true
},
"renewalMethod" : {
"$ref" : "#/components/schemas/RenewalMethod"
},
"folderFullPath" : {
"type" : "string",
"description" : "Only domains with this exact folder path will be included",
"nullable" : true
},
"contactValidated" : {
"type" : "boolean",
"description" : "If `true`, only domains where the owner contact has been validated will be included",
"nullable" : true
},
"contactValidationExpiringSoon" : {
"type" : "boolean",
"description" : "Only domains with a contact validation close to expiring will be included",
"nullable" : true
},
"contactValidationMethod" : {
"$ref" : "#/components/schemas/ContactValidationMethod"
}
}
},
"RenewHttpsRedirectSubscription" : {
"type" : "object",
"properties" : {
"durationUnit" : {
"$ref" : "#/components/schemas/DurationUnitName"
},
"duration" : {
"type" : "number",
"description" : "The renewal duration in the provided unit name."
}
},
"description" : "The input data to order the renewal of a HTTPS redirect subscription."
},
"SubscriptionErrorResponse" : {
"type" : "object",
"properties" : {
"errors" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"code" : {
"$ref" : "#/components/schemas/SubscriptionErrorCode"
},
"title" : {
"type" : "string"
}
}
}
}
}
},
"BusinessCategory" : {
"type" : "string",
"description" : "The business information category used when creating an ORGANIZATION or EXTENDED certificate.",
"enum" : [ "PRIVATE_ORGANIZATION", "GOVERNMENT_ENTITY", "BUSINESS_ENTITY" ]
},
"ResendContactValidationsEmails" : {
"type" : "object",
"properties" : {
"contactsDetails" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ContactValidationDetails"
}
}
}
},
"AcmeSslDomain" : {
"type" : "object",
"properties" : {
"status" : {
"$ref" : "#/components/schemas/AutoSslDomainStatus"
},
"name" : {
"type" : "string",
"description" : "The domain name."
},
"organisationProfile" : {
"$ref" : "#/components/schemas/AcmeSslOrganisationProfile"
}
}
},
"RecordError" : {
"type" : "object",
"properties" : {
"messages" : {
"type" : "array",
"description" : "list of error messages on record",
"items" : {
"type" : "string"
}
},
"record" : {
"$ref" : "#/components/schemas/DnsRecord"
},
"severity" : {
"$ref" : "#/components/schemas/Severity"
}
}
},
"UrlForwardError" : {
"type" : "object",
"properties" : {
"messages" : {
"type" : "array",
"description" : "list of error messages on record",
"items" : {
"type" : "string"
}
},
"urlForward" : {
"$ref" : "#/components/schemas/UrlForward"
},
"severity" : {
"$ref" : "#/components/schemas/Severity"
}
}
},
"OrderLineType" : {
"type" : "string",
"description" : "The order line type",
"enum" : [ "DOMAIN_NAME_ORDER_LINE", "DOMAIN_RECOVERY_ORDER_LINE", "GENERIC_ORDER_LINE_WITH_DOMAIN", "MAIL_ORDER_LINE", "MANUAL_ORDER_LINE", "ORDER_LINE", "OX_ORDER_LINE", "PROVIDER_ORDER_LINE", "SSL_ORDER_LINE", "TOKEN_ORDER_LINE" ]
},
"Order" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "integer",
"description" : "The unique identifier of the order.",
"format" : "int32"
},
"date" : {
"type" : "string",
"description" : "The order creation date.",
"format" : "date-time"
},
"invoiced" : {
"type" : "boolean",
"description" : "The invoicing status. Invoices are sent to the email address of the linked invoice profile."
},
"amountTaxExcluded" : {
"type" : "object",
"properties" : {
"value" : {
"type" : "number"
},
"currencyCode" : {
"type" : "string"
}
},
"description" : "The order amount, excluding taxes."
},
"amountVat" : {
"type" : "object",
"properties" : {
"value" : {
"type" : "number"
},
"currencyCode" : {
"type" : "string"
}
},
"description" : "The VAT amount."
},
"orderPaymentStatus" : {
"$ref" : "#/components/schemas/OrderStatus"
},
"customerInvoiceProfileId" : {
"type" : "integer",
"description" : "The unique identifier of the user invoice profile used for all related generated invoices.",
"format" : "int32"
},
"offerValidUntil" : {
"type" : "string",
"description" : "The validity end date of the quote.\nThis should only be set when the 'orderPaymentStatus' is set to 'QUOTE' invoice profile id.\nOnce this date is reached, you will no longer be able to pay the quote and it will be discarded.",
"format" : "date-time"
},
"orderLines" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/OrderLine"
}
}
}
},
"SslOrganizationInfo" : {
"required" : [ "name", "organizationAddress" ],
"type" : "object",
"properties" : {
"name" : {
"type" : "string",
"description" : "The SSL certificate organization name."
},
"organizationAddress" : {
"$ref" : "#/components/schemas/SslOrganizationAddress"
}
},
"description" : "The SSL certificate organization information required when provisioning an ORGANIZATION or EXTENDED certificate."
},
"RenewSslSubscription" : {
"type" : "object",
"properties" : {
"encodedCsr" : {
"type" : "string",
"description" : "The SSL certificate encoded CSR containing the certificate data.
When not provided, the CSR used during the certificate provisioning will be reused.
Any Subject Alternative Name (SAN) present in the encoded CSR will be ignored during the provisioning.
To provision SANs for multi-domain products, provide them in the 'sanEntries' field.
The quantity of allowed host names depends on your original certificate order."
},
"verificationEmailAddress" : {
"$ref" : "#/components/schemas/SslVerificationEmailAddress"
},
"sanEntries" : {
"type" : "array",
"description" : "The list of SAN names to add to the SSL multi-domain certificate. It is only required for multi-domain certificate products and must include the encoded CSR common name.",
"items" : {
"type" : "string"
}
}
},
"description" : "The input data to renew an SSL subscription."
},
"PrepaidBalance" : {
"type" : "object",
"properties" : {
"balanceAmount" : {
"$ref" : "#/components/schemas/Amount"
}
}
},
"AdditionalOrderLineType" : {
"type" : "string",
"enum" : [ "AUTO_SSL", "SSL", "SSL_MDC", "WORDPRESS", "EMAIL", "PREMIUM_DNS", "SHARED_HOSTING", "MICROSOFT", "WEB_SECURITY" ]
},
"InvoiceLine" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "integer",
"description" : "The unique identifier of the invoice line.",
"format" : "int32"
},
"amountTaxExcluded" : {
"type" : "object",
"properties" : {
"value" : {
"type" : "number"
},
"currencyCode" : {
"type" : "string"
}
},
"description" : "The invoice line amount, excluding taxes."
},
"amountDiscount" : {
"type" : "object",
"properties" : {
"value" : {
"type" : "number"
},
"currencyCode" : {
"type" : "string"
}
},
"description" : "The invoice line discount amount to be deducted from the initial price."
},
"quantity" : {
"type" : "number",
"description" : "The ordered product quantity."
},
"vatRate" : {
"type" : "number",
"description" : "The invoice line applied VAT rate."
},
"description" : {
"type" : "string",
"description" : "The invoice line description."
},
"orderLineId" : {
"type" : "integer",
"description" : "The unique identifier of the related order line.",
"format" : "int32"
},
"orderId" : {
"type" : "integer",
"description" : "The unique identifier of the related order.",
"format" : "int32"
}
}
},
"SubscriptionErrorCode" : {
"type" : "string",
"enum" : [ "INVALID_REQUEST", "SUBSCRIPTION_NOT_FOUND", "SUBSCRIPTION_DELETED", "CERTIFICATE_DELETED", "SUBSCRIPTION_CREATION_FAILED", "INVALID_ALIAS_FORMAT", "ALIAS_ALREADY_EXISTS", "CATCH_ALL_ALREADY_EXISTS", "CATCH_ALL_NOT_FOUND", "SUBSCRIPTION_NOT_RENEWABLE", "INVALID_PRODUCT", "FORBIDDEN_ACTION", "SUBSCRIPTION_NOT_DELETABLE", "INVALID_DURATION", "INVALID_CSR", "INVALID_COMMON_NAME", "INVALID_SAN_CONFIGURATION", "COMMON_NAME_SAN_NOT_FOUND", "SAN_NOT_FOUND", "VALIDATION_APPROVER_REQUIRED", "FREE_SSL_ALREADY_EXISTS", "SSL_CERTIFICATE_NOT_FOUND", "CERTIFICATE_NOT_REVOCABLE", "CERTIFICATE_NOT_REISSUABLE", "CERTIFICATE_NOT_CANCELLABLE", "SAN_COMMON_NAME_CANNOT_BE_DELETED", "SSL_CERTIFICATE_EMPTY_SSL_CONTACT", "AUTORENEW_VALUE_REQUIRED", "SSL_VERIFICATION_EMAIL_ADDRESS_NOT_SUPPORTED", "DOMAIN_WITH_DNSSEC", "DOMAIN_PENDING", "ORDER_CREATION_ERROR", "PAYMENT_ERROR", "SUBSCRIPTION_NOT_REACTIVABLE", "SUBSCRIPTION_NOT_UPGRADABLE", "SUBSCRIPTION_NOT_DOWNGRADABLE", "SSL_VERIFICATION_EMAIL_ADDRESS_REQUIRED", "SSL_VERIFICATION_METHOD_NOT_SUPPORTED", "ZONE_ALREADY_EXISTS", "PREMIUM_DNS_ALREADY_ACTIVE", "SUBSCRIPTION_ALREADY_EXISTS", "HTTPS_REDIRECT_INVALID_CAA", "INVALID_DOMAIN_NAME", "ORGANISATION_NOT_FOUND", "INVALID_SUBSCRIPTION_STATUS" ]
},
"Nameserver" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "integer",
"format" : "int32"
},
"ipV4Address" : {
"type" : "string"
},
"ipV6Address" : {
"type" : "string"
},
"fqdn" : {
"type" : "string"
}
}
},
"DnsZoneDnssecKey" : {
"type" : "object",
"properties" : {
"dnssecTypeId" : {
"type" : "integer",
"nullable" : true
},
"dnskeyDnssecFlagId" : {
"type" : "integer",
"nullable" : true
},
"dnskeyDnssecProtocolId" : {
"type" : "integer",
"nullable" : true
},
"dnskeyDnssecAlgorithm" : {
"$ref" : "#/components/schemas/DnsZoneDnssecAlgorithm"
},
"dnskeyPublicKey" : {
"type" : "string",
"nullable" : true
},
"dsKeyTag" : {
"type" : "integer",
"nullable" : true
},
"dsDnssecAlgorithmId" : {
"type" : "integer",
"nullable" : true
},
"dsDnssecDigestTypeId" : {
"type" : "integer",
"nullable" : true
},
"dsDigest" : {
"type" : "string",
"nullable" : true
}
}
},
"ReactivatePremiumDnsSubscription" : {
"type" : "object",
"properties" : {
"domainName" : {
"type" : "string"
},
"durationUnit" : {
"$ref" : "#/components/schemas/DurationUnitName"
},
"duration" : {
"type" : "number",
"description" : "The reactivation duration in the provided unit name."
}
},
"description" : "The input data to order the reactivation of a Premium DNS subscription."
},
"DomainSearchResult" : {
"type" : "object",
"properties" : {
"domainName" : {
"type" : "string",
"description" : "The domain name"
},
"tldName" : {
"type" : "string",
"description" : "The domain TLD name"
},
"folderFullPath" : {
"type" : "string",
"description" : "The complete domain folder structure"
},
"renewalMethod" : {
"$ref" : "#/components/schemas/RenewalMethod"
},
"creationDate" : {
"type" : "string",
"description" : "The domain creation date",
"format" : "date-time"
},
"lastUpdateDate" : {
"type" : "string",
"description" : "The date of the last update of the domain",
"format" : "date-time",
"nullable" : true
},
"expirationDate" : {
"type" : "string",
"description" : "The domain expiration date",
"format" : "date-time"
},
"pendingModification" : {
"type" : "boolean",
"description" : "`true` if a pending operation is ongoing on the domain",
"nullable" : true
},
"active" : {
"type" : "boolean",
"description" : "`true` if the domain is not expired"
},
"renewable" : {
"type" : "boolean",
"description" : "`true` if the domain is currently renewable",
"nullable" : true
},
"reactivable" : {
"type" : "boolean",
"description" : "`true` if the domain is currently reactivable"
},
"dnssecActivated" : {
"type" : "boolean",
"description" : "`true` if the domain has an active DNSSEC protection",
"nullable" : true
},
"useOurNameservers" : {
"type" : "boolean",
"description" : "`true` if the domain is using our nameserver configuration"
},
"whoisPrivacy" : {
"type" : "boolean",
"description" : "`true` if domain privacy is activated on the domain"
},
"renewableFrom" : {
"type" : "string",
"description" : "The date at which the domain will become renewable",
"format" : "date-time"
},
"renewableUntil" : {
"type" : "string",
"description" : "The date at which the domain will stop being renewable",
"format" : "date-time"
},
"reactivateUntil" : {
"type" : "string",
"description" : "The date at which the domain will stop being reactivable",
"format" : "date-time"
},
"contactValidated" : {
"type" : "boolean",
"description" : "`true` if the domain owner contact has been validated",
"nullable" : true
},
"contactValidationExpirationDate" : {
"type" : "string",
"description" : "The date until which the owner's contact validation remains valid",
"format" : "date-time",
"nullable" : true
},
"premiumDns" : {
"type" : "boolean",
"description" : "`true` if the domain is using our premium DNS solution",
"nullable" : true
},
"premium" : {
"type" : "boolean",
"description" : "`true` if the domain is a premium domain name",
"nullable" : true
},
"nameservers" : {
"type" : "array",
"description" : "The list of nameservers the domain uses",
"items" : {
"type" : "string"
}
},
"contactValidationExpiringSoon" : {
"type" : "boolean",
"description" : "`true` if the domain contact validation is close to expiring",
"nullable" : true
},
"owner" : {
"$ref" : "#/components/schemas/DomainContact"
},
"admin" : {
"$ref" : "#/components/schemas/DomainContact"
},
"tech" : {
"$ref" : "#/components/schemas/DomainContact"
},
"billing" : {
"$ref" : "#/components/schemas/DomainContact"
}
}
},
"SslType" : {
"type" : "string",
"description" : "The SSL certificate type.",
"example" : "DOMAIN_SSL",
"enum" : [ "ALPHA_SSL", "INSTANT_SSL", "DOMAIN_SSL", "ORGANIZATION_SSL", "EXTENDED_SSL" ]
},
"MailForwardError" : {
"type" : "object",
"properties" : {
"messages" : {
"type" : "array",
"description" : "list of error messages on record",
"items" : {
"type" : "string"
}
},
"mailForward" : {
"$ref" : "#/components/schemas/MailForward"
},
"severity" : {
"$ref" : "#/components/schemas/Severity"
}
}
},
"Domain" : {
"type" : "object",
"properties" : {
"domainName" : {
"type" : "string",
"description" : "The domain name"
},
"tldName" : {
"type" : "string",
"description" : "The domain TLD name"
},
"folderFullPath" : {
"type" : "string",
"description" : "The complete domain folder path",
"nullable" : true
},
"renewalMethod" : {
"$ref" : "#/components/schemas/RenewalMethod"
},
"creationDate" : {
"type" : "string",
"description" : "The domain creation date",
"format" : "date-time",
"nullable" : true
},
"lastUpdateDate" : {
"type" : "string",
"description" : "The date of the last update of the domain",
"format" : "date-time",
"nullable" : true
},
"expirationDate" : {
"type" : "string",
"description" : "The domain expiration date",
"format" : "date-time",
"nullable" : true
},
"active" : {
"type" : "boolean",
"description" : "`true` if the domain is not expired"
},
"renewable" : {
"type" : "boolean",
"description" : "`true` if the domain is currently renewable"
},
"reactivable" : {
"type" : "boolean",
"description" : "`true` if the domain is currently reactivable"
},
"updatable" : {
"type" : "boolean",
"description" : "`true` if the domain can be updated"
},
"renewableFrom" : {
"type" : "string",
"description" : "The date at which the domain will become renewable",
"format" : "date-time",
"nullable" : true
},
"renewableUntil" : {
"type" : "string",
"description" : "The date at which the domain will stop being renewable",
"format" : "date-time",
"nullable" : true
},
"reactivateUntil" : {
"type" : "string",
"description" : "The date at which the domain will stop being reactivable",
"format" : "date-time",
"nullable" : true
},
"contactValidated" : {
"type" : "boolean",
"description" : "`true` if the domain owner contact has been validated",
"nullable" : true
},
"contactValidationExpirationDate" : {
"type" : "string",
"description" : "The date until which the owner's contact validation remains valid",
"format" : "date-time",
"nullable" : true
},
"statuses" : {
"type" : "array",
"description" : "The statuses currently associated with the domain",
"nullable" : true,
"items" : { }
},
"owner" : {
"$ref" : "#/components/schemas/DomainContact"
},
"admin" : {
"$ref" : "#/components/schemas/DomainContact"
},
"tech" : {
"$ref" : "#/components/schemas/DomainContact"
},
"billing" : {
"$ref" : "#/components/schemas/DomainContact"
},
"nameservers" : {
"type" : "array",
"description" : "The list of nameservers configured for the domain",
"items" : {
"$ref" : "#/components/schemas/DomainNameserver"
}
}
}
},
"DnsRecord" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "integer",
"description" : "(read only) the DNS record identifier.",
"nullable" : true
},
"type" : {
"$ref" : "#/components/schemas/DnsRecordType"
},
"host" : {
"type" : "string",
"description" : "Name of the node to which this record pertains (i.e. NAME).",
"nullable" : true
},
"ttl" : {
"type" : "integer",
"description" : "Count of seconds that the Resource record stays valid.
Allowed values: `600`, `900`, `1800`,`3600`, `7200`, `14400`, `21600`, `43200`, `86400`, `172800`, `432000`, `604800`",
"nullable" : true
},
"rdata" : {
"type" : "string",
"description" : "RFC 1035 5.1 text representation of record data",
"nullable" : true
},
"updated" : {
"type" : "boolean",
"description" : "(read only) Indicates whether the Record has been modified by the user or the server during the Validate operation.",
"nullable" : true
},
"locked" : {
"type" : "boolean",
"description" : "(read only) record is locked and cannot be modified/removed.",
"nullable" : true
},
"isDynDns" : {
"type" : "boolean",
"description" : "(`A` Record only) enable DYNDNS for a A Record.",
"nullable" : true
},
"proxy" : {
"$ref" : "#/components/schemas/ProxyStatus"
}
}
},
"DowngradePremiumDnsSubscription" : {
"type" : "object",
"properties" : {
"subscriptionProduct" : {
"$ref" : "#/components/schemas/PremiumSubscriptionProduct"
}
},
"description" : "The input data to order the downgrade of a Premium DNS subscription."
},
"NameserverProfile" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "integer",
"format" : "int32"
},
"name" : {
"type" : "string"
},
"defaultProfile" : {
"type" : "boolean"
},
"canDelete" : {
"type" : "boolean"
},
"nameservers" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/Nameserver"
}
}
}
},
"LocalDateTime" : {
"type" : "string",
"format" : "date-time"
},
"UrlForward" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "integer",
"description" : "(read only) the URL forward record identifier.",
"nullable" : true
},
"forwardType" : {
"$ref" : "#/components/schemas/UrlForwardType"
},
"host" : {
"type" : "string",
"description" : "Name of the node to which this record pertains (i.e. NAME).",
"nullable" : true
},
"url" : {
"type" : "string",
"description" : "target URL to forward to.",
"nullable" : true
},
"title" : {
"type" : "string",
"description" : "(forwardType `FRAME` only) iframe title",
"nullable" : true
},
"keywords" : {
"type" : "string",
"description" : "(forwardType `FRAME` only) iframe keywords (space separated)",
"nullable" : true
},
"description" : {
"type" : "string",
"description" : "(forwardType `FRAME` only) iframe description",
"nullable" : true
},
"updated" : {
"type" : "boolean",
"description" : "(read only) Indicates whether the URL forward has been modified by the user or the server during the Validate operation.",
"nullable" : true
}
}
},
"ZoneProfilePage" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "integer",
"description" : "(read only) the zone profile identifier.",
"nullable" : true
},
"name" : {
"type" : "string",
"description" : "the profile name",
"nullable" : true
},
"domainConnect" : {
"type" : "boolean",
"description" : "(read only) domain connect activation status",
"nullable" : true
},
"records" : {
"type" : "array",
"nullable" : true,
"items" : {
"$ref" : "#/components/schemas/DnsRecord"
}
},
"urlForwards" : {
"type" : "array",
"nullable" : true,
"items" : {
"$ref" : "#/components/schemas/UrlForward"
}
},
"mailForwards" : {
"type" : "array",
"nullable" : true,
"items" : {
"$ref" : "#/components/schemas/MailForward"
}
},
"report" : {
"$ref" : "#/components/schemas/ZoneValidationReport"
}
}
},
"CipType" : {
"type" : "string",
"description" : "The invoice profile type",
"enum" : [ "PRIVATE_PERSON", "COMPANY" ]
},
"CreateSslSubscription" : {
"required" : [ "contact", "encodedCsr", "subscriptionProduct", "verificationMethod" ],
"type" : "object",
"properties" : {
"subscriptionProduct" : {
"$ref" : "#/components/schemas/SslSubscriptionProduct"
},
"encodedCsr" : {
"type" : "string",
"description" : "The SSL certificate encoded CSR containing the certificate data.
Any Subject Alternative Name (SAN) present in the encoded CSR will be ignored during the provisioning.
To provision SANs for multi-domain products, provide them in the 'sanEntries' field.
The CSR must include a subject, a common name, and a valid email address.
Using the RSA signature algorithm, a key length between 2048 and 8192 must be used.
Using the ECC signature algorithm, a key length between 256 and 384 must be used. "
},
"contact" : {
"$ref" : "#/components/schemas/SslContact"
},
"outlookWebAccess" : {
"type" : "boolean",
"description" : "Unified Communication Cert Option, allows 'owa' subdomain to be added for free.
Available for 'domain', 'extended' and 'organization' certificates.",
"default" : false
},
"mail" : {
"type" : "boolean",
"description" : "Unified Communication Cert Option, allows 'mail' subdomain to be added for free.
Available for 'domain', 'extended' and 'organization' certificates.",
"default" : false
},
"autoDiscover" : {
"type" : "boolean",
"description" : "Unified Communication Cert Option, allows 'autodiscover' subdomain to be added for free.
Available for 'domain', 'extended' and 'organization' certificates.",
"default" : false
},
"verificationMethod" : {
"$ref" : "#/components/schemas/SslVerificationMethod"
},
"verificationEmailAddress" : {
"$ref" : "#/components/schemas/SslVerificationEmailAddress"
},
"organizationInfo" : {
"$ref" : "#/components/schemas/SslOrganizationInfo"
},
"businessInfo" : {
"$ref" : "#/components/schemas/SslBusinessInfo"
},
"requestor" : {
"$ref" : "#/components/schemas/SslRequestorContact"
},
"approver" : {
"$ref" : "#/components/schemas/SslApproverContact"
},
"signer" : {
"$ref" : "#/components/schemas/SslSignerContact"
},
"sanEntries" : {
"type" : "array",
"description" : "The list of Subject Alternative Name (SAN) to provision on the SSL multi-domain certificate.
It is only required for multi-domain certificate products and must include the encoded CSR common name.
It cannot exceed 250 host names.",
"items" : {
"type" : "string"
}
},
"skipUseAvailableToken" : {
"type" : "boolean",
"description" : "When set to true, the API will always purchase a new token instead of activating an existing one. Default value: false",
"default" : false
}
},
"description" : "The input data to order an SSL subscription."
},
"SubscriptionAutoRenewSettings" : {
"required" : [ "autoRenewEnabled" ],
"type" : "object",
"properties" : {
"autoRenewEnabled" : {
"type" : "boolean",
"description" : "Tells if auto-renewal is enabled or not for this subscription."
},
"autoRenewDurationInMonths" : {
"type" : "integer",
"description" : "The time in months the subscription will last before it gets automatically renewed",
"format" : "int32"
}
},
"description" : "Auto-renewal configuration of the subscription"
},
"RenewPremiumDnsSubscription" : {
"type" : "object",
"properties" : {
"durationUnit" : {
"$ref" : "#/components/schemas/DurationUnitName"
},
"duration" : {
"type" : "number",
"description" : "The renewal duration in the provided unit name."
}
},
"description" : "The input data to order the renewal of a Premium DNS subscription."
},
"UpdateAcmeSslDomains" : {
"type" : "object",
"properties" : {
"domainNames" : {
"maxItems" : 200,
"type" : "array",
"description" : "The complete list of domain names of the subscription post-upgrade.
Note: The \"www\" sub-domain is included for free (e.g., domain.com also covers www.domain.com)",
"items" : {
"type" : "string"
}
},
"wildcards" : {
"maxItems" : 200,
"type" : "array",
"description" : "The complete list of wildcard domain names of the subscription post-upgrade.
Note: The base domain is included with each wildcard for free (e.g., *.domain.com also covers domain.com)",
"items" : {
"type" : "string"
}
},
"organisationProfileId" : {
"type" : "integer",
"description" : "The id of an existing organisation profile already linked to the subscription to attach to the added domain names or wildcards.
Only provide the organisation profile id for `ORGANISATION` subscriptions.",
"format" : "int32"
}
}
},
"EmailPassword" : {
"type" : "object",
"properties" : {
"password" : {
"type" : "string"
},
"passwordConfirmation" : {
"type" : "string"
}
}
},
"SslOrganizationAddress" : {
"required" : [ "address1", "city", "countryCode", "phone", "zipCode" ],
"type" : "object",
"properties" : {
"address1" : {
"type" : "string",
"description" : "The SSL certificate organization first address line."
},
"address2" : {
"type" : "string",
"description" : "The SSL certificate organization second line."
},
"address3" : {
"type" : "string",
"description" : "The SSL certificate organization third line."
},
"city" : {
"type" : "string",
"description" : "The SSL certificate organization city.",
"example" : "Boston"
},
"state" : {
"type" : "string",
"description" : "The SSL certificate organization state.",
"example" : "Massachusetts"
},
"zipCode" : {
"type" : "string",
"description" : "The SSL certificate organization zip code."
},
"countryCode" : {
"type" : "string",
"description" : "The SSL certificate organization country code (ISO 3166-1 alpha-2).",
"example" : "US"
},
"phone" : {
"type" : "string",
"description" : "The SSL certificate organization phone number."
},
"fax" : {
"type" : "string",
"description" : "The SSL certificate organization fax number."
}
},
"description" : "The SSL certificate organization address. It is only required for 'organization' and 'extended' SSL certificates."
},
"Tld" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "integer"
},
"name" : {
"type" : "string"
},
"regionGroup" : {
"$ref" : "#/components/schemas/RegionGroup"
},
"country" : {
"type" : "string"
},
"minSubscriptionPeriod" : {
"type" : "integer"
},
"incSubscriptionPeriod" : {
"type" : "integer"
},
"maxSubscriptionPeriod" : {
"type" : "integer"
},
"registrationDelay" : {
"type" : "string",
"nullable" : true
},
"minRenewPeriod" : {
"type" : "integer"
},
"incRenewPeriod" : {
"type" : "integer"
},
"maxRenewPeriod" : {
"type" : "integer"
},
"dayRenewBeforeExpiration" : {
"type" : "integer"
},
"minCharAllowed" : {
"type" : "integer"
},
"maxCharAllowed" : {
"type" : "integer"
},
"hyphenAllowed" : {
"type" : "boolean"
},
"numberAllowed" : {
"type" : "boolean"
},
"localOwnerRequired" : {
"type" : "boolean"
},
"localAdminRequired" : {
"type" : "boolean"
},
"localTechRequired" : {
"type" : "boolean"
},
"localBillingRequired" : {
"type" : "boolean"
},
"minNSAllowed" : {
"type" : "integer"
},
"maxNSAllowed" : {
"type" : "integer"
},
"needContactValidation" : {
"type" : "boolean"
},
"lockingEnabled" : {
"type" : "boolean"
},
"whoisPrivacy" : {
"type" : "boolean"
}
}
},
"TermMatchingMode" : {
"type" : "string",
"default" : "CONTAINS",
"enum" : [ "CONTAINS", "STARTS_WITH", "EXACTLY" ]
},
"OrganisationProfileStatus" : {
"type" : "string",
"description" : "Current validation status of this organisation profile (e.g. pending, validated, rejected).",
"enum" : [ "CANCELLED", "DELETED", "NOT_VALIDATED", "PENDING_VALIDATION", "TO_CANCEL", "VALIDATED", "VALIDATION_ERROR", "EXPIRED", "REJECTED", "PENDING_DELETE", "PENDING_REVOCATION", "REVOKED", "REVOCATION_ERROR" ]
},
"DnsZoneDnssecAlgorithm" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "integer"
},
"name" : {
"type" : "string"
}
}
},
"RenewAcmeSslSubscription" : {
"type" : "object",
"properties" : {
"durationUnit" : {
"type" : "string",
"description" : "The time unit the product will last for",
"default" : "YEAR",
"enum" : [ "YEAR" ]
},
"duration" : {
"type" : "number",
"description" : "The renewal duration in years. Allowed values: 1.0, 2.0, 3.0."
}
},
"description" : "The input data to order the renewal of an ACME SSL subscription."
},
"PremiumDnsSubscription" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "integer",
"description" : "The unique id of the subscription",
"format" : "int32"
},
"subscriptionType" : {
"$ref" : "#/components/schemas/SubscriptionType"
},
"deliveryDate" : {
"type" : "string",
"description" : "The delivery date of the subscription",
"format" : "date-time"
},
"expirationDate" : {
"type" : "string",
"description" : "The date the subscription will expire",
"format" : "date-time"
},
"updateDate" : {
"type" : "string",
"description" : "The date of the last subscription update",
"format" : "date-time"
},
"subscriptionStatus" : {
"$ref" : "#/components/schemas/SubscriptionStatus"
},
"active" : {
"type" : "boolean",
"description" : "Tells if the service behind the subscription is effectively active or not."
},
"autoRenewSettings" : {
"$ref" : "#/components/schemas/SubscriptionAutoRenewSettings"
},
"domainName" : {
"type" : "string",
"description" : "The domain name the subscription is attached to"
},
"productDescription" : {
"type" : "string",
"description" : "The description of the product the subscription is attached to"
},
"renewable" : {
"type" : "boolean",
"description" : "Defines if the subscription can be renewed."
},
"upgradable" : {
"type" : "boolean",
"description" : "Defines if the subscription can be upgraded."
},
"downgradable" : {
"type" : "boolean",
"description" : "Defines if the subscription can be downgraded."
}
}
},
"EmailSubscription" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "integer",
"description" : "The unique id of the subscription",
"format" : "int32"
},
"subscriptionType" : {
"$ref" : "#/components/schemas/SubscriptionType"
},
"deliveryDate" : {
"type" : "string",
"description" : "The delivery date of the subscription",
"format" : "date-time"
},
"expirationDate" : {
"type" : "string",
"description" : "The date the subscription will expire",
"format" : "date-time"
},
"updateDate" : {
"type" : "string",
"description" : "The date of the last subscription update",
"format" : "date-time"
},
"subscriptionStatus" : {
"$ref" : "#/components/schemas/SubscriptionStatus"
},
"active" : {
"type" : "boolean",
"description" : "Tells if the service behind the subscription is effectively active or not."
},
"autoRenewSettings" : {
"$ref" : "#/components/schemas/SubscriptionAutoRenewSettings"
},
"domainName" : {
"type" : "string",
"description" : "The domain name the subscription is attached to"
},
"productDescription" : {
"type" : "string",
"description" : "The description of the product the subscription is attached to"
},
"renewable" : {
"type" : "boolean",
"description" : "Defines if the subscription can be renewed."
},
"upgradable" : {
"type" : "boolean",
"description" : "Defines if the subscription can be upgraded."
},
"downgradable" : {
"type" : "boolean",
"description" : "Defines if the subscription can be downgraded."
},
"emailAddress" : {
"type" : "string",
"description" : "The unique email address related to the subscription"
},
"aliases" : {
"type" : "array",
"description" : "The list of email address aliases related to the subscription",
"items" : {
"type" : "string"
}
},
"catchAll" : {
"type" : "boolean",
"description" : "The status of the catch-all configuration on the subscription"
},
"maxMailQuotaInMb" : {
"type" : "integer",
"description" : "The maximum mail quota allowed for this subscription in MB. Not populated on the search endpoint.",
"format" : "int64"
},
"usedMailQuotaInMb" : {
"type" : "integer",
"description" : "The currently used mail quota for this subscription in MB. Not populated on the search endpoint.",
"format" : "int64"
}
}
},
"HttpsRedirectSslStatus" : {
"type" : "string",
"enum" : [ "ACTIVE", "PENDING", "NO_FORWARD" ]
},
"RenewalMethod" : {
"type" : "string",
"enum" : [ "AUTORENEW", "AUTOEXPIRE" ]
},
"OrderLineDeliveryStatus" : {
"type" : "string",
"description" : "The order line delivery status",
"enum" : [ "IN_PROGRESS", "PARTIALLY_DELIVERED", "DELIVERED", "UNDELIVERED", "NONE" ]
},
"UpgradePremiumDnsSubscription" : {
"type" : "object",
"properties" : {
"subscriptionProduct" : {
"$ref" : "#/components/schemas/PremiumSubscriptionProduct"
}
},
"description" : "The input data to order the upgrade of a Premium DNS subscription."
},
"SslContact" : {
"required" : [ "email", "firstName", "jobTitle", "lastName", "organization", "organizationUnit", "phone" ],
"type" : "object",
"properties" : {
"organization" : {
"type" : "string",
"description" : "The SSL certificate contact organization."
},
"firstName" : {
"type" : "string",
"description" : "The SSL certificate contact firstname."
},
"lastName" : {
"type" : "string",
"description" : "The SSL certificate contact lastname."
},
"jobTitle" : {
"type" : "string",
"description" : "The SSL certificate contact job title."
},
"phone" : {
"type" : "string",
"description" : "The SSL certificate contact phone number."
},
"email" : {
"type" : "string",
"description" : "The SSL certificate contact email address."
},
"organizationUnit" : {
"type" : "string",
"description" : "The SSL certificate contact organization unit."
}
},
"description" : "The SSL certificate contact information."
},
"SortOrder" : {
"type" : "string",
"enum" : [ "ASC", "DESC" ]
},
"Severity" : {
"type" : "string",
"enum" : [ "ERROR", "WARNING" ]
},
"UpgradeSslSubscriptionQuantity" : {
"type" : "object",
"properties" : {
"additionalSanQuantity" : {
"type" : "integer",
"description" : "The quantity of SAN to add to the existing subscription.",
"format" : "int32",
"default" : 0
},
"additionalSanWildcardQuantity" : {
"type" : "integer",
"description" : "The quantity of wildcard SAN to add to the existing subscription.",
"format" : "int32",
"default" : 0
}
},
"description" : "The input data to upgrade the number of allowed Subject Alternative Name (SAN) of an SSL subscription.
At least one of the san quantity field must be provided and be positive.
The subscription total SAN quantity cannot exceed 250.
Only allowed for multi-domain products."
},
"InvoiceType" : {
"type" : "string",
"description" : "The type of invoice\n- CORRECTIVE_INVOICE: a modified invoice linked to a cancelled invoice and its credit note.\n- CREDIT_NOTE: the summary of the refunded invoice lines of a cancelled related invoice.\n- EDITED_INVOICE: a new modified invoice based on an existing invoice.\n- INVOICE: an invoice linked to one or several order lines.\n",
"enum" : [ "INVOICE", "CREDIT_NOTE", "CORRECTIVE_INVOICE", "EDITED_INVOICE" ]
},
"UpgradeAcmeSslSubscriptionQuantity" : {
"type" : "object",
"properties" : {
"additionalDomainNameQuantity" : {
"type" : "integer",
"description" : "The quantity of domain names to add to the existing subscription.",
"format" : "int32",
"default" : 0
},
"additionalWildcardQuantity" : {
"type" : "integer",
"description" : "The quantity of wildcards to add to the existing subscription.",
"format" : "int32",
"default" : 0
}
},
"description" : "The input data to upgrade the number of allowed domain names or wildcards of an ACME SSL subscription.
At least one of the quantity field must be provided and be positive.
The number of domain names or wildcards cannot exceed 200."
},
"ContactValidationDetails" : {
"type" : "object",
"properties" : {
"email" : {
"type" : "string"
},
"phone" : {
"type" : "string"
}
}
},
"SubscriptionStatus" : {
"type" : "string",
"description" : "The current status of the subscription",
"enum" : [ "ACTIVE", "TO_RESTORE", "TO_RENEW", "TO_DELETE", "PENDING_RENEW", "PENDING_RENEW_DOWNGRABLE", "UPGRADE_QUANTITY", "PENDING_UPGRADE_PRODUCT", "HOLD", "PENDING_DOWNGRADE_PRODUCT", "MIGRATED", "PENDING_REACTIVATE", "PROVISIONING" ]
},
"GetDomainsAvailability" : {
"type" : "object",
"properties" : {
"domainNames" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}
},
"DnsZonePage" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string",
"description" : "(read only) the DNS zone name",
"nullable" : true
},
"domainConnect" : {
"type" : "boolean",
"description" : "domain connect activation status",
"nullable" : true
},
"records" : {
"type" : "array",
"nullable" : true,
"items" : {
"$ref" : "#/components/schemas/DnsRecord"
}
},
"urlForwards" : {
"type" : "array",
"nullable" : true,
"items" : {
"$ref" : "#/components/schemas/UrlForward"
}
},
"mailForwards" : {
"type" : "array",
"nullable" : true,
"items" : {
"$ref" : "#/components/schemas/MailForward"
}
},
"report" : {
"$ref" : "#/components/schemas/ZoneValidationReport"
}
}
},
"DnssecStatus" : {
"type" : "string",
"description" : "DNSSEC Status of the zone",
"enum" : [ "SIGNED", "SIGN_PENDING", "SIGN_ERROR", "UNSIGNED", "UNSIGN_PENDING", "UNSIGN_ERROR" ]
},
"HttpsRedirectSubscription" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "integer",
"description" : "The unique id of the subscription",
"format" : "int32"
},
"subscriptionType" : {
"$ref" : "#/components/schemas/SubscriptionType"
},
"deliveryDate" : {
"type" : "string",
"description" : "The delivery date of the subscription",
"format" : "date-time"
},
"expirationDate" : {
"type" : "string",
"description" : "The date the subscription will expire",
"format" : "date-time"
},
"updateDate" : {
"type" : "string",
"description" : "The date of the last subscription update",
"format" : "date-time"
},
"subscriptionStatus" : {
"$ref" : "#/components/schemas/SubscriptionStatus"
},
"active" : {
"type" : "boolean",
"description" : "Tells if the service behind the subscription is effectively active or not."
},
"autoRenewSettings" : {
"$ref" : "#/components/schemas/SubscriptionAutoRenewSettings"
},
"domainName" : {
"type" : "string",
"description" : "The domain name the subscription is attached to"
},
"productDescription" : {
"type" : "string",
"description" : "The description of the product the subscription is attached to"
},
"renewable" : {
"type" : "boolean",
"description" : "Defines if the subscription can be renewed."
},
"upgradable" : {
"type" : "boolean",
"description" : "Defines if the subscription can be upgraded."
},
"downgradable" : {
"type" : "boolean",
"description" : "Defines if the subscription can be downgraded."
},
"sslStatus" : {
"$ref" : "#/components/schemas/HttpsRedirectSslStatus"
}
}
},
"HttpsRedirectSubscriptionProduct" : {
"type" : "string",
"description" : "The HTTPS redirect product to order",
"example" : "HTTPS_REDIRECT",
"enum" : [ "HTTPS_REDIRECT" ]
},
"ErrorCode" : {
"type" : "string",
"enum" : [ "PAYMENT_OPERATION_UPDATE_ERROR", "DNS_ZONE_ALREADY_EXISTS", "PASSWORD_UPDATE_FAILED", "SSL_VERIFICATION_EMAIL_ADDRESS_NOT_SUPPORTED", "CATCH_ALL_ALREADY_EXISTS", "INVALID_OPTION_DEFINITION", "NO_MIGRATABLE_AUTO_SSL_DOMAINS", "PRODUCT_MAX_QUANTITY_COMBINED_REQUIRED", "PENDING_ORDERLINE_ALREADY_EXISTS", "SUBSCRIPTION_UNAVAILABLE", "WEB_COM_AUTO_RENEW_STATUS_SWITCH_ERROR", "INSUFFICIENT_PREPAID_BALANCE", "MODE_NOT_FOUND", "INVALID_CSR_INVALID_KEY", "INVALID_EXPIRATION_DATE", "CANCEL_ERROR", "MISSING_VERIFICATION_CODE", "CERTIFICATE_EXPIRED", "INVALID_ORDERGOOD_ACTION", "PREMIUM_DNS_DOMAIN_WITH_DNSSEC", "CONTACT_VALIDATION_ALREADY_VALID", "WRONG_OPERATION", "INVALID_CSR_ORGANISATION_EMAIL", "OX_CREDENTIALS_REQUIRED", "IDN_LANGUAGE_DISALLOWED", "NO_OFFLINE_ACCOUNT_AVAILABLE", "PREMIUM_DNS_ZONE_ALREADY_EXISTS", "DOMAIN_INTERNAL_TRANSFER_NOT_FOUND", "INVALID_EMAIL_VALIDATION", "CIP_NOT_FOUND", "VERIFACTU_RECORD_NOT_FOUND", "NOT_ALLOWED", "CONTACT_ORIGINAL_UPDATE_FAILED", "INVALID_PEPPOL_PARTICIPANT_ID", "SSL_STATUS_CHECK_FAILURE", "TOO_MANY_COUNTRIES_FOUND", "INVALID_CSR_COMMON_NAME_INCLUDE_HTTPS", "DOMAIN_RECOMMENDATION_FAILED", "PREMIUM_DOMAIN_NOT_FOUND", "EMPTY_ORDER", "PREMIUM_DNS_ALREADY_ACTIVE", "RESELLER_USER_ID_REQUIRED", "DIG_QUERY_FAILED", "MISSING_TOKEN", "CIP_ASSOCIATION_DELETION_FAILED", "JETPACK_ALREADY_ACTIVE", "SSL_VERIFICATION_EMAIL_ADDRESS_REQUIRED", "PRODUCT_CODE_INVALID", "INVALID_AUTO_SSL_DOMAIN_STATUS", "DOMAIN_UPDATE_VALIDATION_FAILED", "REGISTRAR_ACCOUNT_COST_ALREADY_EXIST", "MDC_PRODUCT_CONFIGURATION_REQUIRED", "REGISTRAR_ACCOUNT_COST_FORBIDDEN_TYPE", "PEPPOL_DOCUMENT_REJECTED", "APPLICABLE_VAT_NOT_FOUND", "AUTO_SSL_UPDATE_FAILED", "PHONE_NUMBER_REQUIRED", "INVALID_GOOD_STATUS", "INVALID_NAMESERVER_LIST", "INVALID_CSR_COUNTRY_CODE", "E_INVOICING_ID_NOT_VALID", "CONTACT_PROFILE_BULK_UPDATE_FAILED", "ORDERGOOD_ID_REQUIRED", "PROVIDER_URL_FORWARD_IP_NOT_FOUND", "COMMON_NAME_SAN_NOT_FOUND", "DOMAIN_INTERNAL_TRANSFER_ALREADY_ACCEPTED", "DOMAIN_EXISTS", "AUTO_SSL_ORGANISATION_UPDATE_FAILED", "E_INVOICING_FEATURE_NOT_ALLOWED", "ORDER_NOT_REIMBURSABLE", "PHONE_VALIDATION_REQUESTED_RECENTLY", "USER_NOT_ACTIVE", "ACCOUNT_PENDING_DELETE", "INVALID_CSR_COMMON_NAME_FQDN", "INVALID_MANUAL_ORDERLINE_ID", "PROVIDER_SERIAL_NUMBER_NOT_FOUND", "SHARED_HOSTING_CERTIFICATE_ID_REQUIRED", "PAYMENT_REFUND_THRESHOLD_REACHED", "PHONE_VALIDATION_TOO_MANY_ATTEMPTS", "INVALID_CSR_UNSUPPORTED_KEY_SIZE", "INVALID_CSR_COMPROMISED_KEY", "TOO_MANY_DOMAIN_NAME_RECORD_DATA", "INVALID_SSL_PRODUCT", "DEFAULT_NS_ALREADY_EXISTS", "SSL_PROVIDER_BAD_REQUEST", "EXPORT_GENERATION_ERROR", "ORDERLINE_EXPIRATION_ERROR", "DNS_SOLUTION_FEATURE_NOT_ACTIVE", "TOKEN_ORDERLINE_REQUIRED", "INVALID_ORDER_DOMAIN_CONFIGURATION", "PDF_FETCH_FAILED", "INVALID_ORDER_GOOD", "E_INVOICING_NOT_ENABLED", "ORDER_AUTO_SSL_OPERATION_NOT_FOUND", "TRANSFER_OUT_INVALID_AUTHORIZATION_TYPE", "INVALID_CSR_COMMON_NAME_IS_IP_ADDRESS", "ORDER_LINE_DETAILS_NOT_FOUND", "PHONE_VALIDATION_TEMPORARY_BLOCKED", "OX_USERNAME_NOT_FOUND", "DOMAIN_CONNECT_MISSING_ARGUMENTS", "INVALID_NOMINET_DOMAIN", "ALL_LINES_EXIST_IN_ANOTHER_QUOTE", "AMOUNT_REQUIRED", "GOOD_DELETION_NOT_CANCELLABLE", "ORDER_PAYMENT_TRANSACTIONS_NOT_FOUND", "RENEWAL_UNAVAILABLE", "PEPPOL_TRANSMISSION_FAILED", "PREMIUM_PRODUCT_PRICE_NOT_FOUND", "INVALID_DNS_RECORD_DATA", "GOOD_NOT_DELETABLE", "CONTACT_PROFILE_NOT_FOUND", "DOMAIN_NOT_SIGNABLE", "ORGANISATION_PROFILE_REQUIRED", "MISSING_PARAMETER", "PREMIUM_NAMESERVERS_UNAVAILABLE", "PRODUCT_PRICE_NOT_FOUND", "AUTO_SSL_DURATION_EXTENSION_FAILURE", "INVALID_DURATION_RANGE", "PREMIUM_DNS_DOMAIN_NOT_OWNED", "DOMAIN_PENDING", "EAS_CODE_NOT_FOUND", "EMAIL_ADDRESS_REQUIRED", "CIP_DELETION_FAILED", "AUTO_SSL_DOMAIN_NOT_FOUND", "SAN_COMMON_NAME_CANNOT_BE_DELETED", "GOOD_NOT_TRANSFERABLE", "INVALID_CSR_CANT_BE_DECODED", "INVALID_AUTHORIZATION_REQUEST", "IP_INVALID", "COUNTRY_NOT_FOUND", "INVALID_RENEWAL_PRODUCT", "FREE_ANYCAST_AVAILABLE", "DNS_ZONE_NOT_EDITABLE", "PAYMENT_NOT_REFUNDABLE", "INVALID_CIP_ASSOCIATION_CONTEXT", "MICROSOFT_GOOD_GROUP_NOT_FOUND", "NO_DOMAIN_TO_ADD_OR_REMOVE", "IP_LOOKUP_RESOLVER_ERROR", "PRODUCT_NOT_FOUND", "DNS_ZONE_PROFILE_NOT_FOUND", "PREMIUM_DNS_CONFIGURATION_CHECK_UNAVAILABLE", "DOMAIN_PRIVACY_NOT_ACTIVE", "ACCOUNT_ALREADY_EXISTS", "DELETE_DEFAULT_CONTACT_FORBIDDEN", "ORDER_ID_REQUIRED", "SINGLE_USER_REQUIRED", "USER_NOT_FOUND", "ORDERLINE_QUANTITY_NOT_ALLOWED", "USER_MAIL_FORWARD_SERVER_NOT_FOUND", "AUTO_SSL_DOMAIN_UPDATE_FAILED", "INVALID_CSR", "AUTO_SSL_DELETE_DOMAIN_FAILED", "REFUND_DECLINED", "PREMIUM_DNS_INVALID_DOMAIN", "E_INVOICING_RELATED_INVOICE_REQUIRED", "GOOD_TYPE_NOT_RENEWABLE", "MISSING_UPDATE_PARAM", "INVALID_QUOTE_OFFER_VALIDITY_DATE", "INVALID_REQUEST", "HOSTING_PROXY_ERROR", "PREMIUM_DNS_DOMAIN_PENDING_MODIFICATION", "INVALID_ORDERLINE", "PEPPOL_PARTICIPANT_NOT_FOUND", "CONTACT_TYPE_REQUIRED", "OX_USER_DOES_NOT_EXISTS", "CONTACT_ORIGINAL_DELETE_FAILED", "PREMIUM_DNS_GOOD_NOT_UPGRADABLE", "HTTPS_REDIRECT_CAA_CHECK_ERROR", "SEVERAL_APPLICABLE_VAT_ERROR", "PRODUCT_OPTION_NOT_FOUND", "INVOICE_EMAIL_SEND_FAILED", "INVALID_RENEWAL_DURATION", "MISSING_DELIVERY_DATE", "REQUIRED_PARAMS", "HTTPS_REDIRECT_ALREADY_ACTIVE", "TOGGLE_RENEW_NOTICE_REQUIRED", "INVOICE_NOT_PAYABLE", "AUTO_SSL_DOMAIN_ALREADY_INCLUDED", "DOMAIN_NAME_REQUIRED", "DOMAIN_CONNECT_SIGNATURE_FORMAT", "CONTACT_ORIGINAL_CREATION_FAILED", "ALIAS_ALREADY_EXISTS", "OX_INFO_NOT_FOUND", "CIP_USER_MISMATCH", "OPERATION_NOT_ALLOWED", "AUTO_SSL_ADD_DOMAIN_FAILED", "INVALID_CONTACT_ROLE", "UNKNOWN_SSL_TYPE", "DOMAIN_NOT_FOUND", "RETRY_CAA_CHECK_LIMIT_REACHED", "TOO_MANY_DNS_RECORDS", "ORGANISATION_VALIDATION_FAILED", "INVALID_PREVALIDATION_DURATION", "NAMESERVER_LIST_REQUIRED", "PAYMENT_TRANSACTION_ID_REQUIRED", "DOMAIN_CONNECT_UNSUPPORTED_TEMPLATE", "NS_PROFILE_CREATION_FAILED", "MISSING_PHONE_NUMBER", "ORDERLINE_ERROR", "HSTS_REQUIRES_HTTPS_REDIRECT", "INVALID_AUTHORIZATION_TYPES", "DYN_DNS_ABUSE", "DOMAIN_LOCK_FAILED", "WORDPRESS_CONFIGURATION_ERROR", "TOKEN_NOT_SSL", "DNS_SOLUTION_FEATURE_NOT_FOUND", "PDF_NOT_FOUND", "TOKEN_INVALID_EXPIRATION_DATE", "GOOD_ALREADY_ACTIVE", "DEFAULT_CONTACT_PROFILE_REQUIRED", "INVALID_REMINDER_NUMBER", "PREVALIDATION_ALREADY_EXISTS", "USER_UNAUTHORIZED", "ALIASES_UNAVAILABLE", "DOMAIN_NOT_VALID", "HAS_PENDING_ORDERLINE", "CONTACT_PROFILE_UPDATE_FAILED", "IP_LOOKUP_INVALID_HOST", "NO_APPLICABLE_VAT_ERROR", "ALIAS_FORMAT", "E_INVOICING_NOT_REGISTERED", "PEPPOL_SML_LOOKUP_FAILED", "HTTPS_REDIRECT_ALREADY_PENDING", "ORDER_VAT_VALIDATION_STATUS_REQUIRED", "DEFAULT_ACCOUNT_NOT_DELETABLE", "TOKEN_EXPIRED", "ZONE_ALREADY_EXISTS", "USER_ID_REQUIRED", "PHONE_VALIDATION_LANDLINE_NOT_ALLOWED", "INVOICE_ID_REQUIRED", "GOOD_NOT_REACTIVABLE", "PREMIUM_DNS_GOOD_NOT_RENEWABLE", "CONTACT_VALIDATION_STILL_IN_USE", "SOA_RECORD_NOT_FOUND", "ORDER_ALREADY_PAID", "ANYCAST_SOLUTION_FEATURE_PARAM_NOT_FOUND", "CERTIFICATE_SSL_NOT_FOUND", "GOOD_NOT_SUSPENDABLE", "DNSSEC_AND_APEX_RECORD_CONFLICT", "DOMAIN_NOT_TRANSFERABLE", "PREMIUM_DNS_GOOD_NOT_REACTIVABLE", "FEATURE_PROXY_ERROR", "DELETE_MAIN_USER_DEFAULT_CONTACT_FORBIDDEN", "GOOD_ID_REQUIRED", "TLD_DISABLED", "WEB_SECURITY_GOOD_NOT_FOUND", "VALIDATION_FAILED", "ALIAS_PLUS_SIGN_NOT_ALLOWED", "INVALID_USER_ID", "E_INVOICE_NOT_PUBLISHABLE", "PHONE_VALIDATION_NOT_FOUND", "QUOTE_VALIDITY_REQUIRED", "DOMAIN_CONNECT_TEMPLATE_NOT_FOUND", "DOMAIN_AUTHCODE_REGENERATION_FAILED", "GOOD_NOT_ACTIVE", "USED_PUBLIC_KEY", "WRONG_PO_STATUS", "UNKNOWN_NUDNS_DNSSEC_ALGORITHM", "ZONE_CHECK_ERROR", "CIP_UPDATE_FAILED", "EMAIL_VALIDATION_ERROR", "SAN_ALREADY_VALIDATED", "FORBIDDEN_OPERATION", "DOMAIN_NOT_UNLOCKABLE", "GOOD_TYPE_NOT_AUTORENEWABLE", "INVALID_ORGANISATION_STATUS_CODE", "PAYMENT_ALREADY_ONGOING_ON_CHECKOUT", "INVALID_CSR_INVALID_SIGNATURE", "REQUIRED_INVOICE_IDS_PARAM", "DNS_SNAPSHOT_RESTORE_MISSING_SOLUTION_ID", "DIG_QUERY_FAILED_RETRY", "OX_FEEDBACK_TARGET_NOT_IMPLEMENTED", "ORGANISATION_NOT_FOUND", "TRANSACTION_NOT_DIRECTLY_REFUNDABLE", "ACME_ACCOUNT_DEACTIVATION_FAILED", "REFUND_REQUEST_NOT_PENDING", "TRANSFER_OUT_REFUSED", "CONTACT_ORIGINAL_NOT_FOUND", "DNS_TASK_CANCEL", "AUTO_SSL_DOMAIN_NOT_REQUIRED", "AUTORENEW_ORDERLINE_ERROR", "MANUAL_GOOD_NOT_RENEWABLE", "OX_API_ERROR", "INVALID_CSR_COMMON_NAME_INCLUDE_HTTP", "AUTO_RENEW_NOT_ALLOWED", "DOMAIN_CONNECT_SIG_RECORD_MISSING", "DOMAIN_PRIVACY_ALREADY_ACTIVE", "OX_ACTION_REQUIRED", "INVALID_COUNTRY", "DOMAIN_UNAVAILABLE", "DIG_RESPONSE_NAMESERVER_NOT_FOUND", "MAX_QUANTITY_EXCEEDED", "DOMAIN_CONNECT_INVALID_SIGNATURE", "INVALID_COUNTRY_CODE", "TOKEN_NOT_AVAILABLE", "INVALID_FOLDER", "TOO_MANY_CONTACT_VALIDATION_STATUSES", "DNS_INVALID_SNAPSHOT_ID", "INVALID_INVOICE_TYPE", "PROVIDER_INVOICE_PROFILE_NOT_FOUND", "ORDERGOOD_CREATION_FAILED", "ORDERLINE_NOT_FOUND", "WEB_SECURITY_TRIAL_NOT_AVAILABLE", "ADDITIONAL_INFO_VALIDATION_FAILED", "INVALID_QUANTITY", "DEFAULT_CIP_ALREADY_EXISTS", "FOLDER_NOT_FOUND", "DOMAIN_NOT_UNSIGNABLE", "INVALID_INVOICE_STATUS", "REVOKED_PUBLIC_KEY", "PHONE_VALIDATION_INVALID_PHONE_NUMBER", "DNS_ZONE_IMPORT_PARSE_ERROR", "REFUND_REQUEST_CREATION_FAILED", "PROVIDER_ID_REQUIRED", "CONTACT_VALIDATION_NOT_FOUND", "IP_LOOKUP_UNKNOWN_HOST", "DELETE_MAIN_USER_DEFAULT_NS_PROFILE_FORBIDDEN", "MISSING_ACME_ACCOUNT_ID", "QUOTA_MAX_NOT_FOUND", "OX_RESELLER_USER_ID_NOT_NULL", "PHONE_VALIDATION_ERROR", "INVALID_TLD", "UNABLE_TO_GET_ORDER_STATUS", "ORDERLINE_DURATION_UNIT_ERROR", "ORDER_NOT_FOUND", "DNS_ZONE_FORMAT", "DOMAIN_CONNECT_MISSING_REPLACEMENT", "UNSUPPORTED_DNS_RECORD_TYPE", "DOMAIN_COMMENT_NOT_FOUND", "FEEDBACK_ERROR", "ZONE_DELETED", "WEB_COM_AUTO_RENEW_STATUS_RETRIEVING_ERROR", "REQUEST_FAILED", "SSL_VERIFICATION_METHOD_UPDATE_NOT_SUPPORTED", "PAYMENT_DECLINED", "PHONE_OR_EMAIL_REQUIRED", "INVALID_AMOUNT", "PREVALIDATION_ALREADY_REJECTED", "FEATURE_NOT_ACTIVATED", "DNS_ZONE_NOT_VALID", "MULTIPLE_ORDER_INVOICE_NOT_DIRECTLY_REFUNDABLE", "CONFLICTING_DOMAIN_OPERATIONS", "PEPPOL_DOCUMENT_CONFLICT", "DNS_SOLUTION_NOT_FOUND", "GOOD_NOT_FOUND", "MAIN_USER_CIP_DELETION_FAILED", "PREMIUM_DNS_DOMAIN_REQUIRED", "ORDER_IDS_REQUIRED", "ORDERLINE_DURATION_RANGE_ERROR", "NOT_DELETABLE_ORDER_PAYMENT_STATUS", "DIG_REQUEST_DOMAIN_NAME_NOT_FOUND", "SEVERAL_PRODUCTS_ERROR", "SSL_ACTION_REQUIRED", "ACCOUNT_NOT_EXPIRED", "HOSTED_CHECKOUT_CANCELLED", "OFFLINE_PAYMENT_ERROR", "OX_INFO_REQUIRED", "FREE_SSL_ALREADY_EXISTS", "ACCOUNT_NOT_FOUND", "COMMON_NAME_REQUIRED", "INVALID_DOMAIN_NAME", "MISSING_EXPIRATION_DATE", "CIP_ASSOCIATION_CREATION_FAILED", "REFUND_TRANSACTION_PENDING", "HTTPS_REDIRECT_INVALID_CAA", "CATCH_ALL_NOT_FOUND", "DNS_SOLUTION_FEATURE_REQUIRED", "INVALID_BUNDLE_CONFIGURATION", "MISSING_DOMAIN_NAME", "INCOMPATIBLE_DNS_RECORD_DATA", "SHARED_HOSTING_GOOD_REQUIRED", "REGISTRAR_ACCOUNT_ALREADY_EXIST", "GOOD_NOT_DOWNGRADABLE", "INVALID_PARAM", "FEATURE_NOT_SUPPORTED", "INVALID_TLD_REGISTRAR_ACCOUNT_COSTS_CURRENCY_ID", "EMAIL_VALIDATION_EXPIRED", "PEPPOL_DOCUMENT_NOT_FOUND", "GOOD_NOT_RENEWABLE", "WRONG_PRODUCT", "ORDERLINES_IDS_LIST_REQUIRED", "DNS_ZONE_NOT_FOUND", "PRODUCT_CODE_REQUIRED", "HOSTED_CHECKOUT_EXPIRED", "UNIFIED_QUOTA_PROPERTY_NOT_FOUND", "PAYMENT_OPERATION_NOT_FOUND", "AUTO_SSL_UPDATE_DOMAIN_FAILED", "DOMAIN_ID_REQUIRED", "HOSTING_CERTIFICATE_UNAVAILABLE", "GROUPWARE_NOT_FOUND", "X509_CERTIFICATE_ERROR", "INVALID_CONTACT_VALIDATION_DETAILS", "PHONE_VALIDATION_ALREADY_VALIDATED", "ORDERLINE_DURATION_ERROR", "COUNTRY_REQUIRED", "SINGLE_PRODUCT_REQUIRED", "DNS_ZONE_DNSKEY_NOT_FOUND", "DNS_LOOKUP_FAILED", "LOCAL_PRESENCE_NOT_FOUND", "TOO_MUCH_ORDERGOOD", "NO_REASON_FOR_FEEDBACK", "PRODUCT_PROPERTY_NOT_FOUND", "NOT_IMPLEMENTED", "PREVALIDATION_NOT_AWAITING_VALIDATION", "WEB_COM_REQUEST_ERROR", "CONTACT_PROFILE_CREATION_FAILED", "FOLDER_MANAGER_NOT_FOUND", "DIG_REQUEST_ERROR", "UNSUPPORTED_PRODUCT_TYPE", "INVALID_EMAIL_ADDRESS", "ORDER_DOMAIN_ERROR", "PAYMENT_NOT_REFUNDABLE_YET", "NOT_DELETABLE_ORDER_STATUS", "EMAIL_VALIDATION_REMINDER_DATE_INVALID", "PAYMENT_TIMEOUT", "CONFIGURATION_FAILED", "SSL_TOKEN_ID_REQUIRED", "INVALID_PO_NUMBER", "NOT_DOMAIN_BASED_GOOD", "CIP_CREATION_FAILED", "URL_FORWARD_SERVER_NOT_FOUND", "ORGANISATION_VALIDATION_NUMBER_REQUIRED", "PAYMENT_METHOD_ERROR", "ACME_ACCOUNT_SUSPENSION_FAILED", "DYN_DNS_INVALID_IP", "WEB_COM_SSO_URL_RETRIEVING_ERROR", "INVALID_AUTO_SSL_DOMAIN_NAME", "PROVIDER_MAIL_FORWARD_SERVER_NOT_FOUND", "CERTIFICATE_NOT_REVOCABLE", "DOMAIN_UNLOCK_FAILED", "OX_PASSWORD_NOT_FOUND", "SEND_NOTICE_FLAG_REQUIRED", "DOMAIN_CONNECT_DOMAIN_NOT_FOUND", "TOKEN_USER_REQUIRED", "INVALID_CSR_UNSUPPORTED_ALGORITHM", "TRANSFER_OUT_INVALID_HASH_KEY", "PAYMENT_PROVIDER_NOT_AVAILABLE", "SSL_CERTIFICATE_EMPTY_SSL_CONTACT", "GOOD_NOT_UNSUSPENDABLE", "ORDER_CREATION_ERROR", "ACCEPT_CHALLENGED_ERROR", "INVALID_OPERATION_COUNT", "DYN_DNS_NOT_YOUR_DOMAIN", "AVAILABILITY_OPERATION_NOT_SUPPORTED", "INVOICE_NOT_REFUNDABLE", "HOSTED_CHECKOUT_NOT_FOUND", "MISSING_PARAMETERS", "ZONE_PROFILE_NOT_VALID", "OX_SUBSCRIPTION_NOT_FOUND", "OPERATION_NOT_SUPPORTED", "INVALID_REGISTRAR_TAG", "GOOD_NOT_UPGRADABLE", "VALIDATION_ERROR", "EMAIL_TEMPLATE_REQUIRED", "VAT_NUMBER_NOT_VALID", "NS_PROFILE_UPDATE_FAILED", "NO_VALID_OPERATION", "INVOICE_NOT_FOUND", "ORDERLINE_REQUIRED", "WRONG_SSL_PRODUCT", "OVERQUOTA_PRODUCT_NOT_FOUND", "PHONE_VALIDATION_UNABLE_TO_SEND_SMS", "ACME_ACCOUNT_REINSTATEMENT_FAILED", "MISSING_DELETE_PARAM", "UNSUPPORTED_PAYMENT_METHOD", "NAMEMEDIA_CHECK_FAILED", "WEB_SECURITY_GOOD_TO_DELETE", "PHONE_VALIDATION_INVALID_CODE", "PAYMENT_ERROR", "INVALID_DURATION", "GOOD_DELETED", "UBL_VALIDATION_FAILED", "INVOICE_LINE_NOT_FOUND", "DOMAIN_WITH_DNSSEC", "CERTIFICATE_NOT_CANCELLABLE", "REFUND_REQUEST_NOT_FOUND", "MULTIPLE_AUTHORIZATION_TYPES", "MANUAL_AUTHORISATION_REQUIRED", "TOO_MUCH_GOOD", "PREMIUM_DNS_DNS_SOLUTION_REQUIRED", "INVALID_ACCOUNT_TYPE", "CERTIFICATE_ALREADY_ISSUED", "TOO_LATE_TO_CHANGE_RENEWAL_METHOD", "ORDER_DOMAIN_IDS_LIST_REQUIRED", "CERTIFICATE_NOT_REISSUABLE", "SSL_VERIFICATION_METHOD_NOT_SUPPORTED", "INVALID_SAN_CONFIGURATION", "NO_OVERQUOTA_ORDER_TO_CREATE", "PREMIUM_DNS_INCOMPATIBLE_DOMAIN", "ORDERLINE_OPTIONVALUES_ERROR", "PROXY_ERROR", "INVALID_DOMAIN", "OX_INVALID_EMAIL_ADDRESS", "WRONG_PHONE_VERIFICATION_CHANNEL", "SSL_PRODUCT_ID_REQUIRED", "QUOTE_AUTHORIZATION_REQUIRED", "SIGN_DOMAIN_FAILED", "PRODUCT_NOT_ALLOWED", "INVALID_DOMAIN_AVAILABILITY_STATUS", "DNS_SNAPSHOT_NOT_FOUND", "EMPTY_PDF", "REFUND_REQUEST_PENDING", "ORDERGOOD_NOT_FOUND", "E_INVOICING_NOT_FOUND", "FEATURE_PARAMETER_NOT_FOUND", "INVALID_DELIVERY_DATE", "DOMAIN_ALREADY_VALIDATED", "ZONE_NAME_REQUIRED", "DOMAIN_PRIVACY_NOT_ALLOWED", "TOKEN_NOT_FOUND", "INVALID_DURATION_UNIT", "ORDER_AUTO_SSL_OPERATION_TYPE_REQUIRED", "INVALID_PRODUCT", "INVALID_ACME_DNS_RECORD", "MISSING_DOMAIN_ID", "BULK_CREATE_DOMAIN_INTERNAL_TRANSFER_FAILED", "ORDER_AUTO_SSL_OPERATION_UPDATE_FAILED", "DYN_DNS_TOO_MANY_DOMAINS", "DNS_ZONE_PARKING_ERROR", "PROCESS_ALREADY_INITIATED", "NO_VALID_COMPANY_ID_NUMBER_FOUND", "PREMIUM_DNS_DOMAIN_IN_CART", "OX_ENDPOINT_NOT_FOUND", "INVOICE_AMOUNT_REQUIRED", "ORDERGOOD_ACTIVATION_FAILED", "MISSING_USER_ID", "SEVERAL_PREMIUM_PRODUCT_PRICES", "NS_PROFILE_NOT_FOUND", "EMAIL_VALIDATION_NOT_EXPIRED", "INVALID_GOOD_TYPE", "STANDALONE_ORDERLINE_ERROR", "MISSING_CREATE_PARAM", "INVALID_ORDER_ID", "PROFILE_NAME_ALREADY_TAKEN", "ORDER_SNAPSHOT_NOT_FOUND", "DOMAIN_NOT_LOCKABLE", "ORDERLINE_OPTION_NOT_FOUND", "TOKEN_EXPIRATION_DATE_REQUIRED", "NO_LINE_TO_INVOICE", "DNS_XML_PROFILE_NOT_FOUND", "TRANSFER_OUT_UNAVAILABLE", "DEFAULT_CONTACT_ALREADY_EXISTS", "HTTPS_REDIRECT_INVALID_QUANTITY", "INVALID_RENEWAL_MODE", "CERTIFICATE_DELETED", "SAN_NOT_FOUND", "PAYMENT_PROVIDER_ERROR", "DYN_DNS_NOT_FQDN", "TLD_NOT_FOUND", "PRODUCT_ID_REQUIRED", "DNS_ZONE_ALREADY_UNSIGNED", "EMPTY_DNS_RECORD_DATA", "AUTO_SSL_ORGANISATION_NOT_FOUND", "EMAIL_VALIDATION_NOT_FOUND", "NOT_ENOUGH_AVAILABLE_SLOTS", "UNSIGN_DOMAIN_FAILED", "E_INVOICE_NOT_REPUBLISHABLE", "INVALID_COMMON_NAME_INCLUDE_INVALID_CHARACTERS", "ORDERLINE_ID_REQUIRED", "INVALID_TLD_BASE_COST_CURRENCY_ID", "PHONE_VALIDATION_VOICE_NOT_ALLOWED", "NS_PROFILE_DELETION_FAILED", "EMAIL_VALIDATION_ALREADY_VALID", "PHONE_VALIDATION_CODE_SENT_RECENTLY", "INVALID_PAYMENT_OPERATION_HASH", "INVALID_ORGANISATION_VALIDATION_STATUS", "INVALID_ORDER_AUTO_SSL_OPERATION_TYPE", "TRANSFER_OUT_MISSING_PARAMETER", "MAX_COUNT_EXCEEDED", "ACTIVE_GOOD_FOUND", "INVALID_NS_PROFILE", "CONFLICTING_GOOD_OPERATIONS", "SSL_PROVIDER_REQUIRED", "MOVE_TO_FOLDER_FAILED", "E_INVOICE_NOT_CANCELLABLE", "INVALID_DV_EMAIL", "CONTACT_VALIDATION_EXPIRED", "ACCOUNT_REQUIRED", "NO_OPEN_CHECKOUT_FOUND", "DNS_ZONE_LOCKED_RECORD", "INVALID_DNSSEC_STATUS", "INVALID_PARAMETERS", "DNS_ZONE_PENDING_DNSSEC_ACTION", "DOMAIN_INTERNAL_TRANSFER_CREATION_FAILED", "ORDER_STATUS_REQUIRED", "FORBIDDEN_ACTION", "INVOICE_NUMBER_GENERATION_FAILED", "CIP_ASSOCIATION_NOT_FOUND", "OX_PRODUCT_REQUIRED", "ORDER_REQUIRED", "NO_AUTO_SSL_DOMAINS", "EMAIL_VALIDATION_RESENT_RECENTLY", "REFUND_TRANSACTION_CREATION_FAILED", "DNS_ZONE_ALREADY_SIGNED", "INVALID_ORDERGOOD_STATUS", "NOT_PAYABLE_INVOICE_STATUS", "ACCOUNT_ALREADY_DEACTIVATED", "INSUFFICIENT_FUNDS", "PAYMENT_TRANSACTION_NOT_FOUND", "E_INVOICING_DOCUMENT_ID_REQUIRED", "PREMIUM_DNS_INVALID_QUANTITY", "DEFAULT_CIP_REQUIRED", "LOGIN_NOT_FOUND", "PDF_GENERATION_FAILED", "INVALID_ORDER_DOMAIN_TYPE", "ORDER_AUTO_SSL_OPERATION_ALREADY_CANCELLED", "TRANSFER_OUT_STEP_FAILED", "TOKEN_NOT_EXISTS", "USER_URL_FORWARD_IP_NOT_FOUND", "APPROVER_REQUIRED", "WRONG_ORDERGOOD_TYPE", "ALIAS_NOT_FOUND", "CIP_ID_REQUIRED", "DOMAIN_CONNECT_USER_FORBIDDEN", "DYN_DNS_NO_HOSTNAMES", "INVALID_TOKEN", "SHARED_HOSTING_MULTIPLE_DOMAINS_NOT_ALLOWED", "AUTO_SSL_SUB_PRODUCT_CONFIGURATION_REQUIRED", "COUNTRY_PROXY_ERROR", "ORDER_STATUS_ERROR", "RENEW_PRODUCT_NOT_FOUND" ]
},
"ReissueSslSubscription" : {
"required" : [ "encodedCsr" ],
"type" : "object",
"properties" : {
"encodedCsr" : {
"type" : "string",
"description" : "The encoded CSR containing the new data to be used during the certificate reissue.
Any Subject Alternative Name (SAN) present in the encoded CSR will be ignored during the provisioning.
To provision SANs for multi-domain products, provide them in the 'sanEntries' field."
},
"sanEntries" : {
"type" : "array",
"description" : "The list of SAN entries to be used during the certificate reissue.
It is only required for multi-domain certificate products and must include the encoded CSR common name.
The quantity of allowed host names depends on your original certificate order.",
"items" : {
"type" : "string"
}
}
},
"description" : "The data required to reissue an SSL certificate."
},
"OrderSslAction" : {
"type" : "string",
"description" : "The SSL certificate action.",
"example" : "ISSUE",
"enum" : [ "ISSUE", "REISSUE", "AUTO_REISSUE", "RENEW", "TRANSFER" ]
}
},
"securitySchemes" : {
"X-APP-ID" : {
"type" : "apiKey",
"description" : "Your application Id provided by Namespace",
"name" : "X-APP-ID",
"in" : "header"
},
"X-API-KEY" : {
"type" : "apiKey",
"description" : "Your API Key provided by Namespace",
"name" : "X-API-KEY",
"in" : "header"
}
}
}
}