Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ProvisionDevice

Creates a device and returns a configuration archive. The configuration archive is a ZIP file that contains a provisioning certificate that is valid for 5 minutes. Name the configuration archive certificates-omni_device-name.zip and transfer it to the device within 5 minutes. Use the included USB storage device and connect it to the USB 3.0 port next to the HDMI output.

Request Syntax


POST /devices HTTP/1.1
Content-type: application/json

{
   "Description": "string",
   "Name": "string",
   "NetworkingConfiguration": { 
      "Ethernet0": { 
         "ConnectionType": "string",
         "StaticIpConnectionInfo": { 
            "DefaultGateway": "string",
            "Dns": [ "string" ],
            "IpAddress": "string",
            "Mask": "string"
         }
      },
      "Ethernet1": { 
         "ConnectionType": "string",
         "StaticIpConnectionInfo": { 
            "DefaultGateway": "string",
            "Dns": [ "string" ],
            "IpAddress": "string",
            "Mask": "string"
         }
      },
      "Ntp": { 
         "NtpServers": [ "string" ]
      }
   },
   "Tags": { 
      "string" : "string" 
   }
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

Description

A description for the device.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 255.

Pattern: ^.*$

Required: No

Name

A name for the device.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: ^[a-zA-Z0-9\-\_]+$

Required: Yes

NetworkingConfiguration

A networking configuration for the device.

Type: NetworkPayload object

Required: No

Tags

Tags for the device.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: ^.+$

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Value Pattern: ^.*$

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Arn": "string",
   "Certificates": blob,
   "DeviceId": "string",
   "IotThingName": "string",
   "Status": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Arn

The device's ARN.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Certificates

The device's configuration bundle.

Type: Base64-encoded binary data object

DeviceId

The device's ID.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: ^[a-zA-Z0-9\-\_]+$

IotThingName

The device's IoT thing name.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Status

The device's status.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

The requestor does not have permission to access the target action or resource.

HTTP Status Code: 403

ConflictException

The target resource is in use.

HTTP Status Code: 409

InternalServerException

An internal error occurred.

HTTP Status Code: 500

ServiceQuotaExceededException

The request would cause a limit to be exceeded.

HTTP Status Code: 402

ValidationException

The request contains an invalid parameter value.

HTTP Status Code: 400