show-gaia-claimed-gateway-status

Description

Retrieve a claimed Gaia Gateway's status with its MAC address.

Request URL

POST

https://zerotouch.checkpoint.com/ZeroTouch/web_api/v2/show-gaia-claimed-gateway-status

Request Headers

Parameter Name

Type

Description

Content-Type

application/json

Send JSON object to use the API Web Services

X-chkp-sid

string token

Session unique identifier as the response to the login request

Request Body

Parameter Name

Status

Type

Description

mac

Mandatory

string

Unique Media Access Control address for the Security Gateway

account-id

Mandatory

int

The User Center account to which Security Gateways and templates belong

Response

On Success, HTTP Return code: 200

Parameter Name

Type

Description

mac

string

Unique Media Access Control address for the Security Gateway

reported-status-time

int

Timestamp when the Security Gateway last reported its status

The value is the number of milliseconds that have elapsed since 00:00:00, 1 January 1970

reported-display-status

string

Possible values:

Not reported, Installing, Finished, Rebooting, Failed, Error, Fetched

On Failure, HTTP Return code: 400, 401, 500

Parameter Name

Type

Description

message

string

Operation status

messages

List: string

List of validation errors

code

string

Error code

Request Example

{
"mac": "xx:xx:xx:8B:C8:0A",
"account-id": 7899567
}

Response Example

{
"mac": "xx:xx:xx:8B:C8:0A",
"reported-status-time": null,
"reported-display-status": "Not reported"
}