Create or replace proxy

Content

Responses
Permissions
Examples

PUT /_signals/proxies/{proxy-id}

Create a new proxy if no proxy with the provided id exists. If a proxy with the provided id exists, the existing proxy is replaced.

Responses

200 OK

Proxy added or replaced, information about proxy is present in response body.

400 Bad Request

The request was malformed.

If the proxy specified in the request body was malformed, a JSON document containing detailed validation errors will be returned in the response body.

403 Forbidden

The user does not have the required permissions to access the endpoint.

Permissions

For being able to access the endpoint, the user needs to have the privilege cluster:admin:searchguard:signals:proxies/createorreplace.

Examples

Create a new proxy with id `my-proxy`

PUT /_signals/proxies/my-proxy

{
  "name": "my test proxy",
  "uri": "http://127.0.0.1:9199"
}

Response

200 OK

{
  "status": 200,
  "data": {
    "id": "my-proxy",
    "name": "my test proxy",
    "uri": "http://127.0.0.1:9199"
  }
}

Questions? Drop us a note!