Fortinet Document Library

Version:


Table of Contents

ScreenShotMachine

1.0.0
Copy Link

About the connector

ScreenshotMachine provides a service to create screenshot or thumbnail of any online web page in a couple of seconds, using your phone, tablet, or desktop. For more information, see the ScreenshotMachine website.

This document provides information about the ScreenShot Machine connector, which facilitates automated interactions, with a ScreenshotMachine server using FortiSOAR™ playbooks. Add the Screenshot Machine connector as a step in FortiSOAR™ playbooks and perform automated operations, such as automatically taking a screenshot for a specified web page and storing that screenshot in the FortiSOAR™ attachment module.

 

Version information

Connector Version: 1.0.0

Compatibility with FortiSOAR™ Versions: 4.9.0.0-708 and later

 

Installing the connector

For the procedure to install a connector, click here.

 

Prerequisites to configuring the connector

  • You must have the IP address or Hostname of the ScreenshotMachine server to which you will connect and perform the automated operations and credentials to access that server.
  • To access the FortiSOAR™ UI, ensure that port 443 is open through the firewall for the FortiSOAR™ instance.

 

Configuring the connector

For the procedure to configure a connector, click here.

 

Configuration parameters

In FortiSOAR™, on the Connectors page, select the ScreenShot Machine connector and click Configure to configure the following parameters:

 

Parameter Description
Server URL URL of ScreenShotMachine server to which you will connect and perform the automated operations.
Protocol Protocol, such as http or https, that is used to connect to the ScreenShotMachine server.
API Key API Key used to access the ScreenshotMachine API.
Secret Phrase Secret Phrase that you configure while creating your ScreenShotMachine account. If you set your secret phrase then all requests with missing or incorrect hash parameter are ignored.
Verify SSL Specifies whether the SSL certificate for the server is to be verified or not.
By default, this option is set as True.

 

 

Actions supported by the connector

The following automated operations can be included in playbooks:

  • Get Screenshot: Takes a screenshot of the web page you have specified and stores that screenshot in the FortiSOAR™ Attachment module.

operation: Get Screenshot

Input parameters

 

Parameter Description
URL URL of the web page whose screenshot you want to capture.
Format Format in which you want to capture the thumbnail or screenshot. By default, the screenshot is stored in the .jpg format.
Available formats are .jpg, .png, or .gif formats.
Device Device that you are going to use to capture the web page. Available device options are Desktop, Phone, or Tablet.
Dimension Size of the thumbnail or screenshot that you want to capture in the format [width]x[height].
Dimensions are specified in pixels (px).
CacheLimit Number of days within which cached images are accepted. By default, images are used from cache only if it not older than 14 days.
Examples:
CacheLimit=0 : Never use cache, always download fresh screenshot.
CacheLimit=1 : Use image from cache only if is not older than 1 day.
Timeout Time in milliseconds after which the capturing engine will create the screenshot. By default, the capturing engine waits 200 milliseconds before capturing the screenshot.

 

Output

The output contains the screenshot of the web page that you have specified. The screenshot is stored in the FortiSOAR™ Attachment module as a new attachment in the image format you have specified. For example, if you have chosen .png as the image format, then the screenshot is saved as an attachment in the .png format in the FortiSOAR™ Attachment module.

Following image displays a sample output:

 

Sample output of the Get Screenshot operation

 

Included playbooks

 

The Sample - ScreenShot Machine - 1.0.0 playbook collection comes bundled with the ScreenShot Machine connector. This playbook contains steps using which you can perform all supported actions. You can see the bundled playbooks in the Automation > Playbooks section in FortiSOAR™ after importing the ScreenShot Machine connector.

  • Get Screenshot

Note: If you are planning to use any of the sample playbooks in your environment, ensure that you clone those playbooks and move them to a different collection since the sample playbook collection gets deleted during connector upgrade and delete.

 

About the connector

ScreenshotMachine provides a service to create screenshot or thumbnail of any online web page in a couple of seconds, using your phone, tablet, or desktop. For more information, see the ScreenshotMachine website.

This document provides information about the ScreenShot Machine connector, which facilitates automated interactions, with a ScreenshotMachine server using FortiSOAR™ playbooks. Add the Screenshot Machine connector as a step in FortiSOAR™ playbooks and perform automated operations, such as automatically taking a screenshot for a specified web page and storing that screenshot in the FortiSOAR™ attachment module.

 

Version information

Connector Version: 1.0.0

Compatibility with FortiSOAR™ Versions: 4.9.0.0-708 and later

 

Installing the connector

For the procedure to install a connector, click here.

 

Prerequisites to configuring the connector

 

Configuring the connector

For the procedure to configure a connector, click here.

 

Configuration parameters

In FortiSOAR™, on the Connectors page, select the ScreenShot Machine connector and click Configure to configure the following parameters:

 

Parameter Description
Server URL URL of ScreenShotMachine server to which you will connect and perform the automated operations.
Protocol Protocol, such as http or https, that is used to connect to the ScreenShotMachine server.
API Key API Key used to access the ScreenshotMachine API.
Secret Phrase Secret Phrase that you configure while creating your ScreenShotMachine account. If you set your secret phrase then all requests with missing or incorrect hash parameter are ignored.
Verify SSL Specifies whether the SSL certificate for the server is to be verified or not.
By default, this option is set as True.

 

 

Actions supported by the connector

The following automated operations can be included in playbooks:

operation: Get Screenshot

Input parameters

 

Parameter Description
URL URL of the web page whose screenshot you want to capture.
Format Format in which you want to capture the thumbnail or screenshot. By default, the screenshot is stored in the .jpg format.
Available formats are .jpg, .png, or .gif formats.
Device Device that you are going to use to capture the web page. Available device options are Desktop, Phone, or Tablet.
Dimension Size of the thumbnail or screenshot that you want to capture in the format [width]x[height].
Dimensions are specified in pixels (px).
CacheLimit Number of days within which cached images are accepted. By default, images are used from cache only if it not older than 14 days.
Examples:
CacheLimit=0 : Never use cache, always download fresh screenshot.
CacheLimit=1 : Use image from cache only if is not older than 1 day.
Timeout Time in milliseconds after which the capturing engine will create the screenshot. By default, the capturing engine waits 200 milliseconds before capturing the screenshot.

 

Output

The output contains the screenshot of the web page that you have specified. The screenshot is stored in the FortiSOAR™ Attachment module as a new attachment in the image format you have specified. For example, if you have chosen .png as the image format, then the screenshot is saved as an attachment in the .png format in the FortiSOAR™ Attachment module.

Following image displays a sample output:

 

Sample output of the Get Screenshot operation

 

Included playbooks

 

The Sample - ScreenShot Machine - 1.0.0 playbook collection comes bundled with the ScreenShot Machine connector. This playbook contains steps using which you can perform all supported actions. You can see the bundled playbooks in the Automation > Playbooks section in FortiSOAR™ after importing the ScreenShot Machine connector.

Note: If you are planning to use any of the sample playbooks in your environment, ensure that you clone those playbooks and move them to a different collection since the sample playbook collection gets deleted during connector upgrade and delete.