Skip to content

AWS IoT Wireless API

by amazonaws.com

API keyHTTPSCloud Platforms
Open documentation ↗

Overview

<p>AWS IoT Wireless provides bi-directional communication between internet-connected wireless devices and the AWS Cloud. To onboard both LoRaWAN and Sidewalk devices to AWS IoT, use the IoT Wireless API. These wireless devices use the Low Power Wide Area Networking (LPWAN) communication protocol to communicate with AWS IoT.</p> <p>Using the API, you can perform create, read, update, and delete operations for your wireless devices, gateways, destinations, and profiles. After onboarding your devices, you can use the API operations to set log levels and monitor your devices with CloudWatch.</p> <p>You can also use the API operations to create multicast groups and schedule a multicast session for sending a downlink message to devices in the group. By using Firmware Updates Over-The-Air (FUOTA) API operations, you can create a FUOTA task and schedule a session to update the firmware of individual devices or an entire group of devices in a multicast group.</p>

AWS IoT Wireless is a cloud platforms API from amazonaws.com. Requests are authenticated with an API key. It is served over HTTPS. Its OpenAPI description documents 109 endpoints.

At a glance

Authentication
API key
HTTPS
Yes
CORS
Unknown
Version
2020-11-22
Endpoints
109
Spec updated
2021-01-15

Endpoints

