Endpoint: /nodes/{nodeId}/licenses

Returns list of licenses on an EFT node and provides the ability to register EFT or a module.

• GET

• POST

Method & URL

GET https://[server URL]:[port]/admin/v2/nodes/{nodeId}/licenses

GET Body Sample

@NodeID = WIN-4NFJASSP163
GET https://{{host}}/admin/v2/nodes/{{NodeID}}/licenses HTTP/1.1
Authorization: EFTAdminAuthToken {{AuthToken}}

GET Response Body Sample

{ 
"data": [ 
  { 
    "attributes": { 
      "registrationStatus": "Evaluation period" 
    }, 
    "id": "AAMModule", 
    "links": { 
      "self": "admin/v2/nodes/WIN-4NFJASSP163/licenses/AAMModule" 
    }, 
     "type": "license" }, { "attributes": { "registrationStatus": "Evaluation period" }, "id": "ARMModule", 
     "links": { "self": "admin/v2/nodes/WIN-4NFJASSP163/licenses/ARMModule" }, "type": "license" },

GET PowerShell Sample

###
#GET SERVER NODE LICENSE
Write-Output "Get EFT Server Node Licenses"
$serverNodeID = "WIN-4NFJASSP163"
Write-Output "Server Node ID: $serverNodeID"
Write-Output "-----"
$serverAdminDetails = Invoke-RestMethod -Uri "$baseURL/v2/nodes/$serverNodeID/licenses" 
-Method 'GET' -Headers $authHeader
Write-Output $serverAdminDetails | ConvertTo-Json -Depth 10

Method & URL

POST https://[server URL]:[port]/admin/v2/nodes/{nodeId}/licenses

POST Body Sample

@NodeID = WIN-4NFJASSP163
POST https://{{host}}/admin/v2/nodes/{{NodeID}}/licenses HTTP/1.1
Authorization: EFTAdminAuthToken {{AuthToken}}

{
  "data": [
    {
      "id": "ARMModule",
      "attributes": {
        "serialNumber": "MySerialNumberHere"
      }
    }
  ]
}

POST PowerShell Sample

###
#POST SERVER NODE LICENSE
Write-Output "Register EFT Server Node"
$serverNodeID = "WIN-4NFJASSP163"
Write-Output "Server Node ID: $serverNodeID"
Write-Output "-----"
$update = 
'{
  "data": [
    {
      "id": "ARMModule",
      "attributes": {
        "serialNumber": "MySerialNumberHere"
      }
    }
  ]
}'   
$update = $update | ConvertFrom-Json
$update = $update | ConvertTo-Json -Depth 10
$patchReturn = Invoke-RestMethod -Uri "$baseURL/v2/nodes/$serverNodeID/licenses" 
-Method 'POST' -Headers $authHeader -Body $update 

Available options for ids:

• AAMModule (Advanced Authentication Modes)

• ARMModule (Auditing and Reporting Module)

• AS2Module (Applicability Statement 2 Module)

• AWModule (Advanced Workflow Engine Module)

• AccelerateModule (FAST Protocol – Deprecated)

• CloudConnectorModule (CCM – Cloud Connector Module)

• DMZGWModule (DMZ Gateway Module)

• EFTServer (EFT Server)

• EnterpriseActionsWModule (Enterprise Actions Module)

• FTPModule (FTP/S Module)

• FileTransferClientModule (File Transfer Client Module)

• FolderMonitorEventModule (Folder Monitor Event Module)

• HSModule (will be deprecated)

• HTTPModule (HTTP/s Module)

• PGPModule (OpenPGP Module)

• RAModule (Remote Agent Module)

• SSHModule (SFTP Module)

• SecureFormsModule (Secure Forms Module)

• TimerEventModule (Timer Event Module)

• WorkspacesModule (Workspaces Module)