Zero Touch API Commands for Gaia Gateways

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

Parameter Name

Value

Description

gaia-version-description

string

Description of Gaia version

gaia-version-id

int

ID number of Gaia version from: show-all-gaia-versions-ids

message

string

Operation status

messages

List: string

List of validation errors

code

string

Error code

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

name

Required

string

The new template's name

account-id

Required

int

The User Center account to which gateways and templates belong

admin-password

Required

string

Administrator password for the gateway

The admin-password is returned as “******” in the JSON response

ftw-sic-key

Required

string

Creating a Secure Internal Communication (SIC) activation key

identification-key

Required

string

This is configured on the gateway as a unique identifier to be recognized unambiguously by Zero Touch

The string for the key is set at the gateway's command line interface:

set cloud-config identification-key <key_string>

If there are repeated invalid entries of identification-key in API requests, the gateway will lock and the parameter is-locked will be set to true

Set is-locked to false to unlock the gateway and re-try the identification-key

gaia-version-id

Required

int

ID number of Gaia version from: show-all-gaia-versions-ids

force-reimage

Required

boolean

If true, this forces a re-image of the machine even if the selected Gaia image version is already installed

cluster-member

Required

boolean

If true, the gateway is a member of a cluster

under-construction

Required

boolean

A true value prevents downloads to the gateway until the final configuration and deployment decisions are complete

Default value: false

config-ipv6

Required

boolean

Must be true to set ipv6 configuration

upload-info

Required

boolean

If true, improves product experience by sending data to Check Point

download-info

Required

boolean

If true, automatically downloads Blade Contracts and other important data (highly recommended)

time-zone

Required

string

Time zone for the gateway

template-id

int

The template's unique identifier

comments

string

General comments

user-script

string

CLI commands execute on the gateway immediately after all other settings are applied

In multiline CLISH scripts, use end line ("\n") at the end of each command line

"user-script": "set static-route 192.0.2.100 nexthop gateway address 192.0.2.155 on\nset static-route 192.0.3.0/24 nexthop blackhole\n"

Before executing the script, the gateway locks the database automatically

No need to add the "lock database override" command to the script

dns-server1

string

The primary DNS server

dns-server2

string

The secondary DNS server

dns-server3

string

The tertiary DNS server

ntp1

string

Network Time Protocol for clock synchronization between computer systems

ntp.checkpoint.com is recommended

ntp2

string

Network Time Protocol for clock synchronization between computer systems

ntp2.checkpoint.com is recommended

creating-user

string

The user who created the template

last-modifying-user

string

The user who last modified the template

mgmt-eth-ip-address-ipv6

string

Enter this IP address if config-ipv6 is true

mgmt-eth-ip-address-ipv4

string

IPv4 address

mgmt-eth-subnet-mask-ipv4

string

IPv4's subnet mask

mgmt-eth-mask-length-ipv6

int

Enter the mask length value if config-ipv6 is true

default-gateway-ipv6

string

Enter the default gateway if config-ipv6 is true

ntp1-version

string

Most recent version of Check Point's NTP servers is the string value "4"

ntp2-version

string

Most recent version of Check Point's NTP servers is the string value "4"

default-gateway-ipv4

string

IPv4's default gateway

proxy-server

string

IP address of the proxy server

proxy-port

int

Proxy port number for client connections (8080 by default)

creation-time

object

Timestamps for creating a template

last-modify-time

object

Timestamps for last modifying a template

account-id

int

The User Center account to which gateways and templates belong

template-id

int

The template's unique identifier

mgmt-eth-subnet-mask-ipv4

string

IPv4's subnet mask

config-ipv6

boolean

Must be true to set ipv6 configuration

mgmt-eth-mask-length-ipv6

int

Enter the mask length value if config-ipv6 is true

default-gateway-ipv6

string

Enter the default gateway if config-ipv6 is true

under-construction

boolean

A true value prevents downloads to the gateway until the final configuration and deployment decisions are complete

Default value: false

ntp1

string

Network Time Protocol for clock synchronization between computer systems

ntp.checkpoint.com is recommended

ntp1-version

string

Most recent version of Check Point's NTP servers is the string value "4"

ntp2

string

Network Time Protocol for clock synchronization between computer systems

ntp2.checkpoint.com is recommended

ntp2-version

string

Most recent version of Check Point's NTP servers is the string value "4"

default-gateway-ipv4

string

IPv4's default gateway

proxy-server

string

IP address of the proxy server

proxy-port

int

Proxy port number for client connections (8080 by default)

gaia-version-id

int

ID number of Gaia version from: show-all-gaia-versions-ids

force-reimage

boolean

If true, this forces a re-image of the machine even if the selected Gaia image version is already installed

identification-key

string

This is configured on the gateway as a unique identifier to be recognized unambiguously by Zero Touch

The string for the key is set at the gateway's command line interface:

set cloud-config identification-key <key_string>

If there are repeated invalid entries of identification-key in API requests, the gateway will lock and the parameter is-locked will be set to true

Set is-locked to false to unlock the gateway and re-try the identification-key

comments

string

General comments

creating-user

string

The user who created the template

last-modifying-user

string

The user who last modified the template

user-script

string

CLI commands execute on the gateway immediately after all other settings are applied

In multiline CLISH scripts, use end line ("\n") at the end of each command line

"user-script": "set static-route 192.0.2.100 nexthop gateway address 192.0.2.155 on\nset static-route 192.0.3.0/24 nexthop blackhole\n"

Before executing the script, the gateway locks the database automatically

No need to add the "lock database override" command to the script

admin-password

string

