Need help? Call Live Support at +31 (0) 38 453 07 59

Attention! You're currently using the OT&E environment.

Create ACME Subscription

Used to create an ACME subscription

  • POSTMethod
  • /v2/ssl/acmeURL
  • application/jsonContent-Type
Request parameters
Name Type Required / Optional Description Restrictions
quote Boolean Optional If true, validate the request and request a quote for the action
Request content fields
Name Type Required / Optional Description Restrictions
customer String Required The customer handle
  • Regular expression: [a-zA-Z0-9\-_@\.]+
  • Minimum length: 3
  • Maximum length: 40
product String Required The product defines the type of certificate to create
domainNames List <String> Optional List of Domain Names
  • Regular expression: (?:\*\.)?(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)+(?:[a-z][a-z0-9-]{0,61}[a-z0-9])
  • Minimum length: 4
  • Maximum length: 255
organization String Optional The organization, see requiredFields/optionalFields in ssl product metadata for supported usage
  • Minimum length: 1
  • Maximum length: 64
country String Optional The country, see requiredFields/optionalFields in ssl product metadata for supported usage
  • Minimum length: 2
  • Maximum length: 2
state String Optional The state, see requiredFields/optionalFields in ssl product metadata for supported usage
  • Minimum length: 1
  • Maximum length: 60
address String Optional The address, see requiredFields/optionalFields in ssl product metadata for supported usage
  • Minimum length: 1
  • Maximum length: 60
postalCode String Optional The postal code, see requiredFields/optionalFields in ssl product metadata for supported usage
  • Minimum length: 1
  • Maximum length: 10
city String Optional The city, see requiredFields/optionalFields in ssl product metadata for supported usage
  • Minimum length: 1
  • Maximum length: 60
autoRenew Boolean Optional Automatically renew subscription
period Integer Required The validity period of the subscription
certValidity Integer Optional Certificate validity in days, only allowed for DigiCert products
  • Maximum value: 200
  • Minimum value: 47
approver approver Optional Approver of the ACME subscription, see requiredFields/optionalFields in ssl product metadata for usage.
approver
Name Type Required / Optional Description Restrictions
firstName String Required First name of the approver
  • Minimum length: 1
  • Maximum length: 40
lastName String Required Last name of the approver
  • Minimum length: 1
  • Maximum length: 40
jobTitle String Optional Job title of the approver
  • Minimum length: 1
  • Maximum length: 40
email String Required Email address of the approver
  • Regular expression: (?=.{1,64}@)[a-z0-9_\-+]+(?:\.[a-z0-9_\-+]+)*@(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)+(?:[a-z][a-z0-9-]{0,61}[a-z0-9])
  • Minimum length: 6
  • Maximum length: 255
voice String Required The voice telephone number of the approver
  • Regular expression: \+[0-9]{1,3}\.[0-9]{1,14}
  • Minimum length: 4
  • Maximum length: 17

Successful request

ACME subscription has been created
  • 201 CreatedHTTP Status
  • application/jsonContent-Type
Response fields
Name Type Required / Optional Description
id Integer Required
directoryUrl String Required The ACME directory URL
accountKey String Required Key identifier for the external account binding. Securely store this credential, it is only returned in this call.
hmacKey String Required HMAC key for the external account binding. Securely store this credential, it is only returned in this call.

Failed requests

Generic errors can be expected.

Request parameters
If true, validate the request and request a quote for the action
Request parameters
The customer handle
The product defines the type of certificate to create
List of Domain Names
The organization, see requiredFields/optionalFields in ssl product metadata for supported usage
The country, see requiredFields/optionalFields in ssl product metadata for supported usage
The state, see requiredFields/optionalFields in ssl product metadata for supported usage
The address, see requiredFields/optionalFields in ssl product metadata for supported usage
The postal code, see requiredFields/optionalFields in ssl product metadata for supported usage
The city, see requiredFields/optionalFields in ssl product metadata for supported usage
Automatically renew subscription
The validity period of the subscription
Certificate validity in days, only allowed for DigiCert products
approver
First name of the approver
Last name of the approver
Job title of the approver
Email address of the approver
The voice telephone number of the approver
Request

POST /v2/ssl/acme
Content-Type: application/json 

{}
Response