Web Security Cloud - API Documentation

API docs by Redocly

API Key Management (1.0.0)

Download OpenAPI specification:

License: MIT

Token Management Public API

This API enables customers to generate a bearer access token to call the Cloud Web APIs.

Authentication
Requests to the Token Management API require an API token (api-key-string) to be passed in the header. To generate this API token, go to the Platform Services > Admin in the Web Security Cloud and click the Generate API Token.
Now that the api-key-string has been generated, a bearer access token can be created using the Generate bearer access token endpoint.

Generate bearer access token

Generate a bearer access token that can be used for authorization purpose.

Token Validity: The generated bearer access token is valid for 59 minutes after creation.

header Parameters
X-API-KEY
required
string
Example: api-key-string

In this header you will have to pass your api key

Responses

Response samples

Content type
application/json
{
  • "token": "token-string"
}

Custom Category API

This API enables customers to manage Custom Categories via API endpoints instead of the portal.

Audience
This API guide is intended for:

- Developers who integrate and manage Custom Categories via API endpoints instead of using the portal.
- Software Engineers responsible for implementing API-based automation within their organization.
- System Administrators who configure and maintain API access for managing Custom Categories.

Authentication
All requests to the Custom Category API require authentication using bearer access tokens. Clients must include a valid bearer access token in the Authorization header of each request.

Example Header:
Authorization: Bearer YOUR_BEARER_ACCESS_TOKEN

To obtain a bearer access token, see the Token Management Public API.

Get all custom categories

API path to retrieve all custom categories for the account.

Authorizations:
custom-authorizer
query Parameters
cursor
string

Cursor for pagination

Responses

Request samples 

import requests

def get_categories(
  url:str, headers, next_page_cursor: str = ""
) -> object:
    """Get all categories."""
    querystring = {"cursor": next_page_cursor}
    response = requests.request(
        "GET",
        url,
        data="",
        headers=headers,
        params=querystring,
    )
    print(response.text)
    return response

token = ""            # Insert bearer access token here
next_page_cursor = "" # Insert nextPageCursor value from previous response here (OPTIONAL: Leave empty string)

host = "https://ws-custom-categories.api.forcepoint.io"
api_version = "1.0.0"
headers = {"Authorization": f"Bearer {token}"}
url = f"{host}/v{api_version}"

get_categories(url, headers, next_page_cursor)

Response samples

Content type
application/json
{
  • "totalResults": 0,
  • "nextPageCursor": "string",
  • "categories": [
    ]
}

Create a new category

API path to create a new custom category for the account.

Authorizations:
custom-authorizer
Request Body schema: application/json
required
name
required
string
description
string
sites
Array of strings <= 30000 items

List of website URLs and IP addresses

policyName
string

Policy level custom category created via API will appear in the UI after the Enable custom categories per policy toggle on Web › Custom Categories page is turned on

comment
string

Comment field appears in "Get Transaction Status" response, not in Cloud Web portal

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "sites": [
    ],
  • "policyName": "string",
  • "comment": "string"
}

Response samples

Content type
application/json
{
  • "transactionId": "00000000-0000-0000-0000-000000000000",
  • "status": "pending",
  • "data": { },
  • "comment": "string"
}

Get category and site counts and limits

API path to retrieve the number of sites, number of custom categories, site limits and custom category limits for the account.

Authorizations:
custom-authorizer

Responses

Request samples 

import requests

def get_limits(url:str, headers:object) -> object:
    """Get number of sites, number of custom categories, site limits and custom category limits."""
    response = requests.request(
        "GET",
        url,
        data="",
        headers=headers,
    )
    print(response.text)
    return response

token = ""            # Insert bearer access token here

host = "https://ws-custom-categories.api.forcepoint.io"
api_version = "1.0.0"
headers = {"Authorization": f"Bearer {token}"}
url = f"{host}/v{api_version}/limits"

get_limits(url, headers)

Response samples

Content type
application/json
{
  • "customCategoryCount": 1,
  • "customCategoryUrlCount": 1,
  • "customCategoryLimit": 1,
  • "customCategoryUrlLimit": 1
}

Get category by ID