Administrator password for the gateway

The admin-password is returned as “******” in the JSON response

upload-info

boolean

If true, improves product experience by sending data to Check Point

mgmt-eth-ip-address-ipv4

string

IPv4 address

ftw-sic-key

string

Creating a Secure Internal Communication (SIC) activation key

dns-server1

string

The primary DNS server

dns-server2

string

The secondary DNS server

dns-server3

string

The tertiary DNS server

download-info

boolean

If true, automatically downloads Blade Contracts and other important data (highly recommended)

cluster-member

boolean

If true, the gateway is a member of a cluster

mgmt-eth-ip-address-ipv6

string

Enter this IP address if config-ipv6 is true

time-zone

string

Time zone for the gateway

name

string

The template name

posix

int

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

iso-8601

string

Date and time represented in international ISO 8601 format

posix

int

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

iso-8601

string

Date and time represented in international ISO 8601 format

message

string

Operation status

messages

List: string

List of validation errors

code

string

Error code

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

source-account-id

Required

int

The User Center account to which templates belong

target-account-id

Required

int

The User Center account to which templates should be copied

items-to-clone

Required

List: object

List of templates to be copied

item-id

Required

int

The template's unique identifier

item-new-name

Required

string

Name given to the copied template under target account

source-account-id

int

The User Center account to which templates belong

target-account-id

int

The User Center account to which templates should be copied

items-to-clone

List: object

List of templates to be copied

item-id

int

The template's unique identifier

item-new-name

string

Name given to the copied template under target account

message

string

Operation status for the item

message

string

Operation status

messages

List: string

List of validation errors

code

string

Error code

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

template-id

Required

int

The template's unique identifier

account-id

Required

int

The User Center account to which gateways and templates belong

creation-time

object

Timestamps for creating a template

last-modify-time

object

Timestamps for last modifying a template

account-id

int

The User Center account to which gateways and templates belong

template-id

int

The template's unique identifier

mgmt-eth-subnet-mask-ipv4

string

IPv4's subnet mask

config-ipv6

boolean

Must be true to set ipv6 configuration

mgmt-eth-mask-length-ipv6

int

Enter the mask length value if config-ipv6 is true

default-gateway-ipv6

string

Enter the default gateway if config-ipv6 is true

under-construction

boolean

A true value prevents downloads to the gateway until the final configuration and deployment decisions are complete

Default value: false

ntp1

string

Network Time Protocol for clock synchronization between computer systems

ntp.checkpoint.com is recommended

ntp1-version

string

Most recent version of Check Point's NTP servers is the string value "4"

ntp2

string

Network Time Protocol for clock synchronization between computer systems

ntp2.checkpoint.com is recommended

ntp2-version

string

Most recent version of Check Point's NTP servers is the string value "4"

default-gateway-ipv4

string

IPv4's default gateway

proxy-server

string

IP address of the proxy server

proxy-port

int

Proxy port number for client connections (8080 by default)

gaia-version-id

int

ID number of Gaia version from: show-all-gaia-versions-ids

force-reimage

boolean

If true, this forces a re-image of the machine even if the selected Gaia image version is already installed

identification-key

string

This is configured on the gateway as a unique identifier to be recognized unambiguously by Zero Touch

The string for the key is set at the gateway's command line interface:

set cloud-config identification-key <key_string>

If there are repeated invalid entries of identification-key in API requests, the gateway will lock and the parameter is-locked will be set to true

Set is-locked to false to unlock the gateway and re-try the identification-key

comments

string

General comments

creating-user

string

The user who created the template

last-modifying-user

string

The user who last modified the template

user-script

string

CLI commands execute on the gateway immediately after all other settings are applied

In multiline CLISH scripts, use end line ("\n") at the end of each command line

"user-script": "set static-route 192.0.2.100 nexthop gateway address 192.0.2.155 on\nset static-route 192.0.3.0/24 nexthop blackhole\n"

Before executing the script, the gateway locks the database automatically

No need to add the "lock database override" command to the script

admin-password

string

Administrator password for the gateway

The admin-password is returned as “******” in the JSON response

upload-info

boolean

If true, improves product experience by sending data to Check Point

mgmt-eth-ip-address-ipv4

string

IPv4 address

ftw-sic-key

string

Creating a Secure Internal Communication (SIC) activation key

dns-server1

string

The primary DNS server

dns-server2

string

The secondary DNS server

dns-server3

string

The tertiary DNS server

download-info

boolean

If true, automatically downloads Blade Contracts and other important data (highly recommended)

cluster-member

boolean

If true, the gateway is a member of a cluster

mgmt-eth-ip-address-ipv6

string

Enter this IP address if config-ipv6 is true

time-zone

string

Time zone for the gateway

name

string

The template name

posix

int

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

iso-8601

string

Date and time represented in international ISO 8601 format

posix

int

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

iso-8601

string

Date and time represented in international ISO 8601 format

message

string

Operation status

messages

List: string

List of validation errors

code

string

Error code

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

account-ids

Required

List: int

List of User Center account IDs to which templates belong

creation-time

object

Timestamps for creating a template

last-modify-time

object

Timestamps for last modifying a template

account-id

int

The User Center account to which gateways and templates belong

template-id

int

The template's unique identifier

mgmt-eth-subnet-mask-ipv4

string

IPv4's subnet mask

config-ipv6

boolean

Must be true to set ipv6 configuration

mgmt-eth-mask-length-ipv6

int

Enter the mask length value if config-ipv6 is true

default-gateway-ipv6

string

Enter the default gateway if config-ipv6 is true

under-construction

boolean

