system-agent API documentation version 1.1.x

http://localhost:48090/api

Welcome

Welcome to the System Management Agent Microservice API Documentation.

Service Operation

example - http://localhost:48090/api/v1/operation

post

post

Issue a start, stop or restart action to the specified services. HTTP 500 for unknown or unanticipated issues.

Issue a start, stop or restart action to the specified services. HTTP 500 for unknown or unanticipated issues.

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","description":"Service operation","title":"operation","properties":{"action":{"type":"string","required":false,"title":"Action"}, "services": {"type": "array","items": { "type": "string" },"uniqueItems": true}}}

Example:

{"action":"stop","services":["edgex-support-notifications","edgex-core-data"]}

HTTP status code 500

for unknown or unanticipated issues.

Service Configuration (by service names comma delimited)

example - http://localhost:48090/api/v1/config/edgex-support-notifications,edgex-core-data

get

get

Fetch the configuration of the specified EdgeX services by their unique names - returning null if none is found for the service. HTTP 500 for unknown or unanticipated issues

Fetch the configuration of the specified EdgeX services by their unique names - returning null if none is found for the service. HTTP 500 for unknown or unanticipated issues

URI Parameters

  • service names: required (string)

    EdgeX micro service names (the unique name of each service comma delimited)

HTTP status code 200

an array of config

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","description":"Service configuration","title":"config","properties":{"Service":{"type":"string","required":false,"title":"Service"},"Config":{"type":"string","required":false,"title":"Config"}}}

Example:

{"Service":"edgex-support-notifications","Config":{"Clients":{"Logging":{"Host":"localhost","Port":48061,"Protocol":"http"}},"Databases":{"Primary":{"Host":"localhost","Name":"notifications","Password":"","Port":27017,"Timeout":5000,"Type":"mongodb","Username":""}},"Logging":{"EnableRemote":false,"File":"./logs/edgex-support-notifications.log"},"Registry":{"Host":"localhost","Port":8500,"Type":"consul"},"ResendLimit":2,"Service":{"BootTimeout":30000,"CheckInterval":"10s","ClientMonitor":15000,"Host":"localhost","Port":48060,"Protocol":"http","MaxResultCount":1000,"StartupMsg":"This is the Support Notifications Microservice","Timeout":5000},"Smtp":{"Host":"smtp.gmail.com","Password":"mypassword","Port":587,"Sender":"jdoe@gmail.com","Subject":"EdgeX Notification"}}}

HTTP status code 500

for unknown or unanticipated issues.

Service Metrics (by service names comma delimited)

example - http://localhost:48090/api/v1/metrics/edgex-support-notifications,edgex-core-data

get

get

Fetch the operating performance metrics of the specified EdgeX services by their unique names - returning null if none is found for the service. HTTP 500 for unknown or unanticipated issues

Fetch the operating performance metrics of the specified EdgeX services by their unique names - returning null if none is found for the service. HTTP 500 for unknown or unanticipated issues

URI Parameters

  • service names: required (string)

    EdgeX micro service names (the unique name of each service comma delimited)

HTTP status code 200

an array of metrics

Body

Type: application/json

Schema:

{"type":"object","$schema":"http://json-schema.org/draft-03/schema#","description":"Service metrics","title":"metric","properties":{"Service":{"type":"string","required":false,"title":"Service"},"Metrics":{"type":"string","required":false,"title":"Metrics"}}}

Example:

{"Service":"edgex-support-notifications","Metrics":{"Alloc":2128944,"Frees":5911,"LiveObjects":31630,"Mallocs":37541,"Sys":7211256,"TotalAlloc":2128944}}

HTTP status code 500

for unknown or unanticipated issues.

Ping Resource

example - http://localhost:48090/api/v1/ping

get

get

Test service providing an indication that the service is available.

Edgex API Version

Example - http://localhost:48090/api/version

get

get

Get the API version