PUT

/greengrass/things/{thingName}/connectivityInfo

http://greengrass.{region}.amazonaws.com/greengrass/things/{thingName}/connectivityInfo

Updates connectivity information for a Greengrass core device. Connectivity information includes endpoints and ports where client devices can connect to an MQTT broker on the core device. When a client device calls the <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-discover-api.html">IoT Greengrass discovery API</a>, IoT Greengrass returns connectivity information for all of the core devices where the client device can connect. For more information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/connect-client-devices.html">Connect client devices to core devices</a> in the IoT Greengrass Version 2 Developer Guide.

Access Token Required: API Key

Path Parameters

thingNamestringrequired

The name of the core device. This is also the name of the IoT thing.

Body Params

ConnectivityInfoarrayrequired

The connectivity information for the core device.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request PUT \
2     --url 'http://greengrass.{region}.amazonaws.com/greengrass/things/{thingName}/connectivityInfo' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

PUT