Endpoint

/v1/support/settings

GET

Get monitoring configuration.

Parameters

This resource has no parameters.

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "api_monitoring_config_get",
  "type": "object",
  "properties": {
    "enabled": {
      "description": "enabled",
      "type": "boolean"
    },
    "mq_host": {
      "description": "mq_host",
      "type": "string"
    },
    "mq_port": {
      "description": "mq_port",
      "type": "number"
    },
    "mq_proxy_host": {
      "description": "mq_proxy_host",
      "type": "string"
    },
    "mq_proxy_port": {
      "description": "mq_proxy_port",
      "type": "number"
    },
    "s3_proxy_host": {
      "description": "s3_proxy_host",
      "type": "string"
    },
    "s3_proxy_port": {
      "description": "s3_proxy_port",
      "type": "number"
    },
    "s3_proxy_disable_https": {
      "description": "s3_proxy_disable_https",
      "type": "boolean"
    },
    "vpn_enabled": {
      "description": "vpn_enabled",
      "type": "boolean"
    },
    "vpn_host": {
      "description": "vpn_host",
      "type": "string"
    },
    "period": {
      "description": "period",
      "type": "number"
    },
    "nexus_enabled": {
      "description": "nexus_enabled",
      "type": "boolean"
    },
    "nexus_host": {
      "description": "nexus_host",
      "type": "string"
    },
    "nexus_port": {
      "description": "nexus_port",
      "type": "number"
    },
    "nexus_interval": {
      "description": "nexus_interval",
      "type": "number"
    },
    "nexus_registration_key": {
      "description": "nexus_registration_key",
      "type": "string"
    },
    "nexus_secret_created_at": {
      "description": "nexus_secret_created_at",
      "type": "string"
    }
  }
}

PUT

Set monitoring configuration.

Parameters

Name Description Required
If-Match ETag for expected version No

Request

Schema

{
  "description": "api_monitoring_config_put",
  "type": "object",
  "properties": {
    "enabled": {
      "description": "enabled",
      "type": "boolean"
    },
    "mq_host": {
      "description": "mq_host",
      "type": "string"
    },
    "mq_port": {
      "description": "mq_port",
      "type": "number"
    },
    "mq_proxy_host": {
      "description": "mq_proxy_host",
      "type": "string"
    },
    "mq_proxy_port": {
      "description": "mq_proxy_port",
      "type": "number"
    },
    "s3_proxy_host": {
      "description": "s3_proxy_host",
      "type": "string"
    },
    "s3_proxy_port": {
      "description": "s3_proxy_port",
      "type": "number"
    },
    "s3_proxy_disable_https": {
      "description": "s3_proxy_disable_https",
      "type": "boolean"
    },
    "vpn_enabled": {
      "description": "vpn_enabled",
      "type": "boolean"
    },
    "vpn_host": {
      "description": "vpn_host",
      "type": "string"
    },
    "period": {
      "description": "period",
      "type": "number"
    },
    "nexus_enabled": {
      "description": "nexus_enabled",
      "type": "boolean"
    },
    "nexus_host": {
      "description": "nexus_host",
      "type": "string"
    },
    "nexus_port": {
      "description": "nexus_port",
      "type": "number"
    },
    "nexus_interval": {
      "description": "nexus_interval",
      "type": "number"
    },
    "nexus_registration_key": {
      "description": "nexus_registration_key",
      "type": "string"
    }
  }
}

Response

Codes

Code Description
202 Return value on success

PATCH

Partial set of monitoring configuration.

Parameters

Name Description Required
If-Match ETag for expected version No

Request

Schema

{
  "description": "api_monitoring_config_put",
  "type": "object",
  "properties": {
    "enabled": {
      "description": "enabled",
      "type": "boolean"
    },
    "mq_host": {
      "description": "mq_host",
      "type": "string"
    },
    "mq_port": {
      "description": "mq_port",
      "type": "number"
    },
    "mq_proxy_host": {
      "description": "mq_proxy_host",
      "type": "string"
    },
    "mq_proxy_port": {
      "description": "mq_proxy_port",
      "type": "number"
    },
    "s3_proxy_host": {
      "description": "s3_proxy_host",
      "type": "string"
    },
    "s3_proxy_port": {
      "description": "s3_proxy_port",
      "type": "number"
    },
    "s3_proxy_disable_https": {
      "description": "s3_proxy_disable_https",
      "type": "boolean"
    },
    "vpn_enabled": {
      "description": "vpn_enabled",
      "type": "boolean"
    },
    "vpn_host": {
      "description": "vpn_host",
      "type": "string"
    },
    "period": {
      "description": "period",
      "type": "number"
    },
    "nexus_enabled": {
      "description": "nexus_enabled",
      "type": "boolean"
    },
    "nexus_host": {
      "description": "nexus_host",
      "type": "string"
    },
    "nexus_port": {
      "description": "nexus_port",
      "type": "number"
    },
    "nexus_interval": {
      "description": "nexus_interval",
      "type": "number"
    },
    "nexus_registration_key": {
      "description": "nexus_registration_key",
      "type": "string"
    }
  }
}

Response

Codes

Code Description
202 Return value on success