Skip to main content
POST
Preview Tool Attachment Upgrade

Authorizations

Authorization
string
header
required

Your SLNG consumer API key.

Path Parameters

agent_id
string<uuid>
required

The agent UUID that owns the attachment being upgraded.

attachment_id
string<uuid>
required

The UUID of the tool attachment on the agent.

to_version
integer
required

The published tool version number to upgrade the attachment to.

Response

A preview of upgrading the attached tool to the target version: the diff, any blocking issues, and gate checks. While the sandbox is still preparing dependencies, the endpoint instead returns 202 with a Retry-After header.

Preview of upgrading an attachment to a target version, with the parameter diff and blocking issues.

agent_id
string<uuid>
required
attachment_id
string<uuid>
required
tool_id
string<uuid>
required
from_version
integer
required
to_version
integer
required
current_config_hash
string
required
current_tool_version_hash
string
required
target_tool_version_hash
string
required
acceptance_hash
string
required
reconciled_attachment
ToolAttachment · object
required

A tool bound to an agent at a specific version, with any overrides.

added_parameters
string[]
required
removed_parameters
string[]
required
renamed_parameters
Renamed Parameters · object
required
type_changed_parameters
Type Changed Parameters · object
required
issues
ToolUpgradeIssue · object[]
required
can_accept
boolean
required
dependency_proof_hash
string | null
Pattern: ^[0-9a-f]{64}$
preparation_state
enum<string> | null
Available options:
ready,
preparing,
failed
preparation_operation_id
string | null
retry_after_seconds
integer | null
Required range: 1 <= x <= 60