Designer API

Welcome to the documentation for the Designer APIs! These APIs provide programmatic access to the functionality of the disguise platform, allowing you to build integrations and applications that can control and interact with disguise.

Software Version

This documentation relates to the suite of APIs released in version r23.2. The latest and previous versions of Designer can be found at disguise.download .

Service and Session

The Service APIs relate to functionality provided by the d3service runtime and are available whenever disguise is installed on a machine. The Session APIs relate to the currently running session and as such are only available when Designer is running.

Ports

The Service and Session APIs are accessed by HTTP over a single port, 80. In most cases only the IP address or hostname needs to be specified in a HTTP request or web browser.

If a conflict exists this port can be changed using d3 Manager under Machine Settings > Advanced Network Configuration.

Getting Started

To get started with these APIs, you will need to make HTTP requests to the appropriate API endpoint. Here is a simple example using the javascript Fetch API to make a GET request to the /api/service/system/detectsystems endpoint to retrieve the list of machines found on the local network:

// Make a HTTP API request using javascript

fetch('http://127.0.0.1/api/service/system/detectsystems')
  .then(response => response.json())
  .then(data => console.log(data.result));

This code uses the fetch function to send a GET request to the /api/service/system/detectsystems endpoint, it logs the systems found to the console.

For more information about the Service and Session APIs, including a list of all available endpoints and the parameters and responses for each endpoint, please see the detailed documentation using the links in the sidebar.