1.1.3 • Published 6 years ago

green-http v1.1.3

Weekly downloads
3
License
MIT
Repository
github
Last release
6 years ago

green-http

An API interface exposing AWS Greengrass green applications over HTTP.

Green application CodeFactor

Current version: 1.1.3

Lead Maintainer: Halim Qarroum

Table of contents

Install

green add npm://green-http

Description

This application exposes an HTTP RESTful API as a green application on the port 8081, that makes the bridge between your LAN or VLAN HTTP clients and the Greengrass Core ecosystem of green applications.

Since every green application is referenced and discoverable within each Greengrass Core by the green-discovery application, green-http is an attempt to allow external agents on the network to discover and interact with the API exposed by green applications over the HTTP protocol.

Multicast DNS

This application also embeds a compliant multicast DNS advertiser packaged within green-http. It exposes Greengrass Core devices on which it is deployed on the multicast DNS network under the _greengrass._tcp. service.

API

This application exposes an HTTP RESTful API which is accessible on the local LAN or VLAN by any thrid-party HTTP application. The available API endpoints are documented and described below.

MethodResourceQuery parameter(s)Return code(s)Payload requiredDescription
GET/None200NoBy calling this route, green-http returns its green-app.json description. This route can be used to ping the service to assess its availability.
GET/shadowNone200NoThis route returns the shadow document of the current Greengrass core.
PUT/shadowNone200YesThis route allows a client ot update the current Greengrass core shadow document.
ANY/service/:pathnamespace200/400/500OptionalThis route can be used to query over http an Expressify endpoint exposed by any green applications running on a Greengrass core. The path is to be associated with the resource exposed by the remote Expressify endpoint. The namespace mandatory query parameter is used to specify the topic on which the remote Expressify applciation is accessible.

See also

1.1.3

6 years ago

1.1.2

6 years ago

1.1.1

6 years ago

1.1.0

6 years ago

1.0.9

6 years ago

1.0.8

6 years ago

1.0.7

6 years ago

1.0.6

6 years ago

1.0.5

6 years ago

1.0.4

6 years ago

1.0.3

6 years ago

1.0.2

6 years ago

1.0.1

6 years ago

1.0.0

6 years ago