Skip to content

AWS Greengrass API

by amazonaws.com

API keyHTTPSCloud Platforms
Open documentation ↗

Overview

AWS IoT Greengrass seamlessly extends AWS onto physical devices so they can act locally on the data they generate, while still using the cloud for management, analytics, and durable storage. AWS IoT Greengrass ensures your devices can respond quickly to local events and operate with intermittent connectivity. AWS IoT Greengrass minimizes the cost of transmitting data to the cloud by allowing you to author AWS Lambda functions that execute locally.

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

At a glance

Authentication
API key
HTTPS
Yes
CORS
Unknown
Version
2017-06-07
Endpoints
92
Spec updated
2020-03-11

Endpoints

MethodPathWhat it does
GET/greengrass/groups/{GroupId}/roleRetrieves the role associated with a particular group.
PUT/greengrass/groups/{GroupId}/roleAssociates a role with a group. Your Greengrass core will use the role to access AWS cloud services. The role's permissions should allow Greengrass core Lambda
DELETE/greengrass/groups/{GroupId}/roleDisassociates the role from a group.
GET/greengrass/serviceroleRetrieves the service role that is attached to your account.
PUT/greengrass/serviceroleAssociates a role with your account. AWS IoT Greengrass will use the role to access your Lambda functions and AWS IoT resources. This is necessary for deploymen
DELETE/greengrass/serviceroleDisassociates the service role from your account. Without a service role, deployments will not work.
GET/greengrass/definition/connectorsRetrieves a list of connector definitions.
POST/greengrass/definition/connectorsCreates a connector definition. You may provide the initial version of the connector definition now or use ''CreateConnectorDefinitionVersion'' at a later time.
GET/greengrass/definition/connectors/{ConnectorDefinitionId}/versionsLists the versions of a connector definition, which are containers for connectors. Connectors run on the Greengrass core and contain built-in integration with l
POST/greengrass/definition/connectors/{ConnectorDefinitionId}/versionsCreates a version of a connector definition which has already been defined.
GET/greengrass/definition/coresRetrieves a list of core definitions.
POST/greengrass/definition/coresCreates a core definition. You may provide the initial version of the core definition now or use ''CreateCoreDefinitionVersion'' at a later time. Greengrass gro
GET/greengrass/definition/cores/{CoreDefinitionId}/versionsLists the versions of a core definition.
POST/greengrass/definition/cores/{CoreDefinitionId}/versionsCreates a version of a core definition that has already been defined. Greengrass groups must each contain exactly one Greengrass core.
GET/greengrass/groups/{GroupId}/deploymentsReturns a history of deployments for the group.
POST/greengrass/groups/{GroupId}/deploymentsCreates a deployment. ''CreateDeployment'' requests are idempotent with respect to the ''X-Amzn-Client-Token'' token and the request parameters.
GET/greengrass/definition/devicesRetrieves a list of device definitions.
POST/greengrass/definition/devicesCreates a device definition. You may provide the initial version of the device definition now or use ''CreateDeviceDefinitionVersion'' at a later time.
GET/greengrass/definition/devices/{DeviceDefinitionId}/versionsLists the versions of a device definition.
POST/greengrass/definition/devices/{DeviceDefinitionId}/versionsCreates a version of a device definition that has already been defined.
GET/greengrass/definition/functionsRetrieves a list of Lambda function definitions.
POST/greengrass/definition/functionsCreates a Lambda function definition which contains a list of Lambda functions and their configurations to be used in a group. You can create an initial version
GET/greengrass/definition/functions/{FunctionDefinitionId}/versionsLists the versions of a Lambda function definition.
POST/greengrass/definition/functions/{FunctionDefinitionId}/versionsCreates a version of a Lambda function definition that has already been defined.
GET/greengrass/groupsRetrieves a list of groups.
POST/greengrass/groupsCreates a group. You may provide the initial version of the group or use ''CreateGroupVersion'' at a later time. Tip: You can use the ''gg_group_setup'' package
GET/greengrass/groups/{GroupId}/certificateauthoritiesRetrieves the current CAs for a group.
POST/greengrass/groups/{GroupId}/certificateauthoritiesCreates a CA for the group. If a CA already exists, it will rotate the existing CA.
GET/greengrass/groups/{GroupId}/versionsLists the versions of a group.
POST/greengrass/groups/{GroupId}/versionsCreates a version of a group which has already been defined.
GET/greengrass/definition/loggersRetrieves a list of logger definitions.
POST/greengrass/definition/loggersCreates a logger definition. You may provide the initial version of the logger definition now or use ''CreateLoggerDefinitionVersion'' at a later time.
GET/greengrass/definition/loggers/{LoggerDefinitionId}/versionsLists the versions of a logger definition.
POST/greengrass/definition/loggers/{LoggerDefinitionId}/versionsCreates a version of a logger definition that has already been defined.
GET/greengrass/definition/resourcesRetrieves a list of resource definitions.
POST/greengrass/definition/resourcesCreates a resource definition which contains a list of resources to be used in a group. You can create an initial version of the definition by providing a list
GET/greengrass/definition/resources/{ResourceDefinitionId}/versionsLists the versions of a resource definition.
POST/greengrass/definition/resources/{ResourceDefinitionId}/versionsCreates a version of a resource definition that has already been defined.
POST/greengrass/updatesCreates a software update for a core or group of cores (specified as an IoT thing group.) Use this to update the OTA Agent as well as the Greengrass core softwa
GET/greengrass/definition/subscriptionsRetrieves a list of subscription definitions.
POST/greengrass/definition/subscriptionsCreates a subscription definition. You may provide the initial version of the subscription definition now or use ''CreateSubscriptionDefinitionVersion'' at a la
GET/greengrass/definition/subscriptions/{SubscriptionDefinitionId}/versionsLists the versions of a subscription definition.
POST/greengrass/definition/subscriptions/{SubscriptionDefinitionId}/versionsCreates a version of a subscription definition which has already been defined.
GET/greengrass/definition/connectors/{ConnectorDefinitionId}Retrieves information about a connector definition.
PUT/greengrass/definition/connectors/{ConnectorDefinitionId}Updates a connector definition.
DELETE/greengrass/definition/connectors/{ConnectorDefinitionId}Deletes a connector definition.
GET/greengrass/definition/cores/{CoreDefinitionId}Retrieves information about a core definition version.
PUT/greengrass/definition/cores/{CoreDefinitionId}Updates a core definition.
DELETE/greengrass/definition/cores/{CoreDefinitionId}Deletes a core definition.
GET/greengrass/definition/devices/{DeviceDefinitionId}Retrieves information about a device definition.
PUT/greengrass/definition/devices/{DeviceDefinitionId}Updates a device definition.
DELETE/greengrass/definition/devices/{DeviceDefinitionId}Deletes a device definition.
GET/greengrass/definition/functions/{FunctionDefinitionId}Retrieves information about a Lambda function definition, including its creation time and latest version.
PUT/greengrass/definition/functions/{FunctionDefinitionId}Updates a Lambda function definition.
DELETE/greengrass/definition/functions/{FunctionDefinitionId}Deletes a Lambda function definition.
GET/greengrass/groups/{GroupId}Retrieves information about a group.
PUT/greengrass/groups/{GroupId}Updates a group.
DELETE/greengrass/groups/{GroupId}Deletes a group.
GET/greengrass/definition/loggers/{LoggerDefinitionId}Retrieves information about a logger definition.
PUT/greengrass/definition/loggers/{LoggerDefinitionId}Updates a logger definition.
DELETE/greengrass/definition/loggers/{LoggerDefinitionId}Deletes a logger definition.
GET/greengrass/definition/resources/{ResourceDefinitionId}Retrieves information about a resource definition, including its creation time and latest version.
PUT/greengrass/definition/resources/{ResourceDefinitionId}Updates a resource definition.
DELETE/greengrass/definition/resources/{ResourceDefinitionId}Deletes a resource definition.
GET/greengrass/definition/subscriptions/{SubscriptionDefinitionId}Retrieves information about a subscription definition.
PUT/greengrass/definition/subscriptions/{SubscriptionDefinitionId}Updates a subscription definition.
DELETE/greengrass/definition/subscriptions/{SubscriptionDefinitionId}Deletes a subscription definition.
GET/greengrass/bulk/deployments/{BulkDeploymentId}/statusReturns the status of a bulk deployment.
GET/greengrass/things/{ThingName}/connectivityInfoRetrieves the connectivity information for a core.
PUT/greengrass/things/{ThingName}/connectivityInfoUpdates the connectivity information for the core. Any devices that belong to the group which has this core will receive this information in order to find the l
GET/greengrass/definition/connectors/{ConnectorDefinitionId}/versions/{ConnectorDefinitionVersionId}Retrieves information about a connector definition version, including the connectors that the version contains. Connectors are prebuilt modules that interact wi
GET/greengrass/definition/cores/{CoreDefinitionId}/versions/{CoreDefinitionVersionId}Retrieves information about a core definition version.
GET/greengrass/groups/{GroupId}/deployments/{DeploymentId}/statusReturns the status of a deployment.
GET/greengrass/definition/devices/{DeviceDefinitionId}/versions/{DeviceDefinitionVersionId}Retrieves information about a device definition version.
GET/greengrass/definition/functions/{FunctionDefinitionId}/versions/{FunctionDefinitionVersionId}Retrieves information about a Lambda function definition version, including which Lambda functions are included in the version and their configurations.
GET/greengrass/groups/{GroupId}/certificateauthorities/{CertificateAuthorityId}Retreives the CA associated with a group. Returns the public key of the CA.
GET/greengrass/groups/{GroupId}/certificateauthorities/configuration/expiryRetrieves the current configuration for the CA used by the group.
PUT/greengrass/groups/{GroupId}/certificateauthorities/configuration/expiryUpdates the Certificate expiry time for a group.
GET/greengrass/groups/{GroupId}/versions/{GroupVersionId}Retrieves information about a group version.
GET/greengrass/definition/loggers/{LoggerDefinitionId}/versions/{LoggerDefinitionVersionId}Retrieves information about a logger definition version.
GET/greengrass/definition/resources/{ResourceDefinitionId}/versions/{ResourceDefinitionVersionId}Retrieves information about a resource definition version, including which resources are included in the version.
GET/greengrass/definition/subscriptions/{SubscriptionDefinitionId}/versions/{SubscriptionDefinitionVersionId}Retrieves information about a subscription definition version.
GET/greengrass/things/{ThingName}/runtimeconfigGet the runtime configuration of a thing.
PUT/greengrass/things/{ThingName}/runtimeconfigUpdates the runtime configuration of a thing.
GET/greengrass/bulk/deployments/{BulkDeploymentId}/detailed-reportsGets a paginated list of the deployments that have been started in a bulk deployment operation, and their current deployment status.
GET/greengrass/bulk/deploymentsReturns a list of bulk deployments.
POST/greengrass/bulk/deploymentsDeploys multiple groups in one operation. This action starts the bulk deployment of a specified set of group versions. Each group version deployment will be tri
GET/tags/{resource-arn}Retrieves a list of resource tags for a resource arn.
POST/tags/{resource-arn}Adds tags to a Greengrass resource. Valid resources are 'Group', 'ConnectorDefinition', 'CoreDefinition', 'DeviceDefinition', 'FunctionDefinition', 'LoggerDefin
POST/greengrass/groups/{GroupId}/deployments/$resetResets a group's deployments.
PUT/greengrass/bulk/deployments/{BulkDeploymentId}/$stopStops the execution of a bulk deployment. This action returns a status of ''Stopping'' until the deployment is stopped. You cannot start a new bulk deployment w
DELETE/tags/{resource-arn}#tagKeysRemove resource tags from a Greengrass Resource.

Questions

Does the AWS Greengrass API need an API key?

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

Does the AWS Greengrass API support HTTPS?

Yes, the AWS Greengrass API is served over HTTPS.

How many endpoints does the AWS Greengrass API have?

Its OpenAPI description lists 92 endpoints in version 2017-06-07. All of them are shown on this page.

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