Scaleway logo
IoT Hub API
IoT Hub API

IoT Cloud Twins

Download schema

Create cloud twins as virtual representations of IoT devices in the cloud to manage, monitor, and control them remotely

BETA - List the documents of a Cloud Twin

GET
https://api.scaleway.com
/iot/v1/regions/{region}/twins/{twin_id}

BETA - List the documents of a Cloud Twin › path Parameters

region
​string · enum · required

The region you want to target

Enum values:
fr-par
twin_id
​string · required

Twin ID.

BETA - List the documents of a Cloud Twin › Responses

BETA - Delete all the documents of a Cloud Twin

DELETE
https://api.scaleway.com
/iot/v1/regions/{region}/twins/{twin_id}

BETA - Delete all the documents of a Cloud Twin › path Parameters

region
​string · enum · required

The region you want to target

Enum values:
fr-par
twin_id
​string · required

Twin ID.

BETA - Delete all the documents of a Cloud Twin › Responses

No data returned

BETA - Get a Cloud Twin Document

GET
https://api.scaleway.com
/iot/v1/regions/{region}/twins/{twin_id}/documents/{document_name}

BETA - Get a Cloud Twin Document › path Parameters

region
​string · enum · required

The region you want to target

Enum values:
fr-par
twin_id
​string · required

Twin ID.

document_name
​string · required

Name of the document.

BETA - Get a Cloud Twin Document › Responses

200
scaleway.iot.v1.TwinDocument
twin_id
​string

Parent twin ID of the document.

document_name
​string

Name of the document.

version
​integer · uint32

New version of the document.

​object

New data related to the document.

BETA - Update a Cloud Twin Document

PUT
https://api.scaleway.com
/iot/v1/regions/{region}/twins/{twin_id}/documents/{document_name}

BETA - Update a Cloud Twin Document › path Parameters

region
​string · enum · required

The region you want to target

Enum values:
fr-par
twin_id
​string · required

Twin ID.

document_name
​string · required

Name of the document.

BETA - Update a Cloud Twin Document › Request Body

version
​integer | null · uint32

Version of the document to update. If set, ensures that the current version of the document matches before persisting the update.

​object

Data of the new document. New data that will replace the contents of the document.

BETA - Update a Cloud Twin Document › Responses

200
scaleway.iot.v1.TwinDocument
twin_id
​string

Parent twin ID of the document.

document_name
​string

Name of the document.

version
​integer · uint32

New version of the document.

​object

New data related to the document.

BETA - Delete a Cloud Twin Document

DELETE
https://api.scaleway.com
/iot/v1/regions/{region}/twins/{twin_id}/documents/{document_name}

BETA - Delete a Cloud Twin Document › path Parameters

region
​string · enum · required

The region you want to target

Enum values:
fr-par
twin_id
​string · required

Twin ID.

document_name
​string · required

Name of the document.

BETA - Delete a Cloud Twin Document › Responses

No data returned

BETA - Patch a Cloud Twin Document

PATCH
https://api.scaleway.com
/iot/v1/regions/{region}/twins/{twin_id}/documents/{document_name}

BETA - Patch a Cloud Twin Document › path Parameters

region
​string · enum · required

The region you want to target

Enum values:
fr-par
twin_id
​string · required

Twin ID.

document_name
​string · required

Name of the document.

BETA - Patch a Cloud Twin Document › Request Body

version
​integer | null · uint32

The version of the document to update. If set, ensures that the current version of the document matches before persisting the update.

​object

Patch data. A json data that will be applied on the document's current data. Patching rules:

  • The patch goes recursively through the patch objects.
  • If the patch object property is null, it is removed from the final object.
  • If the patch object property is a value (number, strings, bool, arrays), it is replaced.
  • If the patch object property is an object, the previous rules will be applied recursively on it.

BETA - Patch a Cloud Twin Document › Responses

200
scaleway.iot.v1.TwinDocument
twin_id
​string

Parent twin ID of the document.

document_name
​string

Name of the document.

version
​integer · uint32

New version of the document.

​object

New data related to the document.

IoT Networks