Ping Thing IP Address

This guide will show you how can you use API to ping your SIM card IP address. Ping is very useful to check if SIM card is still active and can be used to prevent from being purged from network.

Ping IP address

POST https://console.monogoto.io/thing/ThingId_ICCID_{ICCID}/ping

Path Parameters

Name	Type	Description
ICCID*	String	The ICCID of your SIM

Headers

Name	Type	Description
YOUR_TOKEN*	String	Your authentication token
CUSTOMER_ID	String	Customer API key

Request Body

Name	Type	Description
THING_IP_ADDRESS*	String	IP address of Thing

200: OK OK

[
  {
    "alarmId": "string",
    "alarmDescription": "string",
    "Alert": {},
    "Thing": {},
    "ThingsGroupName": "string",
    "NetworkId": "string",
    "NetworkName": "string",
    "TelephonyProfileId": "string",
    "TelephonyProfileName": "string",
    "CloseTime": "2022-05-30T11:32:12.180Z",
    "Owner": "string",
    "Status": "Active"
  }
]

400: Bad Request Invalid Input Data

{
    // Response
}

401: Unauthorized Unauthorized

{
    // Response
}

404: Not Found Not found

{
    // Response
}

500: Internal Server Error Internal Server Error

{
    // Response
}

To get the Thing IP address, see Get Thing information

Example using cURL:

curl -X POST \
    --url "https://console.monogoto.io/thing/ThingId_ICCID_{ICCID}/ping" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer {TOKEN_HERE}" \
    -H "apikey: {Customer ID}" \
    -d "{ \"IPAddress\": \"{THING_IP_ADDRESS}\"}"

The above shown command needs to be replaced with information: {ICCID} - replace with your Monogoto Thing ICCID number {TOKEN_HERE} - replace with your token {CUSTOMER_ID} - (optional) replace with your customer ID. It can be received together with a Login Token or from request to obtain Thing information. {THING_IP_ADDRESS} - replace with your thing IP address If needed this API can be tested and used in the Monogoto portal following this path: Thing POST /thing/{ThingId}/ping

Example request:

curl -X POST \
    --url "https://console.monogoto.io/thing/ThingId_ICCID_8912372646888991/ping" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer eyJhbGciOiJIUzI1N2R5cCI6IkpXVCJ9.eyJSb2x5oiVXNlclByb2ZpbGVJZF9kZGM2MThhNC0wNTI1LTQ2MmUtYtNlNt03NzhhMGQxYmQyNGYiLCJSZWFsiSI6ImFkbWluIiwiQ3VzdG9tZXJJZfI6bnVsbCwiVXNlcklkIjoiVXNlcklkXzg52OG486TUwZjUtNDQ1Ny05NThhLTEzZjA0MzJhZDE3YyIsImp3dGlkIjoiZjE0iMzZWYtZjViNC00MzQ1LWFlZWQag1YWM1NWUzNjQ5IiwiaWF0IjoxN784MTA2LCJleHAiOjE2MDMyMTI15DZ9.7U26dqOGSz-4qZJaG6bC4J6--0x3-_6dAWLRTALXMAk" \
    -H "apikey: cid_c256463da-742-491b-911b-8850177ef5121" \
    -d "{ \"IPAddress\": \"10.140.90.211\"}"

Example response:

[
  {
    "host": "11.111.11.211",
    "size": "56",
    "ttl": "63",
    "time": "82ms",
    "sent": "1",
    "received": "1",
    "packetLoss": "0"
  },
  {
    "host": "11.111.11.211",
    "size": "56",
    "ttl": "60",
    "time": "89ms",
    "sent": "2",
    "received": "2",
    "packetLoss": "0"
  },
  {
    "host": "11.111.11.211",
    "size": "56",
    "ttl": "73",
    "time": "60ms",
    "sent": "3",
    "received": "3",
    "packetLoss": "0"
  }
]

Error while loading OpenAPI operation — Failed to convert Swagger 2.0 to OpenAPI 3.1.1