Description: Add a custom AMI Image.
Security: Requires admin credentials
Usage: POST api/v1/buildPlaneImages
Produces: application/json
Request Parameters:
Parameter | Data Type | Description |
|---|---|---|
| String | Name of the build plane image. |
| String | The Id of the master integration. For AWS type, masterIntegrationId is 46. |
| String | The Id of thecustom AMI you created. |
| String | The AWS region. |
| Boolean | Set as |
| String | x86_64, which is the architecture Pipelines supports. |
| String | The operating systems supported for the selected architecture. For a list of supported OS and architecture combinations, refer to Runtime Images. |
| Object | Object containing configuration for AWS. |
Sample Response:
Response - Shortened for brevity
{
"metadataPropertyBag": {
"projectName": "pipelines-cloud-stg",
"imageName": "us-west1-image-for-x86-64-ubuntu18-1619591031886"
},
"id": 10,
"name": "us-west1 image for x86_64 Ubuntu_18.04",
"masterIntegrationId": 76,
"imageId": "6019675003889729941",
"region": "us-west1",
"isAvailable": true,
"architecture": "x86_64",
"operatingSystem": "Ubuntu_18.04",
"isInternal": false,
"createdAt": "2021-04-28T00:00:00.000Z",
"updatedAt": "2021-04-28T00:00:00.000Z"
}