ExHook

Update the server

put/exhooks/{name}

Request

  • Base URL: https://docs.emqx.com/api/v5
  • URL: https://docs.emqx.com/api/v5/exhooks/{name}
  • Auth: one of:
    • HTTP basic
    • bearerAuth (a scheme the document does not define)

Path parameters

namestring required

The Exhook server name

Request body

namestring required

Name of the exhook server

enableboolean

Enable this Exhook server

urlstring required

URL of the gRPC server

request_timeoutstring

The timeout of request gRPC server

failed_action'deny' | 'ignore'

The value that is returned when the request to the gRPC server fails for any reason

pool_sizeinteger

The process pool size for gRPC client

Example request

{
  "name": "default",
  "url": "http://127.0.0.1:9000",
  "request_timeout": "12m",
  "socket_options": {
    "recbuf": "64KB",
    "sndbuf": "16KB"
  },
  "auto_reconnect": "12m"
}

Response

namestring required

Name of the exhook server

enableboolean

Enable this Exhook server

urlstring required

URL of the gRPC server

request_timeoutstring

The timeout of request gRPC server

failed_action'deny' | 'ignore'

The value that is returned when the request to the gRPC server fails for any reason

pool_sizeinteger

The process pool size for gRPC client

Example response

{
  "name": "default",
  "url": "http://127.0.0.1:9000",
  "request_timeout": "12m",
  "socket_options": {
    "recbuf": "64KB",
    "sndbuf": "16KB"
  },
  "auto_reconnect": "12m"
}

Changes

No recorded changes to this operation across all 1 revision of this API.