Microsoft IoTHub API

Microsoft IoTHub API Reference

get  /archivist/v2/iothubgdr

Description:

null
Response Parameter Type Description
operations array Long running operation
Responses Description
200A successful response.
401Returned when the user is not authenticated to the system.
403Returned when the user is not authorized to view Event.
defaultAn unexpected error response.

post  /archivist/v2/iothubgdr

Description:

{
  "arc_home_location_identity": "locations/25f812d3-10ab-4451-8bd1-fb02454c9361",
  "display_name": "My Company IoT Hub",
  "secret": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}
Parameter Type Description
arc_home_location_identity string Identity of locationas inlocations/add30235-1424-4fda-840a-d5ef82c4c96f`
display_name string display name for this import
secret string secret used to connect to IoT Hub

{
  "message": "abcd"
}
Response Parameter Type Description
done boolean indicates if import is still running
error
identity string unique identity of this operations
result
timestamp_accepted string time when import has been accepted by the API
timestamp_finished string time import finished
Responses Description
200A successful response.
401Returned when the user is not authenticated to the system.
403Returned when the user is not authorized to view Event.
defaultAn unexpected error response.

delete  /archivist/v2/{identity}

Description:

Responses Description
200A successful response.
401Returned when the user is not authenticated to the system.
403Returned when the user is not authorized to view Event.
404Returned when the IotHubGDR does not exist.
defaultAn unexpected error response.

get  /archivist/v2/{identity}

Description:

{
  "message": "abcd"
}
Response Parameter Type Description
done boolean indicates if import is still running
error
identity string unique identity of this operations
result
timestamp_accepted string time when import has been accepted by the API
timestamp_finished string time import finished
Responses Description
200A successful response.
401Returned when the user is not authenticated to the system.
403Returned when the user is not authorized to view Event.
404Returned when the IotHubGDR does not exist.
defaultAn unexpected error response.

post  /archivist/v2/{identity}:cancel

Description:

{
  "message": "abcd"
}
Response Parameter Type Description
done boolean indicates if import is still running
error
identity string unique identity of this operations
result
timestamp_accepted string time when import has been accepted by the API
timestamp_finished string time import finished
Responses Description
200A successful response.
401Returned when the user is not authenticated to the system.
403Returned when the user is not authorized to view Event.
404Returned when the IotHubGDR does not exist.
defaultAn unexpected error response.

Edit this page on GitHub