A true value prevents downloads to the gateway until the final configuration and deployment decisions are complete

Default value: false

ntp1

string

Network Time Protocol for clock synchronization between computer systems

ntp.checkpoint.com is recommended

ntp1-version

string

Most recent version of Check Point's NTP servers is the string value "4"

ntp2

string

Network Time Protocol for clock synchronization between computer systems

ntp2.checkpoint.com is recommended

ntp2-version

string

Most recent version of Check Point's NTP servers is the string value "4"

default-gateway-ipv4

string

IPv4's default gateway

proxy-server

string

IP address of the proxy server

proxy-port

int

Proxy port number for client connections (8080 by default)

gaia-version-id

int

ID number of Gaia version from: show-all-gaia-versions-ids

force-reimage

boolean

If true, this forces a re-image of the machine even if the selected Gaia image version is already installed

identification-key

string

This is configured on the gateway as a unique identifier to be recognized unambiguously by Zero Touch

The string for the key is set at the gateway's command line interface:

set cloud-config identification-key <key_string>

If there are repeated invalid entries of identification-key in API requests, the gateway will lock and the parameter is-locked will be set to true

Set is-locked to false to unlock the gateway and re-try the identification-key

comments

string

General comments

creating-user

string

The user who created the template

last-modifying-user

string

The user who last modified the template

user-script

string

CLI commands execute on the gateway immediately after all other settings are applied

In multiline CLISH scripts, use end line ("\n") at the end of each command line

"user-script": "set static-route 192.0.2.100 nexthop gateway address 192.0.2.155 on\nset static-route 192.0.3.0/24 nexthop blackhole\n"

Before executing the script, the gateway locks the database automatically

No need to add the "lock database override" command to the script

admin-password

string

Administrator password for the gateway

The admin-password is returned as “******” in the JSON response

upload-info

boolean

If true, improves product experience by sending data to Check Point

mgmt-eth-ip-address-ipv4

string

IPv4 address

ftw-sic-key

string

Creating a Secure Internal Communication (SIC) activation key

dns-server1

string

The primary DNS server

dns-server2

string

The secondary DNS server

dns-server3

string

The tertiary DNS server

download-info

boolean

If true, automatically downloads Blade Contracts and other important data (highly recommended)

cluster-member

boolean

If true, the gateway is a member of a cluster

mgmt-eth-ip-address-ipv6

string

Enter this IP address if config-ipv6 is true

time-zone

string

Time zone for the gateway

name

string

The template name

posix

int

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

iso-8601

string

Date and time represented in international ISO 8601 format

posix

int

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

iso-8601

string

Date and time represented in international ISO 8601 format

message

string

Operation status

messages

List: string

List of validation errors

code

string

Error code

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

account-id

Required

int

The User Center account to which gateways and templates belong

template-id

Required

int

The template's unique identifier

mgmt-eth-subnet-mask-ipv4

string

IPv4's subnet mask

config-ipv6

boolean

Must be true to set ipv6 configuration

mgmt-eth-mask-length-ipv6

int

Enter the mask length value if config-ipv6 is true

default-gateway-ipv6

string

Enter the default gateway if config-ipv6 is true

under-construction

boolean

A true value prevents downloads to the gateway until the final configuration and deployment decisions are complete

Default value: false

ntp1

string

Network Time Protocol for clock synchronization between computer systems

ntp.checkpoint.com is recommended

ntp1-version

string

Most recent version of Check Point's NTP servers is the string value "4"

ntp2

string

Network Time Protocol for clock synchronization between computer systems

ntp2.checkpoint.com is recommended

ntp2-version

string

Most recent version of Check Point's NTP servers is the string value "4"

default-gateway-ipv4

string

IPv4's default gateway

proxy-server

string

IP address of the proxy server

proxy-port

int

Proxy port number for client connections (8080 by default)

gaia-version-id

int

ID number of Gaia version from: show-all-gaia-versions-ids

force-reimage

boolean

If true, this forces a re-image of the machine even if the selected Gaia image version is already installed

identification-key

string

This is configured on the gateway as a unique identifier to be recognized unambiguously by Zero Touch

The string for the key is set at the gateway's command line interface:

set cloud-config identification-key <key_string>

If there are repeated invalid entries of identification-key in API requests, the gateway will lock and the parameter is-locked will be set to true

Set is-locked to false to unlock the gateway and re-try the identification-key

comments

string

General comments

creating-user

string

The user who created the template

last-modifying-user

string

The user who last modified the template

user-script

string

CLI commands execute on the gateway immediately after all other settings are applied

In multiline CLISH scripts, use end line ("\n") at the end of each command line

"user-script": "set static-route 192.0.2.100 nexthop gateway address 192.0.2.155 on\nset static-route 192.0.3.0/24 nexthop blackhole\n"

Before executing the script, the gateway locks the database automatically

No need to add the "lock database override" command to the script

admin-password

string

Administrator password for the gateway

The admin-password is returned as “******” in the JSON response

upload-info

boolean

If true, improves product experience by sending data to Check Point

mgmt-eth-ip-address-ipv4

string

IPv4 address

ftw-sic-key

string

Creating a Secure Internal Communication (SIC) activation key

dns-server1

string

The primary DNS server

dns-server2

string

The secondary DNS server

dns-server3

string

The tertiary DNS server

download-info

boolean

If true, automatically downloads Blade Contracts and other important data (highly recommended)

cluster-member

boolean

If true, the gateway is a member of a cluster

mgmt-eth-ip-address-ipv6

string

Enter this IP address if config-ipv6 is true

time-zone

string

