Scaleway logo
IoT Hub API
IoT Hub API

IoT Networks

Download schema

Connect a Hub to external networks and services using links to external IoT networks

List the networks

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

List the networks › path Parameters

region
​string · enum · required

The region you want to target

Enum values:
fr-par

List the networks › query Parameters

page
​integer · int32

Page number to return, from the paginated results.

page_size
​integer · uint32

Number of networks to return. The maximum value is 100.

Ordering of requested routes.

Enum values:
name_asc
name_desc
type_asc
type_desc
created_at_asc
created_at_desc
Default: name_asc
name
​string

Network name to filter for.

hub_id
​string

Hub ID to filter for.

topic_prefix
​string

Topic prefix to filter for.

List the networks › Responses

200
scaleway.iot.v1.ListNetworksResponse
total_count
​integer · uint32

Total number of Networks.

Page of networks.

Create a new network

POST
https://api.scaleway.com
/iot/v1/regions/{region}/networks

Create a new network for an existing hub. Beside the default network, you can add networks for different data providers. Possible network types are Sigfox and REST.

Create a new network › path Parameters

region
​string · enum · required

The region you want to target

Enum values:
fr-par

Create a new network › Request Body

name
​string · required

Network name.

type
​scaleway.iot.v1.Network.NetworkType · enum · required

Type of network to connect with.

Enum values:
unknown
sigfox
rest
Default: unknown
hub_id
​string · required

Hub ID to connect the Network to.

topic_prefix
​string · required

Topic prefix for the Network.

Create a new network › Responses

200
scaleway.iot.v1.CreateNetworkResponse

Information related to the created network.

secret
​string

Endpoint Key to keep secret. This cannot be retrieved later.

Retrieve a specific network

GET
https://api.scaleway.com
/iot/v1/regions/{region}/networks/{network_id}

Retrieve an existing network, specified by its network ID. The response returns full details of the network, including its type, the topic prefix and its endpoint.

Retrieve a specific network › path Parameters

region
​string · enum · required

The region you want to target

Enum values:
fr-par
network_id
​string · required

Network ID.

Retrieve a specific network › Responses

200
scaleway.iot.v1.Network
id
​string

Network ID.

name
​string

Network name.

Type of network to connect with.

Enum values:
unknown
sigfox
rest
Default: unknown
endpoint
​string

Endpoint to use for interacting with the network.

hub_id
​string

Hub ID to connect the Network to.

created_at
​string | null · date-time

Date at which the network was created. (RFC 3339 format)

topic_prefix
​string

Topic prefix for the Network. This prefix will be prepended to all topics for this Network.

region
​string

Region of the network.

Delete a Network

DELETE
https://api.scaleway.com
/iot/v1/regions/{region}/networks/{network_id}

Delete an existing network, specified by its network ID. Deleting a network is permanent, and cannot be undone.

Delete a Network › path Parameters

region
​string · enum · required

The region you want to target

Enum values:
fr-par
network_id
​string · required

Network ID.

Delete a Network › Responses

No data returned
IoT RoutesIoT Cloud Twins