Skip to content

AWS IoT SiteWise API

by amazonaws.com

API keyHTTPSCloud Platforms
Open documentation ↗

Overview

Welcome to the IoT SiteWise API Reference. IoT SiteWise is an Amazon Web Services service that connects <a href="https://en.wikipedia.org/wiki/Internet_of_things#Industrial_applications">Industrial Internet of Things (IIoT)</a> devices to the power of the Amazon Web Services Cloud. For more information, see the <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/">IoT SiteWise User Guide</a>. For information about IoT SiteWise quotas, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html">Quotas</a> in the <i>IoT SiteWise User Guide</i>.

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

At a glance

Authentication
API key
HTTPS
Yes
CORS
Unknown
Version
2019-12-02
Endpoints
73
Spec updated
2020-05-12

Endpoints

MethodPathWhat it does
POST/assets/{assetId}/associateAssociates a child asset with the given parent asset through a hierarchy defined in the parent asset's model. For more information, see <a href="https://docs.aw
POST/timeseries/associate/#alias&assetId&propertyIdAssociates a time series (data stream) with an asset property.
POST/projects/{projectId}/assets/associateAssociates a group (batch) of assets with an IoT SiteWise Monitor project.
POST/projects/{projectId}/assets/disassociateDisassociates a group (batch) of assets from an IoT SiteWise Monitor project.
POST/properties/batch/aggregatesGets aggregated values (for example, average, minimum, and maximum) for one or more asset properties. For more information, see <a href="https://docs.aws.amazon
POST/properties/batch/latestGets the current value for one or more asset properties. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-indu
POST/properties/batch/historyGets the historical values for one or more asset properties. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-
POST/properties<p>Sends a list of asset property values to IoT SiteWise. Each value is a timestamp-quality-value (TQV) data point. For more information, see <a href="https://d
GET/access-policiesRetrieves a paginated list of access policies for an identity (an IAM Identity Center user, an IAM Identity Center group, or an IAM user) or an IoT SiteWise Mon
POST/access-policiesCreates an access policy that grants the specified identity (IAM Identity Center user, IAM Identity Center group, or IAM user) access to the specified IoT SiteW
GET/assets<p>Retrieves a paginated list of asset summaries.</p> <p>You can use this operation to do the following:</p> <ul> <li> <p>List assets based on a specific asset
POST/assetsCreates an asset from an existing asset model. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-assets.html">
GET/asset-modelsRetrieves a paginated list of summaries of all asset models.
POST/asset-modelsCreates an asset model from specified property and hierarchy definitions. You create assets from asset models. With asset models, you can easily create assets o
GET/jobsRetrieves a paginated list of bulk import job requests. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/ListBulkImp
POST/jobs<p>Defines a job to ingest data to IoT SiteWise from Amazon S3. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/Cre
POST/dashboardsCreates a dashboard in an IoT SiteWise Monitor project.
GET/20200301/gatewaysRetrieves a paginated list of gateways.
POST/20200301/gatewaysCreates a gateway, which is a virtual or edge device that delivers industrial data streams from local servers to IoT SiteWise. For more information, see <a href
GET/portalsRetrieves a paginated list of IoT SiteWise Monitor portals.
POST/portals<p>Creates a portal, which can contain projects and dashboards. IoT SiteWise Monitor uses IAM Identity Center or IAM to authenticate portal users and manage use
POST/projects<p>Creates a project in the specified portal.</p> <note> <p>Make sure that the project name and description don't contain confidential information.</p> </note>
GET/access-policies/{accessPolicyId}Describes an access policy, which specifies an identity's access to an IoT SiteWise Monitor portal or project.
PUT/access-policies/{accessPolicyId}Updates an existing access policy that specifies an identity's access to an IoT SiteWise Monitor portal or project resource.
DELETE/access-policies/{accessPolicyId}Deletes an access policy that grants the specified identity access to the specified IoT SiteWise Monitor resource. You can use this operation to revoke access t
GET/assets/{assetId}Retrieves information about an asset.
PUT/assets/{assetId}Updates an asset's name. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/update-assets-and-models.html">Updating as
DELETE/assets/{assetId}<p>Deletes an asset. This action can't be undone. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/delete-assets-and
GET/asset-models/{assetModelId}Retrieves information about an asset model.
PUT/asset-models/{assetModelId}<p>Updates an asset model and all of the assets that were created from the model. Each asset created from the model inherits the updated asset model's property
DELETE/asset-models/{assetModelId}Deletes an asset model. This action can't be undone. You must delete all assets created from an asset model before you can delete the model. Also, you can't del
GET/dashboards/{dashboardId}Retrieves information about a dashboard.
PUT/dashboards/{dashboardId}Updates an IoT SiteWise Monitor dashboard.
DELETE/dashboards/{dashboardId}Deletes a dashboard from IoT SiteWise Monitor.
GET/20200301/gateways/{gatewayId}Retrieves information about a gateway.
PUT/20200301/gateways/{gatewayId}Updates a gateway's name.
DELETE/20200301/gateways/{gatewayId}Deletes a gateway from IoT SiteWise. When you delete a gateway, some of the gateway's files remain in your gateway's file system.
GET/portals/{portalId}Retrieves information about a portal.
PUT/portals/{portalId}Updates an IoT SiteWise Monitor portal.
DELETE/portals/{portalId}Deletes a portal from IoT SiteWise Monitor.
GET/projects/{projectId}Retrieves information about a project.
PUT/projects/{projectId}Updates an IoT SiteWise Monitor project.
DELETE/projects/{projectId}Deletes a project from IoT SiteWise Monitor.
POST/timeseries/delete/<p>Deletes a time series (data stream). If you delete a time series that's associated with an asset property, the asset property still exists, but the time seri
GET/assets/{assetId}/properties/{propertyId}<p>Retrieves information about an asset property.</p> <note> <p>When you call this operation for an attribute property, this response includes the default attri
PUT/assets/{assetId}/properties/{propertyId}<p>Updates an asset property's alias and notification state.</p> <important> <p>This operation overwrites the property's existing alias and notification state.
GET/jobs/{jobId}Retrieves information about a bulk import job request. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/DescribeBulk
GET/configuration/account/encryptionRetrieves information about the default encryption configuration for the Amazon Web Services account in the default or specified Region. For more information, s
POST/configuration/account/encryptionSets the default encryption configuration for the Amazon Web Services account. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/lates
GET/20200301/gateways/{gatewayId}/capability/{capabilityNamespace}Retrieves information about a gateway capability configuration. Each gateway capability defines data sources for a gateway. A capability configuration can conta
GET/loggingRetrieves the current IoT SiteWise logging options.
PUT/loggingSets logging options for IoT SiteWise.
GET/configuration/account/storageRetrieves information about the storage configuration for IoT SiteWise.
POST/configuration/account/storageConfigures storage settings for IoT SiteWise.
GET/timeseries/describe/<p>Retrieves information about a time series (data stream).</p> <p>To identify a time series, do one of the following:</p> <ul> <li> <p>If the time series isn't
POST/assets/{assetId}/disassociateDisassociates a child asset from the given parent asset through a hierarchy defined in the parent asset's model.
POST/timeseries/disassociate/#alias&assetId&propertyIdDisassociates a time series (data stream) from an asset property.
GET/properties/aggregates#aggregateTypes&resolution&startDate&endDate<p>Gets aggregated values for an asset property. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-d
GET/properties/latest<p>Gets an asset property's current value. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.ht
GET/properties/history<p>Gets the history of an asset property's values. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial
GET/properties/interpolated#startTimeInSeconds&endTimeInSeconds&quality&intervalInSeconds&type<p>Get interpolated values for an asset property for a specified time interval, during a period of time. If your time series is missing data points during the s
GET/asset-models/{assetModelId}/propertiesRetrieves a paginated list of properties associated with an asset model. If you update properties associated with the model before you finish listing all the pr
GET/assets/{assetId}/propertiesRetrieves a paginated list of properties associated with an asset. If you update properties associated with the model before you finish listing all the properti
GET/assets/{assetId}/assetRelationships#traversalTypeRetrieves a paginated list of asset relationships for an asset. You can use this operation to identify an asset's root asset and all associated assets between t
GET/assets/{assetId}/hierarchies<p>Retrieves a paginated list of associated assets.</p> <p>You can use this operation to do the following:</p> <ul> <li> <p>List child assets associated to a pa
GET/dashboards#projectIdRetrieves a paginated list of dashboards for an IoT SiteWise Monitor project.
GET/projects/{projectId}/assetsRetrieves a paginated list of assets associated with an IoT SiteWise Monitor project.
GET/projects#portalIdRetrieves a paginated list of projects for an IoT SiteWise Monitor portal.
GET/tags#resourceArnRetrieves the list of tags for an IoT SiteWise resource.
POST/tags#resourceArnAdds tags to an IoT SiteWise resource. If a tag already exists for the resource, this operation updates the tag's value.
GET/timeseries/Retrieves a paginated list of time series (data streams).
DELETE/tags#resourceArn&tagKeysRemoves a tag from an IoT SiteWise resource.
POST/20200301/gateways/{gatewayId}/capabilityUpdates a gateway capability configuration or defines a new capability configuration. Each gateway capability defines data sources for a gateway. A capability c

Questions

Does the AWS IoT SiteWise API need an API key?

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

Does the AWS IoT SiteWise API support HTTPS?

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

How many endpoints does the AWS IoT SiteWise API have?

Its OpenAPI description lists 73 endpoints in version 2019-12-02. All of them are shown on this page.

What are alternatives to the AWS IoT SiteWise 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).