Get profile details

accountId

required

string

Account ID.

divisionId

required

string

Division ID.

profileId

required

string

Automation profile ID.

error

object

Object with error details, if any.

data

object

Object with response data.

.. profileId

object

Automation profile ID.

.. accountId

string

Account ID.

.. divisionId

integer

Division ID.

.. profileName

object

Name of the automation profile.

.. profileState

string

Status of the automation profile.

Allowed values: ACTIVE, ACTION_NEEDED.

.. productType

string

Type of the product.

Allowed values: See Glossary – Product identifiers

.. availableDomains

array

Domains available for automation.

.. validity

string

Certificate validity.

Allowed values: 1D,1Y. Ends with D – Day or Y - Year.

Example: 1Y

Max value: 397 days

orderCoverageLength

string

Selected order coverage plan.

Possible values: 1Y, 2Y.

Note: For accounts with Multi-year plans enabled, allowed values range from 1Y-3Y.

.. signatureHash

string

Hash type ID for the algorithm used to sign the certificate.

Allowed values: See Glossary – Hash types.

.. keySizeAndAlgorithm

string

The key size and algorithm used to sign the certificate.

Allowed values: RSA 2048, RSA 4096, RSA 8192, ECC P256, ECC P384

.. ctLogOption

boolean

Use this option to enable CT logging for issued SSL certificates.

.. isDefault

boolean

If true, sets the profile to be the default.

.. createdDate

integer

Date and time when the profile was created.

Format: epoch in milliseconds.

Example: 1598299200000

.. updatedDate

integer

Date and time when the profile was updated.

.. organizationId

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

string

The name of the organization.

.. caCertId

string

ID of the CA certificate that should sign the certificate.

Note: If not specified, the default CA certificate is used.

.. caCertName

string

Name of the CA certificate that should sign the certificate.

.. contacts

array

Object container for automation profile contacts.

.. .. contactId

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

string

Type of contact to add to the profile.

Allowed values: org_contact, technical_contact, ev_approver

.. .. contactName

string

Name of the contact.

.. reason

array

Reason specified if the profile is in ACTION_NEEDED state.

.. profileType

string

Type of profile.

Allowed values: ACME or SENSOR

.. canSignHttpExchangesExtension

boolean

This parameter is used to issue certificates with "canSignHttpExchanges" extension. For more information, See Get your Signed HTTP Exchanges certificate.

.. customFields

array

Account-specific custom fields. Whether or not these fields are required depends on your custom field settings.

.. emailAddresses

string

Email address associated with the profile.

.. autoRenewSettings

object

Object with auto-renew settings.

.. .. daysBeforeExpiry

integer

Number of days before expiration to renew the certificate.

Min: 1 day

Max: Less than the certificate validity.

.. .. scheduleTime

integer

Time when auto-renew starts.

Format: epoch in milliseconds.

An epoch corresponds to 0 hours, 0 minutes, and 0 seconds (00:00:00) Coordinated Universal Time (UTC) on a specific date, which varies from system to system.

Example: 1598299200000

.. .. scheduleTimeZone

string

Time zone for the auto-renew.

Format: GMT + your timezone offset.

Example: -8#pacifictime

.. .. isAutoReplace

boolean

For a revoked or missing certificate, true requests and installs the certificate on the host.

Default: false

.. forceAutoRenewSetting

boolean

If true, auto-renew settings are enabled.

Default: false