Available APIs

This section covers the APIs available in the Workspace Control Management Portal. It provides only the names of the APIs, their scope and the method they use.

The Swagger UI provides more in-depth details about Workspace Control APIs and an environment to test each API. To access the Swagger UI, open the Management Portal, navigate to Datastore Setup > Public API and then select EXPLORE. This opens the Swagger UI in a new tab.


(click the image to enlarge it)

Select an API to expand it. This provides more information about the API, such as response class, parameter details (parameter name, value, description, parameter type, and data type) and examples.

Fill in the necessary fields and then select Try it out! to test the API.


(click the image to enlarge it)

Building Blocks

The following APIs are available to create, upload and import Workspace Control Building Blocks.

Scope: Creates a Building Block XML file that contains all the exportable Workspace Control environment data.

Method: POST

Scope: Creates a Building Block XML file that contains Managed Application rules and/or settings.

Method: POST

Scope: Creates a Building Block XML file that contains all the rules and settings for Managed Applications.

Method: POST

Scope: Creates a Building Block XML file that contains File Certificates rules and/or settings.

Method: POST

Scope: Creates a Building Block XML file that contains all the rules and settings for File Certificates.

Method: POST

Scope: Creates a Building Block XML file that contains User Installed Application rules and/or settings.

Method: POST

Scope: Creates a Building Block XML file that contains all the rules and settings for User Installed Applications.

Method: POST

Scope: Creates a Building Block XML file that contains Files and Folders rules and/or settings.

Method: POST

Scope: Creates a Building Block XML file that contains all the rules and settings for Files and Folders.

Method: POST

Scope: Creates a Building Block XML file that contains Read-Only Blanketing rules and/or settings.

Method: POST

Scope: Creates a Building Block XML file that contains all the rules and settings for Read-Only Blanketing.

Method: POST

Scope: Creates a Building Block XML file that contains Websites rules and/or settings.

Method: POST

Scope: Creates a Building Block XML file that contains all the rules and settings for Websites.

Method: POST

Scope: Creates a Building Block XML file that contains Networks Connections rules and/or settings.

Method: POST

Scope: Creates a Building Block XML file that contains all the rules and settings for Networks Connections.

Method: POST

Scope: Creates a Building Block XML file that contains User Sessions rules and/or settings.

Method: POST

Scope: Creates a Building Block XML file that contains all the rules and settings for User Sessions.

Method: POST

Scope: Uploads a Building Block XML file.

Method: POST

Scope: Imports a Building Block XML file.

Method: POST

 

Authorized Certificates

The following APIs are available to display, create or update Workspace Control Authorized Certificate rules.

Authorized Certificate rules are found in the Workspace Control Console under Security > Authorized Certificates.

Scope: Returns the list of Authorized Certificates that match the specified search criteria.

Method: GET

  • {id}: Specify the ID of the desired Authorized Certificate rule as a string.

    Scope: Returns the Authorized Certificate rule that matches the specified ID, if it exists.

    Method: GET

  • {id}: Specify the ID of the desired Authorized Certificate rule as a string.

    Scope: Updates the Authorized Certificate rule that matches the specified ID, if it exists.

    Method: PUT

  • Scope: Creates a new Authorized Certificate rule.

    Method: POST

  • Scope: Creates a new Authorized Certificate rule, or updates the rule if it already exists.

    Method: PUT

 

Executables

The following APIs are available to display, create or update Workspace Control Managed Application configurations.

Managed Application configurations are found in the Workspace Control Console under Security > Applications > Managed Applications.

Scope: Returns the list of Managed Applications that match the specified search criteria.

Method: GET

  • {id}: Specify the ID of the desired Managed Application configuration as a string.

    Scope: Returns the configuration of the Managed Application that matches the specified ID, if it exists.

    Method: GET

  • {id}: Specify the ID of the desired Managed Application configuration as a string.

    Scope: Updates the configuration of the Managed Application that matches the specified ID, if it exists.

    Method: PUT

  • Scope: Creates a new Managed Application configuration.

    Method: POST

  • Scope: Creates a new Managed Application configuration, or updates the configuration if it already exists.

    Method: PUT

 

File Hashes

The following APIs are available to create or update Workspace Control File Hash rules.

File Hash rules are found in the Workspace Control Console under Security > Authorized Files. Open an authorized file from the right-side pane and navigate to the File Hashes tab.

  • Scope: Creates a new File Hash rule.

    Method: POST

  • Scope: Creates a new File Hash rule, or updates the rule if it already exists.

    Method: PUT

 

Websites

The following APIs are available to create or update Workspace Control Website rules.

Website rules are found in the Workspace Control Console under Security > Applications > Websites.

  • Scope: Creates a new Website rule.

    Method: POST

  • Scope: Creates a new Website rule, or updates the rule if it already exists.

    Method: PUT