API path to retrieve the details of a specific custom category by providing its ID.

Authorizations:
custom-authorizer
path Parameters
categoryId
required
integer

ID of category to return

query Parameters
cursor
string

Cursor for pagination

Responses

Request samples 

import requests

def get_category_by_id(
  url:str, headers, next_page_cursor: str = ""
) -> object:
    """Get category by id."""
    querystring = {"cursor": next_page_cursor}
    response = requests.request(
        "GET",
        url,
        data="",
        headers=headers,
        params=querystring,
    )
    print(response.text)
    return response

token = ""            # Insert bearer access token here
category_id = 0       # Insert category id here
next_page_cursor = "" # Insert nextPageCursor value from previous response here (OPTIONAL: Leave empty string)

host = "https://ws-custom-categories.api.forcepoint.io"
api_version = "1.0.0"
headers = {"Authorization": f"Bearer {token}"}
url = f"{host}/v{api_version}/{category_id}"

get_category_by_id(url, headers, next_page_cursor)

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "no name",
  • "description": "string",
  • "sites": [
    ],
  • "policyName": "string"
}

Update an existing category

API path to update an existing custom category for the account. This API path will replace all the category information with the category details given in the request body.

Authorizations:
custom-authorizer
path Parameters
categoryId
required
integer

ID of category to return

Request Body schema: application/json
required

Category details

name
required
string
description
string
sites
required
Array of strings <= 30000 items

List of website urls and IP addresses

comment
string

Comment field appears in "Get Transaction Status" response, not in Cloud Web portal

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "sites": [
    ],
  • "comment": "string"
}

Response samples

Content type
application/json
{
  • "transactionId": "00000000-0000-0000-0000-000000000000",
  • "status": "pending",
  • "data": { },
  • "comment": "string"
}

Add or Remove category sites

API path to add or remove sites from a custom category. This API path is only for adding or removing sites. To replace all the sites for a category the Update an existing category (PUT) API path must be used.

Authorizations:
custom-authorizer
path Parameters
categoryId
required
integer

ID of category to return

query Parameters
action
required
string
Enum: "add" "remove"

Action identifying whether sites are being added or removed

Request Body schema: application/json
required

Site details

sites
required
Array of strings <= 30000 items

List of website urls and IP addresses

comment
string

Comment field appears in "Get Transaction Status" response, not in Cloud Web portal

Responses

Request samples

Content type
application/json
{
  • "sites": [
    ],
  • "comment": "string"
}

Response samples

Content type
application/json
{
  • "transactionId": "00000000-0000-0000-0000-000000000000",
  • "status": "pending",
  • "data": { },
  • "comment": "string"
}

Delete a category

API path to delete a custom category for the account.

Authorizations:
custom-authorizer
path Parameters
categoryId
required
integer

ID of category to return

Responses

Request samples 

import requests

def delete_category(url:str, headers: object) -> object:
  """Method to delete a Custom Category."""
  response = requests.request("DELETE", url, headers=headers)
  print(response.text)
  return response

token = ""            # Insert bearer access token here
category_id = 0       # Insert category id here

host = "https://ws-custom-categories.api.forcepoint.io"
api_version = "1.0.0"
headers = {"Authorization": f"Bearer {token}"}
url = f"{host}/v{api_version}/{category_id}"

delete_category(url, headers)

Response samples

Content type
application/json
{
  • "transactionId": "00000000-0000-0000-0000-000000000000",
  • "status": "pending",
  • "data": { },
  • "comment": "string"
}

Get transaction status

API path to retrieve the transaction status for a transaction ID.

Authorizations:
custom-authorizer
path Parameters
transactionId
required
string

ID of transaction to return

Responses

Request samples 

import requests

def get_transaction_status(url: str, headers) -> object:
  """Get transaction status."""
  response = requests.request(
      "GET", url, data="", headers=headers,
  )
  print(response.text)
  return response

token = ""          # Insert bearer access token here
transaction_id = "" # Insert transactionId here

host = "https://ws-custom-categories.api.forcepoint.io"
api_version = "1.0.0"
url = f"{host}/v{api_version}/transaction/{transaction_id}"
headers = {"Authorization": f"Bearer {token}"}

