Retrieve a service profile

GET

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

GET

/api/v1/service_profile/:profile_id

$ curl https://cdn.emnify.net/api/v1/service_profile/1.1 \
>      -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     "created": "2019-03-18T16:11:07.000Z",
18     "id": 38,
19     "purpose": "Customer's Webserver",
20     "url": "https://www.customers-server.com"
21   },
22   "api_secret": {
23     "id": 38,
24     "purpose": "K3"
25   },
26   "moc_callback": {
27     "created": "2019-03-18T16:11:17.000Z",
28     "id": 39,
29     "purpose": "Customer's Moc server",
30     "url": "https://moc.customers-server.com"
31   },
32   "esme_interface_type": {
33     "description": "Console",
34     "id": 3
35   },
36   "breakout_region": {
37     "id": 3,
38     "ip_address": "0.0.0.0",
39     "name": "eu-west-1 (VPN)"
40   },
41   "service": [
42     {
43       "description": "Data",
44       "id": 123,
45       "teleservice_code": 7678345,
46       "traffic_limit": [
47         {
48           "id": 123,
49           "period": {
50             "id": 33,
51             "time_units": 5,
52             "unit": "Days"
53           },
54           "volume": 64
55         },
56         {
57           "id": 234,
58           "period": {
59             "id": 35,
60             "time_units": 1,
61             "unit": "Months"
62           },
63           "volume": 128
64         }
65       ],
66       "traffic_type": {
67         "description": "Data",
68         "id": 1,
69         "unit": "GB"
70       }
71     }
72   ],
73   "ip_firewall_rule_set": {
74     "ip_firewall_profiles": [
75       {
76         "id": 43,
77         "name": "Default Inbound Block",
78         "added": "2026-04-09T11:12:45+00:00"
79       }
80     ],
81     "enforce": true
82   }
83 }

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_iddoubleRequired

The Numeric ID of a Service Profile

Response

Success

idintegerOptional

namestringOptional

descriptionstringOptional

allowed_3gbooleanOptional

allowed_4gbooleanOptional

allowed_nb_iotbooleanOptional

allowed_nb_iot_geobooleanOptional

apply_sms_quotabooleanOptional

apply_data_quotabooleanOptional

retailbooleanOptional

sms_p2p_intbooleanOptional

sms_p2p_extbooleanOptional

prepaidbooleanOptional

nipdpbooleanOptional

used_countintegerOptional

api_callbackobjectOptional

api_secretobjectOptional

moc_callbackobjectOptional

esme_interface_typeobjectOptional

breakout_regionobjectOptional

servicelist of objectsOptional

ip_firewall_rule_setobjectOptional