Create profile

POST https://caas.digicert.com/automationws/v1/profile/createProfile

Use this endpoint to create an automation profile for certificate deployment.

This endpoint supports:

Configuring an automation profile for an ACME automation agent (agent-based automation).
Configuring a sensor profile to automate certificate requests on load balancers (agentless automation).

For more information, see Automation profiles.

Example 1. cURL

curl --location --request POST 'https://caas.digicert.com/automationws/v1/profile/createProfile' \
--header 'X-DC-DEVKEY: {{api_key}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "testprofile",
    "productType": "SSL_EV_SECURESITE",
    "validityPeriod": "1Y",
    "signatureHash": "sha256",
    "ctLogOption": false,
    "organizationId": 635082,
    "organizationName": "Win the Customer, LLC",
    "keySizeAndAlgorithm": "RSA 2048",
    "emailAddresses": "cc.admin@cert-testing.com",
    "divisionId": 69748,
    "isDefault": false,
    "profileType": "SENSOR",
    "accountId": "126993",
    "productName": "Secure Site EV SSL",
    "contacts": [
        {
            "contactId": 512773,
            "contactType": "org_contact"
        }
    ],
    "autoRenewSettings": {
        "daysBeforeExpiry": 30,
        "isAutoReplace": false
    }
}'

Request parameters

Name	Req/Opt	Type	Description
name	required	string	Name of the automation profile.
productType	required	string	Type of the product. Allowed values: See Glossary – Product identifiers.
validityPeriod	required	string	Certificate validity. Allowed values: `1D`, `1Y` Ends with `D` – Day or `Y` - Year. Example: `1Y` Max value: 397 days
signatureHash	optional	string	Hash type ID for the algorithm used to sign the certificate. Allowed values: See Glossary – Hash types.
ctLogOption	optional	boolean	Use this option to enable CT logging for issued SSL certificates.
organizationId	optional	integer	The ID of an existing organization to associate with the profile. To get the ID of organizations in your account, use the endpoint List organizations.
organizationName	required	string	The name of the organization.
keySizeAndAlgorithm	optional	string	The key size and algorithm used to sign the certificate. Allowed values: `RSA 2048`, `RSA 4096`, `RSA 8192`, `ECC P256`, `ECC P384`
emailAddresses	optional	string	Email address for the contact associated with the automation profile.
divisionId	required	integer	Division ID.
isDefault	optional	boolean	If `true`, sets the profile to be the default.
profileType	optional	string	Type of profile. Allowed values: `ACME` or `SENSOR`
accountId	required	string	Account ID.
productName	optional	string	Name of the product. Allowed values: See Glossary – Product identifiers.
contacts	optional	array	Object container for automation profile contacts.
.. contactId	optional	integer	ID of existing user or contact for the account. This can be omitted if you are adding a new contact. To get the IDs for users in your account, use the endpoint User info.
.. contactType	optional	string	Type of contact to add to the profile. Allowed values: `org_contact`, `technical_contact`, `ev_approver`
.. contactName	optional	string	Name of the contact.
autoRenewSettings	optional	object	Object with auto-renew settings.
.. daysBeforeExpiry	optional	integer	Number of days before expiration to renew the certificate. Min: 1 day Max: Less than the certificate validity.
.. isAutoReplace	optional	boolean	For a revoked or missing certificate, `true` requests and installs the certificate. Default: `false`
canSignHttpExchangesExtension	optional	boolean	This parameter is used to issue certificates with "canSignHttpExchanges" extension. Note that this certificate profile option must be enabled for your account in order to use it for other certificates. For more information, See Get your Signed HTTP Exchanges certificate.
customFields	optional^*	array	Account-specific custom fields. ^*Whether or not these fields are required depends on your custom field settings.
.. id	optional	integer	Custom field ID.
.. value	optional	object	Value of the custom field.
caCertId	optional^*	string	ID of the CA certificate that should sign the certificate. ^Required if multiple CA certificates are configured. Note:* If not specified, the default CA certificate is used.
caCertName	optional	string	Name of the CA certificate that should sign the certificate.

Response parameters

Name	Type	Description
error	object	Object with error details.
data	object	Object with response data.
.. message	string	Message with details about successful creation.
.. id	integer	Identification number for the profile.

In this section:

Create profile

Request parameters

Response parameters

Search results