---
title: "Create bulk automation"
source_url: https://dev.digicert.com/certcentral-apis/automation-api/create-bulk-automation.html
api_method: POST
api_endpoint: "/automationws/v1/automation/createAutomation/bulk"
api_url: "https://caas.digicert.com/automationws/v1/automation/createAutomation/bulk"
---

**POST** `https://caas.digicert.com/automationws/v1/automation/createAutomation/bulk`

Use this endpoint to set up certificate automation for multiple hosts.

This endpoint supports:

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


> **Info**
>
> Please note that the maximum batch size supported for automation per cycle is 500.


## Example requests and responses

## cURL

```bash
curl --location --request POST 'https://caas.digicert.com/automationws/v1/automation/createAutomation/bulk' \
--header 'X-DC-DEVKEY: {{api_key}}' \
--header 'Content-Type: application/json' \
--data-raw '{
  "accountId": 5153184,
  "divisionId":677793,
  "additionalEmails": "cc.admin@cert-testing.com",  
  "sensorProfileName":"9thJuly",
  "acmeProfileName":"22jul2020 01",
  "automationActionType": "RENEW",
  "installSettings": {
    "installationType": "AUTO_INSTALL_AFTER_APPROVAL",
    "isAlwaysOn": false
  },
  "ipPortsToAutomate": [
    {
      "domainName": "SNIParent.winthecustomer.com",
      "ip": "10.100.196.228",
      "port": 900,
      "managementIp": "10.100.192.227",
      "virtualServerName": "/partition1/per18"
    },
    {
      "domainName": "SNIChild.cert-testing.com",
      "ip": "10.100.196.228",
      "port": 80,
      "managementIp": "10.100.192.227",
      "virtualServerName": "/partition1/per20"
    }
  ]
}'
```

**200 OK**

```json
{
  "error": null,
  "data": {
    "message": "Successfully initiated RENEW for 2 IP/Port(s), progress will be updated against individual IP/Ports",
    "ineligibleIpPorts": [],
    "errors": [],
    "status": {}
  }
}
```

**200 OK (errorCode = 1004)**

```json
{
    "error": null,
    "data": {
        "errors": [
            {
                "errorCode": "1004",
                "errorField": "installationType",
                "errorMessage": "No installationType specified for automation"
            }
        ],
        "status": {}
    }
}
```


## Request parameters

<table class="params-table">
<thead>
<tr>
<th>Name</th>
<th>Req/Opt</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>accountId</td>
<td>required</td>
<td>string</td>
<td>Account ID.</td>
</tr>
<tr>
<td>divisionId</td>
<td>required</td>
<td>integer</td>
<td>Division ID.</td>
</tr>
<tr>
<td>additionalEmails</td>
<td>optional</td>
<td>string</td>
<td>Additional email IDs to send certificate lifecycle notifications. This is a comma separated list.</td>
</tr>
<tr>
<td>sensorProfileName</td>
<td>optional<sup>*</sup></td>
<td>string</td>
<td>Name of the sensor-based (agentless) automation profile.<br>*Required when there is no matching profile (default or associated) for the selected IP/Ports.</td>
</tr>
<tr>
<td>acmeProfileName</td>
<td>optional*</td>
<td>string</td>
<td>Name of the ACME agent automation profile.<br>*Required when there is no matching profile (default or associated) for the selected IP/Ports.</td>
</tr>
<tr>
<td>automationActionType</td>
<td>optional</td>
<td>integer</td>
<td>Certificate automation type.<br>Default: <code>ENROLL</code><br>Allowed values:<br><ul><li>ENROLL – Order and install a new certificate.</li><li>RENEW – Renew an existing DigiCert certificate that is about to expire.</li><li>TRANSFER – Migrate to a DigiCert certificate from another certificate authority.</li></ul></td>
</tr>
<tr>
<td>installSettings</td>
<td>required</td>
<td>object</td>
<td>Object with installation settings.</td>
</tr>
<tr>
<td>.. installationType</td>
<td>required</td>
<td>string</td>
<td>Certificate installation type. Certificate installation can either be on-demand or scheduled for a specific time.<br><ul><li>AUTO_INSTALL_AFTER_APPROVAL: Install the certificate immediately after approval (on demand).</li><li>SCHEDULED_INSTALL: Schedule the certificate installation for a later date/time.</li></ul></td>
</tr>
<tr>
<td>.. .. scheduleTime</td>
<td>optional<sup>*</sup></td>
<td>integer</td>
<td>Time when automation starts.<br>Format: epoch in milliseconds.<br>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.<br>Example: 1598299200000<br>*Required if you choose installationType as SCHEDULED_INSTALL.</td>
</tr>
<tr>
<td>.. .. scheduleTimeZone</td>
<td>optional<sup>*</sup></td>
<td>string</td>
<td>Time zone for the automation.<br>Format:  GMT + your timezone offset.<br>Example: 
 -8#pacifictime<br>*Required if you choose installationType as SCHEDULED_INSTALL.</td>
</tr>
<tr>
<td>ipPortsToAutomate</td>
<td>required</td>
<td>array</td>
<td>A list of objects with information about the IP addresses and ports to configure automation for. Each object includes the key/value pairs listed below.</td>
</tr>
<tr>
<td>.. domainName</td>
<td>optional<sup>*</sup></td>
<td>string</td>
<td>The domain name that you want to configure automation for.<br><sup>*</sup>Required only for SNI (having multiple profiles or certificates on same IP/Port) automation.</td>
</tr>
<tr>
<td>.. ip</td>
<td>required</td>
<td>string</td>
<td>The IP address that you want to configure automation for.</td>
</tr>
<tr>
<td>.. port</td>
<td>required</td>
<td>integer</td>
<td>The port that you want to configure automation for.</td>
</tr>
<tr>
<td>.. managementIp</td>
<td>optional<sup>*</sup></td>
<td>string</td>
<td>Management IP.<br>*Required for agentless automation flow.<br>For more information, see Sensor automation on F5 load balancer.</td>
</tr>
<tr>
<td>.. virtualServerName</td>
<td>optional<sup>*</sup></td>
<td>string</td>
<td>Name of the virtual server to automate.<br><sup>*</sup>Required for agentless automation flow.<br><strong>Note:</strong> This parameter is not required for AWS load balancer.</td>
</tr>
</tbody>
</table>

## Response parameters

<table class="params-table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>error</td>
<td>object</td>
<td>Object with error details.</td>
</tr>
<tr>
<td>data</td>
<td>object</td>
<td>Object with response data.</td>
</tr>
<tr>
<td>..message</td>
<td>string</td>
<td>Message with details about successful creation.</td>
</tr>
<tr>
<td>.. selectedIpPorts</td>
<td>array</td>
<td>List with automation details for the selected IP addresses and ports .</td>
</tr>
<tr>
<td>.. ineligibleIpPorts</td>
<td>array</td>
<td>List of IP addresses and ports from the selectedIpPorts list that are ineligible for automation.</td>
</tr>
<tr>
<td>.. errors</td>
<td>array</td>
<td>List of errors, if any.</td>
</tr>
<tr>
<td>.. errorCode</td>
<td>string</td>
<td>Error code.</td>
</tr>
<tr>
<td>.. errorField</td>
<td>string</td>
<td>The field that is missing.</td>
</tr>
<tr>
<td>.. errorMessage</td>
<td>string</td>
<td>Error message if request failed.</td>
</tr>
</tbody>
</table>