HomeDocumentationAPI Reference
Log In
API Reference

Perform response action on an artifact

Initiates a response action against an existing artifact. For process actions (process_kill, process_suspend, process_resume, process_retrieve), the artifact must contain process data with a SHA-512 hash. For file_retrieve, the artifact must contain a file path (from file, cron, or at job engines). Requires the responder role. Can be disabled server-wide with SF_DISABLE_RESPONSES and at the node level with SF_NODE_DISABLE_RESPONSES.

Returns a ResponseActionResponse in both the queued (HTTP 202) and cached-fulfillment (HTTP 200, retrieve actions only) cases.

Path Params
int64
required

Numeric artifact ID to act on.

required

Action to perform. Process actions require a process artifact; file_retrieve requires an artifact with a file path.

Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json