Time zone for the gateway

name

string

The template name

creation-time

object

Timestamps for creating a template

last-modify-time

object

Timestamps for last modifying a template

account-id

int

The User Center account to which gateways and templates belong

template-id

int

The template's unique identifier

mgmt-eth-subnet-mask-ipv4

string

IPv4's subnet mask

config-ipv6

boolean

Must be true to set ipv6 configuration

mgmt-eth-mask-length-ipv6

int

Enter the mask length value if config-ipv6 is true

default-gateway-ipv6

string

Enter the default gateway if config-ipv6 is true

under-construction

boolean

A true value prevents downloads to the gateway until the final configuration and deployment decisions are complete

Default value: false

ntp1

string

Network Time Protocol for clock synchronization between computer systems

ntp.checkpoint.com is recommended

ntp1-version

string

Most recent version of Check Point's NTP servers is the string value "4"

ntp2

string

Network Time Protocol for clock synchronization between computer systems

ntp2.checkpoint.com is recommended

ntp2-version

string

Most recent version of Check Point's NTP servers is the string value "4"

default-gateway-ipv4

string

IPv4's default gateway

proxy-server

string

IP address of the proxy server

proxy-port

int

Proxy port number for client connections (8080 by default)

gaia-version-id

int

ID number of Gaia version from: show-all-gaia-versions-ids

force-reimage

boolean

If true, this forces a re-image of the machine even if the selected Gaia image version is already installed

identification-key

string

This is configured on the gateway as a unique identifier to be recognized unambiguously by Zero Touch

The string for the key is set at the gateway's command line interface:

set cloud-config identification-key <key_string>

If there are repeated invalid entries of identification-key in API requests, the gateway will lock and the parameter is-locked will be set to true

Set is-locked to false to unlock the gateway and re-try the identification-key

comments

string

General comments

creating-user

string

The user who created the template

last-modifying-user

string

The user who last modified the template

user-script

string

CLI commands execute on the gateway immediately after all other settings are applied

In multiline CLISH scripts, use end line ("\n") at the end of each command line

"user-script": "set static-route 192.0.2.100 nexthop gateway address 192.0.2.155 on\nset static-route 192.0.3.0/24 nexthop blackhole\n"

Before executing the script, the gateway locks the database automatically

No need to add the "lock database override" command to the script

admin-password

string

Administrator password for the gateway

The admin-password is returned as “******” in the JSON response

upload-info

boolean

If true, improves product experience by sending data to Check Point

mgmt-eth-ip-address-ipv4

string

IPv4 address

ftw-sic-key

string

Creating a Secure Internal Communication (SIC) activation key

dns-server1

string

The primary DNS server

dns-server2

string

The secondary DNS server

dns-server3

string

The tertiary DNS server

download-info

boolean

If true, automatically downloads Blade Contracts and other important data (highly recommended)

cluster-member

boolean

If true, the gateway is a member of a cluster

mgmt-eth-ip-address-ipv6

string

Enter this IP address if config-ipv6 is true

time-zone

string

Time zone for the gateway

name

string

The template name

posix

int

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

iso-8601

string

Date and time represented in international ISO 8601 format

posix

int

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

iso-8601

string

Date and time represented in international ISO 8601 format

message

string

Operation status

messages

List: string

List of validation errors

code

string

Error code

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

template-id

Required

int

The template's unique identifier

account-id

Required

int

The User Center account to which gateways and templates belong

message

string

Operation status

code

string

Success code

message

string

Operation status

messages

List: string

List of validation errors

code

string

Error code

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

mac

Required

string

Unique Media Access Control address for the gateway

object-name

Required

string

The gateway's name, a required field when claiming a gateway

account-id

Required

int

The User Center account to which gateways and templates belong

template-id

Required

int

The template's unique identifier

creation-time

object

Timestamps for claiming a gateway

last-modify-time

object

Timestamps for last modifying a gateway

mac

string

Unique Media Access Control address for the gateway

object-name

string

The gateway's name, a required field when claiming a gateway

template-name

string

The name of the template used to claim this gateway

is-locked

boolean

If true, the gateway is locked because of repeated invalid entries of identification-key

Set to false to unlock the gateway and retry the identification-key

It is not possible to use true to lock it

reported-status-time

int

Timestamp when the 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

ip-address

string

The IP address from which the Zero Touch server receives status reports sent by the gateway

This IP address is the same as the ext-interface-ip if there are no changes from a NAT device or a proxy

ext-interface-ip

string

The IP address configured on the external interface of the gateway

sku

string

Stock Keeping Unit code for the gateway

account-id

int

The User Center account to which gateways and templates belong

template-id

int

The template's unique identifier

mgmt-eth-subnet-mask-ipv4

string

IPv4's subnet mask

config-ipv6

boolean

Must be true to set ipv6 configuration

mgmt-eth-mask-length-ipv6

int

Enter the mask length value if config-ipv6 is true

default-gateway-ipv6

string

Enter the default gateway if config-ipv6 is true

under-construction

boolean

A true value prevents downloads to the gateway until the final configuration and deployment decisions are complete

Default value: false

ntp1

string

Network Time Protocol for clock synchronization between computer systems

ntp.checkpoint.com is recommended

ntp1-version

string

Most recent version of Check Point's NTP servers is the string value "4"

ntp2

string

Network Time Protocol for clock synchronization between computer systems

ntp2.checkpoint.com is recommended

ntp2-version

string

Most recent version of Check Point's NTP servers is the string value "4"

default-gateway-ipv4

string

IPv4's default gateway

proxy-server

string

IP address of the proxy server

