API Errors

The Metrics API responds to all requests with a JSON response. When your request has been accepted, the response {"ok":true} will be returned, accompanied by a 200 OK HTTP header.

However, if an error has occurred, you will see one of the following responses from the Metrics API:

NO_METRICS_COLLECTD (1)

No metrics found in POST body: {POST body}

Collectd submitted a request that did not contain any valid metrics.

NO_METRICS (2)

No metrics found in request

We could not parse any metrics from your request. Please consult the API documentation for examples: https://www.wormly.com/help/metrics-collectd/custom-metrics

INVALID_TIMESTAMP (3)

Invalid timestamp: current time is {current time}, timestamp in your request is {client submitted time}

The timestamp provided in your request differs to our system clock by a large margin. Please check that your system clock is correct.

FORBIDDEN_METRIC (4)

The invalid metric name(s) are: {invalid metric name(s)}

You have tried to use a metric name reserved for our internal use. You'll need to use a different metric name.

RATE_LIMITED (5)

You have hit the Metrics rate limit of {maximum allowed} metrics per minute with {number of metrics sent} metrics

You're sending metrics at too high a rate. This is most likely caused by a misconfigured app, but please contact support if you feel this to be in error: wormly.com/support

WRONG_HOST (6)

Host {host id} does not exist or does not belong to your account - please check that you are using the correct API key at: wormly.com/apikeys

The hostID specified does not exist or does not belong to your account.

INTERNAL_ERROR (7)

Internal server error

Oops, there's a problem with our system - our fault, not yours! Our apologies for the inconvenience, our Ops team has been notified and we will have this resolved as soon as possible.

USER_NOT_FOUND (8)

API key not found or missing required permissions

The API key submitted either does not exist or does not have the necessary Host::Health::Submit permission. Verify your keys at: wormly.com/apikeys

NO_USER_PERMISSIONS (9)

User is not allowed to post metrics

The API key used for the request is valid, but the owners' account does not have permission to submit metrics. Please contact support if you feel this is an error: wormly.com/support

WRONG_FORMAT (10)

Incorrect message format: {bad line}

Incorrect metrics submission format. The offending line is shown in the API response.

WRONG_METRIC_PROPERTY (11)

Invalid metric property: {property name}

An invalid metric property was submitted.

WRONG_METRIC_PROPERTY_VALUE (12)

Invalid metric property value: {property name}={property value}

A metric property was submitted with an invalid value.

DISABLED_HOST (13)

Host {host name} has been disabled - please re-enable it here https://www.wormly.com/edithost/hostid/{hostid}#metrics

The host has been explicitly disabled via the Wormly control panel, so all metric submissions are refused. Re-enable this host before sending metrics.