get_transaction_status(url, headers)

Response samples

Content type
application/json
{
  • "transactionId": "00000000-0000-0000-0000-000000000000",
  • "status": "pending",
  • "data": { },
  • "comment": "string"
}

Bypass Settings

This API enables customers to manage Bypass Settings via API endpoints instead of the portal.

Audience
This API guide is intended for:

- Developers who integrate and manage Bypass Settings via API endpoints instead of using the portal.
- Software Engineers responsible for implementing API-based automation within their organization.
- System Administrators who configure and maintain API access for managing Bypass Settings.

Authentication
All requests to the Bypass Settings API require authentication using bearer access tokens. Clients must include a valid bearer access token in the Authorization header of each request.

Example Header:
Authorization: Bearer YOUR_BEARER_ACCESS_TOKEN

To obtain a bearer access token, see the Token Management Public API.

Get Forcepoint defined categories

Get Forcepoint defined categories for SSL authentication decryption bypass settings API. This is a read-only API path to retrieve the list of Forcepoint defined categories that can be used in the SSL authentication decryption bypass settings API.

Authorizations:
bypass-custom-authorizer

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get transaction status

API path to retrieve the transaction status for a transaction ID.

path Parameters
transactionId
required
string

ID of transaction to return

Responses

Response samples

Content type
application/json
{
  • "transactionId": "00000000-0000-0000-0000-000000000000",
  • "status": "pending",
  • "data": { },
  • "comment": "string"
}

SSL

This API enables end users to configure and manage SSL bypass settings via API endpoints instead of the portal.

Get SSL certificate verification bypass settings

Get SSL certificate verification bypass settings

Authorizations:
bypass-custom-authorizer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete SSL certificate verification bypass settings

Delete SSL certificate verification bypass settings

Authorizations:
bypass-custom-authorizer

Responses

Response samples

Content type
application/json
{
  • "transactionId": "00000000-0000-0000-0000-000000000000",
  • "status": "pending",
  • "data": { },
  • "comment": "string"
}

Create SSL certificate verification bypass setting

Create SSL certificate verification bypass setting for the account.

Authorizations:
bypass-custom-authorizer
Request Body schema: application/json
required
ignoreDomains
required
Array of strings <= 3000 items
verify
boolean
enduserCertErrorsBypass
boolean

Responses

Request samples

Content type
application/json
{
  • "ignoreDomains": [
    ],
  • "verify": true,
  • "enduserCertErrorsBypass": true
}

Response samples

Content type
application/json
{
  • "transactionId": "00000000-0000-0000-0000-000000000000",
  • "status": "pending",
  • "data": { },
  • "comment": "string"
}

Update SSL certificate verification bypass settings

Update SSL certificate verification bypass settings for the account.

Authorizations:
bypass-custom-authorizer
Request Body schema: application/json
required
ignoreDomains
required
Array of strings <= 3000 items
verify
boolean
enduserCertErrorsBypass
boolean

Responses

Request samples

Content type
application/json
{
  • "ignoreDomains": [
    ],
  • "verify": true,
  • "enduserCertErrorsBypass": true
}

Response samples

Content type
application/json
{
  • "transactionId": "00000000-0000-0000-0000-000000000000",
  • "status": "pending",
  • "data": { },
  • "comment": "string"
}

Add or Remove cert verification bypass domains

API path to add or remove domains from the SSL bypass certificate verification settings. This API path is only for adding or removing domains. To replace all the domains the (PUT) API path must be used.

Authorizations:
bypass-custom-authorizer
query Parameters
action
required
string
Enum: "add" "remove"

Action identifying whether objects are being added or removed

Request Body schema: application/json
required

Domain details

ignoreDomains
required
Array of strings <= 3000 items

List of urls and IP addresses

comment
string

Comment field appears in "Get Transaction Status" response, not in Cloud Web portal

Responses

Request samples

Content type
application/json
{
  • "ignoreDomains": [
    ],
  • "comment": "string"
}

Response samples

Content type
application/json
{
  • "transactionId": "00000000-0000-0000-0000-000000000000",
  • "status": "pending",
  • "data": { },
  • "comment": "string"
}

