Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

emnify subpackage_serviceProfiles API

The subpackage_serviceProfiles API from emnify — 7 operation(s) for subpackage_serviceprofiles.

emnify subpackage_serviceProfiles API is one of 29 APIs that emnify publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 5 JSON Schema definitions.

Tagged areas include subpackage_serviceProfiles. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 5 JSON Schemas.

This API exposes 14 operations across 7 paths, and defines 39 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against a single base URL, https://cdn.emnify.net.

14 operations 7 paths 39 schemas 6 DELETE3 GET1 PATCH2 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Server
https://cdn.emnify.net
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

emnify subpackage_serviceProfiles API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

  • BearerAuth — Retrieve a JWT via POST /api/v1/authenticate using an applicationtoken or user credentials, then send it as Authorization: Bearer .

Paths & Operations 14

Across 7 paths, the API surfaces 14 operations — 6 DELETE, 3 GET, 1 PATCH, 2 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

subpackage_serviceProfiles 14
GET
/api/v1/service_profile
List service profiles
service-profile-get 1 param → 200
POST
/api/v1/service_profile
Create service profile
service-profile-post 1 param body → 201
GET
/api/v1/service_profile/{profile_id}
Retrieve a service profile
service-profile-by-profile-id-get 2 params → 200
DELETE
/api/v1/service_profile/{profile_id}
Delete a service profile
service-profile-by-profile-id-delete 2 params → 204409
PATCH
/api/v1/service_profile/{profile_id}
Update service profile
service-profile-by-profile-id-patch 2 params body → 201
DELETE
/api/v1/service_profile/{profile_id}/quota/{quota_type}
Remove all quotas of assigned endpoints
delete-quota-by-service-profile-id 3 params → 204404
PUT
/api/v1/service_profile/{profile_id}/service/{service_id}
Add a service to a service profile
service-profile-service-by-profile-and-service-put 3 params → 204409
DELETE
/api/v1/service_profile/{profile_id}/service/{service_id}
Remove a service from a service profile
service-profile-service-by-profile-and-service-delete 3 params → 204409
PUT
/api/v1/service_profile/{profile_id}/service/{service_id}/traffic_limit/{limit_id}
Add SMS limit to service profile
add-traffic-limit 4 params → 200404422
DELETE
/api/v1/service_profile/{profile_id}/service/{service_id}/traffic_limit/{limit_id}
Remove SMS limit from a service profile
remove-traffic-limit 4 params → 200422
GET
/api/v1/service_profile/{profile_id}/traffic_limit
List data limits of service profile
list-service-profile-traffic-limits 2 params → 200403
POST
/api/v1/service_profile/{profile_id}/traffic_limit
Add data limit to service profile
add-service-profile-traffic-limit 2 params body → 201400403409
DELETE
/api/v1/service_profile/{profile_id}/traffic_limit
Delete all data limits of a service profile
remove-service-profile-traffic-limits 2 params → 204403
DELETE
/api/v1/service_profile/{profile_id}/traffic_limit/{limit_id}
Remove data limit from a service profile
delete-service-profile-traffic-limit 3 params → 204403

Schemas 39

The contract defines 39 schemas that model the data the API accepts and returns. The most detailed are Service Profiles_ServiceProfileByProfileIdGet_Response_200 (22 properties), ApiV1ServiceProfileGetResponsesContentApplicationJsonSchemaItems (11 properties), ApiV1ServiceProfileProfileIdTrafficLimitGetResponsesContentApplicationJsonSchemaItems (6 properties), ApiV1ServiceProfileProfileIdGetResponsesContentApplicationJsonSchemaIpFirewallRuleSetIpFirewallProfilesItems (3 properties). Each schema is shown below with its type and property counts.

