Update an agent by ID

PUT /api/fleet/agents/{agentId}
Api key auth Basic auth

Spaces method and path for this operation:

put /s/{space_id}/api/fleet/agents/{agentId}

Refer to Spaces for more information.

Update an agent by ID.

[Required authorization] Route required privileges: fleet-agents-all.

Headers

  • kbn-xsrf string Required

    A required header to protect against CSRF attacks

Path parameters

  • agentId string Required
application/json

Body

  • tags array[string]
  • user_provided_metadata object

    Additional properties are allowed.

Responses

  • 200 application/json
    Hide response attribute Show response attribute object
    • item object Required

      Additional properties are NOT allowed.

      Hide item attributes Show item attributes object
      • access_api_key string
      • access_api_key_id string
      • active boolean Required
      • agent object

        Additional properties are allowed.

        Hide agent attributes Show agent attributes object
        • id string Required
        • version string Required
      • audit_unenrolled_reason string
      • components array[object]
        Hide components attributes Show components attributes object
        • id string Required
        • message string Required
        • status string Required

          Values are STARTING, CONFIGURING, HEALTHY, DEGRADED, FAILED, STOPPING, or STOPPED.

        • type string Required
        • units array[object]
          Hide units attributes Show units attributes object
          • id string Required
          • message string Required
          • payload object

            Additional properties are allowed.

          • status string Required

            Values are STARTING, CONFIGURING, HEALTHY, DEGRADED, FAILED, STOPPING, or STOPPED.

          • type string Required

            Values are input or output.

      • default_api_key string
      • default_api_key_history array[object]
        Hide default_api_key_history attributes Show default_api_key_history attributes object Deprecated
        • id string Required
        • retired_at string Required
      • default_api_key_id string
      • enrolled_at string Required
      • id string Required
      • last_checkin string
      • last_checkin_message string
      • last_checkin_status string

        Values are error, online, degraded, updating, or starting.

      • last_known_status string

        Values are offline, error, online, inactive, enrolling, unenrolling, unenrolled, updating, degraded, uninstalled, or orphaned.

      • local_metadata object Required

        Additional properties are allowed.

      • metrics object

        Additional properties are NOT allowed.

        Hide metrics attributes Show metrics attributes object
        • cpu_avg number
        • memory_size_byte_avg number
      • namespaces array[string]
      • outputs object
        Hide outputs attribute Show outputs attribute object
        • * object Additional properties

          Additional properties are NOT allowed.

          Hide * attributes Show * attributes object
          • api_key_id string
          • to_retire_api_key_ids array[object]
            Hide to_retire_api_key_ids attributes Show to_retire_api_key_ids attributes object
            • id string Required
            • retired_at string Required
          • type string
      • packages array[string] Required
      • policy_id string
      • policy_revision number | null
      • sort array
      • status string

        Values are offline, error, online, inactive, enrolling, unenrolling, unenrolled, updating, degraded, uninstalled, or orphaned.

      • tags array[string]
      • type string Required

        Values are PERMANENT, EPHEMERAL, or TEMPORARY.

      • unenrolled_at string
      • unenrollment_started_at string
      • unhealthy_reason array[string] | null

        Values are input, output, or other.

      • upgrade_attempts array[string] | null
      • upgrade_details object | null

        Additional properties are NOT allowed.

        Hide upgrade_details attributes Show upgrade_details attributes object | null
        • action_id string Required
        • metadata object

          Additional properties are NOT allowed.

          Hide metadata attributes Show metadata attributes object
          • download_percent number
          • download_rate number
          • error_msg string
          • failed_state string

            Values are UPG_REQUESTED, UPG_SCHEDULED, UPG_DOWNLOADING, UPG_EXTRACTING, UPG_REPLACING, UPG_RESTARTING, UPG_FAILED, UPG_WATCHING, or UPG_ROLLBACK.

          • retry_error_msg string
          • retry_until string
          • scheduled_at string
        • state string Required

          Values are UPG_REQUESTED, UPG_SCHEDULED, UPG_DOWNLOADING, UPG_EXTRACTING, UPG_REPLACING, UPG_RESTARTING, UPG_FAILED, UPG_WATCHING, or UPG_ROLLBACK.

        • target_version string Required
      • upgrade_started_at string | null
      • upgraded_at string | null
      • user_provided_metadata object

        Additional properties are allowed.
  • 400 application/json
    Hide response attributes Show response attributes object
    • error string
    • errorType string
    • message string Required
    • statusCode number
PUT /api/fleet/agents/{agentId} 
curl \
 --request PUT 'https://localhost:5601/api/fleet/agents/{agentId}' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --header "kbn-xsrf: true" \
 --data '{"tags":["string"],"user_provided_metadata":{}}'