Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
 

POST /staged_config/deploy_status

Executes a deploy.

Executes a deploy.

Table 1: POST /staged_config/deploy_status Resource Details

MIME Type

application/json

Table 2: POST /staged_config/deploy_status Request Body Details

Parameter

Data Type

MIME Type

Description

Sample

deploy_status

Object

application/json

null

{ "hosts": [ { "host_status": "String <one of: SUCCESS, INITIATING, IN_PROGRESS, TIMED_OUT, ERROR>", "ip": "String", "status": "String <one of: SUCCESS, INITIATING, IN_PROGRESS, TIMED_OUT, ERROR>" } ], "initiated_by": "String", "initiated_from": "String", "percent_complete": 42, "status": "String <one of: INITIALIZING, IN_PROGRESS, COMPLETE>", "type": "String <one of: INCREMENTAL, FULL>" }

Table 3: POST /staged_config/deploy_status Response Codes

HTTP Response Code

Unique Code

Description

200

 

The deploy was scheduled.

409

1002

Theere already exists a deploy in action, or there are no changes to deploy.

409

1003

null

409

1004

null

422

1005

null

500

1020

An error occurred during the attempt to run the deploy

Response Description

The deploy status object. A deploy status object contains the following fields:

  • initiated_by - String - The name of the user who initiated the deploy.

  • initiated_from - String - The hostname from where the deploy was initiated.

  • type - String - The type of deploy: FULL or INCREMENTAL.

  • status - String - The status of the deploy: UNKNOWN, START, DONE.

  • hosts - Map of < String, List of String > - A map of status states and a list of hosts.

  • error_message - String - The deployment error message.

  • has_errors - Boolean - True if the deploy has encountered an error.

  • percent_complete - Integer - The percentage of completion of the deploy. ( 0 - 100 )

Response Sample