Service Profiles_ServiceProfileByProfileIdPatch_Response_201
object
ApiV1ServiceProfileGetResponsesContentApplicationJsonSchemaItemsIpFirewallRuleSet
object
2 properties
ApiV1ServiceProfilePostRequestBodyContentApplicationJsonSchemaMocCallback
object
ApiV1ServiceProfileProfileIdPatchRequestBodyContentApplicationJsonSchemaDns
object
ServiceProfileServiceByProfileAndServicePutRequestConflictError
object
3 properties
ApiV1ServiceProfileProfileIdGetResponsesContentApplicationJsonSchemaEsmeInterfaceType
object
ApiV1ServiceProfileProfileIdTrafficLimitGetResponsesContentApplicationJsonSchemaItemsService
object
2 properties
Service Profiles_RemoveTrafficLimit_Response_200
object
Empty response body
ApiV1ServiceProfileProfileIdGetResponsesContentApplicationJsonSchemaServiceItems
object
ApiV1ServiceProfileProfileIdPatchRequestBodyContentApplicationJsonSchemaApiCallback
object
ApiV1ServiceProfileProfileIdGetResponsesContentApplicationJsonSchemaIpFirewallRuleSetIpFirewallProfilesItems
object
3 properties
ApiV1ServiceProfilePostRequestBodyContentApplicationJsonSchemaDns
object
ApiV1ServiceProfilePostRequestBodyContentApplicationJsonSchemaApiCallback
object
Service Profiles_AddTrafficLimit_Response_200
object
Empty response body
ApiV1ServiceProfileProfileIdTrafficLimitPostRequestBodyContentApplicationJsonSchemaPeriodId
string
ApiV1ServiceProfileProfileIdGetResponsesContentApplicationJsonSchemaMocCallback
object
ApiV1ServiceProfilePostRequestBodyContentApplicationJsonSchemaApiSecret
object
ApiV1ServiceProfileProfileIdPatchRequestBodyContentApplicationJsonSchemaApiSecret
object
ApiV1ServiceProfileProfileIdPatchRequestBodyContentApplicationJsonSchemaBreakoutRegion
object
ApiV1ServiceProfileProfileIdTrafficLimitPostRequestBodyContentApplicationJsonSchemaServiceId
string
ApiV1ServiceProfileProfileIdGetResponsesContentApplicationJsonSchemaApiSecret
object
ApiV1ServiceProfileGetResponsesContentApplicationJsonSchemaItems
object
11 properties
ApiV1ServiceProfileProfileIdTrafficLimitPostRequestBodyContentApplicationJsonSchemaService
object
Service type to which the limit applies. The only supported service type is Data, which has an ID of 38.
1 property
ApiV1ServiceProfilePostRequestBodyContentApplicationJsonSchemaBreakoutRegion
object
Service Profiles_AddServiceProfileTrafficLimit_Response_201
object
Empty response body
ServiceProfileByProfileIdDeleteRequestConflictError
object
3 properties
Service Profiles_ServiceProfilePost_Response_201
object
Empty response body
ApiV1ServiceProfileProfileIdGetResponsesContentApplicationJsonSchemaBreakoutRegion
object
ApiV1ServiceProfileProfileIdPatchRequestBodyContentApplicationJsonSchemaEsmeInterfaceType
object
ApiV1ServiceProfileProfileIdGetResponsesContentApplicationJsonSchemaApiCallback
object
Service Profiles_ServiceProfileByProfileIdGet_Response_200
object
22 properties
ApiV1ServiceProfileProfileIdTrafficLimitGetResponsesContentApplicationJsonSchemaItemsPeriod
object
3 properties
ApiV1ServiceProfilePostRequestBodyContentApplicationJsonSchemaEsmeInterfaceType
object
ApiV1ServiceProfileProfileIdPatchRequestBodyContentApplicationJsonSchemaMocCallback
object
ApiV1ServiceProfileGetResponsesContentApplicationJsonSchemaItemsIpFirewallRuleSetIpFirewallProfilesItems
object
3 properties
ApiV1ServiceProfileProfileIdGetResponsesContentApplicationJsonSchemaIpFirewallRuleSet
object
2 properties
ApiV1ServiceProfileProfileIdTrafficLimitGetResponsesContentApplicationJsonSchemaItems
object
6 properties
ApiV1ServiceProfileProfileIdTrafficLimitPostRequestBodyContentApplicationJsonSchemaPeriod
object
Period of the limit. The only supported period is Monthly, which uses calendar months and has an ID of 2. The limit resets at the beginning of each month 00:00…
1 property
ServiceProfileServiceByProfileAndServiceDeleteRequestConflictError
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

emnify-subpackage-serviceprofiles-api-openapi.yml Raw ↑

Other APIs emnify publishes across the network.

emnify GraphQL API
emnify Data Streamer
emnify Documentation MCP Server
emnify subpackage_applicationTokens API
emnify subpackage_authentication API
emnify subpackage_automations API
emnify subpackage_cloudConnect API
emnify subpackage_customEvents API
emnify subpackage_endpoint API
emnify subpackage_euicc API
emnify subpackage_euiccOperation API
emnify subpackage_events API