Skip to main content
Skip table of contents

Check if Port is Open

LAST UPDATED: AUG 06, 2024

Checks if a port of an IP address is open

Implementation

System

Command Category

Cyber Utility

Tags

NETWORK CONDITION ARTIFACT IP

Inputs

Parameter Name

Required/Optional

Description

Sample Data

Host Name

Required

IP address or URL

127.0.0.1

Port

Required

Number of a port

8000

Output

Return Data

The returned result of this command. If some required parameters are not defined, this returned data could be empty. The returned result can be passed down directly to a subsequent command in playbooks.

SAMPLE DATA

JSON
true

Remote Command API

The D3 command API allows you to send requests to D3 SOAR to execute this utility command via REST API.

Request

POST

CODE
https:/{base_url}/{api_namespace}/api/Command/IsPortOpen

Headers

Please refer to the page Webhook Configuration Guide - Authentication Method: API Keys for more details.

Request Body

JSON
{
  "Username": <Username here>,
  "Site": <Site here>,
  "CommandParams": {
    "Host Name": <IP address or URL>,
    "Port": <Number of a port>
  }
}

Body Parameters

Parameter Name

Type

Required/Optional

Description

Username

string

Required

The username of your D3 SOAR account.

Site

string

Required

The D3 SOAR site to run the remote command.

Host Name

string

Required

IP address or URL

Port

int

Required

Number of a port

Sample Request

SAMPLE DATA

JSON
{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "Host Name": "127.0.0.1",
    "Port": 8000
  }
}

Response

Response Fields

Field Name

Type

Description

error

string

The error message if the API request has failed.

returnData

boolean

The return data from the API request.

Sample Response

JSON
{
    "error": "",
    "returnData": "true",
}
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.