Retrieve prohibited software across managed computers

Returns the list of prohibited software detected across the network, including details such as uninstallability and installer format.

Endpoints

get /dcapi/inventory/viewData/prohibitedSW

Copy full URL

Request URL

https://{server-hostname}:8383/dcapi/inventory/viewData/prohibitedSW

Scope

Inventory.READCopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory

application/InventoryMobileAPI.v1+jsonCopied!

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request GET \
  --url https://appdomain/dcapi/inventory/viewData/prohibitedSW \
  --header 'Accept: application/InventoryMobileAPI.v1+json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.io.IOException;
import java.net.http.HttpTimeoutException;

public class Main {
  public static void main(String[] args) {

    HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create("https://appdomain/dcapi/inventory/viewData/prohibitedSW"))
        .header("Accept", "application/InventoryMobileAPI.v1+json")
        .header("Authorization", " d92d4xxxxxxxxxxxxx15f52")
        .method("GET", HttpRequest.BodyPublishers.noBody())
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

conn = http.client.HTTPSConnection("appdomain")

headers = {
    'Accept': "application/InventoryMobileAPI.v1+json",
    'Authorization': " d92d4xxxxxxxxxxxxx15f52"
    }

conn.request("GET", "/dcapi/inventory/viewData/prohibitedSW", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))


    headersMap = Map();
    headersMap.put("Accept", "application/InventoryMobileAPI.v1+json");

    response = invokeUrl
    [
        url: "https://appDomain/dcapi/inventory/viewData/prohibitedSW"
        type: GET
        headers: headersMap
        connection: connection_name
    ]

    info response;

$headers=@{}
$headers.Add("Accept", "application/InventoryMobileAPI.v1+json")
$headers.Add("Authorization", " d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomain/dcapi/inventory/viewData/prohibitedSW' -Method GET -Headers $headers

Response Parameters

- HTTP code 200

Response Body - application/json

JSON Object

Hide Sub-Attributes

metadataJSON Object

Pagination metadata

Show Sub-Attributes

limitstring

Number of items returned per page

pagestring

Current page number in paginated response

totalRecordsstring

Total number of records matching the query

messageResponseJSON Array

Array of prohibited software objects

Show Sub-Attributes

JSON Object

Show Sub-Attributes

managed_installations_transformstring

Managed installations count display value

manufacturer_idstring

Manufacturer identifier

software_version_transformstring

Software version display value

network_installations_transformstring

Network installations count display value

exclusionsstring

Exclusion configuration

display_namestring

Software display name

exclusions_transformstring

Exclusions display value

installed_format_transformstring

Installed format display value

invswtoosrel_software_idstring

Software to OS relation ID

managed_installationsstring

Managed installations count

software_idstring

Software identifier

is_uninstallablestring

Whether software supports uninstall - Yes or No

installed_formatstring

Installed format - EXE or MSI

silent_switchstring

Silent uninstall switch

display_name_transformstring

Display name display value

silent_switch_transformstring

Silent switch display value

software_namestring

Software name

software_versionstring

Software version

sw_typestring

Software type code

is_usage_prohibitedstring

Prohibited status code

network_installationsstring

Network installations count

managed_sw_idstring

Managed software identifier

totalPagesstring

Total number of pages

LinksJSON Object

Pagination links

Show Sub-Attributes

nextstring

URL to the next page of results, null if last page

prevstring

URL to the previous page of results, null if first page

statusstring

Response status - success

- HTTP code 500

Response Body - application/json

JSON Object

Hide Sub-Attributes

error_codestring

INTERNAL_ERROR - unexpected exception in the service layer

error_descriptionstring

Internal server error message

Possible Response Codes

200HTTP code

500HTTP code

Sample Response: HTTP 200

Prohibited software view

Copied!

  {
    "metadata": {
      "limit": 25,
      "page": 1
    },
    "totalRecords": "2",
    "messageResponse": [
      {
        "managed_installations_transform": "1",
        "manufacturer_id": "57",
        "software_version_transform": "1.0.0",
        "network_installations_transform": "1",
        "exclusions": null,
        "display_name": "Sample Software A",
        "exclusions_transform": "Not Configured",
        "installed_format_transform": "EXE",
        "invswtoosrel_software_id": "51",
        "managed_installations": "1",
        "software_id": "51",
        "is_uninstallable": "No",
        "installed_format": "EXE",
        "silent_switch": null,
        "display_name_transform": "Sample Software A",
        "silent_switch_transform": "Not Configured",
        "software_name": "Sample Software A",
        "software_version": "1.0.0",
        "sw_type": "1",
        "is_usage_prohibited": "2",
        "network_installations": "1",
        "managed_sw_id": "51"
      },
      {
        "managed_installations_transform": "1",
        "manufacturer_id": "17",
        "software_version_transform": "2.0.0",
        "network_installations_transform": "1",
        "exclusions": null,
        "display_name": "Sample Software B",
        "exclusions_transform": "Not Configured",
        "installed_format_transform": "EXE",
        "invswtoosrel_software_id": "4",
        "managed_installations": "1",
        "software_id": "4",
        "is_uninstallable": "No",
        "installed_format": "EXE",
        "silent_switch": null,
        "display_name_transform": "Sample Software B",
        "silent_switch_transform": "Not Configured",
        "software_name": "Sample Software B",
        "software_version": "2.0.0",
        "sw_type": "0",
        "is_usage_prohibited": "2",
        "network_installations": "1",
        "managed_sw_id": "4"
      }
    ],
    "totalPages": 1,
    "Links": {
      "next": null,
      "prev": null
    },
    "status": "success"
  }

▼ Show full

Sample Response: HTTP 500

Server error

Copied!

  {
    "error_description": "Internal server error",
    "error_code": "INTERNAL_ERROR"
  }

▼ Show full

Duration: 1 minute | Threshold: 120 | Lock period: 5 minutes

Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.