Optimized Preparation Server API

API calls to publish and verify the publication status of environment preparation servers.

Optimized Publication

Optimized publication offers more control over the imaging process of the preparation server.

Publish image in an optimized way

POST /environments/{amb_uuid}/servers/template/optimized-publish/

Path parameters

Parameters	Required	Description
amb_uuid	Yes	Environment UUID

Request Body

Field	Type	Description
stop_server	boolean	Whether the staging server should be stopped during image creation.
notify_list	array	List of emails to be notified when publication ends.
replace_instances	object	Publication settings.
replace_instances.block_instances	boolean	Whether instances with previous versions should be blocked after publication.
replace_instances.block_users	boolean	Whether to request use block_instances: true)
replace_instances.block_users_message	string	Reconnection warning message (when block_users: true)
replace_instances.block_users_seconds	number	Disconnection time in seconds (when block_users: true)

Accepted Values for block_users_seconds

Value	Equivalent
300	5 minutes
600	10 minutes
900	15 minutes
1200	20 minutes
1500	25 minutes
1800	30 minutes

Publication Modes

Mode 1 - Default

Updated instances are started, previous instances are not blocked, and users are not disconnected.

{
    "stop_server": false,
    "notify_list": ["[e-mail]"],
    "replace_instances": {
        "block_instances": false,
        "block_users": false
    }
}

Mode 2 - Keep Users Connected

Updated instances are started, previous instances are blocked, but users are not disconnected.

{
    "stop_server": false,
    "notify_list": ["[e-mail]"],
    "replace_instances": {
        "block_instances": true,
        "block_users": false
    }
}

Mode 3 - Request User Reconnection

Previous instances are blocked and users are notified to reconnect.

Important: It is not possible to send block_users: true with block_instances: false.

{
    "stop_server": false,
    "notify_list": ["[e-mail]"],
    "replace_instances": {
        "block_instances": true,
        "block_users": true,
        "block_users_message": "Warning message to users",
        "block_users_seconds": 300
    }
}

Option: Stop server during creation

Any mode above accepts stop_server: true to make the staging server unavailable during image creation.

{
    "stop_server": true,
    "notify_list": ["[e-mail]"],
    "replace_instances": {
        "block_instances": false,
        "block_users": false
    }
}

Response

Status: 202 Accepted

{
    "status": 202,
    "message": "Publication successfully initiated.",
    "request_id": "149cbd70-5241-4e62-88a7-c87bcdf2eecc"
}

Verify optimized publication status

Verifies the image publication status for the specified request.

GET /environments/{amb_uuid}/servers/template/optimized-publish/{request_id}/

Path parameters

Parameters	Required	Description
amb_uuid	Yes	Environment UUID
request_id	Yes	Publication request UUID

Response

Status: 200 OK

{
    "status": 200,
    "image_publication_status": "PUBLISHING",
    "message": "Publication in progress."
}

Possible Values for image_publication_status

Value	Description
PUBLISHING	Publication in progress
PUBLISHED	Publication completed
ERROR	Publication error