# Azure Data Box management API

> Azure Data Box management API on Apizie: 17 endpoints (List the operations for the provider, Lists all the jobs available under the subscription., This API provides configuration details specific to given region/location at Subscription level., This method does all necessary pre-job creation validation under subscription., …) 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://zieapi.vercel.app/v1/cloud:azure-arm-databox/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:azure-arm-databox`
- Category: Cloud
- Status: byok
- Source: https://learn.microsoft.com/rest/api/azure/
- Page: https://zieapi.vercel.app/api/cloud/azure-arm-databox
- OpenAPI: https://zieapi.vercel.app/api/cloud/azure-arm-databox/openapi.json

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

## Endpoints

### List the operations for the provider
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-databox/operations-list` (byok)

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

### Lists all the jobs available under the subscription.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-databox/jobs-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. |
| $skipToken | string | no | $skipToken is supported on Get list of jobs, which provides the next page in the list of jobs. |

### This API provides configuration details specific to given region/location at Subscription level.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-databox/service-region-configuration` (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. |
| location | string | yes | The name of Azure region. |
| body | object | yes | JSON request body |

### This method does all necessary pre-job creation validation under subscription.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-databox/service-validate-inputs` (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. |
| location | string | yes | The name of Azure region. |
| body | object | yes | JSON request body |

### Lists all the jobs available under the given resource group.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-databox/jobs-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. |
| $skipToken | string | no | $skipToken is supported on Get list of jobs, which provides the next page in the list of jobs. |

### Gets information about the specified job.
`GET https://zieapi.vercel.app/v1/cloud:azure-arm-databox/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. |
| jobName | string | yes | The name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any… |
| $expand | string | no | $expand is supported on details parameter for job, which provides details on the job stages. |

### Creates a new job with the specified parameters. Existing job cannot be updated with this API and should…
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-databox/jobs-create` (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. |
| jobName | string | yes | The name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any… |
| body | object | yes | JSON request body |

### Updates the properties of an existing job.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-databox/jobs-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. |
| jobName | string | yes | The name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any… |
| If-Match | string | no | Defines the If-Match condition. The patch will be performed only if the ETag of the job on the server matches this value. |
| body | object | yes | JSON request body |

### Deletes a job.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-databox/jobs-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. |
| jobName | string | yes | The name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any… |

### Book shipment pick up.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-databox/jobs-book-shipment-pick-up` (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. |
| jobName | string | yes | The name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any… |
| body | object | yes | JSON request body |

### CancelJob.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-databox/jobs-cancel` (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. |
| jobName | string | yes | The name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any… |
| body | object | yes | JSON request body |

### This method gets the unencrypted secrets related to the job.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-databox/jobs-list-credentials` (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. |
| jobName | string | yes | The name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any… |

### Request to mark devices for a given job as shipped
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-databox/jobs-mark-devices-shipped` (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. |
| jobName | string | yes | The name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any… |
| body | object | yes | JSON request body |

### Request to mitigate for a given job
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-databox/mitigate` (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. |
| jobName | string | yes | The name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any… |
| body | object | yes | JSON request body |

### This method provides the list of available skus for the given subscription, resource group and location.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-databox/service-list-available-skus-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. |
| location | string | yes | The name of Azure region. |
| body | object | yes | JSON request body |

### This API provides configuration details specific to given region/location at Resource group level.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-databox/service-region-configuration-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. |
| location | string | yes | The name of Azure region. |
| body | object | yes | JSON request body |

### This method does all necessary pre-job creation validation under resource group.
`POST https://zieapi.vercel.app/v1/cloud:azure-arm-databox/service-validate-inputs-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. |
| location | string | yes | The name of Azure region. |
| body | object | yes | JSON request body |

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:azure-arm-databox/operations-list" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

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

### Is the Azure Data Box 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 management itself also needs your own key from azure.com.

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

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