Checking Landing Zone Updates

Function

This API is used to check whether the landing zone needs to be updated.

URI

GET https://{endpoint}/v1/landing-zone/available-updates

Request Parameters

None

Response Parameters

Status code: 200

**Table 1** Response body parameters
Parameter	Type	Description
baseline_update_available	Boolean	Whether the current landing zone version is the latest.
control_update_available	Boolean	Controls if a new governance policy is enabled for the current account.
landing_zone_update_available	Boolean	Whether the landing zone can be updated.
service_landing_zone_version	String	Latest version of the landing zone.
user_landing_zone_version	String	Current version of the landing zone.

Status code: 403

**Table 2** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
request_id	String	Unique ID of the request.
encoded_authorization_message	String	Encrypted error message.
details	Array of ForbiddenErrorDetail objects	Error message indicating no permissions for cross-service invoking.

**Table 3** ForbiddenErrorDetail
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Requests

Checking whether the landing zone needs to be updated

GET https://{endpoint}/v1/landing-zone/available-updates

Example Responses

Status code: 200

Request succeeded.

{
  "baseline_update_available" : true,
  "control_update_available" : true,
  "landing_zone_update_available" : true,
  "service_landing_zone_version" : "string",
  "user_landing_zone_version" : "string"
}