Plug Database Advanced icon

Plug Database Advanced

Run Plug Database commands over REST or Socket.

Actions26

Client Access → Get Client Agent

AI-generated

Summary

Fetches detailed information about a specific Plug client agent identified by its Agent ID.

Inputs

  • Agent ID (required) — The unique identifier of the Plug agent to fetch details for.
  • Include Plug Metadata — Optional boolean to include the __plug metadata object containing operation and pagination metadata in the response (default true).

Output shape

a single JSON record representing the client agent's details, optionally including metadata under the __plug field.

The output includes the client agent's information fetched by the given Agent ID. If 'Include Plug Metadata' is true (default), operation-related metadata is included. Errors or missing agents are handled according to the node's standard error behavior.

Examples

Example 1: Get details of a client agent by ID

Specify the Agent ID of the client agent whose details you want to retrieve. Optionally toggle inclusion of metadata for pagination or operation details.

Links

Discussion