openapi: 3.0.0 info: title: GAIA API-1.6 description: >- GAIA API gives a new way to read information and to send commands to the Check Point servers. Just like it is possible to manage any checkpoint device, it is now possible to do the same using command line tools and through web-services. Target audience, GAIA API was created for the following audiences, System administrators who wish to improve their productivity by scripting some of their daily tasks, Customers who wish to integrate the Check Point solution with other solutions that they have (virtualization servers, ticketing systems, change management systems, etc.) and ever Check Point partners and integrators that look for an easy to use API that can help them create complementary products around the Check Point solution. contact: {} version: '1.0' servers: - url: http://example.com/gaia_api variables: {} paths: /v1.1/login: post: tags: - 01 Session Management summary: login description: Log in to the server with username and password. The server shows your session unique identifier. Enter this session unique identifier in the 'X-chkp-sid' header of each request operationId: login parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/loginrequest' - example: password: '{{password}}' user: '{{username}}' example: password: '{{password}}' user: '{{username}}' required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1/logout: post: tags: - 01 Session Management summary: logout description: Log out from the current session. After logging out the session id is not valid any more operationId: logout parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: type: object example: {} example: {} required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.1/keepalive: post: tags: - 01 Session Management summary: keepalive description: Keep the session valid/alive (Increasing session by 600 seconds) operationId: keepalive parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: type: object example: {} example: {} required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.4/set-ipv6: post: tags: - IPv6 summary: setipv6 description: Enables/Disables IPv6 support in the machine's operating system operationId: setipv6 parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/setipv6request' - example: enabled: true example: enabled: true required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.4/show-ipv6: post: tags: - IPv6 summary: showipv6 description: Check IPv6 support in the machine's operating system operationId: showipv6 parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: type: object example: {} example: {} required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.6/set-pbr-rule: post: tags: - Policy Based Routing summary: setpbrrule description: Set configurations for a pbr rule operationId: setpbrrule parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/setpbrrulerequest' - example: priority: 1 action: table: mytable unreachable: false main-table: false prohibit: false match: interface: eth1 source: mask-length: 32 address: 1.1.1.1 destination: mask-length: 32 address: 3.3.3.3 protocol: tcp port: 10 example: priority: 1 action: table: mytable unreachable: false main-table: false prohibit: false match: interface: eth1 source: mask-length: 32 address: 1.1.1.1 destination: mask-length: 32 address: 3.3.3.3 protocol: tcp port: 10 required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.6/set-pbr-table-static-next-hop-priority: post: tags: - Policy Based Routing summary: setpbrtablestaticnexthoppriority description: Setting the priority of a PBR table static route nexthop gateway operationId: setpbrtablestaticnexthoppriority parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/setpbrtablestaticnexthoppriorityrequest' - example: priority: 3 table: mytable static-address: 1.2.3.0 next-hop-gateway: 1.1.1.1 static-mask-length: 24 example: priority: 3 table: mytable static-address: 1.2.3.0 next-hop-gateway: 1.1.1.1 static-mask-length: 24 required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.6/show-pbr-rules: post: tags: - Policy Based Routing summary: showpbrrules description: Show the configuration of all PBR Rules operationId: showpbrrules parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/showpbrrulesrequest' - example: limit: 2 order: DESC offset: 0 example: limit: 2 order: DESC offset: 0 required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.6/delete-pbr-rule: post: tags: - Policy Based Routing summary: deletepbrrule description: Delete a PBR rule operationId: deletepbrrule parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/deletepbrrulerequest' - example: priority: 1 example: priority: 1 required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.6/set-pbr-table: post: tags: - Policy Based Routing summary: setpbrtable description: Configure a PBR table operationId: setpbrtable parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/setpbrtablerequest' - example: table: mytable static-routes: add: type: blackhole ping: false mask-length: 24 address: 4.5.6.0 example: table: mytable static-routes: add: type: blackhole ping: false mask-length: 24 address: 4.5.6.0 required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.6/show-pbr-table: post: tags: - Policy Based Routing summary: showpbrtable description: Show the configuration of a PBR table operationId: showpbrtable parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/showpbrtablerequest' - example: table: mytable static-route-offset: 0 static-route-limit: 2 static-route-order: ASC example: table: mytable static-route-offset: 0 static-route-limit: 2 static-route-order: ASC required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.6/show-pbr-rule: post: tags: - Policy Based Routing summary: showpbrrule description: Show the configuration of a PBR rule operationId: showpbrrule parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/deletepbrrulerequest' - example: priority: 1 example: priority: 1 required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.6/show-pbr-tables: post: tags: - Policy Based Routing summary: showpbrtables description: Show the configuration of all PBR Tables operationId: showpbrtables parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/showpbrrulesrequest' - example: limit: 4 order: ASC offset: 1 example: limit: 4 order: ASC offset: 1 required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.6/delete-pbr-table: post: tags: - Policy Based Routing summary: deletepbrtable description: Delete a PBR table operationId: deletepbrtable parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/deletepbrtablerequest' - example: table: mytable example: table: mytable required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.5/show-static-routes: post: tags: - Static Routes summary: showstaticroutes description: Show the configuration of all static routes operationId: showstaticroutes parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/showpbrrulesrequest' - example: limit: 2 order: DESC offset: 0 example: limit: 2 order: DESC offset: 0 required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.5/set-static-route-next-hop-priority: post: tags: - Static Routes summary: setstaticroutenexthoppriority description: Setting the priority of a static route nexthop gateway operationId: setstaticroutenexthoppriority parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/setstaticroutenexthoppriorityrequest' - example: priority: 3 next-hop-gateway: 1.1.1.1 mask-length: 24 address: 1.2.3.0 example: priority: 3 next-hop-gateway: 1.1.1.1 mask-length: 24 address: 1.2.3.0 required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.5/set-static-route: post: tags: - Static Routes summary: setstaticroute description: Set configurations for a new or existing static route operationId: setstaticroute parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/setstaticrouterequest' - example: comment: hello rank: 25 mask-length: 24 address: 1.2.3.0 next-hop: add: priority: 2 gateway: 1.1.1.1 type: gateway example: comment: hello rank: 25 mask-length: 24 address: 1.2.3.0 next-hop: add: priority: 2 gateway: 1.1.1.1 type: gateway required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.5/show-static-route: post: tags: - Static Routes summary: showstaticroute description: Show the configuration of a static route operationId: showstaticroute parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/Source' - example: mask-length: 24 address: 1.2.3.0 example: mask-length: 24 address: 1.2.3.0 required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.5/delete-static-route: post: tags: - Static Routes summary: deletestaticroute description: Delete a static route operationId: deletestaticroute parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/Source' - example: mask-length: 24 address: 1.2.3.0 example: mask-length: 24 address: 1.2.3.0 required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.6/show-routes-aggregate: post: tags: - Routes summary: showroutesaggregate description: Show active Aggregate routes operationId: showroutesaggregate parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/showpbrrulesrequest' - example: limit: 1 order: DESC offset: 0 example: limit: 1 order: DESC offset: 0 required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.6/show-routes-static: post: tags: - Routes summary: showroutesstatic description: Show active Static routes operationId: showroutesstatic parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/showpbrrulesrequest' - example: limit: 1 order: DESC offset: 0 example: limit: 1 order: DESC offset: 0 required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.6/show-routes: post: tags: - Routes summary: showroutes description: Show active routes operationId: showroutes parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/showpbrrulesrequest' - example: limit: 1 order: DESC offset: 0 example: limit: 1 order: DESC offset: 0 required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.6/show-routes-direct: post: tags: - Routes summary: showroutesdirect description: Show active Interface routes operationId: showroutesdirect parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/showpbrrulesrequest' - example: limit: 1 order: DESC offset: 0 example: limit: 1 order: DESC offset: 0 required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.6/show-routes-bgp: post: tags: - Routes summary: showroutesbgp description: Show active BGP routes operationId: showroutesbgp parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/showpbrrulesrequest' - example: limit: 1 order: DESC offset: 0 example: limit: 1 order: DESC offset: 0 required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.6/show-routes-kernel: post: tags: - Routes summary: showrouteskernel description: Show active Kernel routes operationId: showrouteskernel parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/showpbrrulesrequest' - example: limit: 1 order: DESC offset: 0 example: limit: 1 order: DESC offset: 0 required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.6/show-routes-ospf: post: tags: - Routes summary: showroutesospf description: Show active OSPF routes operationId: showroutesospf parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/showpbrrulesrequest' - example: limit: 1 order: DESC offset: 0 example: limit: 1 order: DESC offset: 0 required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.6/show-routes-rip: post: tags: - Routes summary: showroutesrip description: Show active RIP routes operationId: showroutesrip parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/showpbrrulesrequest' - example: limit: 1 order: DESC offset: 0 example: limit: 1 order: DESC offset: 0 required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1/delete-proxy: post: tags: - Proxy summary: deleteproxy description: Delete proxy setting operationId: deleteproxy parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: type: object example: {} example: {} required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1/set-proxy: post: tags: - Proxy summary: setproxy description: Set proxy setting operationId: setproxy parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/setproxyrequest' - example: port: '89' address: 1.1.1.1 example: port: '89' address: 1.1.1.1 required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1/show-proxy: post: tags: - Proxy summary: showproxy description: Show proxy setting operationId: showproxy parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: type: object example: {} example: {} required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.3/show-time-and-date: post: tags: - Date and Time summary: showtimeanddate description: Shows time and date operationId: showtimeanddate parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: type: object example: {} example: {} required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.3/show-ntp: post: tags: - Date and Time summary: showntp description: Show the NTP state, servers(primary and secondary) and the current NTP server operationId: showntp parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: type: object example: {} example: {} required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.3/set-ntp: post: tags: - Date and Time summary: setntp description: Sets NTP status and servers operationId: setntp parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/setntprequest' - example: enabled: true servers: - version: '3' type: primary address: 4.4.4.4 - version: 4 type: secondary address: 2.2.2.2 example: enabled: true servers: - version: '3' type: primary address: 4.4.4.4 - version: 4 type: secondary address: 2.2.2.2 required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.3/show-timezones: post: tags: - Date and Time summary: showtimezones description: Shows available areas and regions for timezone operationId: showtimezones parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: type: object example: {} example: {} required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.3/set-time-and-date: post: tags: - Date and Time summary: settimeanddate description: 'Sets time, date, and timezone. Note: time and date cannot be changed while NTP is active.' operationId: settimeanddate parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/settimeanddaterequest' - example: date: 2019-07-22 timezone: Asia / Jerusalem time: 16:32:56 example: date: 2019-07-22 timezone: Asia / Jerusalem time: 16:32:56 required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1/show-dhcp-server: post: tags: - DHCP summary: showdhcpserver description: Shows DHCP server information. operationId: showdhcpserver parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: type: object example: {} example: {} required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1/set-dhcp-server: post: tags: - DHCP summary: setdhcpserver description: Set DHCP server operationId: setdhcpserver parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/setdhcpserverrequest' - example: subnets: - subnet: 4.5.6.0 netmask: 24 dns: domain-name: my-domain-name primary: 8.8.8.8 tertiary: 8.8.4.4 secondary: 8.8.8.8 default-gateway: 4.5.6.1 max-lease: 86400 default-lease: 43200 enabled: true ip-pools: - start: 4.5.6.5 include: include end: 4.5.6.7 enabled: true enabled: false example: subnets: - subnet: 4.5.6.0 netmask: 24 dns: domain-name: my-domain-name primary: 8.8.8.8 tertiary: 8.8.4.4 secondary: 8.8.8.8 default-gateway: 4.5.6.1 max-lease: 86400 default-lease: 43200 enabled: true ip-pools: - start: 4.5.6.5 include: include end: 4.5.6.7 enabled: true enabled: false required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1/set-dns: post: tags: - DNS summary: setdns description: Setting DNS configuration operationId: setdns parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/setdnsrequest' - example: suffix: checkpoint.com primary: 1.2.3.4 tertiary: 3.4.5.6 secondary: 2.3.4.5 example: suffix: checkpoint.com primary: 1.2.3.4 tertiary: 3.4.5.6 secondary: 2.3.4.5 required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1/show-dns: post: tags: - DNS summary: showdns description: Show DNS settings operationId: showdns parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: type: object example: {} example: {} required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.6/show-physical-interfaces: post: tags: - Physical Interfaces summary: showphysicalinterfaces description: Show Physical interfaces operationId: showphysicalinterfaces parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: type: object example: {} example: {} required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.6/set-physical-interface: post: tags: - Physical Interfaces summary: setphysicalinterface description: Set Physical interface operationId: setphysicalinterface parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/setphysicalinterfacerequest' - example: enabled: true name: eth0 comments: eth0 interface example: enabled: true name: eth0 comments: eth0 interface required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.6/show-physical-interface: post: tags: - Physical Interfaces summary: showphysicalinterface description: Show Physical interface operationId: showphysicalinterface parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/showphysicalinterfacerequest' - example: name: eth0 example: name: eth0 required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.5/show-gre-interfaces: post: tags: - GRE Interfaces summary: showgreinterfaces description: Show all GRE interfaces configuration operationId: showgreinterfaces parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: type: object example: {} example: {} required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.5/show-gre-interface: post: tags: - GRE Interfaces summary: showgreinterface description: Show GRE interface configuration operationId: showgreinterface parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/showphysicalinterfacerequest' - example: name: gre3 example: name: gre3 required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.5/delete-gre-interface: post: tags: - GRE Interfaces summary: deletegreinterface description: Delete GRE interface operationId: deletegreinterface parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/showphysicalinterfacerequest' - example: name: gre3 example: name: gre3 required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.5/set-gre-interface: post: tags: - GRE Interfaces summary: setgreinterface description: Set GRE interface configuration operationId: setgreinterface parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/setgreinterfacerequest' - example: enabled: true name: gre3 example: enabled: true name: gre3 required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.5/add-gre-interface: post: tags: - GRE Interfaces summary: addgreinterface description: Add GRE interface operationId: addgreinterface parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/addgreinterfacerequest' - example: comments: test comment local-ip-address: 10.10.2.8 ttl: 255 gre-id: 3 ipv4-address: 10.10.3.2 peer-address: 10.10.4.2 remote-ip-address: 10.10.2.9 ipv4-mask-length: 24 example: comments: test comment local-ip-address: 10.10.2.8 ttl: 255 gre-id: 3 ipv4-address: 10.10.3.2 peer-address: 10.10.4.2 remote-ip-address: 10.10.2.9 ipv4-mask-length: 24 required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1/delete-bond-interface: post: tags: - Bond Interfaces summary: deletebondinterface description: Delete Bond interface operationId: deletebondinterface parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/showphysicalinterfacerequest' - example: name: bond5 example: name: bond5 required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.6/set-bond-interface: post: tags: - Bond Interfaces summary: setbondinterface description: Set Bond interface operationId: setbondinterface parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/setbondinterfacerequest' - example: lacp-rate: slow name: bond5 mode: 8023AD example: lacp-rate: slow name: bond5 mode: 8023AD required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.6/show-bond-interface: post: tags: - Bond Interfaces summary: showbondinterface description: Show Bond interface operationId: showbondinterface parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/showphysicalinterfacerequest' - example: name: bond5 example: name: bond5 required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.6/add-bond-interface: post: tags: - Bond Interfaces summary: addbondinterface description: Add Bond interface operationId: addbondinterface parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/addbondinterfacerequest' - example: id: 5 mode: xor example: id: 5 mode: xor required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.6/show-bond-interfaces: post: tags: - Bond Interfaces summary: showbondinterfaces description: Show Bond interfaces operationId: showbondinterfaces parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: type: object example: {} example: {} required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1/show-loopback-interfaces: post: tags: - Loopback Interfaces summary: showloopbackinterfaces description: Show Loopback interfaces operationId: showloopbackinterfaces parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: type: object example: {} example: {} required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1/add-loopback-interface: post: tags: - Loopback Interfaces summary: addloopbackinterface description: Add Loopback interface operationId: addloopbackinterface parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/addloopbackinterfacerequest' - example: ipv4-address: 1.1.1.1 ipv4-mask-length: 24 example: ipv4-address: 1.1.1.1 ipv4-mask-length: 24 required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1/show-loopback-interface: post: tags: - Loopback Interfaces summary: showloopbackinterface description: Show Loopback interface operationId: showloopbackinterface parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/showphysicalinterfacerequest' - example: name: loop00 example: name: loop00 required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1/set-loopback-interface: post: tags: - Loopback Interfaces summary: setloopbackinterface description: Set Loopback interface operationId: setloopbackinterface parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/setgreinterfacerequest' - example: enabled: true name: loop00 example: enabled: true name: loop00 required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1/delete-loopback-interface: post: tags: - Loopback Interfaces summary: deleteloopbackinterface description: Delete Loopback interface operationId: deleteloopbackinterface parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/showphysicalinterfacerequest' - example: name: loop00 example: name: loop00 required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1/show-alias-interfaces: post: tags: - Alias Interface summary: showaliasinterfaces description: Show Alias interfaces operationId: showaliasinterfaces parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: type: object example: {} example: {} required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1/delete-alias-interface: post: tags: - Alias Interface summary: deletealiasinterface description: Delete Alias interface operationId: deletealiasinterface parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/showphysicalinterfacerequest' - example: name: eth0:1 example: name: eth0:1 required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1/show-alias-interface: post: tags: - Alias Interface summary: showaliasinterface description: Show Alias interface operationId: showaliasinterface parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/showphysicalinterfacerequest' - example: name: eth0:1 example: name: eth0:1 required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1/add-alias-interface: post: tags: - Alias Interface summary: addaliasinterface description: Add Alias interface operationId: addaliasinterface parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/addaliasinterfacerequest' - example: ipv4-address: 15.15.15.15 parent: eth0 ipv4-mask-length: 24 example: ipv4-address: 15.15.15.15 parent: eth0 ipv4-mask-length: 24 required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.6/set-bridge-interface: post: tags: - Bridge Interface summary: setbridgeinterface description: Set Bridge interface operationId: setbridgeinterface parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/setbridgeinterfacerequest' - example: name: br9 comments: Bridge9 example: name: br9 comments: Bridge9 required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.6/show-bridge-interface: post: tags: - Bridge Interface summary: showbridgeinterface description: Show Bridge interface operationId: showbridgeinterface parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/showphysicalinterfacerequest' - example: name: br9 example: name: br9 required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1/delete-bridge-interface: post: tags: - Bridge Interface summary: deletebridgeinterface description: Delete Bridge interface operationId: deletebridgeinterface parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/showphysicalinterfacerequest' - example: name: br9 example: name: br9 required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.6/add-bridge-interface: post: tags: - Bridge Interface summary: addbridgeinterface description: Add Bridge interface operationId: addbridgeinterface parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/addbridgeinterfacerequest' - example: id: 9 example: id: 9 required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.6/show-bridge-interfaces: post: tags: - Bridge Interface summary: showbridgeinterfaces description: Show Bridge interfaces operationId: showbridgeinterfaces parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: type: object example: {} example: {} required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.6/add-vlan-interface: post: tags: - Vlan Interface summary: addvlaninterface description: Add Vlan interface operationId: addvlaninterface parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/addvlaninterfacerequest' - example: id: 2 parent: eth0 example: id: 2 parent: eth0 required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.6/set-vlan-interface: post: tags: - Vlan Interface summary: setvlaninterface description: Set Vlan interface operationId: setvlaninterface parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/setgreinterfacerequest' - example: enabled: true name: eth0.2 example: enabled: true name: eth0.2 required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1/delete-vlan-interface: post: tags: - Vlan Interface summary: deletevlaninterface description: Delete Vlan interface operationId: deletevlaninterface parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/showphysicalinterfacerequest' - example: name: eth0.2 example: name: eth0.2 required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.6/show-vlan-interface: post: tags: - Vlan Interface summary: showvlaninterface description: Show Vlan interface operationId: showvlaninterface parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/showphysicalinterfacerequest' - example: name: eth0.2 example: name: eth0.2 required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.6/show-vlan-interfaces: post: tags: - Vlan Interface summary: showvlaninterfaces description: Show Vlan interfaces operationId: showvlaninterfaces parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: type: object example: {} example: {} required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.5/add-vxlan-interface: post: tags: - Vxlan Interface summary: addvxlaninterface description: 'Add Vxlan interface. Note: This tunnel is not secure because it is not encrypted' operationId: addvxlaninterface parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/addvxlaninterfacerequest' - example: destination-port: 4789 member-of: eth0 vxlan-id: 600 remote-ip-address: 1.1.1.1 example: destination-port: 4789 member-of: eth0 vxlan-id: 600 remote-ip-address: 1.1.1.1 required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.5/show-vxlan-interface: post: tags: - Vxlan Interface summary: showvxlaninterface description: Show Vxlan interface operationId: showvxlaninterface parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/showphysicalinterfacerequest' - example: name: vxlan200 example: name: vxlan200 required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.5/set-vxlan-interface: post: tags: - Vxlan Interface summary: setvxlaninterface description: Set Vxlan interface operationId: setvxlaninterface parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/setbridgeinterfacerequest' - example: name: vxlan500 comments: vxlan500 example: name: vxlan500 comments: vxlan500 required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.5/delete-vxlan-interface: post: tags: - Vxlan Interface summary: deletevxlaninterface description: Delete Vxlan interface operationId: deletevxlaninterface parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/showphysicalinterfacerequest' - example: name: vxlan600 example: name: vxlan600 required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.5/show-vxlan-interfaces: post: tags: - Vxlan Interface summary: showvxlaninterfaces description: Show Vxlan interfaces operationId: showvxlaninterfaces parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: type: object example: {} example: {} required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1/show-interface: post: tags: - 04 Interfaces summary: showinterface description: Show interface operationId: showinterface parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/showphysicalinterfacerequest' - example: name: eth0 example: name: eth0 required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.6/show-interfaces-by-type: post: tags: - 04 Interfaces summary: showinterfacesbytype description: Show interfaces by type operationId: showinterfacesbytype parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: type: object example: {} example: {} required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1/show-interfaces: post: tags: - 04 Interfaces summary: showinterfaces description: Show interfaces operationId: showinterfaces parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: type: object example: {} example: {} required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.2/add-system-group: post: tags: - Groups summary: addsystemgroup description: Create a new system group operationId: addsystemgroup parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/addsystemgrouprequest' - example: gid: '1000' name: financeGroup users: - John - Chris - Olivia example: gid: '1000' name: financeGroup users: - John - Chris - Olivia required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.2/set-system-group: post: tags: - Groups summary: setsystemgroup description: Change a group's characteristics operationId: setsystemgroup parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/addsystemgrouprequest' - example: gid: '2000' name: financeGroup users: - John - Emily example: gid: '2000' name: financeGroup users: - John - Emily required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.2/show-system-groups: post: tags: - Groups summary: showsystemgroups description: List the groups currently exist in the system. For each group, the group name, GID and users are shown. operationId: showsystemgroups parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: type: object example: {} example: {} required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.2/show-system-group: post: tags: - Groups summary: showsystemgroup description: Display the group's characteristics (gid and members). operationId: showsystemgroup parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/showphysicalinterfacerequest' - example: name: financeGroup example: name: financeGroup required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.2/delete-system-group: post: tags: - Groups summary: deletesystemgroup description: Remove an existing group operationId: deletesystemgroup parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/showphysicalinterfacerequest' - example: name: financeGroup example: name: financeGroup required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.1/add-user: post: tags: - Users summary: adduser description: Add a new user operationId: adduser parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/adduserrequest' - example: roles: monitorRole password: 12345abcde name: myusername secondary-system-groups: - users shell: cli primary-system-group-id: 50 allow-access-using: - CLI - Web-UI homedir: /home/myusername uid: 1000 example: roles: monitorRole password: 12345abcde name: myusername secondary-system-groups: - users shell: cli primary-system-group-id: 50 allow-access-using: - CLI - Web-UI homedir: /home/myusername uid: 1000 required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.1/set-user: post: tags: - Users summary: setuser description: Change a user's characteristics operationId: setuser parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/setuserrequest' - example: shell: no-login name: myusername must-change-password: true allow-access-using: - CLI primary-system-group-id: 60 uid: 2000 example: shell: no-login name: myusername must-change-password: true allow-access-using: - CLI primary-system-group-id: 60 uid: 2000 required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.1/delete-user: post: tags: - Users summary: deleteuser description: Remove a user from the system operationId: deleteuser parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/showphysicalinterfacerequest' - example: name: myusername example: name: myusername required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.1/show-users: post: tags: - Users summary: showusers description: Display all the users currently configured operationId: showusers parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: type: object example: {} example: {} required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.1/show-user: post: tags: - Users summary: showuser description: Display a user's characteristics operationId: showuser parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/showphysicalinterfacerequest' - example: name: myusername example: name: myusername required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1/show-allowed-clients: post: tags: - 06 Allowed Clients summary: showallowedclients description: Show allowed clients operationId: showallowedclients parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: type: object example: {} example: {} required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1/set-allowed-clients: post: tags: - 06 Allowed Clients summary: setallowedclients description: Set allowed clients access operationId: setallowedclients parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/setallowedclientsrequest' - example: allowed-networks: - subnet: 44.4.44.0 mask-length: 24 - subnet: 55.4.55.0 mask-length: 24 example: allowed-networks: - subnet: 44.4.44.0 mask-length: 24 - subnet: 55.4.55.0 mask-length: 24 required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1/show-tacacs: post: tags: - Tacacs summary: showtacacs description: Show Tacacs servers settings operationId: showtacacs parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: type: object example: {} example: {} required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1/set-tacacs: post: tags: - Tacacs summary: settacacs description: Set tacacs servers settings operationId: settacacs parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/settacacsrequest' - example: servers: priority: 3 secret: '56' timeout: 1 address: 1.2.1.2 example: servers: priority: 3 secret: '56' timeout: 1 address: 1.2.1.2 required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1/set-radius: post: tags: - Radius summary: setradius description: Set radius servers settings operationId: setradius parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/setradiusrequest' - example: servers: priority: 3 secret: '12345' port: 56 timeout: 1 address: 1.2.1.2 example: servers: priority: 3 secret: '12345' port: 56 timeout: 1 address: 1.2.1.2 required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1/show-radius: post: tags: - Radius summary: showradius description: Show radius servers settings operationId: showradius parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: type: object example: {} example: {} required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.6/add-scheduled-backup: post: tags: - Scheduled Backups summary: addscheduledbackup description: Add scheduled backup operationId: addscheduledbackup parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/addscheduledbackuprequest' - example: recurrence: pattern: monthly months: - 2 - 4 - 6 days: - 10 - 15 - 20 - 25 weekdays: - Mon - Wed host: username: username upload-path: /home/admin/ password: secret target: scp ip-address: 172.23.1.209 time: minute: 13 hour: 13 name: test retention-policy: max-num-of-backups: 9999 min-num-of-backups: 1 max-disk-space: 500 example: recurrence: pattern: monthly months: - 2 - 4 - 6 days: - 10 - 15 - 20 - 25 weekdays: - Mon - Wed host: username: username upload-path: /home/admin/ password: secret target: scp ip-address: 172.23.1.209 time: minute: 13 hour: 13 name: test retention-policy: max-num-of-backups: 9999 min-num-of-backups: 1 max-disk-space: 500 required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.6/show-scheduled-backup: post: tags: - Scheduled Backups summary: showscheduledbackup description: Show scheduled backup operationId: showscheduledbackup parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/showphysicalinterfacerequest' - example: name: test example: name: test required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.6/set-scheduled-backup: post: tags: - Scheduled Backups summary: setscheduledbackup description: Set scheduled backup operationId: setscheduledbackup parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/setscheduledbackuprequest' - example: recurrence: pattern: weekly months: - 2 - 4 - 6 days: - 10 - 15 - 20 - 25 weekdays: - Mon - Wed host: username: username password: secret target: mgmt retention-policy: max-num-of-backups: 9999 min-num-of-backups: 1 max-disk-space: 500 name: test time: minute: 15 hour: 15 example: recurrence: pattern: weekly months: - 2 - 4 - 6 days: - 10 - 15 - 20 - 25 weekdays: - Mon - Wed host: username: username password: secret target: mgmt retention-policy: max-num-of-backups: 9999 min-num-of-backups: 1 max-disk-space: 500 name: test time: minute: 15 hour: 15 required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.1/show-scheduled-backups: post: tags: - Scheduled Backups summary: showscheduledbackups description: Show scheduled backups operationId: showscheduledbackups parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: type: object example: {} example: {} required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.1/delete-scheduled-backup: post: tags: - Scheduled Backups summary: deletescheduledbackup description: Delete scheduled backup operationId: deletescheduledbackup parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/showphysicalinterfacerequest' - example: name: test example: name: test required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.4/set-scheduled-snapshot: post: tags: - Scheduled Snapshots summary: setscheduledsnapshot description: Set scheduled snapshot operationId: setscheduledsnapshot parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/setscheduledsnapshotrequest' - example: recurrence: pattern: weekly weekdays: - Mon - Wed time: minute: 30 hour: 13 name-prefix: weeklySnap host: username: username upload-path: /home/admin/ password: secret target: scp ip-address: 172.23.1.209 enabled: true description: weekly example: recurrence: pattern: weekly weekdays: - Mon - Wed time: minute: 30 hour: 13 name-prefix: weeklySnap host: username: username upload-path: /home/admin/ password: secret target: scp ip-address: 172.23.1.209 enabled: true description: weekly required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.4/show-scheduled-snapshot: post: tags: - Scheduled Snapshots summary: showscheduledsnapshot description: Show the snapshot scheduler configuration operationId: showscheduledsnapshot parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: type: object example: {} example: {} required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1/set-hostname: post: tags: - Hostname summary: sethostname description: Setting the hostname of a machine operationId: sethostname parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/showphysicalinterfacerequest' - example: name: new-hostname example: name: new-hostname required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1/show-hostname: post: tags: - Hostname summary: showhostname description: Show hostname settings operationId: showhostname parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: type: object example: {} example: {} required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.6/set-hostname-on-login-page: post: tags: - Messages summary: sethostnameonloginpage description: Enable showing hostname on WebUI login page operationId: sethostnameonloginpage parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/setipv6request' - example: enabled: true example: enabled: true required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.6/set-banner: post: tags: - Messages summary: setbanner description: Change the banner message operationId: setbanner parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/setbannerrequest' - example: message: This is a new banner message enabled: true example: message: This is a new banner message enabled: true required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.6/set-message-of-the-day: post: tags: - Messages summary: setmessageoftheday description: Change the message of the day operationId: setmessageoftheday parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/setbannerrequest' - example: message: Hello today enabled: true example: message: Hello today enabled: true required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.6/show-banner: post: tags: - Messages summary: showbanner description: Show banner message operationId: showbanner parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: type: object example: {} example: {} required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.6/show-message-of-the-day: post: tags: - Messages summary: showmessageoftheday description: Show the message of the day operationId: showmessageoftheday parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: type: object example: {} example: {} required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.6/show-hostname-on-login-page: post: tags: - Messages summary: showhostnameonloginpage description: Status of showing hostname on WebUI login page operationId: showhostnameonloginpage parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: type: object example: {} example: {} required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.2/show-api-versions: post: tags: - 08 System summary: showapiversions description: Shows all the supported API versions, and the current API version (the latest one) operationId: showapiversions parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: type: object example: {} example: {} required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.2/show-diagnostics-topics: post: tags: - 08 System summary: showdiagnosticstopics description: Show Diagnostics topics operationId: showdiagnosticstopics parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: type: object example: {} example: {} required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1/show-version: post: tags: - 08 System summary: showversion description: Show Version operationId: showversion parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: type: object example: {} example: {} required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1/show-asset: post: tags: - 08 System summary: showasset description: Show Asset operationId: showasset parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: type: object example: {} example: {} required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.2/show-diagnostics: post: tags: - 08 System summary: showdiagnostics description: Show diagnostics operationId: showdiagnostics parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/showdiagnosticsrequest' - example: category: os topic: memory example: category: os topic: memory required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.4/set-initial-setup: post: tags: - 08 System summary: setinitialsetup description: Run First Time Wizard configuration operationId: setinitialsetup parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/setinitialsetuprequest' - example: password: user-password security-gateway: dynamically-assigned-ip: false activation-key: aaaa cluster-member: true example: password: user-password security-gateway: dynamically-assigned-ip: false activation-key: aaaa cluster-member: true required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.4/run-reboot: post: tags: - 08 System summary: runreboot description: Reboot machine operation operationId: runreboot parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: type: object example: {} example: {} required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1/set-remote-syslog: post: tags: - Syslog summary: setremotesyslog description: Modify remote system log server configuration operationId: setremotesyslog parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/setremotesyslogrequest' - example: server-ip: 10.11.2.130 level: debug example: server-ip: 10.11.2.130 level: debug required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1/show-syslog: post: tags: - Syslog summary: showsyslog description: Show system log configuration operationId: showsyslog parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: type: object example: {} example: {} required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1/show-remote-syslogs: post: tags: - Syslog summary: showremotesyslogs description: Show all remote system log server operationId: showremotesyslogs parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: type: object example: {} example: {} required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1/add-remote-syslog: post: tags: - Syslog summary: addremotesyslog description: Add remote system log server operationId: addremotesyslog parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/setremotesyslogrequest' - example: server-ip: 10.11.4.134 level: all example: server-ip: 10.11.4.134 level: all required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1/delete-remote-syslog: post: tags: - Syslog summary: deleteremotesyslog description: Delete remote system log server operationId: deleteremotesyslog parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/deleteremotesyslogrequest' - example: server-ip: 10.11.2.130 example: server-ip: 10.11.2.130 required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1/show-remote-syslog: post: tags: - Syslog summary: showremotesyslog description: Show remote system log server configuration operationId: showremotesyslog parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/deleteremotesyslogrequest' - example: server-ip: 10.11.2.130 example: server-ip: 10.11.2.130 required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1/set-syslog: post: tags: - Syslog summary: setsyslog description: Setting system logging configuration operationId: setsyslog parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/setsyslogrequest' - example: send-to-mgmt: false cp-logs: false audit-log: true filename: /var/log/messages example: send-to-mgmt: false cp-logs: false audit-log: true filename: /var/log/messages required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.5/show-snmp-trap-receivers: post: tags: - Trap Receiver summary: showsnmptrapreceivers description: Show all snmp trap receivers operationId: showsnmptrapreceivers parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: type: object example: {} example: {} required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.5/show-snmp-trap-receiver: post: tags: - Trap Receiver summary: showsnmptrapreceiver description: Show snmp trap receiver operationId: showsnmptrapreceiver parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/showsnmptrapreceiverrequest' - example: address: 4.4.4.4 example: address: 4.4.4.4 required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.5/delete-snmp-trap-receiver: post: tags: - Trap Receiver summary: deletesnmptrapreceiver description: Delete snmp trap receiver operationId: deletesnmptrapreceiver parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/showsnmptrapreceiverrequest' - example: address: 4.4.4.5 example: address: 4.4.4.5 required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.5/add-snmp-trap-receiver: post: tags: - Trap Receiver summary: addsnmptrapreceiver description: Add snmp trap receiver operationId: addsnmptrapreceiver parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/addsnmptrapreceiverrequest' - example: community-string: yy version: v2 address: 4.4.4.5 example: community-string: yy version: v2 address: 4.4.4.5 required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.5/set-snmp-trap-receiver: post: tags: - Trap Receiver summary: setsnmptrapreceiver description: Modify snmp trap receiver operationId: setsnmptrapreceiver parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/addsnmptrapreceiverrequest' - example: community-string: yy version: v3 address: 4.4.4.5 example: community-string: yy version: v3 address: 4.4.4.5 required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.5/delete-snmp-user: post: tags: - USM summary: deletesnmpuser description: Delete USM user operationId: deletesnmpuser parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/showphysicalinterfacerequest' - example: name: test5 example: name: test5 required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.5/add-snmp-user: post: tags: - USM summary: addsnmpuser description: Add USM user operationId: addsnmpuser parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/addsnmpuserrequest' - example: allowed-virtual-systems: - 1 - 3 authentication: password: Abcd#123 protocol: SHA256 name: test6 example: allowed-virtual-systems: - 1 - 3 authentication: password: Abcd#123 protocol: SHA256 name: test6 required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.5/show-snmp-user: post: tags: - USM summary: showsnmpuser description: Show USM user operationId: showsnmpuser parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/showphysicalinterfacerequest' - example: name: test2 example: name: test2 required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.5/set-snmp-user: post: tags: - USM summary: setsnmpuser description: Modify USM user operationId: setsnmpuser parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/setsnmpuserrequest' - example: allowed-virtual-systems: all authentication: password: Abcd#123 protocol: SHA256 name: test3 privacy: password: Abcd#123 protocol: AES example: allowed-virtual-systems: all authentication: password: Abcd#123 protocol: SHA256 name: test3 privacy: password: Abcd#123 protocol: AES required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.5/show-snmp-users: post: tags: - USM summary: showsnmpusers description: Show all USM users operationId: showsnmpusers parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: type: object example: {} example: {} required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.5/show-snmp-pre-defined-traps: post: tags: - Pre-defined Trap summary: showsnmppredefinedtraps description: Show pre-defined traps operationId: showsnmppredefinedtraps parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: type: object example: {} example: {} required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.5/set-snmp-pre-defined-traps: post: tags: - Pre-defined Trap summary: setsnmppredefinedtraps description: Set pre-defined traps operationId: setsnmppredefinedtraps parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/setsnmppredefinedtrapsrequest' - example: authorizationError: enabled: true biosFailure: enabled: true coldStart: threshold: 5 reboot-only: false enabled: false example: authorizationError: enabled: true biosFailure: enabled: true coldStart: threshold: 5 reboot-only: false enabled: false required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.5/show-snmp-custom-trap: post: tags: - Custom Trap summary: showsnmpcustomtrap description: Show Custom trap operationId: showsnmpcustomtrap parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/showphysicalinterfacerequest' - example: name: test2 example: name: test2 required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.5/set-snmp-custom-trap: post: tags: - Custom Trap summary: setsnmpcustomtrap description: Modify Custom trap operationId: setsnmpcustomtrap parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/setsnmpcustomtraprequest' - example: name: test oid: 2.16.840.1.113883.3.3190.100 threshold: 4 frequency: 6 operator: greater-than message: Test example: name: test oid: 2.16.840.1.113883.3.3190.100 threshold: 4 frequency: 6 operator: greater-than message: Test required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.5/add-snmp-custom-trap: post: tags: - Custom Trap summary: addsnmpcustomtrap description: Add Custom trap operationId: addsnmpcustomtrap parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/setsnmpcustomtraprequest' - example: name: test2 oid: 2.16.840.1.113883.3.3190.100 threshold: 4 frequency: 2 operator: greater-than message: wer example: name: test2 oid: 2.16.840.1.113883.3.3190.100 threshold: 4 frequency: 2 operator: greater-than message: wer required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.5/show-snmp-custom-traps: post: tags: - Custom Trap summary: showsnmpcustomtraps description: Show all Custom traps operationId: showsnmpcustomtraps parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: type: object example: {} example: {} required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.5/delete-snmp-custom-trap: post: tags: - Custom Trap summary: deletesnmpcustomtrap description: Delete Custom trap operationId: deletesnmpcustomtrap parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/showphysicalinterfacerequest' - example: name: test example: name: test required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.5/show-snmp: post: tags: - 10 Snmp summary: showsnmp description: Show snmp agent configuration operationId: showsnmp parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: type: object example: {} example: {} required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.5/set-snmp: post: tags: - 10 Snmp summary: setsnmp description: Set snmp agent configuration operationId: setsnmp parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/setsnmprequest' - example: version: any pre-defined-traps-settings: polling-frequency: 7 interfaces: add: - eth2 - eth1 read-only-community: '' vsx-settings: sysname: false enabled: true vs-access: direct custom-traps-settings: clear-trap-amount: 4 clear-trap-interval: 6 enabled: true contact: rr location: Tel-Aviv read-write-community: '' trap-usm: testpriv example: version: any pre-defined-traps-settings: polling-frequency: 7 interfaces: add: - eth2 - eth1 read-only-community: '' vsx-settings: sysname: false enabled: true vs-access: direct custom-traps-settings: clear-trap-amount: 4 clear-trap-interval: 6 enabled: true contact: rr location: Tel-Aviv read-write-community: '' trap-usm: testpriv required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.2/show-cluster-state: post: tags: - 11 Cluster summary: showclusterstate description: Show cluster state operationId: showclusterstate parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: type: object example: {} example: {} required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.3/show-custom-intelligence-feeds: post: tags: - Custom Intelligence Feeds summary: showcustomintelligencefeeds description: Prints all existing feeds operationId: showcustomintelligencefeeds parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: type: object example: {} example: {} required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.3/add-custom-intelligence-feed: post: tags: - Custom Intelligence Feeds summary: addcustomintelligencefeed description: Add a new feed operationId: addcustomintelligencefeed parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/addcustomintelligencefeedrequest' - example: protocol: http name: custom_csv_1 url: http://reputation.alienvault.com/reputation.data enabled: true custom-csv-settings: csv-observable-product: anti-virus csv-observable-severity: Critical csv-observable-description: 4 csv-delimiter: '#' csv-observable-value: 1 csv-observable-type: ip action: detect example: protocol: http name: custom_csv_1 url: http://reputation.alienvault.com/reputation.data enabled: true custom-csv-settings: csv-observable-product: anti-virus csv-observable-severity: Critical csv-observable-description: 4 csv-delimiter: '#' csv-observable-value: 1 csv-observable-type: ip action: detect required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.3/show-custom-intelligence-feed: post: tags: - Custom Intelligence Feeds summary: showcustomintelligencefeed description: Show Feed operationId: showcustomintelligencefeed parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/showphysicalinterfacerequest' - example: name: custom_csv_1 example: name: custom_csv_1 required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.3/set-custom-intelligence-interval: post: tags: - Custom Intelligence Feeds summary: setcustomintelligenceinterval description: Check for updates frequency operationId: setcustomintelligenceinterval parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/setcustomintelligenceintervalrequest' - example: interval: 900 example: interval: 900 required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.3/show-custom-intelligence-interval: post: tags: - Custom Intelligence Feeds summary: showcustomintelligenceinterval description: Prints fetching interval operationId: showcustomintelligenceinterval parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: type: object example: {} example: {} required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.3/delete-custom-intelligence-feed: post: tags: - Custom Intelligence Feeds summary: deletecustomintelligencefeed description: Delete an existing feed operationId: deletecustomintelligencefeed parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/showphysicalinterfacerequest' - example: name: custom_csv_1 example: name: custom_csv_1 required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.3/set-custom-intelligence-feed: post: tags: - Custom Intelligence Feeds summary: setcustomintelligencefeed description: Edit existing feed operationId: setcustomintelligencefeed parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/setcustomintelligencefeedrequest' - example: action: detect name: remote_csv_http15 example: action: detect name: remote_csv_http15 required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.6/put-file: post: tags: - 13 Files summary: putfile description: Create new file with content operationId: putfile parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/putfilerequest' - example: override: true text-content: "first line \n second line" file-name: file.txt example: override: true text-content: "first line \n second line" file-name: file.txt required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.3/show-task: post: tags: - 14 Misc. summary: showtask description: Show status of async task operationId: showtask parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/showtaskrequest' - example: task-id: ccc88f8f-ee65-44d2-bdc6-797f8347f6e1 example: task-id: ccc88f8f-ee65-44d2-bdc6-797f8347f6e1 required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.6/run-script: post: tags: - 14 Misc. summary: runscript description: "Running a script on 'expert' mode. Note: don't pass sensitive data on the APIs arguments" operationId: runscript parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/runscriptrequest' - example: script: date > /home/admin/run_script_example;echo Done example: script: date > /home/admin/run_script_example;echo Done required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.4/show-licenses: post: tags: - 15 Licensing summary: showlicenses description: Show attached licenses operationId: showlicenses parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: type: object example: {} example: {} required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.4/add-license: post: tags: - 15 Licensing summary: addlicense description: Add local or central license operationId: addlicense parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/addlicenserequest' - example: license: 192.168.1.2 never aTaaRmuQb-i3ThevQCn-iCpr6F23V-Qf23mgAah cpsg-c-1-50 cpsb-fw cpsb-vpn cpsb-ia cpsb-ips-s1 cpsb-urlf cpsb-apcl-s1 cpsb-av cpsb-aspm CK-6FC44FDDCBE7 example: license: 192.168.1.2 never aTaaRmuQb-i3ThevQCn-iCpr6F23V-Qf23mgAah cpsg-c-1-50 cpsb-fw cpsb-vpn cpsb-ia cpsb-ips-s1 cpsb-urlf cpsb-apcl-s1 cpsb-av cpsb-aspm CK-6FC44FDDCBE7 required: true responses: '200': description: '' headers: {} content: {} deprecated: false /v1.4/del-license: post: tags: - 15 Licensing summary: dellicense description: Delete local or central license. operationId: dellicense parameters: - name: X-chkp-sid in: header description: '' required: true style: simple schema: type: string example: '{{sid}}' requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/dellicenserequest' - example: signature: aTaaRmuQb-i3ThevQCn-iCpr6F23V-Qf23mgAah example: signature: aTaaRmuQb-i3ThevQCn-iCpr6F23V-Qf23mgAah required: true responses: '200': description: '' headers: {} content: {} deprecated: false components: schemas: loginrequest: title: loginrequest required: - password - user type: object properties: password: type: string user: type: string example: password: '{{password}}' user: '{{username}}' setipv6request: title: setipv6request required: - enabled type: object properties: enabled: type: boolean example: enabled: true setpbrrulerequest: title: setpbrrulerequest required: - priority - action - match type: object properties: priority: type: integer format: int32 action: allOf: - $ref: '#/components/schemas/Action' - example: table: mytable unreachable: false main-table: false prohibit: false match: allOf: - $ref: '#/components/schemas/Match' - example: interface: eth1 source: mask-length: 32 address: 1.1.1.1 destination: mask-length: 32 address: 3.3.3.3 protocol: tcp port: 10 example: priority: 1 action: table: mytable unreachable: false main-table: false prohibit: false match: interface: eth1 source: mask-length: 32 address: 1.1.1.1 destination: mask-length: 32 address: 3.3.3.3 protocol: tcp port: 10 Action: title: Action required: - table - unreachable - main-table - prohibit type: object properties: table: type: string unreachable: type: boolean main-table: type: boolean prohibit: type: boolean example: table: mytable unreachable: false main-table: false prohibit: false Match: title: Match required: - interface - source - destination - protocol - port type: object properties: interface: type: string source: allOf: - $ref: '#/components/schemas/Source' - example: mask-length: 32 address: 1.1.1.1 destination: allOf: - $ref: '#/components/schemas/Destination' - example: mask-length: 32 address: 3.3.3.3 protocol: type: string port: type: integer format: int32 example: interface: eth1 source: mask-length: 32 address: 1.1.1.1 destination: mask-length: 32 address: 3.3.3.3 protocol: tcp port: 10 Source: title: Source required: - mask-length - address type: object properties: mask-length: type: integer format: int32 address: type: string example: mask-length: 32 address: 1.1.1.1 Destination: title: Destination required: - mask-length - address type: object properties: mask-length: type: integer format: int32 address: type: string example: mask-length: 32 address: 3.3.3.3 setpbrtablestaticnexthoppriorityrequest: title: setpbrtablestaticnexthoppriorityrequest required: - priority - table - static-address - next-hop-gateway - static-mask-length type: object properties: priority: type: integer format: int32 table: type: string static-address: type: string next-hop-gateway: type: string static-mask-length: type: integer format: int32 example: priority: 3 table: mytable static-address: 1.2.3.0 next-hop-gateway: 1.1.1.1 static-mask-length: 24 showpbrrulesrequest: title: showpbrrulesrequest required: - limit - order - offset type: object properties: limit: type: integer format: int32 order: type: string offset: type: integer format: int32 example: limit: 2 order: DESC offset: 0 deletepbrrulerequest: title: deletepbrrulerequest required: - priority type: object properties: priority: type: integer format: int32 example: priority: 1 setpbrtablerequest: title: setpbrtablerequest required: - table - static-routes type: object properties: table: type: string static-routes: allOf: - $ref: '#/components/schemas/StaticRoutes' - example: add: type: blackhole ping: false mask-length: 24 address: 4.5.6.0 example: table: mytable static-routes: add: type: blackhole ping: false mask-length: 24 address: 4.5.6.0 StaticRoutes: title: StaticRoutes required: - add type: object properties: add: allOf: - $ref: '#/components/schemas/Add' - example: type: blackhole ping: false mask-length: 24 address: 4.5.6.0 example: add: type: blackhole ping: false mask-length: 24 address: 4.5.6.0 Add: title: Add required: - type - ping - mask-length - address type: object properties: type: type: string ping: type: boolean mask-length: type: integer format: int32 address: type: string example: type: blackhole ping: false mask-length: 24 address: 4.5.6.0 showpbrtablerequest: title: showpbrtablerequest required: - table - static-route-offset - static-route-limit - static-route-order type: object properties: table: type: string static-route-offset: type: integer format: int32 static-route-limit: type: integer format: int32 static-route-order: type: string example: table: mytable static-route-offset: 0 static-route-limit: 2 static-route-order: ASC showpbrrulerequest: title: showpbrrulerequest required: - priority type: object properties: priority: type: integer format: int32 example: priority: 1 showpbrtablesrequest: title: showpbrtablesrequest required: - limit - order - offset type: object properties: limit: type: integer format: int32 order: type: string offset: type: integer format: int32 example: limit: 4 order: ASC offset: 1 deletepbrtablerequest: title: deletepbrtablerequest required: - table type: object properties: table: type: string example: table: mytable showstaticroutesrequest: title: showstaticroutesrequest required: - limit - order - offset type: object properties: limit: type: integer format: int32 order: type: string offset: type: integer format: int32 example: limit: 2 order: DESC offset: 0 setstaticroutenexthoppriorityrequest: title: setstaticroutenexthoppriorityrequest required: - priority - next-hop-gateway - mask-length - address type: object properties: priority: type: integer format: int32 next-hop-gateway: type: string mask-length: type: integer format: int32 address: type: string example: priority: 3 next-hop-gateway: 1.1.1.1 mask-length: 24 address: 1.2.3.0 setstaticrouterequest: title: setstaticrouterequest required: - comment - rank - mask-length - address - next-hop - type type: object properties: comment: type: string rank: type: integer format: int32 mask-length: type: integer format: int32 address: type: string next-hop: allOf: - $ref: '#/components/schemas/NextHop' - example: add: priority: 2 gateway: 1.1.1.1 type: type: string example: comment: hello rank: 25 mask-length: 24 address: 1.2.3.0 next-hop: add: priority: 2 gateway: 1.1.1.1 type: gateway NextHop: title: NextHop required: - add type: object properties: add: allOf: - $ref: '#/components/schemas/Add1' - example: priority: 2 gateway: 1.1.1.1 example: add: priority: 2 gateway: 1.1.1.1 Add1: title: Add1 required: - priority - gateway type: object properties: priority: type: integer format: int32 gateway: type: string example: priority: 2 gateway: 1.1.1.1 showstaticrouterequest: title: showstaticrouterequest required: - mask-length - address type: object properties: mask-length: type: integer format: int32 address: type: string example: mask-length: 24 address: 1.2.3.0 deletestaticrouterequest: title: deletestaticrouterequest required: - mask-length - address type: object properties: mask-length: type: integer format: int32 address: type: string example: mask-length: 24 address: 1.2.3.0 showroutesaggregaterequest: title: showroutesaggregaterequest required: - limit - order - offset type: object properties: limit: type: integer format: int32 order: type: string offset: type: integer format: int32 example: limit: 1 order: DESC offset: 0 showroutesstaticrequest: title: showroutesstaticrequest required: - limit - order - offset type: object properties: limit: type: integer format: int32 order: type: string offset: type: integer format: int32 example: limit: 1 order: DESC offset: 0 showroutesrequest: title: showroutesrequest required: - limit - order - offset type: object properties: limit: type: integer format: int32 order: type: string offset: type: integer format: int32 example: limit: 1 order: DESC offset: 0 showroutesdirectrequest: title: showroutesdirectrequest required: - limit - order - offset type: object properties: limit: type: integer format: int32 order: type: string offset: type: integer format: int32 example: limit: 1 order: DESC offset: 0 showroutesbgprequest: title: showroutesbgprequest required: - limit - order - offset type: object properties: limit: type: integer format: int32 order: type: string offset: type: integer format: int32 example: limit: 1 order: DESC offset: 0 showrouteskernelrequest: title: showrouteskernelrequest required: - limit - order - offset type: object properties: limit: type: integer format: int32 order: type: string offset: type: integer format: int32 example: limit: 1 order: DESC offset: 0 showroutesospfrequest: title: showroutesospfrequest required: - limit - order - offset type: object properties: limit: type: integer format: int32 order: type: string offset: type: integer format: int32 example: limit: 1 order: DESC offset: 0 showroutesriprequest: title: showroutesriprequest required: - limit - order - offset type: object properties: limit: type: integer format: int32 order: type: string offset: type: integer format: int32 example: limit: 1 order: DESC offset: 0 setproxyrequest: title: setproxyrequest required: - port - address type: object properties: port: type: string address: type: string example: port: '89' address: 1.1.1.1 setntprequest: title: setntprequest required: - enabled - servers type: object properties: enabled: type: boolean servers: type: array items: $ref: '#/components/schemas/Server' description: '' example: enabled: true servers: - version: '3' type: primary address: 4.4.4.4 - version: 4 type: secondary address: 2.2.2.2 Server: title: Server required: - version - type - address type: object properties: version: oneOf: - type: string - type: integer format: int32 type: type: string address: type: string example: version: '3' type: primary address: 4.4.4.4 settimeanddaterequest: title: settimeanddaterequest required: - date - timezone - time type: object properties: date: type: string timezone: type: string time: type: string example: date: 2019-07-22 timezone: Asia / Jerusalem time: 16:32:56 setdhcpserverrequest: title: setdhcpserverrequest required: - subnets - enabled type: object properties: subnets: type: array items: $ref: '#/components/schemas/Subnet' description: '' enabled: type: boolean example: subnets: - subnet: 4.5.6.0 netmask: 24 dns: domain-name: my-domain-name primary: 8.8.8.8 tertiary: 8.8.4.4 secondary: 8.8.8.8 default-gateway: 4.5.6.1 max-lease: 86400 default-lease: 43200 enabled: true ip-pools: - start: 4.5.6.5 include: include end: 4.5.6.7 enabled: true enabled: false Subnet: title: Subnet required: - subnet - netmask - dns - default-gateway - max-lease - default-lease - enabled - ip-pools type: object properties: subnet: type: string netmask: type: integer format: int32 dns: allOf: - $ref: '#/components/schemas/Dns' - example: domain-name: my-domain-name primary: 8.8.8.8 tertiary: 8.8.4.4 secondary: 8.8.8.8 default-gateway: type: string max-lease: type: integer format: int32 default-lease: type: integer format: int32 enabled: type: boolean ip-pools: type: array items: $ref: '#/components/schemas/IpPool' description: '' example: subnet: 4.5.6.0 netmask: 24 dns: domain-name: my-domain-name primary: 8.8.8.8 tertiary: 8.8.4.4 secondary: 8.8.8.8 default-gateway: 4.5.6.1 max-lease: 86400 default-lease: 43200 enabled: true ip-pools: - start: 4.5.6.5 include: include end: 4.5.6.7 enabled: true Dns: title: Dns required: - domain-name - primary - tertiary - secondary type: object properties: domain-name: type: string primary: type: string tertiary: type: string secondary: type: string example: domain-name: my-domain-name primary: 8.8.8.8 tertiary: 8.8.4.4 secondary: 8.8.8.8 IpPool: title: IpPool required: - start - include - end - enabled type: object properties: start: type: string include: type: string end: type: string enabled: type: boolean example: start: 4.5.6.5 include: include end: 4.5.6.7 enabled: true setdnsrequest: title: setdnsrequest required: - suffix - primary - tertiary - secondary type: object properties: suffix: type: string primary: type: string tertiary: type: string secondary: type: string example: suffix: checkpoint.com primary: 1.2.3.4 tertiary: 3.4.5.6 secondary: 2.3.4.5 setphysicalinterfacerequest: title: setphysicalinterfacerequest required: - enabled - name - comments type: object properties: enabled: type: boolean name: type: string comments: type: string example: enabled: true name: eth0 comments: eth0 interface showphysicalinterfacerequest: title: showphysicalinterfacerequest required: - name type: object properties: name: type: string example: name: eth0 showgreinterfacerequest: title: showgreinterfacerequest required: - name type: object properties: name: type: string example: name: gre3 deletegreinterfacerequest: title: deletegreinterfacerequest required: - name type: object properties: name: type: string example: name: gre3 setgreinterfacerequest: title: setgreinterfacerequest required: - enabled - name type: object properties: enabled: type: boolean name: type: string example: enabled: true name: gre3 addgreinterfacerequest: title: addgreinterfacerequest required: - comments - local-ip-address - ttl - gre-id - ipv4-address - peer-address - remote-ip-address - ipv4-mask-length type: object properties: comments: type: string local-ip-address: type: string ttl: type: integer format: int32 gre-id: type: integer format: int32 ipv4-address: type: string peer-address: type: string remote-ip-address: type: string ipv4-mask-length: type: integer format: int32 example: comments: test comment local-ip-address: 10.10.2.8 ttl: 255 gre-id: 3 ipv4-address: 10.10.3.2 peer-address: 10.10.4.2 remote-ip-address: 10.10.2.9 ipv4-mask-length: 24 deletebondinterfacerequest: title: deletebondinterfacerequest required: - name type: object properties: name: type: string example: name: bond5 setbondinterfacerequest: title: setbondinterfacerequest required: - lacp-rate - name - mode type: object properties: lacp-rate: type: string name: type: string mode: type: string example: lacp-rate: slow name: bond5 mode: 8023AD showbondinterfacerequest: title: showbondinterfacerequest required: - name type: object properties: name: type: string example: name: bond5 addbondinterfacerequest: title: addbondinterfacerequest required: - id - mode type: object properties: id: type: integer format: int32 mode: type: string example: id: 5 mode: xor addloopbackinterfacerequest: title: addloopbackinterfacerequest required: - ipv4-address - ipv4-mask-length type: object properties: ipv4-address: type: string ipv4-mask-length: type: integer format: int32 example: ipv4-address: 1.1.1.1 ipv4-mask-length: 24 showloopbackinterfacerequest: title: showloopbackinterfacerequest required: - name type: object properties: name: type: string example: name: loop00 setloopbackinterfacerequest: title: setloopbackinterfacerequest required: - enabled - name type: object properties: enabled: type: boolean name: type: string example: enabled: true name: loop00 deleteloopbackinterfacerequest: title: deleteloopbackinterfacerequest required: - name type: object properties: name: type: string example: name: loop00 deletealiasinterfacerequest: title: deletealiasinterfacerequest required: - name type: object properties: name: type: string example: name: eth0:1 showaliasinterfacerequest: title: showaliasinterfacerequest required: - name type: object properties: name: type: string example: name: eth0:1 addaliasinterfacerequest: title: addaliasinterfacerequest required: - ipv4-address - parent - ipv4-mask-length type: object properties: ipv4-address: type: string parent: type: string ipv4-mask-length: type: integer format: int32 example: ipv4-address: 15.15.15.15 parent: eth0 ipv4-mask-length: 24 setbridgeinterfacerequest: title: setbridgeinterfacerequest required: - name - comments type: object properties: name: type: string comments: type: string example: name: br9 comments: Bridge9 showbridgeinterfacerequest: title: showbridgeinterfacerequest required: - name type: object properties: name: type: string example: name: br9 deletebridgeinterfacerequest: title: deletebridgeinterfacerequest required: - name type: object properties: name: type: string example: name: br9 addbridgeinterfacerequest: title: addbridgeinterfacerequest required: - id type: object properties: id: type: integer format: int32 example: id: 9 addvlaninterfacerequest: title: addvlaninterfacerequest required: - id - parent type: object properties: id: type: integer format: int32 parent: type: string example: id: 2 parent: eth0 setvlaninterfacerequest: title: setvlaninterfacerequest required: - enabled - name type: object properties: enabled: type: boolean name: type: string example: enabled: true name: eth0.2 deletevlaninterfacerequest: title: deletevlaninterfacerequest required: - name type: object properties: name: type: string example: name: eth0.2 showvlaninterfacerequest: title: showvlaninterfacerequest required: - name type: object properties: name: type: string example: name: eth0.2 addvxlaninterfacerequest: title: addvxlaninterfacerequest required: - destination-port - member-of - vxlan-id - remote-ip-address type: object properties: destination-port: type: integer format: int32 member-of: type: string vxlan-id: type: integer format: int32 remote-ip-address: type: string example: destination-port: 4789 member-of: eth0 vxlan-id: 600 remote-ip-address: 1.1.1.1 showvxlaninterfacerequest: title: showvxlaninterfacerequest required: - name type: object properties: name: type: string example: name: vxlan200 setvxlaninterfacerequest: title: setvxlaninterfacerequest required: - name - comments type: object properties: name: type: string comments: type: string example: name: vxlan500 comments: vxlan500 deletevxlaninterfacerequest: title: deletevxlaninterfacerequest required: - name type: object properties: name: type: string example: name: vxlan600 showinterfacerequest: title: showinterfacerequest required: - name type: object properties: name: type: string example: name: eth0 addsystemgrouprequest: title: addsystemgrouprequest required: - gid - name - users type: object properties: gid: type: string name: type: string users: type: array items: type: string description: '' example: gid: '1000' name: financeGroup users: - John - Chris - Olivia setsystemgrouprequest: title: setsystemgrouprequest required: - gid - name - users type: object properties: gid: type: string name: type: string users: type: array items: type: string description: '' example: gid: '2000' name: financeGroup users: - John - Emily showsystemgrouprequest: title: showsystemgrouprequest required: - name type: object properties: name: type: string example: name: financeGroup deletesystemgrouprequest: title: deletesystemgrouprequest required: - name type: object properties: name: type: string example: name: financeGroup adduserrequest: title: adduserrequest required: - roles - password - name - secondary-system-groups - shell - primary-system-group-id - allow-access-using - homedir - uid type: object properties: roles: type: string password: type: string name: type: string secondary-system-groups: type: array items: type: string description: '' shell: type: string primary-system-group-id: type: integer format: int32 allow-access-using: type: array items: type: string description: '' homedir: type: string uid: type: integer format: int32 example: roles: monitorRole password: 12345abcde name: myusername secondary-system-groups: - users shell: cli primary-system-group-id: 50 allow-access-using: - CLI - Web-UI homedir: /home/myusername uid: 1000 setuserrequest: title: setuserrequest required: - shell - name - must-change-password - allow-access-using - primary-system-group-id - uid type: object properties: shell: type: string name: type: string must-change-password: type: boolean allow-access-using: type: array items: type: string description: '' primary-system-group-id: type: integer format: int32 uid: type: integer format: int32 example: shell: no-login name: myusername must-change-password: true allow-access-using: - CLI primary-system-group-id: 60 uid: 2000 deleteuserrequest: title: deleteuserrequest required: - name type: object properties: name: type: string example: name: myusername showuserrequest: title: showuserrequest required: - name type: object properties: name: type: string example: name: myusername setallowedclientsrequest: title: setallowedclientsrequest required: - allowed-networks type: object properties: allowed-networks: type: array items: $ref: '#/components/schemas/AllowedNetwork' description: '' example: allowed-networks: - subnet: 44.4.44.0 mask-length: 24 - subnet: 55.4.55.0 mask-length: 24 AllowedNetwork: title: AllowedNetwork required: - subnet - mask-length type: object properties: subnet: type: string mask-length: type: integer format: int32 example: subnet: 44.4.44.0 mask-length: 24 settacacsrequest: title: settacacsrequest required: - servers type: object properties: servers: allOf: - $ref: '#/components/schemas/Servers' - example: priority: 3 secret: '56' timeout: 1 address: 1.2.1.2 example: servers: priority: 3 secret: '56' timeout: 1 address: 1.2.1.2 Servers: title: Servers required: - priority - secret - timeout - address type: object properties: priority: type: integer format: int32 secret: type: string timeout: type: integer format: int32 address: type: string example: priority: 3 secret: '56' timeout: 1 address: 1.2.1.2 setradiusrequest: title: setradiusrequest required: - servers type: object properties: servers: allOf: - $ref: '#/components/schemas/Servers1' - example: priority: 3 secret: '12345' port: 56 timeout: 1 address: 1.2.1.2 example: servers: priority: 3 secret: '12345' port: 56 timeout: 1 address: 1.2.1.2 Servers1: title: Servers1 required: - priority - secret - port - timeout - address type: object properties: priority: type: integer format: int32 secret: type: string port: type: integer format: int32 timeout: type: integer format: int32 address: type: string example: priority: 3 secret: '12345' port: 56 timeout: 1 address: 1.2.1.2 addscheduledbackuprequest: title: addscheduledbackuprequest required: - recurrence - host - time - name - retention-policy type: object properties: recurrence: allOf: - $ref: '#/components/schemas/Recurrence' - example: pattern: monthly months: - 2 - 4 - 6 days: - 10 - 15 - 20 - 25 weekdays: - Mon - Wed host: allOf: - $ref: '#/components/schemas/Host' - example: username: username upload-path: /home/admin/ password: secret target: scp ip-address: 172.23.1.209 time: allOf: - $ref: '#/components/schemas/Time' - example: minute: 13 hour: 13 name: type: string retention-policy: allOf: - $ref: '#/components/schemas/RetentionPolicy' - example: max-num-of-backups: 9999 min-num-of-backups: 1 max-disk-space: 500 example: recurrence: pattern: monthly months: - 2 - 4 - 6 days: - 10 - 15 - 20 - 25 weekdays: - Mon - Wed host: username: username upload-path: /home/admin/ password: secret target: scp ip-address: 172.23.1.209 time: minute: 13 hour: 13 name: test retention-policy: max-num-of-backups: 9999 min-num-of-backups: 1 max-disk-space: 500 Recurrence: title: Recurrence required: - pattern - months - days - weekdays type: object properties: pattern: type: string months: type: array items: type: integer format: int32 description: '' days: type: array items: type: integer format: int32 description: '' weekdays: type: array items: type: string description: '' example: pattern: monthly months: - 2 - 4 - 6 days: - 10 - 15 - 20 - 25 weekdays: - Mon - Wed Host: title: Host required: - username - upload-path - password - target - ip-address type: object properties: username: type: string upload-path: type: string password: type: string target: type: string ip-address: type: string example: username: username upload-path: /home/admin/ password: secret target: scp ip-address: 172.23.1.209 Time: title: Time required: - minute - hour type: object properties: minute: type: integer format: int32 hour: type: integer format: int32 example: minute: 13 hour: 13 RetentionPolicy: title: RetentionPolicy required: - max-num-of-backups - min-num-of-backups - max-disk-space type: object properties: max-num-of-backups: type: integer format: int32 min-num-of-backups: type: integer format: int32 max-disk-space: type: integer format: int32 example: max-num-of-backups: 9999 min-num-of-backups: 1 max-disk-space: 500 showscheduledbackuprequest: title: showscheduledbackuprequest required: - name type: object properties: name: type: string example: name: test setscheduledbackuprequest: title: setscheduledbackuprequest required: - recurrence - host - retention-policy - name - time type: object properties: recurrence: allOf: - $ref: '#/components/schemas/Recurrence' - example: pattern: monthly months: - 2 - 4 - 6 days: - 10 - 15 - 20 - 25 weekdays: - Mon - Wed host: allOf: - $ref: '#/components/schemas/Host1' - example: username: username password: secret target: mgmt retention-policy: allOf: - $ref: '#/components/schemas/RetentionPolicy' - example: max-num-of-backups: 9999 min-num-of-backups: 1 max-disk-space: 500 name: type: string time: allOf: - $ref: '#/components/schemas/Time' - example: minute: 13 hour: 13 example: recurrence: pattern: weekly months: - 2 - 4 - 6 days: - 10 - 15 - 20 - 25 weekdays: - Mon - Wed host: username: username password: secret target: mgmt retention-policy: max-num-of-backups: 9999 min-num-of-backups: 1 max-disk-space: 500 name: test time: minute: 15 hour: 15 Host1: title: Host1 required: - username - password - target type: object properties: username: type: string password: type: string target: type: string example: username: username password: secret target: mgmt deletescheduledbackuprequest: title: deletescheduledbackuprequest required: - name type: object properties: name: type: string example: name: test setscheduledsnapshotrequest: title: setscheduledsnapshotrequest required: - recurrence - name-prefix - host - enabled - description type: object properties: recurrence: allOf: - $ref: '#/components/schemas/Recurrence2' - example: pattern: weekly weekdays: - Mon - Wed time: minute: 30 hour: 13 name-prefix: type: string host: allOf: - $ref: '#/components/schemas/Host' - example: username: username upload-path: /home/admin/ password: secret target: scp ip-address: 172.23.1.209 enabled: type: boolean description: type: string example: recurrence: pattern: weekly weekdays: - Mon - Wed time: minute: 30 hour: 13 name-prefix: weeklySnap host: username: username upload-path: /home/admin/ password: secret target: scp ip-address: 172.23.1.209 enabled: true description: weekly Recurrence2: title: Recurrence2 required: - pattern - weekdays - time type: object properties: pattern: type: string weekdays: type: array items: type: string description: '' time: allOf: - $ref: '#/components/schemas/Time' - example: minute: 13 hour: 13 example: pattern: weekly weekdays: - Mon - Wed time: minute: 30 hour: 13 sethostnamerequest: title: sethostnamerequest required: - name type: object properties: name: type: string example: name: new-hostname sethostnameonloginpagerequest: title: sethostnameonloginpagerequest required: - enabled type: object properties: enabled: type: boolean example: enabled: true setbannerrequest: title: setbannerrequest required: - message - enabled type: object properties: message: type: string enabled: type: boolean example: message: This is a new banner message enabled: true setmessageofthedayrequest: title: setmessageofthedayrequest required: - message - enabled type: object properties: message: type: string enabled: type: boolean example: message: Hello today enabled: true showdiagnosticsrequest: title: showdiagnosticsrequest required: - category - topic type: object properties: category: type: string topic: type: string example: category: os topic: memory setinitialsetuprequest: title: setinitialsetuprequest required: - password - security-gateway type: object properties: password: type: string security-gateway: allOf: - $ref: '#/components/schemas/SecurityGateway' - example: dynamically-assigned-ip: false activation-key: aaaa cluster-member: true example: password: user-password security-gateway: dynamically-assigned-ip: false activation-key: aaaa cluster-member: true SecurityGateway: title: SecurityGateway required: - dynamically-assigned-ip - activation-key - cluster-member type: object properties: dynamically-assigned-ip: type: boolean activation-key: type: string cluster-member: type: boolean example: dynamically-assigned-ip: false activation-key: aaaa cluster-member: true setremotesyslogrequest: title: setremotesyslogrequest required: - server-ip - level type: object properties: server-ip: type: string level: type: string example: server-ip: 10.11.2.130 level: debug addremotesyslogrequest: title: addremotesyslogrequest required: - server-ip - level type: object properties: server-ip: type: string level: type: string example: server-ip: 10.11.4.134 level: all deleteremotesyslogrequest: title: deleteremotesyslogrequest required: - server-ip type: object properties: server-ip: type: string example: server-ip: 10.11.2.130 showremotesyslogrequest: title: showremotesyslogrequest required: - server-ip type: object properties: server-ip: type: string example: server-ip: 10.11.2.130 setsyslogrequest: title: setsyslogrequest required: - send-to-mgmt - cp-logs - audit-log - filename type: object properties: send-to-mgmt: type: boolean cp-logs: type: boolean audit-log: type: boolean filename: type: string example: send-to-mgmt: false cp-logs: false audit-log: true filename: /var/log/messages showsnmptrapreceiverrequest: title: showsnmptrapreceiverrequest required: - address type: object properties: address: type: string example: address: 4.4.4.4 deletesnmptrapreceiverrequest: title: deletesnmptrapreceiverrequest required: - address type: object properties: address: type: string example: address: 4.4.4.5 addsnmptrapreceiverrequest: title: addsnmptrapreceiverrequest required: - community-string - version - address type: object properties: community-string: type: string version: type: string address: type: string example: community-string: yy version: v2 address: 4.4.4.5 setsnmptrapreceiverrequest: title: setsnmptrapreceiverrequest required: - community-string - version - address type: object properties: community-string: type: string version: type: string address: type: string example: community-string: yy version: v3 address: 4.4.4.5 deletesnmpuserrequest: title: deletesnmpuserrequest required: - name type: object properties: name: type: string example: name: test5 addsnmpuserrequest: title: addsnmpuserrequest required: - allowed-virtual-systems - authentication - name type: object properties: allowed-virtual-systems: type: array items: type: integer format: int32 description: '' authentication: allOf: - $ref: '#/components/schemas/Authentication' - example: password: Abcd#123 protocol: SHA256 name: type: string example: allowed-virtual-systems: - 1 - 3 authentication: password: Abcd#123 protocol: SHA256 name: test6 Authentication: title: Authentication required: - password - protocol type: object properties: password: type: string protocol: type: string example: password: Abcd#123 protocol: SHA256 showsnmpuserrequest: title: showsnmpuserrequest required: - name type: object properties: name: type: string example: name: test2 setsnmpuserrequest: title: setsnmpuserrequest required: - allowed-virtual-systems - authentication - name - privacy type: object properties: allowed-virtual-systems: type: string authentication: allOf: - $ref: '#/components/schemas/Authentication' - example: password: Abcd#123 protocol: SHA256 name: type: string privacy: allOf: - $ref: '#/components/schemas/Privacy' - example: password: Abcd#123 protocol: AES example: allowed-virtual-systems: all authentication: password: Abcd#123 protocol: SHA256 name: test3 privacy: password: Abcd#123 protocol: AES Privacy: title: Privacy required: - password - protocol type: object properties: password: type: string protocol: type: string example: password: Abcd#123 protocol: AES setsnmppredefinedtrapsrequest: title: setsnmppredefinedtrapsrequest required: - authorizationError - biosFailure - coldStart type: object properties: authorizationError: allOf: - $ref: '#/components/schemas/AuthorizationError' - example: enabled: true biosFailure: allOf: - $ref: '#/components/schemas/BiosFailure' - example: enabled: true coldStart: allOf: - $ref: '#/components/schemas/ColdStart' - example: threshold: 5 reboot-only: false enabled: false example: authorizationError: enabled: true biosFailure: enabled: true coldStart: threshold: 5 reboot-only: false enabled: false AuthorizationError: title: AuthorizationError required: - enabled type: object properties: enabled: type: boolean example: enabled: true BiosFailure: title: BiosFailure required: - enabled type: object properties: enabled: type: boolean example: enabled: true ColdStart: title: ColdStart required: - threshold - reboot-only - enabled type: object properties: threshold: type: integer format: int32 reboot-only: type: boolean enabled: type: boolean example: threshold: 5 reboot-only: false enabled: false showsnmpcustomtraprequest: title: showsnmpcustomtraprequest required: - name type: object properties: name: type: string example: name: test2 setsnmpcustomtraprequest: title: setsnmpcustomtraprequest required: - name - oid - threshold - frequency - operator - message type: object properties: name: type: string oid: type: string threshold: type: integer format: int32 frequency: type: integer format: int32 operator: type: string message: type: string example: name: test oid: 2.16.840.1.113883.3.3190.100 threshold: 4 frequency: 6 operator: greater-than message: Test addsnmpcustomtraprequest: title: addsnmpcustomtraprequest required: - name - oid - threshold - frequency - operator - message type: object properties: name: type: string oid: type: string threshold: type: integer format: int32 frequency: type: integer format: int32 operator: type: string message: type: string example: name: test2 oid: 2.16.840.1.113883.3.3190.100 threshold: 4 frequency: 2 operator: greater-than message: wer deletesnmpcustomtraprequest: title: deletesnmpcustomtraprequest required: - name type: object properties: name: type: string example: name: test setsnmprequest: title: setsnmprequest required: - version - pre-defined-traps-settings - interfaces - read-only-community - vsx-settings - custom-traps-settings - enabled - contact - location - read-write-community - trap-usm type: object properties: version: type: string pre-defined-traps-settings: allOf: - $ref: '#/components/schemas/PreDefinedTrapsSettings' - example: polling-frequency: 7 interfaces: allOf: - $ref: '#/components/schemas/Interfaces' - example: add: - eth2 - eth1 read-only-community: type: string vsx-settings: allOf: - $ref: '#/components/schemas/VsxSettings' - example: sysname: false enabled: true vs-access: direct custom-traps-settings: allOf: - $ref: '#/components/schemas/CustomTrapsSettings' - example: clear-trap-amount: 4 clear-trap-interval: 6 enabled: type: boolean contact: type: string location: type: string read-write-community: type: string trap-usm: type: string example: version: any pre-defined-traps-settings: polling-frequency: 7 interfaces: add: - eth2 - eth1 read-only-community: '' vsx-settings: sysname: false enabled: true vs-access: direct custom-traps-settings: clear-trap-amount: 4 clear-trap-interval: 6 enabled: true contact: rr location: Tel-Aviv read-write-community: '' trap-usm: testpriv PreDefinedTrapsSettings: title: PreDefinedTrapsSettings required: - polling-frequency type: object properties: polling-frequency: type: integer format: int32 example: polling-frequency: 7 Interfaces: title: Interfaces required: - add type: object properties: add: type: array items: type: string description: '' example: add: - eth2 - eth1 VsxSettings: title: VsxSettings required: - sysname - enabled - vs-access type: object properties: sysname: type: boolean enabled: type: boolean vs-access: type: string example: sysname: false enabled: true vs-access: direct CustomTrapsSettings: title: CustomTrapsSettings required: - clear-trap-amount - clear-trap-interval type: object properties: clear-trap-amount: type: integer format: int32 clear-trap-interval: type: integer format: int32 example: clear-trap-amount: 4 clear-trap-interval: 6 addcustomintelligencefeedrequest: title: addcustomintelligencefeedrequest required: - protocol - name - url - enabled - custom-csv-settings - action type: object properties: protocol: type: string name: type: string url: type: string enabled: type: boolean custom-csv-settings: allOf: - $ref: '#/components/schemas/CustomCsvSettings' - example: csv-observable-product: anti-virus csv-observable-severity: Critical csv-observable-description: 4 csv-delimiter: '#' csv-observable-value: 1 csv-observable-type: ip action: type: string example: protocol: http name: custom_csv_1 url: http://reputation.alienvault.com/reputation.data enabled: true custom-csv-settings: csv-observable-product: anti-virus csv-observable-severity: Critical csv-observable-description: 4 csv-delimiter: '#' csv-observable-value: 1 csv-observable-type: ip action: detect CustomCsvSettings: title: CustomCsvSettings required: - csv-observable-product - csv-observable-severity - csv-observable-description - csv-delimiter - csv-observable-value - csv-observable-type type: object properties: csv-observable-product: type: string csv-observable-severity: type: string csv-observable-description: type: integer format: int32 csv-delimiter: type: string csv-observable-value: type: integer format: int32 csv-observable-type: type: string example: csv-observable-product: anti-virus csv-observable-severity: Critical csv-observable-description: 4 csv-delimiter: '#' csv-observable-value: 1 csv-observable-type: ip showcustomintelligencefeedrequest: title: showcustomintelligencefeedrequest required: - name type: object properties: name: type: string example: name: custom_csv_1 setcustomintelligenceintervalrequest: title: setcustomintelligenceintervalrequest required: - interval type: object properties: interval: type: integer format: int32 example: interval: 900 deletecustomintelligencefeedrequest: title: deletecustomintelligencefeedrequest required: - name type: object properties: name: type: string example: name: custom_csv_1 setcustomintelligencefeedrequest: title: setcustomintelligencefeedrequest required: - action - name type: object properties: action: type: string name: type: string example: action: detect name: remote_csv_http15 putfilerequest: title: putfilerequest required: - override - text-content - file-name type: object properties: override: type: boolean text-content: type: string file-name: type: string example: override: true text-content: "first line \n second line" file-name: file.txt showtaskrequest: title: showtaskrequest required: - task-id type: object properties: task-id: type: string example: task-id: ccc88f8f-ee65-44d2-bdc6-797f8347f6e1 runscriptrequest: title: runscriptrequest required: - script type: object properties: script: type: string example: script: date > /home/admin/run_script_example;echo Done addlicenserequest: title: addlicenserequest required: - license type: object properties: license: type: string example: license: 192.168.1.2 never aTaaRmuQb-i3ThevQCn-iCpr6F23V-Qf23mgAah cpsg-c-1-50 cpsb-fw cpsb-vpn cpsb-ia cpsb-ips-s1 cpsb-urlf cpsb-apcl-s1 cpsb-av cpsb-aspm CK-6FC44FDDCBE7 dellicenserequest: title: dellicenserequest required: - signature type: object properties: signature: type: string example: signature: aTaaRmuQb-i3ThevQCn-iCpr6F23V-Qf23mgAah tags: - name: 01 Session Management - name: IPv6 - name: Policy Based Routing - name: Static Routes - name: Routes - name: Proxy - name: Date and Time - name: DHCP - name: DNS - name: Physical Interfaces - name: GRE Interfaces - name: Bond Interfaces - name: Loopback Interfaces - name: Alias Interface - name: Bridge Interface - name: Vlan Interface - name: Vxlan Interface - name: 04 Interfaces - name: Groups - name: Users - name: 06 Allowed Clients - name: Tacacs - name: Radius - name: Scheduled Backups - name: Scheduled Snapshots - name: Hostname - name: Messages - name: 08 System - name: Syslog - name: Trap Receiver - name: USM - name: Pre-defined Trap - name: Custom Trap - name: 10 Snmp - name: 11 Cluster - name: Custom Intelligence Feeds - name: 13 Files - name: 14 Misc. - name: 15 Licensing