1. REST API for Oracle Internet of Things Cloud Service
  2. Tasks
  3. Provisioner

Provisioning File for a Single Device

post

/iot/api/v2/provisioner/device

Get the provisioning file for a single device. The activation id is passed in the request payload

Request

Supported Media Types
Body ()
Root Schema : ProvisioningRequest_create
Type: object
Show Source
  • connectedDevices
    Identifiers for connected devices to be provisioned in this request. Identifiers may be hardware IDs for single devices or registration IDs for devices registered in batches. Any batch registrations included must be in the COMPLETED state.
  • Identifier of the entity to get provisioning information. This should activationId for single device, registrationId for a list of devices and integrationId for enterprise integration.
  • Passphrase that would be used to encrypt the provisioning attributes
  • Transport used by devices to communicate with the IoT Cloud service. Values are "https"
Nested Schema : connectedDevices
Type: array
Identifiers for connected devices to be provisioned in this request. Identifiers may be hardware IDs for single devices or registration IDs for devices registered in batches. Any batch registrations included must be in the COMPLETED state.
Show Source
Back to Top

Response

Supported Media Types

200 Response

Successfully processed
Body ()
Root Schema : ProvisioningRequest_create
Type: object
Show Source
  • connectedDevices
    Identifiers for connected devices to be provisioned in this request. Identifiers may be hardware IDs for single devices or registration IDs for devices registered in batches. Any batch registrations included must be in the COMPLETED state.
  • Identifier of the entity to get provisioning information. This should activationId for single device, registrationId for a list of devices and integrationId for enterprise integration.
  • Passphrase that would be used to encrypt the provisioning attributes
  • Transport used by devices to communicate with the IoT Cloud service. Values are "https"
Nested Schema : connectedDevices
Type: array
Identifiers for connected devices to be provisioned in this request. Identifiers may be hardware IDs for single devices or registration IDs for devices registered in batches. Any batch registrations included must be in the COMPLETED state.
Show Source

400 Response

Bad Request. The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications.

401 Response

Unauthorized. The request requires user authentication.

404 Response

Not Found. The server has not found anything matching the Request-URI. No indication is given of whether the condition is temporary or permanent.

410 Response

Gone. The request could not be completed because the resource is intentionally unavailable. This code is only allowed in situations where it is expected that resource is intentionally unavailable. The request can only be repeated if the cause for the unavailability changes
Back to Top

Examples

curl -X POST 
   -u <username>:<password> 
   -H 'Content-Type: application/json' 
   https://iotserver/iot/api/v2/provisioner/device

Example of Request Body

The following example shows the content of the request body in JSON format 


{
    "passphrase":"changeit",
    "id":"1d5a4be63833-4ce8", 
    "connectedDevices":["icdHardwareId1", "icdHardwareId2"]
}



Complete cURL Example

The following example shows compete cURL command that can be used to perform described operation

curl -X POST 
   -u <username>:<password> 
   -H 'Content-Type:application/json'  
   -d '{"id":"1d5a4be63833-4ce8","passphrase":"changeit","connectedDevices":["icdHardwareId1", "icdHardwareId2"]}' 
   https://iotserver/iot/api/v2/provisioner/device



Note that in the request, https://iotserver will be replaced by the name and port of your assigned IoT Cloud Service instance. The format of the Cloud Service instance is https:// myinstance-myidentitydomain.iot.us.oraclecloud.com and the default port is 443.
Back to Top