MethodPathWhat it does
GET/partner-accountsLists the partner accounts associated with your AWS account.
POST/partner-accountsAssociates a partner account with your AWS account.
PUT/fuota-tasks/{Id}/multicast-groupAssociate a multicast group with a FUOTA task.
PUT/fuota-tasks/{Id}/wireless-deviceAssociate a wireless device with a FUOTA task.
PUT/multicast-groups/{Id}/wireless-deviceAssociates a wireless device with a multicast group.
PUT/wireless-devices/{Id}/thingAssociates a wireless device with a thing.
DELETE/wireless-devices/{Id}/thingDisassociates a wireless device from its currently associated thing.
GET/wireless-gateways/{Id}/certificateGets the ID of the certificate that is currently associated with a wireless gateway.
PUT/wireless-gateways/{Id}/certificateAssociates a wireless gateway with a certificate.
DELETE/wireless-gateways/{Id}/certificateDisassociates a wireless gateway from its currently associated certificate.
PUT/wireless-gateways/{Id}/thingAssociates a wireless gateway with a thing.
DELETE/wireless-gateways/{Id}/thingDisassociates a wireless gateway from its currently associated thing.
GET/multicast-groups/{Id}/sessionGets information about a multicast group session.
PUT/multicast-groups/{Id}/sessionStarts a multicast group session.
DELETE/multicast-groups/{Id}/sessionCancels an existing multicast group session.
GET/destinationsLists the destinations registered to your AWS account.
POST/destinationsCreates a new destination that maps a device message to an AWS IoT rule.
GET/device-profilesLists the device profiles registered to your AWS account.
POST/device-profilesCreates a new device profile.
GET/fuota-tasksLists the FUOTA tasks registered to your AWS account.
POST/fuota-tasksCreates a FUOTA task.
GET/multicast-groupsLists the multicast groups registered to your AWS account.
POST/multicast-groupsCreates a multicast group.
GET/network-analyzer-configurationsLists the network analyzer configurations.
POST/network-analyzer-configurationsCreates a new network analyzer configuration.
GET/service-profilesLists the service profiles registered to your AWS account.
POST/service-profilesCreates a new service profile.
GET/wireless-devicesLists the wireless devices registered to your AWS account.
POST/wireless-devicesProvisions a wireless device.
GET/wireless-gatewaysLists the wireless gateways registered to your AWS account.
POST/wireless-gatewaysProvisions a wireless gateway.
GET/wireless-gateways/{Id}/tasksGets information about a wireless gateway task.
POST/wireless-gateways/{Id}/tasksCreates a task for a wireless gateway.
DELETE/wireless-gateways/{Id}/tasksDeletes a wireless gateway task.
GET/wireless-gateway-task-definitionsList the wireless gateway tasks definitions registered to your AWS account.
POST/wireless-gateway-task-definitionsCreates a gateway task definition.
GET/destinations/{Name}Gets information about a destination.
PATCH/destinations/{Name}Updates properties of a destination.
DELETE/destinations/{Name}Deletes a destination.
GET/device-profiles/{Id}Gets information about a device profile.
DELETE/device-profiles/{Id}Deletes a device profile.
GET/fuota-tasks/{Id}Gets information about a FUOTA task.
PUT/fuota-tasks/{Id}Starts a FUOTA task.
PATCH/fuota-tasks/{Id}Updates properties of a FUOTA task.
DELETE/fuota-tasks/{Id}Deletes a FUOTA task.
GET/multicast-groups/{Id}Gets information about a multicast group.
PATCH/multicast-groups/{Id}Updates properties of a multicast group session.
DELETE/multicast-groups/{Id}Deletes a multicast group if it is not in use by a fuota task.
GET/network-analyzer-configurations/{ConfigurationName}Get network analyzer configuration.
PATCH/network-analyzer-configurations/{ConfigurationName}Update network analyzer configuration.
DELETE/network-analyzer-configurations/{ConfigurationName}Deletes a network analyzer configuration.
DELETE/wireless-devices/{Id}/data#messageIdRemove queued messages from the downlink queue.
GET/service-profiles/{Id}Gets information about a service profile.
DELETE/service-profiles/{Id}Deletes a service profile.
PATCH/wireless-devices/{Id}Updates properties of a wireless device.
DELETE/wireless-devices/{Id}Deletes a wireless device.
GET/wireless_device_import_task/{Id}Get information about an import task and count of device onboarding summary information for the import task.
PATCH/wireless_device_import_task/{Id}Update an import task to add more devices to the task.
DELETE/wireless_device_import_task/{Id}Delete an import task.
PATCH/wireless-gateways/{Id}Updates properties of a wireless gateway.
DELETE/wireless-gateways/{Id}Deletes a wireless gateway.
GET/wireless-gateway-task-definitions/{Id}Gets information about a wireless gateway task definition.
DELETE/wireless-gateway-task-definitions/{Id}Deletes a wireless gateway task definition. Deleting this task definition does not affect tasks that are currently in progress.
PATCH/wireless-devices/{Identifier}/deregisterDeregister a wireless device from AWS IoT Wireless.
GET/partner-accounts/{PartnerAccountId}#partnerTypeGets information about a partner account. If <code>PartnerAccountId</code> and <code>PartnerType</code> are <code>null</code>, returns all partner accounts.
PATCH/partner-accounts/{PartnerAccountId}#partnerTypeUpdates properties of a partner account.
DELETE/partner-accounts/{PartnerAccountId}#partnerTypeDisassociates your AWS account from a partner account. If <code>PartnerAccountId</code> and <code>PartnerType</code> are <code>null</code>, disassociates your A
DELETE/fuota-tasks/{Id}/multicast-groups/{MulticastGroupId}Disassociates a multicast group from a fuota task.
DELETE/fuota-tasks/{Id}/wireless-devices/{WirelessDeviceId}Disassociates a wireless device from a FUOTA task.
DELETE/multicast-groups/{Id}/wireless-devices/{WirelessDeviceId}Disassociates a wireless device from a multicast group.
GET/event-configurations-resource-typesGet the event configuration based on resource types.
PATCH/event-configurations-resource-typesUpdate the event configuration based on resource types.
GET/log-levelsReturns current default log levels or log levels by resource types. Based on resource types, log levels can be for wireless device log options or wireless gatew
POST/log-levelsSet default log level, or log levels by resource types. This can be for wireless device log options or wireless gateways log options and is used to control the
DELETE/log-levelsRemoves the log-level overrides for all resources; both wireless devices and wireless gateways.
GET/positions/{ResourceIdentifier}#resourceTypedeprecated<p>Get the position information for a given resource.</p> <important> <p>This action is no longer supported. Calls to retrieve the position information should u
PATCH/positions/{ResourceIdentifier}#resourceTypedeprecated<p>Update the position information of a resource.</p> <important> <p>This action is no longer supported. Calls to update the position information should use the
GET/position-configurations/{ResourceIdentifier}#resourceTypedeprecated<p>Get position configuration for a given resource.</p> <important> <p>This action is no longer supported. Calls to retrieve the position configuration should u
PUT/position-configurations/{ResourceIdentifier}#resourceTypedeprecated<p>Put position configuration for a given resource.</p> <important> <p>This action is no longer supported. Calls to update the position configuration should use
POST/position-estimateGet estimated position information as a payload in GeoJSON format. The payload measurement data is resolved using solvers that are provided by third-party vendo
GET/event-configurations/{Identifier}#identifierTypeGet the event configuration for a particular resource identifier.
PATCH/event-configurations/{Identifier}#identifierTypeUpdate the event configuration for a particular resource identifier.
GET/log-levels/{ResourceIdentifier}#resourceTypeFetches the log-level override, if any, for a given resource-ID and resource-type. It can be used for a wireless device or a wireless gateway.
PUT/log-levels/{ResourceIdentifier}#resourceTypeSets the log-level override for a resource-ID and resource-type. This option can be specified for a wireless gateway or a wireless device. A limit of 200 log le
DELETE/log-levels/{ResourceIdentifier}#resourceTypeRemoves the log-level override, if any, for a specific resource-ID and resource-type. It can be used for a wireless device or a wireless gateway.
GET/resource-positions/{ResourceIdentifier}#resourceTypeGet the position information for a given wireless device or a wireless gateway resource. The position information uses the <a href="https://gisgeography.com/wgs
PATCH/resource-positions/{ResourceIdentifier}#resourceTypeUpdate the position information of a given wireless device or a wireless gateway resource. The position coordinates are based on the <a href="https://gisgeograp
GET/service-endpointGets the account-specific endpoint for Configuration and Update Server (CUPS) protocol or LoRaWAN Network Server (LNS) connections.
GET/wireless-devices/{Identifier}#identifierTypeGets information about a wireless device.
GET/wireless-devices/{Id}/statisticsGets operating information about a wireless device.
GET/wireless-gateways/{Identifier}#identifierTypeGets information about a wireless gateway.
GET/wireless-gateways/{Id}/firmware-informationGets the firmware version and other information about a wireless gateway.
GET/wireless-gateways/{Id}/statisticsGets operating information about a wireless gateway.
GET/wireless_device_import_task#idList the Sidewalk devices in an import task and their onboarding status.
GET/event-configurations#resourceTypeList event configurations where at least one event topic has been enabled.
GET/fuota-tasks/{Id}/multicast-groupsList all multicast groups associated with a fuota task.
GET/position-configurationsdeprecated<p>List position configurations for a given resource, such as positioning solvers.</p> <important> <p>This action is no longer supported. Calls to retrieve posi
GET/wireless-devices/{Id}/dataList queued messages in the downlink queue.
POST/wireless-devices/{Id}/dataSends a decrypted application data frame to a device.
GET/tags#resourceArnLists the tags (metadata) you have assigned to the resource.

