POST /v1/uploadDockerImage - BlueCat Integrity - 9.5.0

Address Manager Legacy v1 API Guide

Locale
English
Product name
BlueCat Integrity
Version
9.5.0

Description

Uploads a Docker image file to a BlueCat DNS/DHCP Server for configuration of the Gateway service via the configureServerServices method. After successful upload, use the value returned by this method for the Gateway container image field of the configureServerServices JSON body when enabling the Gateway service.

Parameters

Name Description
data

Location: formData

Type: file

The Docker image file to be uploaded. The file is passed to Address Manager as an octet-stream.
Note: The Docker image file must be packaged in tar or tar.gz format.
Note: The SOAP implementation of this method has a 2GB limit for the file size. The REST implementation has no file size limit, but users are advised to check that the Address Manager and DNS/DHCP Servers have sufficient resources and partition sizes to handle larger images, to avoid timeouts and errors.
filename

Location: query

Type: string

The name of the file to be uploaded (including extension).
serverId

Location: query

Type: integer (int64)

The object ID of the BlueCat DNS/DHCP Server.

Responses

Code Description
201

Type: none

Returns the image name of the Docker image file. After successful upload, use this value for the Gateway container image field of the configureServerServices JSON body when enabling the Gateway service.