Retrieve a service profile

GET

https://cdn.emnify.net/api/v1/service_profile/:profile_id

GET

/api/v1/service_profile/:profile_id

1 curl https://cdn.emnify.net/api/v1/service_profile/profile_id \
2      -H "Authorization: Bearer <token>"

200Retrieved

1 {
2   "id": 232,
3   "name": "Smart meter",
4   "description": "Data + SMS - 1G limit",
5   "allowed_3g": true,
6   "allowed_4g": true,
7   "allowed_nb_iot": true,
8   "allowed_nb_iot_geo": false,
9   "apply_sms_quota": false,
10   "apply_data_quota": false,
11   "retail": false,
12   "sms_p2p_int": true,
13   "sms_p2p_ext": true,
14   "nipdp": false,
15   "used_count": 12,
16   "api_callback": {
17     "id": 38,
18     "url": "https://www.customers-server.com",
19     "created": "2019-03-18T16:11:07.000Z",
20     "purpose": "Customer's Webserver"
21   },
22   "api_secret": {
23     "id": 38,
24     "purpose": "K3"
25   },
26   "moc_callback": {
27     "id": 39,
28     "url": "https://moc.customers-server.com",
29     "created": "2019-03-18T16:11:17.000Z",
30     "purpose": "Customer's Moc server"
31   },
32   "esme_interface_type": {
33     "description": "Console",
34     "id": 3
35   },
36   "breakout_region": {
37     "name": "eu-west-1 (VPN)",
38     "ip_address": "0.0.0.0",
39     "id": 3
40   },
41   "service": [
42     {
43       "id": 123,
44       "description": "Data",
45       "teleservice_code": 7678345,
46       "traffic_type": {
47         "id": 1,
48         "description": "Data",
49         "unit": "GB"
50       },
51       "traffic_limit": [
52         {
53           "id": 123,
54           "volume": 64,
55           "period": {
56             "id": 33,
57             "time_units": 5,
58             "unit": "Days"
59           }
60         },
61         {
62           "id": 234,
63           "volume": 128,
64           "period": {
65             "id": 35,
66             "time_units": 1,
67             "unit": "Months"
68           }
69         }
70       ]
71     }
72   ]
73 }

Retrieve a service profile with a given id.

Authentication

AuthorizationBearer

An auth_token should be provided to authenticate a session.

To obtain an auth_token, see the /api/v1/authenticate POST request.

Path parameters

profile_idstringRequired

Response

Success

idinteger

namestring

descriptionstring

allowed_3gboolean

allowed_4gboolean

allowed_nb_iotboolean

allowed_nb_iot_geoboolean

apply_sms_quotaboolean

apply_data_quotaboolean

retailboolean

sms_p2p_intboolean

sms_p2p_extboolean

prepaidboolean

nipdpboolean

used_countinteger

api_callbackobject

api_secretobject

moc_callbackobject

esme_interface_typeobject

breakout_regionobject

servicelist of objects