GET /api/fleet/proxies
Api key auth Basic auth

Spaces method and path for this operation:

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

Refer to Spaces for more information.

List all Fleet proxies.

[Required authorization] Route required privileges: fleet-settings-read.

Responses

  • 200 application/json

    Successful response

    Hide response attributes Show response attributes object
    • items array[object] Required

      Not more than 10000 elements.

      Hide items attributes Show items attributes object
      • certificate string | null
      • certificate_authorities string | null
      • certificate_key string | null
      • id string Required
      • is_preconfigured boolean

        Default value is false.

      • name string Required
      • proxy_headers object | null
      • url string Required
    • page number Required
    • perPage number Required
    • total number Required
  • 400 application/json

    Bad Request

    Hide response attributes Show response attributes object
    • attributes Required
    • error string
    • errorType string
    • message string Required
    • statusCode number
GET /api/fleet/proxies 
curl \
 --request GET 'https://localhost:5601/api/fleet/proxies' \
 --header "Authorization: $API_KEY"
Response examples (200)
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
}
Response examples (400)
Example of a generic error response 
{
  "error": "Bad Request",
  "message": "An error message describing what went wrong",
  "statusCode": 400
}