proxy-port

int

Proxy port number for client connections (8080 by default)

gaia-version-id

int

ID number of Gaia version from: show-all-gaia-versions-ids

force-reimage

boolean

If true, this forces a re-image of the machine even if the selected Gaia image version is already installed

identification-key

string

This is configured on the gateway as a unique identifier to be recognized unambiguously by Zero Touch

The string for the key is set at the gateway's command line interface:

set cloud-config identification-key <key_string>

If there are repeated invalid entries of identification-key in API requests, the gateway will lock and the parameter is-locked will be set to true

Set is-locked to false to unlock the gateway and re-try the identification-key

comments

string

General comments

creating-user

string

The user who claims a gateway

last-modifying-user

string

The user who last modified a gateway

user-script

string

CLI commands execute on the gateway immediately after all other settings are applied

In multiline CLISH scripts, use end line ("\n") at the end of each command line

"user-script": "set static-route 192.0.2.100 nexthop gateway address 192.0.2.155 on\nset static-route 192.0.3.0/24 nexthop blackhole\n"

Before executing the script, the gateway locks the database automatically

No need to add the "lock database override" command to the script

admin-password

string

Administrator password for the gateway

The admin-password is returned as “******” in the JSON response

upload-info

boolean

If true, improves product experience by sending data to Check Point

mgmt-eth-ip-address-ipv4

string

IPv4 address

ftw-sic-key

string

Creating a Secure Internal Communication (SIC) activation key

dns-server1

string

The primary DNS server

dns-server2

string

The secondary DNS server

dns-server3

string

The tertiary DNS server

download-info

boolean

If true, automatically downloads Blade Contracts and other important data (highly recommended)

cluster-member

boolean

If true, the gateway is a member of a cluster

mgmt-eth-ip-address-ipv6

string

Enter this IP address if config-ipv6 is true

time-zone

string

Time zone for the gateway

posix

int

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

iso-8601

string

Date and time represented in international ISO 8601 format

posix

int

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

iso-8601

string

Date and time represented in international ISO 8601 format

message

string

Operation status

messages

List: string

List of validation errors

code

string

Error code

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

mac

Required

string

Unique Media Access Control address for the gateway

account-id

Required

int

The User Center account to which gateways and templates belong

creation-time

object

Timestamps for claiming a gateway

last-modify-time

object

Timestamps for last modifying a gateway

mac

string

Unique Media Access Control address for the gateway

object-name

string

The gateway's name, a required field when claiming a gateway

template-name

string

The name of the template used to claim this gateway

is-locked

boolean

If true, the gateway is locked because of repeated invalid entries of identification-key

Set to false to unlock the gateway and retry the identification-key

It is not possible to use true to lock it

reported-status-time

int

Timestamp when the 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

ip-address

string

The IP address from which the Zero Touch server receives status reports sent by the gateway

This IP address is the same as the ext-interface-ip if there are no changes from a NAT device or a proxy

ext-interface-ip

string

The IP address configured on the external interface of the gateway

sku

string

Stock Keeping Unit code for the gateway

account-id

int

The User Center account to which gateways and templates belong

template-id

int

The template's unique identifier

mgmt-eth-subnet-mask-ipv4

string

IPv4's subnet mask

config-ipv6

boolean

Must be true to set ipv6 configuration

mgmt-eth-mask-length-ipv6

int

Enter the mask length value if config-ipv6 is true

default-gateway-ipv6

string

Enter the default gateway if config-ipv6 is true

under-construction

boolean

A true value prevents downloads to the gateway until the final configuration and deployment decisions are complete

Default value: false

ntp1

string

Network Time Protocol for clock synchronization between computer systems

ntp.checkpoint.com is recommended

ntp1-version

string

Most recent version of Check Point's NTP servers is the string value "4"

ntp2

string

Network Time Protocol for clock synchronization between computer systems

ntp2.checkpoint.com is recommended

ntp2-version

string

Most recent version of Check Point's NTP servers is the string value "4"

default-gateway-ipv4

string

IPv4's default gateway

proxy-server

string

IP address of the proxy server

proxy-port

int

Proxy port number for client connections (8080 by default)

identification-key

string

This is configured on the gateway as a unique identifier to be recognized unambiguously by Zero Touch

The string for the key is set at the gateway's command line interface:

set cloud-config identification-key <key_string>

If there are repeated invalid entries of identification-key in API requests, the gateway will lock and the parameter is-locked will be set to true

Set is-locked to false to unlock the gateway and re-try the identification-key

comments

string

General comments

creating-user

string

The user who claims a gateway

last-modifying-user

string

The user who last modified a gateway

user-script

string

CLI commands execute on the gateway immediately after all other settings are applied

In multiline CLISH scripts, use end line ("\n") at the end of each command line

"user-script": "set static-route 192.0.2.100 nexthop gateway address 192.0.2.155 on\nset static-route 192.0.3.0/24 nexthop blackhole\n"

Before executing the script, the gateway locks the database automatically

No need to add the "lock database override" command to the script

admin-password

string

Administrator password for the gateway

The admin-password is returned as “******” in the JSON response

upload-info

boolean

If true, improves product experience by sending data to Check Point

mgmt-eth-ip-address-ipv4

string

IPv4 address

gaia-version-id

int

ID number of Gaia version from: show-all-gaia-versions-ids

force-reimage

boolean

If true, this forces a re-image of the machine even if the selected Gaia image version is already installed

ftw-sic-key

string

Creating a Secure Internal Communication (SIC) activation key

dns-server1

string

The primary DNS server

dns-server2

string

The secondary DNS server