Get SSL authentication decryption bypass settings

Get SSL authentication decryption bypass settings

Authorizations:
bypass-custom-authorizer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete SSL authentication decryption bypass settings

Delete SSL authentication decryption bypass settings

Authorizations:
bypass-custom-authorizer

Responses

Response samples

Content type
application/json
{
  • "transactionId": "00000000-0000-0000-0000-000000000000",
  • "status": "pending",
  • "data": { },
  • "comment": "string"
}

Create SSL authentication decryption bypass setting

Create SSL authentication decryption bypass setting for the account. Forcepoint defined category IDs can be retrieved from the "Get Forcepoint defined categories" API path. Custom category IDs can be retrieved using the Custom Categories API.

Authorizations:
bypass-custom-authorizer
Request Body schema: application/json
required
categories
required
Array of integers <= 220 items
comment
required
string

Responses

Request samples

Content type
application/json
{
  • "categories": [
    ],
  • "comment": "string"
}

Response samples

Content type
application/json
{
  • "transactionId": "00000000-0000-0000-0000-000000000000",
  • "status": "pending",
  • "data": { },
  • "comment": "string"
}

Update SSL authentication decryption bypass settings

Update SSL authentication decryption bypass settings for the account. Forcepoint defined category IDs can be retrieved from the "Get Forcepoint defined categories" API path. Custom category IDs can be retrieved using the Custom Categories API.

Authorizations:
bypass-custom-authorizer
Request Body schema: application/json
required
categories
required
Array of integers <= 220 items
comment
required
string

Responses

Request samples

Content type
application/json
{
  • "categories": [
    ],
  • "comment": "string"
}

Response samples

Content type
application/json
{
  • "transactionId": "00000000-0000-0000-0000-000000000000",
  • "status": "pending",
  • "data": { },
  • "comment": "string"
}

Add or Remove auth decryption bypass categories

API path to add or remove categories from the SSL bypass authentication decryption settings. This API path is only for adding or removing categories. To replace all the categories the (PUT) API path must be used. Forcepoint defined category IDs can be retrieved from the "Get Forcepoint defined categories" API path. Custom category IDs can be retrieved using the Custom Categories API.

Authorizations:
bypass-custom-authorizer
query Parameters
action
required
string
Enum: "add" "remove"

Action identifying whether objects are being added or removed

Request Body schema: application/json
required

Category details

categories
required
Array of integers <= 220 items

List of category IDs

comment
string

Comment field appears in "Get Transaction Status" response, not in Cloud Web portal

Responses

Request samples

Content type
application/json
{
  • "categories": [
    ],
  • "comment": "string"
}

Response samples

Content type
application/json
{
  • "transactionId": "00000000-0000-0000-0000-000000000000",
  • "status": "pending",
  • "data": { },
  • "comment": "string"
}

Authentication

This API enables end users to configure and manage authentication bypass settings via API endpoints instead of the portal.

Get O365 authentication bypass for cloud applications

Get the O365 authentication bypass setting for cloud applications

Authorizations:
bypass-custom-authorizer

Responses

Response samples

Content type
application/json
{
  • "o365AuthBypass": "on"
}

Delete O365 authentication bypass for cloud applications

Reset the O365 authentication bypass setting for cloud applications to the default value

Authorizations:
bypass-custom-authorizer

Responses

Response samples

Content type
application/json
{
  • "transactionId": "00000000-0000-0000-0000-000000000000",
  • "status": "pending",
  • "data": { },
  • "comment": "string"
}

Update O365 authentication bypass for cloud applications

Update the O365 authentication bypass setting for cloud applications

Authorizations:
bypass-custom-authorizer
Request Body schema: application/json
required
o365AuthBypass
required
string
Enum: "on" "off"

O365 authentication bypass value for cloud applications

Responses

Request samples

Content type
application/json
{
  • "o365AuthBypass": "on"
}

Response samples

Content type
application/json
{
  • "transactionId": "00000000-0000-0000-0000-000000000000",
  • "status": "pending",
  • "data": { },
  • "comment": "string"
}

Get authentication bypass user agent and destinations

