v1

latestOpenAPI 3.0.0Elastic License 2.02026-07-1791851.7 KB

Initiate a file upload process

post/api/fleet/uploads

Headers

X-Request-Idstring

The request tracking ID for APM.

Elastic-Api-Versionstring

The API version to use, format should be "YYYY-MM-DD"

Request body

action_idstring required

ID of the action that requested this file

agent_idstring required

Identifier of the agent uploading. Matches the ID usually found in agent.id

src'endpoint' | 'agent' required

The source integration sending this file

Example request

{
  "file": {
    "Compression": "deflate",
    "hash": {
      "sha256": "04f81394bababa0fb31e6ad2d703c875eb46dc254527e39ff316564c0dc339e2"
    },
    "name": "yankees-stats.zip",
    "mime_type": "application/zip",
    "size": 8276748
  },
  "action_id": "2f440d31-2ea4-42f8-b0f2-4b6e98e8dc5e",
  "agent_id": "9347e918-5e00-48b0-b302-a09f9258a46d"
}

Response

Information about the upload procedure

upload_idstring required

A unique identifier for the ensuing upload operation

chunk_sizeinteger required

The required size (in bytes) that the file must be segmented into for each chunk

Example response

{
  "upload_id": "fbc8e23c-055d-461e-87f7-b0d1b57f14b4",
  "chunk_size": 4194304
}