dns-server3

string

The tertiary DNS server

download-info

boolean

If true, automatically downloads Blade Contracts and other important data (highly recommended)

cluster-member

boolean

If true, the gateway is a member of a cluster

mgmt-eth-ip-address-ipv6

string

Enter this IP address if config-ipv6 is true

time-zone

string

Time zone for the gateway

posix

int

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

iso-8601

string

Date and time represented in international ISO 8601 format

posix

int

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

iso-8601

string

Date and time represented in international ISO 8601 format

message

string

Operation status

messages

List: string

List of validation errors

code

string

Error code

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

mac

Required

string

Unique Media Access Control address for the gateway

account-id

Required

int

The User Center account to which gateways and templates belong

creation-time

object

Timestamps for claiming a gateway

last-modify-time

object

Timestamps for last modifying a gateway

mac

string

Unique Media Access Control address for the gateway

object-name

string

The gateway's name, a required field when claiming a gateway

template-name

string

The name of the template used to claim this gateway

is-locked

boolean

If true, the gateway is locked because of repeated invalid entries of identification-key

Set to false to unlock the gateway and retry the identification-key

It is not possible to use true to lock it

reported-status-time

int

Timestamp when the 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

ip-address

string

The IP address from which the Zero Touch server receives status reports sent by the gateway

This IP address is the same as the ext-interface-ip if there are no changes from a NAT device or a proxy

ext-interface-ip

string

The IP address configured on the external interface of the gateway

sku

string

Stock Keeping Unit code for the gateway

account-id

int

The User Center account to which gateways and templates belong

template-id

int

The template's unique identifier

mgmt-eth-subnet-mask-ipv4

string

IPv4's subnet mask

config-ipv6

boolean

Must be true to set ipv6 configuration

mgmt-eth-mask-length-ipv6

int

Enter the mask length value if config-ipv6 is true

default-gateway-ipv6

string

Enter the default gateway if config-ipv6 is true

under-construction

boolean

A true value prevents downloads to the gateway until the final configuration and deployment decisions are complete

Default value: false

ntp1

string

Network Time Protocol for clock synchronization between computer systems

ntp.checkpoint.com is recommended

ntp1-version

string

Most recent version of Check Point's NTP servers is the string value "4"

ntp2

string

Network Time Protocol for clock synchronization between computer systems

ntp2.checkpoint.com is recommended

ntp2-version

string

Most recent version of Check Point's NTP servers is the string value "4"

default-gateway-ipv4

string

IPv4's default gateway

proxy-server

string

IP address of the proxy server

proxy-port

int

Proxy port number for client connections (8080 by default)

gaia-version-id

int

ID number of Gaia version from: show-all-gaia-versions-ids

force-reimage

boolean

If true, this forces a re-image of the machine even if the selected Gaia image version is already installed

identification-key

string

This is configured on the gateway as a unique identifier to be recognized unambiguously by Zero Touch

The string for the key is set at the gateway's command line interface:

set cloud-config identification-key <key_string>

If there are repeated invalid entries of identification-key in API requests, the gateway will lock and the parameter is-locked will be set to true

Set is-locked to false to unlock the gateway and re-try the identification-key

comments

string

General comments

creating-user

string

The user who claims a gateway

last-modifying-user

string

The user who last modified a gateway

user-script

string

CLI commands execute on the gateway immediately after all other settings are applied

In multiline CLISH scripts, use end line ("\n") at the end of each command line

"user-script": "set static-route 192.0.2.100 nexthop gateway address 192.0.2.155 on\nset static-route 192.0.3.0/24 nexthop blackhole\n"

Before executing the script, the gateway locks the database automatically

No need to add the "lock database override" command to the script

admin-password

string

Administrator password for the gateway

The admin-password is returned as “******” in the JSON response

upload-info

boolean

If true, improves product experience by sending data to Check Point

mgmt-eth-ip-address-ipv4

string

IPv4 address

ftw-sic-key

string

Creating a Secure Internal Communication (SIC) activation key

dns-server1

string

The primary DNS server

dns-server2

string

The secondary DNS server

dns-server3

string

The tertiary DNS server

download-info

boolean

If true, automatically downloads Blade Contracts and other important data (highly recommended)

cluster-member

boolean

If true, the gateway is a member of a cluster

mgmt-eth-ip-address-ipv6

string

Enter this IP address if config-ipv6 is true

time-zone

string

Time zone for the gateway

posix

int

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

iso-8601

string

Date and time represented in international ISO 8601 format

posix

int

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

iso-8601

string

Date and time represented in international ISO 8601 format

message

string

Operation status

messages

List: string

List of validation errors

code

string

Error code

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

account-id

Required

int

The User Center account to which gateways and templates belong

creation-time

object

Timestamps for claiming a gateway

last-modify-time

object

Timestamps for last modifying a gateway

mac

string

Unique Media Access Control address for the gateway

object-name

string

The gateway's name, a required field when claiming a gateway

template-name

string

The name of the template used to claim this gateway

is-locked

boolean

If true, the gateway is locked because of repeated invalid entries of identification-key

Set to false to unlock the gateway and retry the identification-key

It is not possible to use true to lock it

reported-status-time

int

Timestamp when the 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

ip-address

string

The IP address from which the Zero Touch server receives status reports sent by the gateway

This IP address is the same as the ext-interface-ip if there are no changes from a NAT device or a proxy

ext-interface-ip

string

The IP address configured on the external interface of the gateway

sku

string

Stock Keeping Unit code for the gateway

account-id

int

The User Center account to which gateways and templates belong

template-id

int