Get the list of authentication bypass user agent and destinations

Authorizations:
bypass-custom-authorizer
query Parameters
cursor
integer

Cursor to get the next page of results

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "nextPageCursor": 0,
  • "totalResults": 0
}

Create an authentication bypass user agent and destination

Create a new authentication bypass user agent and destination

Authorizations:
bypass-custom-authorizer
Request Body schema: application/json
required
One of
uaType
required
string
Enum: "none" "any" "pattern"

User agent match type: 'none' disables matching, 'any' matches all user agents; both require userAgents to be an empty array. 'pattern' matches against the userAgents list.

userAgents
required
Array of strings <= 500 items

List of user agent patterns. The uaType field takes precedence over this field: when uaType is 'none' or 'any' this must be an empty array.

name
required
string <= 255 characters
destinations
required
Array of strings <= 2500 items

List of destinations to match. An empty array matches all destinations. Wildcards are allowed. For URLs, use the following format: http://www.example.com/ (forward slash at the end). For domains, use the following format: mydomain.com (without any forward slash).

authenticationModel
required
string
Enum: "default" "ntlm" "form" "welcome" "basic" "none"
contentAnalysis
required
string
Enum: "enabled" "disabled"
comment
string <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "uaType": "none",
  • "name": "string",
  • "userAgents": [
    ],
  • "destinations": [
    ],
  • "authenticationModel": "default",
  • "contentAnalysis": "enabled",
  • "comment": "string"
}

Response samples

Content type
application/json
{
  • "transactionId": "00000000-0000-0000-0000-000000000000",
  • "status": "pending",
  • "data": { },
  • "comment": "string"
}

Get an authentication bypass user agent and destination by ID

Get a single authentication bypass user agent and destination by config ID

Authorizations:
bypass-custom-authorizer
path Parameters
configId
required
integer

ID of the user agent and destination to retrieve

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete an authentication bypass user agent and destination

Delete an authentication bypass user agent and destination by config ID

Authorizations:
bypass-custom-authorizer
path Parameters
configId
required
integer

ID of the user agent and destination to delete

Responses

Response samples

Content type
application/json
{
  • "transactionId": "00000000-0000-0000-0000-000000000000",
  • "status": "pending",
  • "data": { },
  • "comment": "string"
}

Update an authentication bypass user agent and destination

Update an existing authentication bypass user agent and destination

Authorizations:
bypass-custom-authorizer
path Parameters
configId
required
integer

ID of the user agent and destination to update

Request Body schema: application/json
required
One of
uaType
required
string
Enum: "none" "any" "pattern"

User agent match type: 'none' disables matching, 'any' matches all user agents; both require userAgents to be an empty array. 'pattern' matches against the userAgents list.

userAgents
required
Array of strings <= 500 items

List of user agent patterns. The uaType field takes precedence over this field: when uaType is 'none' or 'any' this must be an empty array.

name
required
string <= 255 characters
destinations
required
Array of strings <= 2500 items

List of destinations to match. An empty array matches all destinations. Wildcards are allowed. For URLs, use the following format: http://www.example.com/ (forward slash at the end). For domains, use the following format: mydomain.com (without any forward slash).

authenticationModel
required
string
Enum: "default" "ntlm" "form" "welcome" "basic" "none"
contentAnalysis
required
string
Enum: "enabled" "disabled"
comment
string <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "uaType": "none",
  • "name": "string",
  • "userAgents": [
    ],
  • "destinations": [
    ],
  • "authenticationModel": "default",
  • "contentAnalysis": "enabled",
  • "comment": "string"
}

Response samples

Content type
application/json
{
  • "transactionId": "00000000-0000-0000-0000-000000000000",
  • "status": "pending",
  • "data": { },
  • "comment": "string"
}

Get authentication bypass internal network traffic rules

Get the list of authentication bypass internal network traffic rules

Authorizations:
bypass-custom-authorizer
query Parameters
page_cursor
integer

Cursor to get the next page of results

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "nextPageCursor": 0,
  • "totalResults": 0
}

Create an authentication bypass internal network traffic rule

Create a new authentication bypass internal network traffic rule

