Ping

Health check operations.

APIDescription
GET {customer}/ping

This is used to check the service is running.

GET {customer}/utctime

This is used to get utc time.

Maintenance

Manages Edge Server maintenance.

APIDescription
GET {customer}/maintenance

Gets all maintenance for a customer.

GET {customer}/maintenance/{location}

Gets maintenance under an specific resource location.

GET {customer}/maintenance/history/{edgeServerId}?take={take}

Gets maintenance history for an specific edge server.

GET {customer}/maintenance/rollout/{manifestId}?verbose={verbose}

Gets maintenance roll-out progress.

POST {customer}/maintenance

Creates a maintenance entry.

PUT {customer}/maintenance/{location}

Updates a maintenance entry.

DELETE {customer}/maintenance

Deletes a maintenance entry by customer.

DELETE {customer}/maintenance/history/{customerid}/{historyid}

Deletes a maintenance history entity.

DELETE {customer}/maintenance/{location}

Deletes a maintenance entry.

PUT {customer}/maintenance/override

Updates a maintenance history override.

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

ConnectorCanary

Connector Canary Operations.

APIDescription
GET {customer}/ConnectorCanary/ReleaseInfo?ManifestName={ManifestName}&ManifestType={ManifestType}

GetConnector Release Info record

GET {customer}/ConnectorCanary/ReleaseInfoSummary?ManifestName={ManifestName}&ManifestType={ManifestType}

Get summary of all connector manifests and canary states.

PUT {customer}/ConnectorCanary/Rollback?rollback={rollback}&ManifestName={ManifestName}&ManifestType={ManifestType}

Updates connector rollback status at a global level.

POST {customer}/ConnectorCanary/Manifest

Creates a new connector manifest.

PUT {customer}/ConnectorCanary/Manifest?ManifestName={ManifestName}&ManifestType={ManifestType}

Updates connector canary state

PUT {customer}/ConnectorCanary/ManifestReleaseInfo?isCritical={isCritical}&manifestId={manifestId}&ManifestName={ManifestName}&ManifestType={ManifestType}

Updates Manifest Critical flag

PUT {customer}/ConnectorCanary/Manifest/Migrate?force={force}&reverseMigrate={reverseMigrate}

Migrates legacy manifests to new collection

PUT {customer}/ConnectorCanary/Feature

Creates or Updates connector canary features.

GET {customer}/ConnectorCanary/Feature

Get all Connector canary features.

DELETE {customer}/ConnectorCanary/Feature/{name}

Deletes a canary feature.

PUT {customer}/ConnectorCanary/CustomerManifest?customerId={customerId}&manifestId={manifestId}&ManifestName={ManifestName}&ManifestType={ManifestType}

Used to assign a manifest to a customer (mainly for hotfix purposes).

POST {customer}/ConnectorCanary/Customer/{customerId}?ManifestName={ManifestName}&ManifestType={ManifestType}

Create a customer record.

PUT {customer}/ConnectorCanary/Customer/{customerId}?ManifestName={ManifestName}&ManifestType={ManifestType}

Updates a customer record.

PUT {customer}/ConnectorCanary/Customer/Feature?ManifestName={ManifestName}&ManifestType={ManifestType}

Toggles customer feature.

GET {customer}/ConnectorCanary/Customer/{customerId}?ManifestName={ManifestName}&ManifestType={ManifestType}

Get a customer.

DELETE {customer}/ConnectorCanary/Manifest/{manifestId}?ManifestName={ManifestName}&ManifestType={ManifestType}

Deletes the Latest Manifests from Connector Canary Release or the Release Info Document.

DELETE {customer}/ConnectorCanary/Customer/{customerId}?ManifestName={ManifestName}&ManifestType={ManifestType}

Deletes a customer.

Customers

Customers operations.

APIDescription
GET {customer}/Customers

Get all customers with connector

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.

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}&ExtendedData={ExtendedData}&ConnectorType={ConnectorType}

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}&ExtendedData={ExtendedData}&ConnectorType={ConnectorType}

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

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

Get a registry sub keys from a connector machine

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

Get event viewer data from a connector machine

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

Set a event viewer entry in 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
POST {customer}/AgentProcesses

Posts the process detail of an agent

PUT {customer}/AgentProcesses/{id}

Puts the process detail of an agent

POST {customer}/AgentProcesses/Details

Posts the process detail of an agent.

GET {customer}/AgentProcesses

Gets the agent process information of all the supported components

DELETE {customer}/AgentProcesses/{id}

Deletes a associated agent process information

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

GET {customer}/ProviderManifests

Gets Unified Connector Providers

POST {customer}/ProviderManifests

Creates a Unified Connector Provider

DELETE {customer}/ProviderManifests?ProviderId={ProviderId}

Deletes a Unified Connector Provider

GET {customer}/ImageManifests

Gets Unified Connector Images

POST {customer}/ImageManifests

Creates a Unified Connector Image

GET {customer}/ImageManifest/{manifestId}

Gets a specific Unified Connector Image

DELETE {customer}/ImageManifests?imageId={imageId}

Deletes a Unified Connector Image

GET {customer}/ConnectorRoles?RoleName={RoleName}

Gets Unified Connector Roles

GET {customer}/ConnectorRoles/{id}

Gets Unified Connector Roles

POST {customer}/ConnectorRoles

Creates a Connector Role

PUT {customer}/ConnectorRoles

Creates a Connector Role

DELETE {customer}/ConnectorRoles/{id}

Deletes a Connector Role