Device Configuration
List of APIs used to manage your device software to upgrade, retrieve available software images, and upgrade status information.
📄️ Query Software State for Tenant's Elements (v2.0)
Query the software state for all the tenant's elements.
📄️ CIC Renewal Process for Element Device (v2.0)
Start the CIC renewal process for an element device.
📄️ Get Hardware Bypasses in Element (v2.0)
List all the hardware bypasses in an element.
📄️ Handle Operations on Element (v2.0)
Handle all the operations on an element.
📄️ Get Software Upgrade Configuration of Element (v2.0)
Get the software upgrade configuration of an element.
📄️ Upgrade an Element (v2.0)
Upgrade an element.
📄️ Get Image Status (v2.0)
Get the image status.
📄️ Get Element State (v2.0)
Get the element state.
📄️ Update Element State (v2.0)
Update the element state.
📄️ Create a System Report (v2.0)
Create a new system report using the support operations API.
📄️ Delete Active Passage (v2.0)
Delete an active passage.
📄️ Query Interface Status (v2.0)
Query the interface status.
📄️ Allocate Element Shell to Machine (v2.0)
Allocate the element shell to the machine.
📄️ Update Admin State Northbound (v2.0)
Update admin state Northbound.
📄️ Get Application Probe Configuration (v2.0)
Get the application probe configuration of an element.
📄️ Update Application Probe Configuration (v2.0)
Update the application probe configuration of an element.
📄️ Get Element Level Extensions (v2.0)
List all the element level extensions.
📄️ Create Element Level Extension Configuration (v2.0)
Create an element level extension configuration.
📄️ Query Element Level Extensions (v2.0)
Query element level extensions that match query parameters.
📄️ Delete Element Level Extension (v2.0)
Delete a specific extension associated with an element.
📄️ Get Element Level Extension (v2.0)
Get a specific extension associated with an element.
📄️ Update Element Level Extension (v2.0)
Update an element level extension configuration.
📄️ Reset Action on Interface (v2.0)
Reset an action on the device interface.
📄️ Get Site Level Extensions (v2.0)
List all the site level extensions.
📄️ Create Site Level Extension Configuration (v2.0)
Create site level extension configuration.
📄️ Query Site Level Extension (v2.0)
Query site level extensions that match query parameters.
📄️ Delete Site Level Extension (v2.0)
Delete a specific extension associated with a site.
📄️ Get Site Level Extension (v2.0)
Get a specific extension associated with a site.
📄️ Update Site Level Extension Configuration (v2.0)
Update a specific extension configuration associated with a site.
📄️ Get Active/Closed Sessions Details (v2.0)
List all the active and closed session details.
📄️ Query for Toolkit Sessions (v2.0)
Query the DB for toolkit sessions that match query parameters.
📄️ Get Vff License for Tenant (v2.0)
List all the Vff license for a tenant.
📄️ Query and Get Vff License (v2.0)
Query to get the virtual device(vff) license.
📄️ Query Vff License Tokens (v2.0)
Query all the tenant Vff license tokens.
📄️ Get Vff Licenses for Tenant (v2.0)
List all the specific Vff licenses for a tenant.
📄️ Vff Operation (v2.0)
List the vff operations.
📄️ Get Status for Vff License (v2.0)
List the status for the Vff license.
📄️ Get Tenant Vff License Tokens (v2.0)
List all the tenant Vff license tokens.
📄️ Create Tenant Vff License Token (v2.0)
Create a tenant Vff license token.
📄️ Get Tenant Vff License Token (v2.0)
List a specific tenant Vff license token.
📄️ Update Tenant Vff License Token (v2.0)
Update a specific tenant Vff license token.
📄️ Query to Get Vff License State (v2.0)
Query to get the license state of the virtual device (vff).
📄️ Get Extensions from NB (v2.0)
List all the extensions from NB.
📄️ Create Extension Configuration (v2.0)
Create an extension configuration.
📄️ Query DB for Tenant Extensions (v2.0)
Query the DB for limit number of tenant extensions that match the query params.
📄️ Delete Extensions Configuration (v2.0)
Delete a specific extension configuration.
📄️ Get Extensions Configuration from NB (v2.0)
Get a specific extension configuration from the NB.
📄️ Update Extensions Configuration (v2.0)
Update a specific extension configuration.
📄️ Change Mode of Element from FIPS to Non-FIPS (v2.1)
Change the mode of an element from FIPS to Non-FIPS or vice-versa.
📄️ Get Software Upgrade Status (v2.1)
List all the software upgrade status (up to 5) started by the tenant user.
📄️ Get Machine System Status (v2.1)
Get the machine system status for a tenant.
📄️ Get Recovery Token for Machine (v2.1)
Get the recovery token for a machine.
📄️ Create Recovery Token for FIPs (v2.1)
Create a recovery token for the FIPs change mode.
📄️ Update Recovery Token for FIPs (v2.1)
Update a recovery token for the FIPs change mode.
📄️ Get Image Status of Element (v2.1)
Get the current image status of all the elements.
📄️ Query Software Upgrade Status (v2.1)
Query the software upgrade status of all the tenant elements.
📄️ Get Vff Licenses for Tenant (v2.1)
List all the Vff licenses for a tenant.
📄️ Get Vff License for Tenant (v2.1)
List all the specific Vff licenses for a tenant.
📄️ Get Status for Vff License (v2.1)
List the status for the Vff license.
📄️ Get Machines of Tenant (v2.3)
List all the machines of a tenant.
📄️ Query Tenant's Client (v2.3)
Query the machines allocated by the MSP to a client tenant.
📄️ Get Machine of Tenant (v2.3)
Get a specific machine allocated by the MSP to a client tenant.
📄️ Update Tenant Machine (v2.3)
Reallocate a specific machine from one client tenant to another, where both client tenants are clients of the same MSP.
📄️ Get Machines of Tenant (v2.3)
Get all machines of a tenant.
📄️ Query Machine of Tenant (v2.3)
Query the machines of a tenant.
📄️ Get Tenant Machine (v2.3)
Get a specific machine of a tenant.
📄️ Update Tenant Machine (v2.3)
Update a specific machine of a tenant using operations.
📄️ Query Element Status Objects for Tenant (v2.4)
Query and get element the status objects for a tenant.
📄️ Get Element Status for Tenant (v2.4)
Get a specific element status for a tenant.
📄️ Get Machines Allocated by ESP to Client Tenant (v2.5)
Get all machines allocated by ESP to a client tenant.
📄️ Query Machines Allocated by MSP to Client Tenant (v2.5)
Query and get all machines allocated by ESP to a client tenant.
📄️ Get Machine allocated by MSP to a Client Tenant (v2.5)
Get a specific machine allocated by ESP to a client tenant.
📄️ Update Machine from Client of same ESP (v2.5)
Reallocate a specific machine from one client tenant to another, where both client tenants are clients of the same MSP.
📄️ Query Element Status Objects for Tenant (v2.5)
Query and get element the status objects for a tenant.
📄️ Get Element Status for Tenant (v2.5)
Get a specific element status for a tenant.
📄️ Get Machines of Tenant (v2.5)
Get all the machines of a tenant.
📄️ Query Machine of Tenant (v2.5)
Query the machines of a tenant.
📄️ Get Tenant Machine (v2.5)
Get a specific machine of a tenant.
📄️ Update Tenant Machine (v2.5)
Update a specific machine of a tenant using operations.
📄️ Query Client Elements across Regions (v3.0)
Query and list all client elements across regions.
📄️ Get Element of Tenant (v3.1)
Get the element of a tenant.
📄️ Query DB for Elements (v3.1)
Query the DB for elements that match the query parameters.
📄️ Get Element of Tenant (v3.1)
Get the element of a tenant.
📄️ Update Element for Associations (v3.1)
Update element for associations.
📄️ Query MSP Machines across Regions (v3.1)
Query and get all MSP machines across regions.
📄️ Get Elements of a tenant (v3.2)
Get Elements of a tenant
📄️ Query DB for Elements (v3.2)
Query the DB for elements that match the query parameters.
📄️ Get Element of Tenant (v3.2)
Get the element of a tenant.
📄️ Update Element for Associations (v3.2)
Update element for associations.
📄️ Query MSP Machines across Regions (v3.2)
Query and get all MSP machines across regions.
📄️ Get Interface Status (v3.8)
Get interface status.
📄️ Get interface status (v3.9)
Get interface status
📄️ Query DB for limit number of Interfaces (4.20)
Queries the DB for limit number of interfaces that match query params.
📄️ Get all Interfaces (v4.20)
List all the interfaces.
📄️ Create an Interface (v4.20)
Create an interface.
📄️ Delete an Interface (v4.20)
Delete a device interface.
📄️ Get an Interface (v4.20)
List a device interface.
📄️ Update an Interface (v4.20)
Update a device interface.
📄️ Query Interfaces (v4.21)
Query DB for limit number of interfaces that match query params.
📄️ Get all Interfaces (v4.21)
List all the interfaces.
📄️ Create an Interface (v4.21)
Create an interface.
📄️ Delete an Interface (v4.21)
Delete a device interface.
📄️ Get an Interface (v4.21)
List a device interface.
📄️ Update an Interface (v4.21)
Update a device interface.