general
Publish a metric from different Nuon clients for telemetry purposes.
- Github
- Blog
- Community
- Youtube
- GETget all apps for the current org
- POSTcreate an app
- GETget an app
- DELdelete an app
- PATCHupdate an app
- POSTCreate app input configs
- GETget app input configs
- GETget latest app input config
- POSTcreate an app sandbox config
- GETget app sandbox configs
- GETget latest app sandbox config
- GETget all components for an app
- GETget all components for an org
- GETget a component
- PATCHupdate a component
- GETGet all builds for a component
- POSTcreate component build
- GETget latest build for a component
- GETget a build for a component
- GETget component build plan
- GETget all configs for a component
- POSTcreate a docker build component config
- POSTcreate an external image component config
- POSTcreate a helm component config
- POSTcreate a job component config
- GETget latest config for a component
- POSTcreate a terraform component config
- POSTcreate an app installer
- GETrender an installer
- GETget an installer
- DELdelete an installer
- GETget all installs for an app
- POSTcreate an app install
- GETget an install
- POSTcreate an app install from an installer
- GETget all installs for an org
- DELdelete an install
- PATCHupdate an install
- GETget an install component
- GETget an installs components
- GETget an install components deploys
- GETget the latest deploy for an install component
- POSTdeploy a build to an install
- GETget an install deploy
- GETget install deploy logs
- GETget install deploy plan
- GETget an installs inputs
- POSTcreate install inputs
- GETget an installs current inputs
- GETget an installs sandbox runs
- GETget all releases for an app
- GETget all releases for a component
- POSTcreate a release
- POSTCreate a release 1
- GETget a release
- GETget a release
- GETGet config for cli
- GETGet current user
- POSTPublish a metric from different Nuon clients for telemetry purposes.
apps
components
installers
installs
releases
general
general
Publish a metric from different Nuon clients for telemetry purposes.
POST
/
v1
/
general
/
metrics
Authorization
string
*
Authorization
Required
string
Type "Bearer" followed by a space and token.
array
*
curl --request POST \
--url https://ctl.prod.nuon.co/v1/general/metrics \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '[
{
"decr": {
"name": "<string>",
"tags": [
"<string>"
]
},
"event": {
"event": {
"aggregationKey": "<string>",
"alertType": "info",
"hostname": "<string>",
"priority": "normal",
"sourceTypeName": "<string>",
"tags": [
"<string>"
],
"text": "<string>",
"timestamp": "<string>",
"title": "<string>"
}
},
"incr": {
"name": "<string>",
"tags": [
"<string>"
]
},
"timing": {
"name": "<string>",
"tags": [
"<string>"
],
"value": 123
}
}
]'
"<string>"
Authorizations
Authorization
string
headerrequiredType "Bearer" followed by a space and token.
Body
application/json · object[]
decr
object
decr.name
string
decr.tags
string[]
event
object
event.event
object
event.event.aggregationKey
string
AggregationKey groups this event with others of the same key.
event.event.alertType
enum<string>
AlertType can be statsd.Info, statsd.Error, statsd.Warning, or statsd.Success. If absent, the default value applied by the dogstatsd server is Info.
Available options:
info
, error
, warning
, success
event.event.hostname
string
Hostname for the event.
event.event.priority
enum<string>
Priority of the event. Can be statsd.Low or statsd.Normal.
Available options:
normal
, low
event.event.sourceTypeName
string
SourceTypeName is a source type for the event.
event.event.tags
string[]
Tags for the event.
event.event.text
string
Text is the description of the event.
event.event.timestamp
string
Timestamp is a timestamp for the event. If not provided, the dogstatsd server will set this to the current time.
event.event.title
string
Title of the event. Required.
incr
object
incr.name
string
incr.tags
string[]
timing
object
timing.name
string
timing.tags
string[]
timing.value
integer
Response
200 - application/json
The response is of type string
.
curl --request POST \
--url https://ctl.prod.nuon.co/v1/general/metrics \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '[
{
"decr": {
"name": "<string>",
"tags": [
"<string>"
]
},
"event": {
"event": {
"aggregationKey": "<string>",
"alertType": "info",
"hostname": "<string>",
"priority": "normal",
"sourceTypeName": "<string>",
"tags": [
"<string>"
],
"text": "<string>",
"timestamp": "<string>",
"title": "<string>"
}
},
"incr": {
"name": "<string>",
"tags": [
"<string>"
]
},
"timing": {
"name": "<string>",
"tags": [
"<string>"
],
"value": 123
}
}
]'
"<string>"