# Azure Data Box Edge management API

> Azure Data Box Edge management API on Apizie: 77 endpoints (List all the supported operations., List all the available Skus and information related to them., Gets all the Data Box Edge/Data Box Gateway devices in a subscription., Gets all the Data Box Edge/Data Box Gateway devices in a resource group., …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://www.apizie.tech/v1/cloud:azure-arm-databoxedge/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:azure-arm-databoxedge`
- Category: Cloud
- Status: byok
- Source: https://learn.microsoft.com/rest/api/azure/
- Page: https://www.apizie.tech/api/cloud/azure-arm-databoxedge
- OpenAPI: https://www.apizie.tech/api/cloud/azure-arm-databoxedge/openapi.json

Azure Resource Manager API for Data Box Edge: manage these Azure resources in your subscription with a Microsoft Entra access token.

## Endpoints

### List all the supported operations.
`GET https://www.apizie.tech/v1/cloud:azure-arm-databoxedge/operations-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |

### List all the available Skus and information related to them.
`GET https://www.apizie.tech/v1/cloud:azure-arm-databoxedge/available-skus-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. |

### Gets all the Data Box Edge/Data Box Gateway devices in a subscription.
`GET https://www.apizie.tech/v1/cloud:azure-arm-databoxedge/devices-list-by-subscription` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. |
| $expand | string | no | Specify $expand=details to populate additional fields related to the resource or Specify $skipToken= to populate the next page in the list. |

### Gets all the Data Box Edge/Data Box Gateway devices in a resource group.
`GET https://www.apizie.tech/v1/cloud:azure-arm-databoxedge/devices-list-by-resource-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| $expand | string | no | Specify $expand=details to populate additional fields related to the resource or Specify $skipToken= to populate the next page in the list. |

### Gets the properties of the Data Box Edge/Data Box Gateway device.
`GET https://www.apizie.tech/v1/cloud:azure-arm-databoxedge/devices-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| deviceName | string | yes | The device name. |

### Creates or updates a Data Box Edge/Data Box Gateway resource.
`POST https://www.apizie.tech/v1/cloud:azure-arm-databoxedge/devices-create-or-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| deviceName | string | yes | The device name. |
| body | object | yes | JSON request body |

### Modifies a Data Box Edge/Data Box Gateway resource.
`POST https://www.apizie.tech/v1/cloud:azure-arm-databoxedge/devices-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| deviceName | string | yes | The device name. |
| body | object | yes | JSON request body |

### Deletes the Data Box Edge/Data Box Gateway device.
`POST https://www.apizie.tech/v1/cloud:azure-arm-databoxedge/devices-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| deviceName | string | yes | The device name. |

### Gets all the alerts for a Data Box Edge/Data Box Gateway device.
`GET https://www.apizie.tech/v1/cloud:azure-arm-databoxedge/alerts-list-by-data-box-edge-device` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| deviceName | string | yes | The device name. |

### Gets an alert by name.
`GET https://www.apizie.tech/v1/cloud:azure-arm-databoxedge/alerts-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| deviceName | string | yes | The device name. |
| name | string | yes | The alert name. |

### Gets all the bandwidth schedules for a Data Box Edge/Data Box Gateway device.
`GET https://www.apizie.tech/v1/cloud:azure-arm-databoxedge/bandwidth-schedules-list-by-data-box-edge-device` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| deviceName | string | yes | The device name. |

### Gets the properties of the specified bandwidth schedule.
`GET https://www.apizie.tech/v1/cloud:azure-arm-databoxedge/bandwidth-schedules-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| deviceName | string | yes | The device name. |
| name | string | yes | The bandwidth schedule name. |

### Creates or updates a bandwidth schedule.
`POST https://www.apizie.tech/v1/cloud:azure-arm-databoxedge/bandwidth-schedules-create-or-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| deviceName | string | yes | The device name. |
| name | string | yes | The bandwidth schedule name. |
| body | object | yes | JSON request body |

### Deletes the specified bandwidth schedule.
`POST https://www.apizie.tech/v1/cloud:azure-arm-databoxedge/bandwidth-schedules-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| deviceName | string | yes | The device name. |
| name | string | yes | The bandwidth schedule name. |

### Posts the device capacity request info to check feasibility.
`POST https://www.apizie.tech/v1/cloud:azure-arm-databoxedge/device-capacity-check-check-resource-creation-feasibility` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| deviceName | string | yes | The device name. |
| capacityName | string | no | The capacity name. |
| body | object | yes | JSON request body |

### Gets the properties of the specified device capacity info.
`GET https://www.apizie.tech/v1/cloud:azure-arm-databoxedge/device-capacity-info-get-device-capacity-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| deviceName | string | yes | The device name. |

### Gets the proactive log collection settings of the specified Data Box Edge/Data Box Gateway device.
`GET https://www.apizie.tech/v1/cloud:azure-arm-databoxedge/diagnostic-settings-get-diagnostic-proactive-log-collection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| deviceName | string | yes | The device name. |

### Updates the proactive log collection settings on a Data Box Edge/Data Box Gateway device.
`POST https://www.apizie.tech/v1/cloud:azure-arm-databoxedge/diagnostic-settings-update-diagnostic-proactive-log-collecti` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| deviceName | string | yes | The device name. |
| body | object | yes | JSON request body |

### Gets the diagnostic remote support settings of the specified Data Box Edge/Data Box Gateway device.
`GET https://www.apizie.tech/v1/cloud:azure-arm-databoxedge/diagnostic-settings-get-diagnostic-remote-support-settings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| deviceName | string | yes | The device name. |

### Updates the diagnostic remote support settings on a Data Box Edge/Data Box Gateway device.
`POST https://www.apizie.tech/v1/cloud:azure-arm-databoxedge/diagnostic-settings-update-diagnostic-remote-support-setting` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| deviceName | string | yes | The device name. |
| body | object | yes | JSON request body |

### Downloads the updates on a Data Box Edge/Data Box Gateway device.
`POST https://www.apizie.tech/v1/cloud:azure-arm-databoxedge/devices-download-updates` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| deviceName | string | yes | The device name. |

### Generates certificate for activation key.
`POST https://www.apizie.tech/v1/cloud:azure-arm-databoxedge/devices-generate-certificate` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| deviceName | string | yes | The device name. |

### Gets additional information for the specified Azure Stack Edge/Data Box Gateway device.
`POST https://www.apizie.tech/v1/cloud:azure-arm-databoxedge/devices-get-extended-information` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| deviceName | string | yes | The device name. |

### Installs the updates on the Data Box Edge/Data Box Gateway device.
`POST https://www.apizie.tech/v1/cloud:azure-arm-databoxedge/devices-install-updates` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| deviceName | string | yes | The device name. |

### Gets the details of a specified job on a Data Box Edge/Data Box Gateway device.
`GET https://www.apizie.tech/v1/cloud:azure-arm-databoxedge/jobs-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| deviceName | string | yes | The device name. |
| name | string | yes | The job name. |

### Gets the network settings of the specified Data Box Edge/Data Box Gateway device.
`GET https://www.apizie.tech/v1/cloud:azure-arm-databoxedge/devices-get-network-settings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| deviceName | string | yes | The device name. |

### Gets all the nodes currently configured under this Data Box Edge device
`GET https://www.apizie.tech/v1/cloud:azure-arm-databoxedge/nodes-list-by-data-box-edge-device` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| deviceName | string | yes | The device name. |

### Gets the details of a specified job on a Data Box Edge/Data Box Gateway device.
`GET https://www.apizie.tech/v1/cloud:azure-arm-databoxedge/operations-status-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| deviceName | string | yes | The device name. |
| name | string | yes | The job name. |

### Lists all the orders related to a Data Box Edge/Data Box Gateway device.
`GET https://www.apizie.tech/v1/cloud:azure-arm-databoxedge/orders-list-by-data-box-edge-device` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| deviceName | string | yes | The device name. |

### Gets a specific order by name.
`GET https://www.apizie.tech/v1/cloud:azure-arm-databoxedge/orders-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| deviceName | string | yes | The device name. |

### Creates or updates an order.
`POST https://www.apizie.tech/v1/cloud:azure-arm-databoxedge/orders-create-or-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| deviceName | string | yes | The device name. |
| body | object | yes | JSON request body |

### Deletes the order related to the device.
`POST https://www.apizie.tech/v1/cloud:azure-arm-databoxedge/orders-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| deviceName | string | yes | The device name. |

### Gets the DCAccess Code
`POST https://www.apizie.tech/v1/cloud:azure-arm-databoxedge/orders-list-dcaccess-code` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| deviceName | string | yes | The device name. |

### Lists all the roles configured in a Data Box Edge/Data Box Gateway device.
`GET https://www.apizie.tech/v1/cloud:azure-arm-databoxedge/roles-list-by-data-box-edge-device` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| deviceName | string | yes | The device name. |

### Gets a specific role by name.
`GET https://www.apizie.tech/v1/cloud:azure-arm-databoxedge/roles-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| deviceName | string | yes | The device name. |
| name | string | yes | The role name. |

### Create or update a role.
`POST https://www.apizie.tech/v1/cloud:azure-arm-databoxedge/roles-create-or-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| deviceName | string | yes | The device name. |
| name | string | yes | The role name. |
| body | object | yes | JSON request body |

### Deletes the role on the device.
`POST https://www.apizie.tech/v1/cloud:azure-arm-databoxedge/roles-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| deviceName | string | yes | The device name. |
| name | string | yes | The role name. |

### Lists all the addons configured in the role.
`GET https://www.apizie.tech/v1/cloud:azure-arm-databoxedge/addons-list-by-role` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| deviceName | string | yes | The name of the device. |
| roleName | string | yes | The name of the role. |

### Gets a specific addon by name.
`GET https://www.apizie.tech/v1/cloud:azure-arm-databoxedge/addons-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| deviceName | string | yes | The name of the device. |
| roleName | string | yes | The name of the role. |
| addonName | string | yes | The name of the addon. |

### Create or update a addon.
`POST https://www.apizie.tech/v1/cloud:azure-arm-databoxedge/addons-create-or-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| deviceName | string | yes | The name of the device. |
| roleName | string | yes | The name of the role. |
| addonName | string | yes | The name of the addon. |
| body | object | yes | JSON request body |

### Deletes the addon on the device.
`POST https://www.apizie.tech/v1/cloud:azure-arm-databoxedge/addons-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| deviceName | string | yes | The name of the device. |
| roleName | string | yes | The name of the role. |
| addonName | string | yes | The name of the addon. |

### Lists metric configurations in a role.
`GET https://www.apizie.tech/v1/cloud:azure-arm-databoxedge/monitoring-config-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| deviceName | string | yes | The name of the device. |
| roleName | string | yes | The name of the role. |

### Gets a metric configuration of a role.
`GET https://www.apizie.tech/v1/cloud:azure-arm-databoxedge/monitoring-config-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| deviceName | string | yes | The name of the device. |
| roleName | string | yes | The name of the role. |

### Creates a new metric configuration or updates an existing one for a role.
`POST https://www.apizie.tech/v1/cloud:azure-arm-databoxedge/monitoring-config-create-or-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| deviceName | string | yes | The name of the device. |
| roleName | string | yes | The name of the role. |
| body | object | yes | JSON request body |

### deletes a new metric configuration for a role.
`POST https://www.apizie.tech/v1/cloud:azure-arm-databoxedge/monitoring-config-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| deviceName | string | yes | The name of the device. |
| roleName | string | yes | The name of the role. |

### Scans for updates on a Data Box Edge/Data Box Gateway device.
`POST https://www.apizie.tech/v1/cloud:azure-arm-databoxedge/devices-scan-for-updates` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| deviceName | string | yes | The device name. |

### Updates the security settings on a Data Box Edge/Data Box Gateway device.
`POST https://www.apizie.tech/v1/cloud:azure-arm-databoxedge/devices-create-or-update-security-settings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| deviceName | string | yes | The device name. |
| body | object | yes | JSON request body |

### Lists all the shares in a Data Box Edge/Data Box Gateway device.
`GET https://www.apizie.tech/v1/cloud:azure-arm-databoxedge/shares-list-by-data-box-edge-device` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| deviceName | string | yes | The device name. |

### Gets a share by name.
`GET https://www.apizie.tech/v1/cloud:azure-arm-databoxedge/shares-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| deviceName | string | yes | The device name. |
| name | string | yes | The share name. |

### Creates a new share or updates an existing share on the device.
`POST https://www.apizie.tech/v1/cloud:azure-arm-databoxedge/shares-create-or-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| deviceName | string | yes | The device name. |
| name | string | yes | The share name. |
| body | object | yes | JSON request body |

### Deletes the share on the Data Box Edge/Data Box Gateway device.
`POST https://www.apizie.tech/v1/cloud:azure-arm-databoxedge/shares-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| deviceName | string | yes | The device name. |
| name | string | yes | The share name. |

### Refreshes the share metadata with the data from the cloud.
`POST https://www.apizie.tech/v1/cloud:azure-arm-databoxedge/shares-refresh` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| deviceName | string | yes | The device name. |
| name | string | yes | The share name. |

### Gets all the storage account credentials in a Data Box Edge/Data Box Gateway device.
`GET https://www.apizie.tech/v1/cloud:azure-arm-databoxedge/storage-account-credentials-list-by-data-box-edge-device` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| deviceName | string | yes | The device name. |

### Gets the properties of the specified storage account credential.
`GET https://www.apizie.tech/v1/cloud:azure-arm-databoxedge/storage-account-credentials-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| deviceName | string | yes | The device name. |
| name | string | yes | The storage account credential name. |

### Creates or updates the storage account credential.
`POST https://www.apizie.tech/v1/cloud:azure-arm-databoxedge/storage-account-credentials-create-or-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| deviceName | string | yes | The device name. |
| name | string | yes | The storage account credential name. |
| body | object | yes | JSON request body |

### Deletes the storage account credential.
`POST https://www.apizie.tech/v1/cloud:azure-arm-databoxedge/storage-account-credentials-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| deviceName | string | yes | The device name. |
| name | string | yes | The storage account credential name. |

### Lists all the StorageAccounts in a Data Box Edge/Data Box Gateway device.
`GET https://www.apizie.tech/v1/cloud:azure-arm-databoxedge/storage-accounts-list-by-data-box-edge-device` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| deviceName | string | yes | The device name. |

### Gets a StorageAccount by name.
`GET https://www.apizie.tech/v1/cloud:azure-arm-databoxedge/storage-accounts-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| deviceName | string | yes | The device name. |
| storageAccountName | string | yes | The storage account name. |

### Creates a new StorageAccount or updates an existing StorageAccount on the device.
`POST https://www.apizie.tech/v1/cloud:azure-arm-databoxedge/storage-accounts-create-or-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| deviceName | string | yes | The device name. |
| storageAccountName | string | yes | The storage account name. |
| body | object | yes | JSON request body |

### Deletes the StorageAccount on the Data Box Edge/Data Box Gateway device.
`POST https://www.apizie.tech/v1/cloud:azure-arm-databoxedge/storage-accounts-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| deviceName | string | yes | The device name. |
| storageAccountName | string | yes | The storage account name. |

### Lists all the containers of a storage Account in a Data Box Edge/Data Box Gateway device.
`GET https://www.apizie.tech/v1/cloud:azure-arm-databoxedge/containers-list-by-storage-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| deviceName | string | yes | The device name. |
| storageAccountName | string | yes | The storage account name. |

### Gets a container by name.
`GET https://www.apizie.tech/v1/cloud:azure-arm-databoxedge/containers-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| deviceName | string | yes | The device name. |
| storageAccountName | string | yes | The storage account name. |
| containerName | string | yes | The container Name |

### Creates a new container or updates an existing container on the device.
`POST https://www.apizie.tech/v1/cloud:azure-arm-databoxedge/containers-create-or-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| deviceName | string | yes | The device name. |
| storageAccountName | string | yes | The storage account name. |
| containerName | string | yes | The container Name |
| body | object | yes | JSON request body |

### Deletes the container on the Data Box Edge/Data Box Gateway device.
`POST https://www.apizie.tech/v1/cloud:azure-arm-databoxedge/containers-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| deviceName | string | yes | The device name. |
| storageAccountName | string | yes | The storage account name. |
| containerName | string | yes | The container Name |

### Refreshes the container metadata with the data from the cloud.
`POST https://www.apizie.tech/v1/cloud:azure-arm-databoxedge/containers-refresh` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| deviceName | string | yes | The device name. |
| storageAccountName | string | yes | The storage account name. |
| containerName | string | yes | The container Name |

### Triggers support package on the device
`POST https://www.apizie.tech/v1/cloud:azure-arm-databoxedge/support-packages-trigger-support-package` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| deviceName | string | yes | The device name. |
| body | object | yes | JSON request body |

### Lists all the triggers configured in the device.
`GET https://www.apizie.tech/v1/cloud:azure-arm-databoxedge/triggers-list-by-data-box-edge-device` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| deviceName | string | yes | The device name. |
| $filter | string | no | Specify $filter='CustomContextTag eq ' to filter on custom context tag property |

### Get a specific trigger by name.
`GET https://www.apizie.tech/v1/cloud:azure-arm-databoxedge/triggers-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| deviceName | string | yes | The device name. |
| name | string | yes | The trigger name. |

### Creates or updates a trigger.
`POST https://www.apizie.tech/v1/cloud:azure-arm-databoxedge/triggers-create-or-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| deviceName | string | yes | The device name. |
| name | string | yes | The trigger name. |
| body | object | yes | JSON request body |

### Deletes the trigger on the gateway device.
`POST https://www.apizie.tech/v1/cloud:azure-arm-databoxedge/triggers-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| deviceName | string | yes | The device name. |
| name | string | yes | The trigger name. |

### Gets additional information for the specified Data Box Edge/Data Box Gateway device.
`POST https://www.apizie.tech/v1/cloud:azure-arm-databoxedge/devices-update-extended-information` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| deviceName | string | yes | The device name. |
| body | object | yes | JSON request body |

### Gets information about the availability of updates based on the last scan of the device. It also gets…
`GET https://www.apizie.tech/v1/cloud:azure-arm-databoxedge/devices-get-update-summary` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| deviceName | string | yes | The device name. |

### Uploads registration certificate for the device.
`POST https://www.apizie.tech/v1/cloud:azure-arm-databoxedge/devices-upload-certificate` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| deviceName | string | yes | The device name. |
| body | object | yes | JSON request body |

### Gets all the users registered on a Data Box Edge/Data Box Gateway device.
`GET https://www.apizie.tech/v1/cloud:azure-arm-databoxedge/users-list-by-data-box-edge-device` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| deviceName | string | yes | The device name. |
| $filter | string | no | Specify $filter='Type eq ' to filter on user type property |

### Gets the properties of the specified user.
`GET https://www.apizie.tech/v1/cloud:azure-arm-databoxedge/users-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| deviceName | string | yes | The device name. |
| name | string | yes | The user name. |

### Creates a new user or updates an existing user's information on a Data Box Edge/Data Box Gateway device.
`POST https://www.apizie.tech/v1/cloud:azure-arm-databoxedge/users-create-or-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| deviceName | string | yes | The device name. |
| name | string | yes | The user name. |
| body | object | yes | JSON request body |

### Deletes the user on a databox edge/gateway device.
`POST https://www.apizie.tech/v1/cloud:azure-arm-databoxedge/users-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| deviceName | string | yes | The device name. |
| name | string | yes | The user name. |

## Example
```
curl "https://www.apizie.tech/v1/cloud:azure-arm-databoxedge/operations-list" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Azure Data Box Edge management API?
Create a free Apizie key, then send GET https://www.apizie.tech/v1/cloud:azure-arm-databoxedge/operations-list with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Azure Data Box Edge management API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Azure Data Box Edge management itself also needs your own key from azure.com.

### Can AI agents use the Azure Data Box Edge management API?
Yes. Add the Apizie MCP server (https://www.apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:azure-arm-databoxedge.

### What is the status of the Azure Data Box Edge management API?
Needs your own provider key (bring your own key)