The template's unique identifier

mgmt-eth-subnet-mask-ipv4

string

IPv4's subnet mask

config-ipv6

boolean

Must be true to set ipv6 configuration

mgmt-eth-mask-length-ipv6

int

Enter the mask length value if config-ipv6 is true

default-gateway-ipv6

string

Enter the default gateway if config-ipv6 is true

under-construction

boolean

A true value prevents downloads to the gateway until the final configuration and deployment decisions are complete

Default value: false

ntp1

string

Network Time Protocol for clock synchronization between computer systems

ntp.checkpoint.com is recommended

ntp1-version

string

Most recent version of Check Point's NTP servers is the string value "4"

ntp2

string

Network Time Protocol for clock synchronization between computer systems

ntp2.checkpoint.com is recommended

ntp2-version

string

Most recent version of Check Point's NTP servers is the string value "4"

default-gateway-ipv4

string

IPv4's default gateway

proxy-server

string

IP address of the proxy server

proxy-port

int

Proxy port number for client connections (8080 by default)

gaia-version-id

int

ID number of Gaia version from: show-all-gaia-versions-ids

force-reimage

boolean

If true, this forces a re-image of the machine even if the selected Gaia image version is already installed

identification-key

string

This is configured on the gateway as a unique identifier to be recognized unambiguously by Zero Touch

The string for the key is set at the gateway's command line interface:

set cloud-config identification-key <key_string>

If there are repeated invalid entries of identification-key in API requests, the gateway will lock and the parameter is-locked will be set to true

Set is-locked to false to unlock the gateway and re-try the identification-key

comments

string

General comments

creating-user

string

The user who claims a gateway

last-modifying-user

string

The user who last modified a gateway

user-script

string

CLI commands execute on the gateway immediately after all other settings are applied

In multiline CLISH scripts, use end line ("\n") at the end of each command line

"user-script": "set static-route 192.0.2.100 nexthop gateway address 192.0.2.155 on\nset static-route 192.0.3.0/24 nexthop blackhole\n"

Before executing the script, the gateway locks the database automatically

No need to add the "lock database override" command to the script

admin-password

string

Administrator password for the gateway

The admin-password is returned as “******” in the JSON response

upload-info

boolean

If true, improves product experience by sending data to Check Point

mgmt-eth-ip-address-ipv4

string

IPv4 address

ftw-sic-key

string

Creating a Secure Internal Communication (SIC) activation key

dns-server1

string

The primary DNS server

dns-server2

string

The secondary DNS server

dns-server3

string

The tertiary DNS server

download-info

boolean

If true, automatically downloads Blade Contracts and other important data (highly recommended)

cluster-member

boolean

If true, the gateway is a member of a cluster

mgmt-eth-ip-address-ipv6

string

Enter this IP address if config-ipv6 is true

time-zone

string

Time zone for the gateway

posix

int

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

iso-8601

string

Date and time represented in international ISO 8601 format

posix

int

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

iso-8601

string

Date and time represented in international ISO 8601 format

message

string

Operation status

messages

List: string

List of validation errors

code

string

Error code

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

mac

Required

string

Unique Media Access Control address for the gateway

account-id

Required

int

The User Center account to which gateways and templates belong

object-name

string

The gateway's name, a required field when claiming a gateway

template-name

string

The name of the template used to claim this gateway

ip-address

string

The IP address from which the Zero Touch server receives status reports sent by the gateway

This IP address is the same as the ext-interface-ip if there are no changes from a NAT device or a proxy

ext-interface-ip

string

The IP address configured on the external interface of the gateway

sku

string

Stock Keeping Unit code for the gateway

is-locked

boolean

If true, the gateway is locked because of repeated invalid entries of identification-key

Set to false to unlock the gateway and retry the identification-key

It is not possible to use true to lock it

reported-status-time

int

Timestamp when the gateway last reported its status

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

time-zone

string

Time zone for the gateway

template-id

int

The template's unique identifier

comments

string

General comments

user-script

string

CLI commands execute on the gateway immediately after all other settings are applied

In multiline CLISH scripts, use end line ("\n") at the end of each command line

"user-script": "set static-route 192.0.2.100 nexthop gateway address 192.0.2.155 on\nset static-route 192.0.3.0/24 nexthop blackhole\n"

Before executing the script, the gateway locks the database automatically

No need to add the "lock database override" command to the script

upload-info

boolean

If true, improves product experience by sending data to Check Point

ftw-sic-key

string

Creating a Secure Internal Communication (SIC) activation key

dns-server1

string

The primary DNS server

dns-server2

string

The secondary DNS server

dns-server3

string

The tertiary DNS server

config-ipv6

boolean

Must be true to set ipv6 configuration

ntp1

string

Network Time Protocol for clock synchronization between computer systems

ntp.checkpoint.com is recommended

ntp2

string

Network Time Protocol for clock synchronization between computer systems

ntp2.checkpoint.com is recommended

identification-key

string

This is configured on the gateway as a unique identifier to be recognized unambiguously by Zero Touch

The string for the key is set at the gateway's command line interface:

set cloud-config identification-key <key_string>

If there are repeated invalid entries of identification-key in API requests, the gateway will lock and the parameter is-locked will be set to true

Set is-locked to false to unlock the gateway and re-try the identification-key

creating-user

string

The user who claims a gateway

last-modifying-user

string

The user who last modified a gateway

admin-password

string

Administrator password for the gateway

The admin-password is returned as “******” in the JSON response

mgmt-eth-ip-address-ipv6

string

Enter this IP address if config-ipv6 is true

mgmt-eth-ip-address-ipv4

