{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/cloud:azure-arm-databox/operations-list":{"get":{"operationId":"cloud_azure_arm_databox_operations_list","summary":"List the operations for the provider","description":"GET /providers/Microsoft.DataBox/operations","tags":["cloud"],"parameters":[{"name":"api-version","in":"query","required":false,"description":"The API version to use for this operation.","schema":{"type":"string","default":"2025-07-01","description":"The API version to use for this operation."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-arm-databox/jobs-list":{"get":{"operationId":"cloud_azure_arm_databox_jobs_list","summary":"Lists all the jobs available under the subscription.","description":"GET /subscriptions/{subscriptionId}/providers/Microsoft.DataBox/jobs","tags":["cloud"],"parameters":[{"name":"api-version","in":"query","required":false,"description":"The API version to use for this operation.","schema":{"type":"string","default":"2025-07-01","description":"The API version to use for this operation."}},{"name":"subscriptionId","in":"query","required":true,"description":"The ID of the target subscription.","schema":{"type":"string","description":"The ID of the target subscription."}},{"name":"$skipToken","in":"query","required":false,"description":"$skipToken is supported on Get list of jobs, which provides the next page in the list of jobs.","schema":{"type":"string","description":"$skipToken is supported on Get list of jobs, which provides the next page in the list of jobs."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-arm-databox/service-region-configuration":{"post":{"operationId":"cloud_azure_arm_databox_service_region_configuration","summary":"This API provides configuration details specific to given region/location at Subscription level.","description":"POST /subscriptions/{subscriptionId}/providers/Microsoft.DataBox/locations/{location}/regionConfiguration","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["subscriptionId","location","body"],"properties":{"api-version":{"type":"string","default":"2025-07-01","description":"The API version to use for this operation."},"subscriptionId":{"type":"string","description":"The ID of the target subscription."},"location":{"type":"string","description":"The name of Azure region."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-arm-databox/service-validate-inputs":{"post":{"operationId":"cloud_azure_arm_databox_service_validate_inputs","summary":"This method does all necessary pre-job creation validation under subscription.","description":"POST /subscriptions/{subscriptionId}/providers/Microsoft.DataBox/locations/{location}/validateInputs","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["subscriptionId","location","body"],"properties":{"api-version":{"type":"string","default":"2025-07-01","description":"The API version to use for this operation."},"subscriptionId":{"type":"string","description":"The ID of the target subscription."},"location":{"type":"string","description":"The name of Azure region."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-arm-databox/jobs-list-by-resource-group":{"get":{"operationId":"cloud_azure_arm_databox_jobs_list_by_resource_group","summary":"Lists all the jobs available under the given resource group.","description":"GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs","tags":["cloud"],"parameters":[{"name":"api-version","in":"query","required":false,"description":"The API version to use for this operation.","schema":{"type":"string","default":"2025-07-01","description":"The API version to use for this operation."}},{"name":"subscriptionId","in":"query","required":true,"description":"The ID of the target subscription.","schema":{"type":"string","description":"The ID of the target subscription."}},{"name":"resourceGroupName","in":"query","required":true,"description":"The name of the resource group. The name is case insensitive.","schema":{"type":"string","description":"The name of the resource group. The name is case insensitive."}},{"name":"$skipToken","in":"query","required":false,"description":"$skipToken is supported on Get list of jobs, which provides the next page in the list of jobs.","schema":{"type":"string","description":"$skipToken is supported on Get list of jobs, which provides the next page in the list of jobs."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-arm-databox/jobs-get":{"get":{"operationId":"cloud_azure_arm_databox_jobs_get","summary":"Gets information about the specified job.","description":"GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}","tags":["cloud"],"parameters":[{"name":"api-version","in":"query","required":false,"description":"The API version to use for this operation.","schema":{"type":"string","default":"2025-07-01","description":"The API version to use for this operation."}},{"name":"subscriptionId","in":"query","required":true,"description":"The ID of the target subscription.","schema":{"type":"string","description":"The ID of the target subscription."}},{"name":"resourceGroupName","in":"query","required":true,"description":"The name of the resource group. The name is case insensitive.","schema":{"type":"string","description":"The name of the resource group. The name is case insensitive."}},{"name":"jobName","in":"query","required":true,"description":"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…","schema":{"type":"string","description":"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…"}},{"name":"$expand","in":"query","required":false,"description":"$expand is supported on details parameter for job, which provides details on the job stages.","schema":{"type":"string","description":"$expand is supported on details parameter for job, which provides details on the job stages."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:azure-arm-databox/jobs-create":{"post":{"operationId":"cloud_azure_arm_databox_jobs_create","summary":"Creates a new job with the specified parameters. Existing job cannot be updated with this API and should…","description":"PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["subscriptionId","resourceGroupName","jobName","body"],"properties":{"api-version":{"type":"string","default":"2025-07-01","description":"The API version to use for this operation."},"subscriptionId":{"type":"string","description":"The ID of the target subscription."},"resourceGroupName":{"type":"string","description":"The name of the resource group. The name is case insensitive."},"jobName":{"type":"string","description":"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":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-arm-databox/jobs-update":{"post":{"operationId":"cloud_azure_arm_databox_jobs_update","summary":"Updates the properties of an existing job.","description":"PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["subscriptionId","resourceGroupName","jobName","body"],"properties":{"api-version":{"type":"string","default":"2025-07-01","description":"The API version to use for this operation."},"subscriptionId":{"type":"string","description":"The ID of the target subscription."},"resourceGroupName":{"type":"string","description":"The name of the resource group. The name is case insensitive."},"jobName":{"type":"string","description":"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":{"type":"string","description":"Defines the If-Match condition. The patch will be performed only if the ETag of the job on the server matches this value."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-arm-databox/jobs-delete":{"post":{"operationId":"cloud_azure_arm_databox_jobs_delete","summary":"Deletes a job.","description":"DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["subscriptionId","resourceGroupName","jobName"],"properties":{"api-version":{"type":"string","default":"2025-07-01","description":"The API version to use for this operation."},"subscriptionId":{"type":"string","description":"The ID of the target subscription."},"resourceGroupName":{"type":"string","description":"The name of the resource group. The name is case insensitive."},"jobName":{"type":"string","description":"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…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-arm-databox/jobs-book-shipment-pick-up":{"post":{"operationId":"cloud_azure_arm_databox_jobs_book_shipment_pick_up","summary":"Book shipment pick up.","description":"POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}/bookShipmentPickUp","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["subscriptionId","resourceGroupName","jobName","body"],"properties":{"api-version":{"type":"string","default":"2025-07-01","description":"The API version to use for this operation."},"subscriptionId":{"type":"string","description":"The ID of the target subscription."},"resourceGroupName":{"type":"string","description":"The name of the resource group. The name is case insensitive."},"jobName":{"type":"string","description":"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":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-arm-databox/jobs-cancel":{"post":{"operationId":"cloud_azure_arm_databox_jobs_cancel","summary":"CancelJob.","description":"POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}/cancel","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["subscriptionId","resourceGroupName","jobName","body"],"properties":{"api-version":{"type":"string","default":"2025-07-01","description":"The API version to use for this operation."},"subscriptionId":{"type":"string","description":"The ID of the target subscription."},"resourceGroupName":{"type":"string","description":"The name of the resource group. The name is case insensitive."},"jobName":{"type":"string","description":"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":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-arm-databox/jobs-list-credentials":{"post":{"operationId":"cloud_azure_arm_databox_jobs_list_credentials","summary":"This method gets the unencrypted secrets related to the job.","description":"POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}/listCredentials","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["subscriptionId","resourceGroupName","jobName"],"properties":{"api-version":{"type":"string","default":"2025-07-01","description":"The API version to use for this operation."},"subscriptionId":{"type":"string","description":"The ID of the target subscription."},"resourceGroupName":{"type":"string","description":"The name of the resource group. The name is case insensitive."},"jobName":{"type":"string","description":"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…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-arm-databox/jobs-mark-devices-shipped":{"post":{"operationId":"cloud_azure_arm_databox_jobs_mark_devices_shipped","summary":"Request to mark devices for a given job as shipped","description":"POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}/markDevicesShipped","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["subscriptionId","resourceGroupName","jobName","body"],"properties":{"api-version":{"type":"string","default":"2025-07-01","description":"The API version to use for this operation."},"subscriptionId":{"type":"string","description":"The ID of the target subscription."},"resourceGroupName":{"type":"string","description":"The name of the resource group. The name is case insensitive."},"jobName":{"type":"string","description":"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":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-arm-databox/mitigate":{"post":{"operationId":"cloud_azure_arm_databox_mitigate","summary":"Request to mitigate for a given job","description":"POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}/mitigate","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["subscriptionId","resourceGroupName","jobName","body"],"properties":{"api-version":{"type":"string","default":"2025-07-01","description":"The API version to use for this operation."},"subscriptionId":{"type":"string","description":"The ID of the target subscription."},"resourceGroupName":{"type":"string","description":"The name of the resource group. The name is case insensitive."},"jobName":{"type":"string","description":"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":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-arm-databox/service-list-available-skus-by-resource-group":{"post":{"operationId":"cloud_azure_arm_databox_service_list_available_skus_by_resource_group","summary":"This method provides the list of available skus for the given subscription, resource group and location.","description":"POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/locations/{location}/availableSkus","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["subscriptionId","resourceGroupName","location","body"],"properties":{"api-version":{"type":"string","default":"2025-07-01","description":"The API version to use for this operation."},"subscriptionId":{"type":"string","description":"The ID of the target subscription."},"resourceGroupName":{"type":"string","description":"The name of the resource group. The name is case insensitive."},"location":{"type":"string","description":"The name of Azure region."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-arm-databox/service-region-configuration-by-resource-group":{"post":{"operationId":"cloud_azure_arm_databox_service_region_configuration_by_resource_group","summary":"This API provides configuration details specific to given region/location at Resource group level.","description":"POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/locations/{location}/regionConfiguration","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["subscriptionId","resourceGroupName","location","body"],"properties":{"api-version":{"type":"string","default":"2025-07-01","description":"The API version to use for this operation."},"subscriptionId":{"type":"string","description":"The ID of the target subscription."},"resourceGroupName":{"type":"string","description":"The name of the resource group. The name is case insensitive."},"location":{"type":"string","description":"The name of Azure region."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:azure-arm-databox/service-validate-inputs-by-resource-group":{"post":{"operationId":"cloud_azure_arm_databox_service_validate_inputs_by_resource_group","summary":"This method does all necessary pre-job creation validation under resource group.","description":"POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/locations/{location}/validateInputs","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["subscriptionId","resourceGroupName","location","body"],"properties":{"api-version":{"type":"string","default":"2025-07-01","description":"The API version to use for this operation."},"subscriptionId":{"type":"string","description":"The ID of the target subscription."},"resourceGroupName":{"type":"string","description":"The name of the resource group. The name is case insensitive."},"location":{"type":"string","description":"The name of Azure region."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}