Create a Bridge

Function

This API is used by an application to create a bridge on the IoT platform. Only the created bridge can connect to the platform.

An instance supports a maximum of 20 bridges.
This API is supported only by standard and enterprise editions.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

POST /v5/iot/{project_id}/bridges

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Parameter description: project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	No	String	Parameter description: user token. Obtain the token by calling the IAM API for obtaining a user token through password authentication. In the returned response header, X-Subject-Token is the desired user token. For details about how to obtain the token, see Token Authentication.
Instance-Id	No	String	Parameter description: instance ID. Unique identifier of each instance in the physical multi-tenant scenario. Mandatory for professional editions and recommended in other cases. Log in to the IoTDA console and choose Overview in the navigation pane to view the instance ID. For details, see Viewing Instance Details.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
bridge_name	Yes	String	Bridge name. Value: The value can contain a maximum of 64 characters. Only letters, digits, and special characters (_?'#().,&%@!-) are allowed. Minimum: 1 Maximum: 64
bridge_id	No	String	Bridge ID. Value: The value can contain a maximum of 36 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.

Response Parameters

Status code: 201

**Table 4** Response body parameters
Parameter	Type	Description
bridge_id	String	Bridge ID, which uniquely identifies a bridge. The value of this parameter is specified during bridge registration or allocated by the platform.
bridge_name	String	Bridge name.
auth_info	BridgeAuthInfo object	Bridge authentication information.
create_time	String	Time when the bridge was registered on the platform. The value is in the format of yyyyMMdd'T'HHmmss'Z', for example, 20151212T121212Z.

**Table 5** BridgeAuthInfo
Parameter	Type	Description
auth_type	String	Authentication mode. Currently, secret authentication (SECRET) is supported. If you use secret authentication, specify the secret parameter. If auth_type is not set, the secret authentication is used.
secret	String	Bridge secret. This parameter is mandatory when auth_type is SECRET.

Example Requests

POST https://{endpoint}/v5/iot/{project_id}/bridges

{
  "bridge_id" : "d4922d8a-6c8e-4396-852c-164aefa6638f",
  "bridge_name" : "dianabridge"
}

Example Responses

Status code: 201

Created

{
  "bridge_id" : "d4922d8a-6c8e-4396-852c-164aefa6638f",
  "bridge_name" : "dianabridge",
  "auth_info" : {
    "auth_type" : "SECRET",
    "secret" : "3b935******dc3c"
  }
}