string

IPv4 address

download-info

boolean

If true, automatically downloads Blade Contracts and other important data (highly recommended)

cluster-member

boolean

If true, the gateway is a member of a cluster

mgmt-eth-subnet-mask-ipv4

int

IPv4's subnet mask

mgmt-eth-mask-length-ipv6

string

Enter the mask length value if config-ipv6 is true

default-gateway-ipv6

string

Enter the default gateway if config-ipv6 is true

under-construction

boolean

A true value prevents downloads to the gateway until the final configuration and deployment decisions are complete

Default value: false

ntp1-version

string

Most recent version of Check Point's NTP servers is the string value "4"

ntp2-version

string

Most recent version of Check Point's NTP servers is the string value "4"

default-gateway-ipv4

string

IPv4's default gateway

proxy-server

string

IP address of the proxy server

proxy-port

int

Proxy port number for client connections (8080 by default)

gaia-version-id

int

ID number of Gaia version from: show-all-gaia-versions-ids

force-reimage

boolean

If true, this forces a re-image of the machine even if the selected Gaia image version is already installed

creation-time

object

Timestamps for claiming a gateway

last-modify-time

object

Timestamps for last modifying a gateway

mac

string

Unique Media Access Control address for the gateway

object-name

string

The gateway's name, a required field when claiming a gateway

template-name

string

The name of the template used to claim this gateway

is-locked

boolean

If true, the gateway is locked because of repeated invalid entries of identification-key

Set to false to unlock the gateway and retry the identification-key

It is not possible to use true to lock it

reported-status-time

int

Timestamp when the 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

ip-address

string

The IP address from which the Zero Touch server receives status reports sent by the gateway

This IP address is the same as the ext-interface-ip if there are no changes from a NAT device or a proxy

ext-interface-ip

string

The IP address configured on the external interface of the gateway

sku

string

Stock Keeping Unit code for the gateway

account-id

int

The User Center account to which gateways and templates belong

template-id

int

The template's unique identifier

mgmt-eth-subnet-mask-ipv4

string

IPv4's subnet mask

config-ipv6

boolean

Must be true to set ipv6 configuration

mgmt-eth-mask-length-ipv6

int

Enter the mask length value if config-ipv6 is true

default-gateway-ipv6

string

Enter the default gateway if config-ipv6 is true

under-construction

boolean

A true value prevents downloads to the gateway until the final configuration and deployment decisions are complete

Default value: false

ntp1

string

Network Time Protocol for clock synchronization between computer systems

ntp.checkpoint.com is recommended

ntp1-version

string

Most recent version of Check Point's NTP servers is the string value "4"

ntp2

string

Network Time Protocol for clock synchronization between computer systems

ntp2.checkpoint.com is recommended

ntp2-version

string

Most recent version of Check Point's NTP servers is the string value "4"

default-gateway-ipv4

string

IPv4's default gateway

proxy-server

string

IP address of the proxy server

proxy-port

int

Proxy port number for client connections (8080 by default)

gaia-version-id

int

ID number of Gaia version from: show-all-gaia-versions-ids

force-reimage

boolean

If true, this forces a re-image of the machine even if the selected Gaia image version is already installed

identification-key

string

This is configured on the gateway as a unique identifier to be recognized unambiguously by Zero Touch

The string for the key is set at the gateway's command line interface:

set cloud-config identification-key <key_string>

If there are repeated invalid entries of identification-key in API requests, the gateway will lock and the parameter is-locked will be set to true

Set is-locked to false to unlock the gateway and re-try the identification-key

comments

string

General comments

creating-user

string

The user who claims a gateway

last-modifying-user

string

The user who last modified a gateway

user-script

string

CLI commands execute on the gateway immediately after all other settings are applied

In multiline CLISH scripts, use end line ("\n") at the end of each command line

"user-script": "set static-route 192.0.2.100 nexthop gateway address 192.0.2.155 on\nset static-route 192.0.3.0/24 nexthop blackhole\n"

Before executing the script, the gateway locks the database automatically

No need to add the "lock database override" command to the script

admin-password

string

Administrator password for the gateway

The admin-password is returned as “******” in the JSON response

upload-info

boolean

If true, improves product experience by sending data to Check Point

mgmt-eth-ip-address-ipv4

string

IPv4 address

ftw-sic-key

string

Creating a Secure Internal Communication (SIC) activation key

dns-server1

string

The primary DNS server

dns-server2

string

The secondary DNS server

dns-server3

string

The tertiary DNS server

download-info

boolean

If true, automatically downloads Blade Contracts and other important data (highly recommended)

cluster-member

boolean

If true, the gateway is a member of a cluster

mgmt-eth-ip-address-ipv6

string

Enter this IP address if config-ipv6 is true

time-zone

string

Time zone for the gateway

posix

int

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

iso-8601

string

Date and time represented in international ISO 8601 format

posix

int

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

iso-8601

string

Date and time represented in international ISO 8601 format

message

string

Operation status

messages

List: string

List of validation errors

code

string

Error code

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

mac

Required

string

Unique Media Access Control address for the gateway

account-id

Required

int

The User Center account to which gateways and templates belong

mac

string

Unique Media Access Control address for the gateway

reported-status-time

int

Timestamp when the 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

message

string

Operation status

messages

List: string

List of validation errors

code

string

Error code

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

mac

Required

string

Unique Media Access Control address for the gateway

account-id

Required

int

The User Center account to which gateways and templates belong

message

string

Operation status

code

string

Success code

message

string

Operation status

messages

List: string

List of validation errors

code

string

Error code