Showing the first 100 of 109 endpoints; the full list is in the documentation.

Questions

Does the AWS IoT Wireless API need an API key?

Yes. The AWS IoT Wireless API uses API key authentication; the documentation explains how to get credentials.

Does the AWS IoT Wireless API support HTTPS?

Yes, the AWS IoT Wireless API is served over HTTPS.

How many endpoints does the AWS IoT Wireless API have?

Its OpenAPI description lists 109 endpoints in version 2020-11-22. The first 100 are shown on this page.

What are alternatives to the AWS IoT Wireless API?

Other Cloud Platforms APIs include Remote Settings PROD, Linode API, DigitalOcean API, Vercel API, Platform API.

Compare alternatives →

Remote Settings PROD

Cloud Platforms

Firefox is a free web browser backed by Mozilla, a non-profit dedicated to internet health and privacy.

No auth19 endpoints

Linode API

Cloud Platforms

## Introduction The Linode API provides the ability to programmatically manage the full range of Linode products and services. This reference is designed to assist application developers and system administrators. Each endpoint includes descriptions, request syntax, and examples using standard HTTP requests. Response data is returned in JSON format. This document was generated from our OpenAPI Specification. See the <a target="_top" href="https://www.openapis.org">OpenAPI website</a> for more information. <a target="_top" href="/docs/api/openapi.yaml">Download the Linode OpenAPI Specification</a>. ## Changelog <a target="_top" href="/docs/products/tools/api/release-notes/">View our Changelog</a> to see release notes on all changes made to our API. ## Access and Authentication Some endpoints are publicly accessible without requiring authentication. All endpoints affecting your Account, however, require either a Personal Access Token or OAuth authentication (when using third-party applications). ### Personal Access Token The easiest way to access the API is with a Personal Access Token (PAT) generated from the <a target="_top" href="https://cloud.linode.com/profile/tokens">Linode Cloud Manager</a> or the [Create Personal Access Token](/docs/api/profile/#personal-access-token-create) endpoint. All scopes for the OAuth security model ([defined below](/docs/api/profile/#oauth)) apply to this security model as well. #### Authentication | Security Scheme Type: | HTTP | |-----------------------|------| | **HTTP Authorization Scheme** | bearer | ### OAuth If you only need to access the Linode API for personal use, we recommend that you create a [personal access token](/docs/api/#personal-access-token). If you're designing an application that can authenticate with an arbitrary Linode user, then you should use the OAuth 2.0 workflows presented in this section. For a more detailed example of an OAuth 2.0 implementation, see our guide on [How to Create an OAuth App with the Linode Python API Library](/docs/products/tools/api/guides/create-an-oauth-app-with-the-python-api-library/#oauth-2-authentication-exchange). Before you implement OAuth in your application, you first need to create an OAuth client. You can do this [with the Linode API](/docs/api/account/#oauth-client-create) or [via the Cloud Manager](https://cloud.linode.com/profile/clients): - When creating the client, you'll supply a `label` and a `redirect_uri` (referred to as the Callback URL in the Cloud Manager). - The response from this endpoint will give you a `client_id` and a `secret`. - Clients can be public or private, and are private by default. You can choose to make the client public when it is created. - A private client is used with applications which can securely store the client secret (that is, the secret returned to you when you first created the client). For example, an application running on a secured server that only the developer has access to would use a private OAuth client. This is also called a confidential client in some OAuth documentation. - A public client is used with applications where the client secret is not guaranteed to be secure. For example, a native app running on a user's computer may not be able to keep the client secret safe, as a user could potentially inspect the source of the application. So, native apps or apps that run in a user's browser should use a public client. - Public and private clients follow different workflows, as described below. #### OAuth Workflow The OAuth workflow is a series of exchanges between your third-party app and Linode. The workflow is used to authenticate a user before an application can start making API calls on the user's behalf. Notes: - With respect to the diagram in [section 1.2 of RFC 6749](https://tools.ietf.org/html/rfc6749#section-1.2), login.linode.com (referred to in this section as the *login server*) is the Resource Owner and the Authorization Server; api.linode.com (referred to here as the *api se

