Method create
Creates a device in the specified registry.
HTTP request
POST https://iot-devices.api.cloud.yandex.net/iot-devices/v1/devices
Body parameters
{
"registryId": "string",
"name": "string",
"description": "string",
"certificates": [
{
"certificateData": "string"
}
],
"topicAliases": "object",
"password": "string"
}
| Field | Description |
|---|---|
| registryId | string Required. ID of the registry to create a device in. To get a registry ID, make a list request. The maximum string length in characters is 50. |
| name | string Required. Name of the device. The name must be unique within the registry. The maximum string length in characters is 50. Value must match the regular expression |
| description | string Description of the device. The maximum string length in characters is 256. |
| certificates[] | object Specification of a device certificate. |
| certificates[]. certificateData |
string Public part of the device certificate. |
| topicAliases | object Alias of a device topic. Alias is an alternate name of a device topic assigned by the user. Map alias to canonical topic name prefix, e.g. |
| password | string Device password. The password must contain at least three character categories among the following: upper case latin, lower case latin, numbers and special symbols. |
Response
HTTP Code: 200 - OK
{
"id": "string",
"description": "string",
"createdAt": "string",
"createdBy": "string",
"modifiedAt": "string",
"done": true,
"metadata": "object",
// includes only one of the fields `error`, `response`
"error": {
"code": "integer",
"message": "string",
"details": [
"object"
]
},
"response": "object",
// end of the list of possible fields
}
An Operation resource. For more information, see Operation.
| Field | Description |
|---|---|
| id | string ID of the operation. |
| description | string Description of the operation. 0-256 characters long. |
| createdAt | string (date-time) Creation timestamp. String in RFC3339 text format. |
| createdBy | string ID of the user or service account who initiated the operation. |
| modifiedAt | string (date-time) The time when the Operation resource was last modified. String in RFC3339 text format. |
| done | boolean (boolean) If the value is |
| metadata | object Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
| error | object The error result of the operation in case of failure or cancellation. includes only one of the fields error, responseThe error result of the operation in case of failure or cancellation. |
| error. code |
integer (int32) Error code. An enum value of google.rpc.Code. |
| error. message |
string An error message. |
| error. details[] |
object A list of messages that carry the error details. |
| response | object includes only one of the fields error, responseThe normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any. |