Message

Manages messages.

APIDescription
GET {customer}/Messages?EdgeServerId={EdgeServerId}

Gets messages for edge servers belonging to the requesting customer.

DELETE {customer}/Messages?CustomerId={CustomerId}&EdgeServerId={EdgeServerId}

Delete messages.

ConnectorInstallation

Connector Installation Operations.

APIDescription
GET {customer}/ConnectorInstallation/VersionState?connectorVersion={connectorVersion}

Check supported connector installation version

Subscriptions

Azure Subscription Pool management

APIDescription
GET {customer}/Subscriptions

Get all Subscriptions

GET {customer}/Subscriptions/{id}

Get a subscription by its id

POST {customer}/Subscriptions

Add an Azure subscription to the AgentHub pool

PUT {customer}/Subscriptions/{id}

Update a Subscription record from AgentHub.

DELETE {customer}/Subscriptions/{id}

Delete a Subscription record from AgentHub.

GET {customer}/Subscriptions/Availability/{availability}

Get a value indicating whether it is safe to allocate SB namespaces.

EdgeServers

Edge servers management.

APIDescription
GET {customer}/EdgeServers/AllCustomers?take={take}&nextToken={nextToken}

Get all Edge Servers for all customers

GET {customer}/EdgeServers?Location={Location}

Get all Edge Servers

GET {customer}/{customerId}/EdgeServers/{id}/Services/{service}

Get Edge Server service details

GET {customer}/EdgeServers/{id}

Get the status of a an edge server

POST {customer}/EdgeServers

Create a EdgeServer record in AgentHub

PUT {customer}/EdgeServers

Update a EdgeServer records in AgentHub

PUT {customer}/EdgeServers/{id}

Update a EdgeServer record in AgentHub

DELETE {customer}/EdgeServers/{id}

Delete a EdgeServer record from AgentHub.

DELETE {customer}/EdgeServers?Location={Location}

Delete EdgeServers of a specific location from AgentHub.

POST {customer}/EdgeServers/Reboot

Reboots an edge server.

POST {customer}/EdgeServers/ForceReboot

Force Reboots an edge server. For recovering hung connectors only.

PUT {customer}/{customerId}/EdgeServers/{id}/Services/{service}

Updates an edge server service.

POST {customer}/EdgeServers/ForceUpgrade

Forces upgrade of an edge server.

POST {customer}/EdgeServers/ForceUpgrade/All

Forces upgrade of all edge server in a customer.

POST {customer}/EdgeServers/Lease

Lease an edgeserver from a list of edgeserver for a definite amount of time.

GET {customer}/{customerId}/EdgeServers/{id}/MsiProducts

Retrieve the msi products installed on the connector machine.

DELETE {customer}/{customerId}/EdgeServers/{id}/MsiProducts/{code}

Remove an msi product installed on the connector machine.

POST {customer}/EdgeServers/HealthDataRequest

Listen to HealthDataRequest events

POST {customer}/{customerId}/EdgeServers/{id}/Registry

Get a registry value from a connector machine

PUT {customer}/{customerId}/EdgeServers/{id}/Registry

Set a registry value on a connector machine

DELETE {customer}/{customerId}/EdgeServers/{id}/Registry

Delete a registry value on a connector machine

PUT {customer}/{customerId}/EdgeServers/{id}/InMaintenance

Manipulates InMaintenance state.

PUT {customer}/{customerId}/EdgeServers/{id}/RestorePackage

Restore package bundle.

AgentProcesses

Manages Agent Processes

APIDescription
PUT {customer}/AgentProcesses/{id}

Puts the process detail of an agent

DELETE {customer}/AgentProcesses/{id}

Deletes a associated agent process information

POST {customer}/AgentProcesses

Posts the process detail of an agent

GET {customer}/AgentProcesses

Gets the agent process information of all the supported components

EdgeServerVersions

Manages Edge Server versions

APIDescription
GET {customer}/ConnectorPackages

Gets connector packages

POST {customer}/ConnectorPackages

Creates a connector package

DELETE {customer}/ConnectorPackages?Name={Name}&Version={Version}

Deletes a connector package

DELETE {customer}/ConnectorPackages/Outdated

Deletes a connector package

GET {customer}/ConnectorReleases

Gets connector releases

GET {customer}/ConnectorReleases/Production

Gets production connector releases

GET {customer}/ConnectorReleases/Customer

Gets connector release for the customer.

GET {customer}/ConnectorReleases/Deployment

Gets connector release for the customer based on the deployment.

POST {customer}/ConnectorReleases

Creates a connector release

DELETE {customer}/ConnectorReleases?CustomerName={CustomerName}&ReleaseName={ReleaseName}

Deletes a connector release

Ping

Health check operations.

APIDescription
GET {customer}/Ping

This is used to check the service is running.

ServiceBusConnection

Service Bus Connections Operations.

APIDescription
GET {customer}/ServiceBusConnection?Availability={Availability}

ServiceBus Connection is used to get customers service bus record. A new ServiceBus Namespace is created if one does not exist yet. If multiple calls are made during create only one call will succeed.

DELETE {customer}/ServiceBusConnection?CustomerName={CustomerName}

ServiceBus Connection deletion is used to delete customers service bus namespace in Azure and its record in AgentHub

LogQueueConnection

Service Bus Connections Operations.

APIDescription
GET {customer}/LogQueueConnection

ServiceBus Connection is used to get customers service bus record. A new ServiceBus Namespace is created if one does not exist yet.