Create a proxy

Base URL: https://{kibana_url}

POST /api/fleet/proxies
POST /s/{space_id}/api/fleet/proxies

Auth

Create a new Fleet proxy.

Required privileges

Privileges fleet-settings-all

Path parameters

space_id string optional: An identifier for the space. If space_id is not provided in the URL, the default space is used. Refer to Spaces for more information.

Header parameters

kbn-xsrf string required: A required header to protect against CSRF attacks

Request body

certificate string nullable
certificate_authorities string nullable
certificate_key string nullable
id string
is_preconfigured boolean · default: false
name string required
proxy_headers map string to boolean | number | string nullable
url string required

Responses

Successful response

application/json

item object required

Bad Request

application/json

View as Markdown

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Create a new Fleet proxy

Console Kibana Dev Tools

POST kbn:/api/fleet/proxies
{
  "name": "My proxy",
  "url": "http://proxy.example.com:3128"
}

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/fleet/proxies" \
  -H "kbn-xsrf: true" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "My proxy",
    "url": "http://proxy.example.com:3128"
  }'

Generated from the API spec

Response

The created Fleet proxy

{
  "item": {
    "id": "proxy-id-2",
    "is_preconfigured": false,
    "name": "My proxy",
    "url": "http://proxy.example.com:3128"
  }
}

{
  "error": "Bad Request",
  "message": "An error message describing what went wrong",
  "statusCode": 400
}