serviceProfiles

Retrieve device-to-device mode of a service profile

<Info icon="fa-light fa-lock" className="permission-callout"> <div className="permission-callout__header"><span className="permission-callout__title"><span className="permission-callout__label">Required permissions</span> <span className="fern-docs-badge small blue subtle rounded-full permission-callout__beta">Beta</span></span> <span className="permission-callout__learn-more">[Learn more](/developers/api-guidelines/permissions#how-permissions-work)</span></div>

ServiceProfile.D2d + Get

<div className="permission-callout__roles"><span className="permission-callout__roles-label">Roles:</span> <Badge intent="info">Administrator</Badge></div> </Info>

Retrieves the device-to-device (D2D) mode of a service profile. D2D controls whether devices assigned to the service profile can exchange IP traffic with other devices in the same organization and region.

A service profile that has never been configured returns disabled with modified_at set to null.

<Note> Device-to-device is opt-in and enabled per organization. Until it's enabled for your organization, requests return `403`. To request access, contact emnify support. </Note>
get/api/v1/service_profile/{service_profile_id}/d2d

Request

  • Base URL: https://cdn.emnify.net
  • URL: https://cdn.emnify.net/api/v1/service_profile/{service_profile_id}/d2d
  • Auth: HTTP bearer

Path parameters

service_profile_idinteger required

The numeric ID of a service profile.

Query parameters

org_idinteger

Numeric ID of a child organization to act on. Omit to use your own organization. Returns 403 if the organization isn't a child of yours. The service profile must belong to that organization, and device-to-device must be enabled for it.

Response

Success

service_profile_idinteger required

ID of the service profile.

mode'disabled' | 'enabled' | 'forward_to_backend' required

Device-to-device mode of the service profile:

  • disabled (default): Traffic between devices is dropped.
  • enabled: Traffic is delivered directly between devices, as long as the service profiles of both devices have device-to-device enabled.
  • forward_to_backend: Traffic between devices is routed through your Cloud Connect backend, for example so your own firewall can inspect it.
modified_atstring date-time nullable required

When the mode was last changed. null if device-to-device has never been configured on the service profile.

warningsstring[]

Advisory messages about the configuration. Only present in PUT responses, and only when there's something to report, for example after setting forward_to_backend.

Changes

No recorded changes to this operation across all 1 revision of this API.