Create an agent binary download source

Base URL: https://{kibana_url}

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

Auth

Create a new agent binary download source.

Required authorization

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

auth object nullable
host string · format: uri required
id string
is_default boolean · default: false
name string required
proxy_id string nullable: The ID of the proxy to use for this download source. See the proxies API for more information.
secrets object
ssl object

Responses

Successful response

application/json

item object required

Bad Request

application/json

attributes object required
error string
errorType string
message string required
statusCode number

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Create a new agent binary download source

Console Kibana Dev Tools

POST kbn:/api/fleet/agent_download_sources
{
  "host": "https://my-custom-host.example.com/downloads/",
  "is_default": false,
  "name": "My custom download source"
}

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/fleet/agent_download_sources" \
  -H "kbn-xsrf: true" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "host": "https://my-custom-host.example.com/downloads/",
    "is_default": false,
    "name": "My custom download source"
  }'

Generated from the API spec

Response

The created agent binary download source

{
  "item": {
    "host": "https://my-custom-host.example.com/downloads/",
    "id": "download-source-id-2",
    "is_default": false,
    "name": "My custom download source"
  }
}

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