Get proxies

Base URL: https://{kibana_url}

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

Auth

List all Fleet proxies.

Required privileges

Privileges fleet-settings-read

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.

Responses

Successful response

application/json

items object[] · max items: 10000 required
page number required
perPage number required
total number required

Bad Request

application/json

View as Markdown

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

GET kbn:/api/fleet/proxies

Generated from the API spec

curl Shell

curl -X GET "${KIBANA_URL}/api/fleet/proxies" \
  -H "Authorization: ApiKey ${API_KEY}"

Generated from the API spec

Response

List of Fleet proxies

{
  "items": [
    {
      "id": "proxy-id-1",
      "is_preconfigured": false,
      "name": "My proxy",
      "url": "http://proxy.example.com:3128"
    }
  ],
  "page": 1,
  "perPage": 20,
  "total": 1
}

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