Bearer token350 endpoints

DigitalOcean API

Cloud Platforms

# Introduction The DigitalOcean API allows you to manage Droplets and resources within the DigitalOcean cloud in a simple, programmatic way using conventional HTTP requests. All of the functionality that you are familiar with in the DigitalOcean control panel is also available through the API, allowing you to script the complex actions that your situation requires. The API documentation will start with a general overview about the design and technology that has been implemented, followed by reference information about specific endpoints. ## Requests Any tool that is fluent in HTTP can communicate with the API simply by requesting the correct URI. Requests should be made using the HTTPS protocol so that traffic is encrypted. The interface responds to different methods depending on the action required. |Method|Usage| |--- |--- | |GET|For simple retrieval of information about your account, Droplets, or environment, you should use the GET method. The information you request will be returned to you as a JSON object. The attributes defined by the JSON object can be used to form additional requests. Any request using the GET method is read-only and will not affect any of the objects you are querying.| |DELETE|To destroy a resource and remove it from your account and environment, the DELETE method should be used. This will remove the specified object if it is found. If it is not found, the operation will return a response indicating that the object was not found. This idempotency means that you do not have to check for a resource's availability prior to issuing a delete command, the final state will be the same regardless of its existence.| |PUT|To update the information about a resource in your account, the PUT method is available. Like the DELETE Method, the PUT method is idempotent. It sets the state of the target using the provided values, regardless of their current values. Requests using the PUT method do not need to check the current attributes of the object.| |PATCH|Some resources support partial modification. In these cases, the PATCH method is available. Unlike PUT which generally requires a complete representation of a resource, a PATCH request is is a set of instructions on how to modify a resource updating only specific attributes.| |POST|To create a new object, your request should specify the POST method. The POST request includes all of the attributes necessary to create a new object. When you wish to create a new object, send a POST request to the target endpoint.| |HEAD|Finally, to retrieve metadata information, you should use the HEAD method to get the headers. This returns only the header of what would be returned with an associated GET request. Response headers contain some useful information about your API access and the results that are available for your request. For instance, the headers contain your current rate-limit value and the amount of time available until the limit resets. It also contains metrics about the total number of objects found, pagination information, and the total content length.| ## HTTP Statuses Along with the HTTP methods that the API responds to, it will also return standard HTTP statuses, including error codes. In the event of a problem, the status will contain the error code, while the body of the response will usually contain additional information about the problem that was encountered. In general, if the status returned is in the 200 range, it indicates that the request was fulfilled successfully and that no error was encountered. Return codes in the 400 range typically indicate that there was an issue with the request that was sent. Among other things, this could mean that you did not authenticate correctly, that you are requesting an action that you do not have authorization for, that the object you are requesting does not exist, or that your request is malformed. If you receive a status in the 500 range, this generally indicates a server-side problem. This means that we are having

Bearer token290 endpoints

Vercel API

Cloud Platforms

Vercel combines the best developer experience with an obsessive focus on end-user performance. Our platform enables frontend teams to do their best work.

Bearer token112 endpoints

Platform API

Cloud Platforms

The [REST API specification](https://www.ably.io/documentation/rest-api) for Ably.

HTTP Basic22 endpoints

Azure Data Lake Storage

Cloud Platforms

Azure Data Lake Storage provides storage for Hadoop and other big data workloads.

No auth10 endpoints

Listed from APIs.guru (CC0).