Authorizations:
bypass-custom-authorizer
Request Body schema: application/json
required
name
required
string <= 255 characters
authenticationMethod
required
string
Enum: "default" "ntlm" "form" "welcome" "basic" "none"
contentFiltering
required
string
Enum: "enabled" "disabled"
comment
string <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "authenticationMethod": "default",
  • "contentFiltering": "enabled",
  • "comment": "string"
}

Response samples

Content type
application/json
{
  • "transactionId": "00000000-0000-0000-0000-000000000000",
  • "status": "pending",
  • "data": { },
  • "comment": "string"
}

Get an authentication bypass internal network traffic rule by ID

Get a single authentication bypass internal network traffic rule by ID

Authorizations:
bypass-custom-authorizer
path Parameters
rule_id
required
integer

ID of the internal network traffic rule to retrieve

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "nextNetworkPageCursor": 0,
  • "totalNetworks": 0
}

Delete an authentication bypass internal network traffic rule

Delete an authentication bypass internal network traffic rule by ID

Authorizations:
bypass-custom-authorizer
path Parameters
rule_id
required
integer

ID of the internal network traffic rule to delete

Responses

Response samples

Content type
application/json
{
  • "transactionId": "00000000-0000-0000-0000-000000000000",
  • "status": "pending",
  • "data": { },
  • "comment": "string"
}

Update an authentication bypass internal network traffic rule

Update an existing authentication bypass internal network traffic rule

Authorizations:
bypass-custom-authorizer
path Parameters
rule_id
required
integer

ID of the internal network traffic rule to update

Request Body schema: application/json
required
name
required
string <= 255 characters
authenticationMethod
required
string
Enum: "default" "ntlm" "form" "welcome" "basic" "none"
contentFiltering
required
string
Enum: "enabled" "disabled"
comment
string <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "authenticationMethod": "default",
  • "contentFiltering": "enabled",
  • "comment": "string"
}

Response samples

Content type
application/json
{
  • "transactionId": "00000000-0000-0000-0000-000000000000",
  • "status": "pending",
  • "data": { },
  • "comment": "string"
}

Get authentication bypass internal network traffic networks

Get the list of networks for an authentication bypass internal network traffic rule

Authorizations:
bypass-custom-authorizer
path Parameters
rule_id
required
integer

ID of the internal network traffic rule

query Parameters
cursor
integer

Cursor to get the next page of results

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "nextPageCursor": 0,
  • "totalResults": 0
}

Add or remove internal network traffic networks

API path to add or remove networks from an authentication bypass internal network traffic rule. This API path is only for adding or removing networks. To update a network the (PUT) API path must be used.

Authorizations:
bypass-custom-authorizer
path Parameters
rule_id
required
integer

ID of the internal network traffic rule

query Parameters
action
required
string
Enum: "add" "remove"

Action identifying whether objects are being added or removed

Request Body schema: application/json
required

Network details

Array of objects <= 1500 items
networkIds
Array of integers <= 1500 items

Responses

Request samples

Content type
application/json
{
  • "networks": [
    ],
  • "networkIds": [
    ]
}

Response samples

Content type
application/json
{
  • "transactionId": "00000000-0000-0000-0000-000000000000",
  • "status": "pending",
  • "data": { },
  • "comment": "string"
}

Get an authentication bypass internal network traffic network by ID

Get a single network associated with an authentication bypass internal network traffic rule

Authorizations:
bypass-custom-authorizer
path Parameters
rule_id
required
integer

ID of the internal network traffic rule

network_id
required
integer

ID of the network to retrieve

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update an authentication bypass internal network traffic network

Update an existing network within an authentication bypass internal network traffic rule

Authorizations:
bypass-custom-authorizer
path Parameters
rule_id
required
integer

ID of the internal network traffic rule

network_id
required
integer

ID of the network to update

Request Body schema: application/json
required
name
required
string <= 255 characters
network
required
string <= 255 characters
comment
string <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "network": "string",
  • "comment": "string"
}

Response samples

Content type
application/json
{
  • "transactionId": "00000000-0000-0000-0000-000000000000",
  • "status": "pending",
  • "data": { },
  • "comment": "string"
}