Guest Machines
API referenceRuns

Cancel a remote-asset import

POST/api/v1/artifacts/imports/{job_id}/cancel

Cancel a queued or running import. A cancelled import cannot publish an artifact. Cancelling an already completed import does not delete its artifact.

Required access

Credentials: automation account, delegated token, user session, user API key

User API keys use the owner’s current permissions, subject to any key restrictions. Capability scopes below apply to automation account keys and delegated tokens.

Scope: runs:edit

The job must belong to this exact calling identity and organization.

Authorization

AuthorizationBearer <token>

A user-owned key prefixed gsmc_uk_, bound to one organization. It follows its owner's current membership, role and resource permissions, optionally restricted to read-only access. No X-Org-Id header is needed; a conflicting organization is rejected. Credential creation, personal connection setup and human attestations require a signed-in session. Runs are private to the calling user; sharing an agent grants access to your own personal memory of it, never to the agent's own memory.

In: header

Path Parameters

job_id*Job Id
Formatuuid

Header Parameters

X-Org-Id?|

Selects the active organization for a direct user session that has more than one membership. Automation account keys and delegated tokens are each bound to one organization and ignore it.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1/artifacts/imports/497f6eca-6276-4993-bfeb-53cbbbba6f08/cancel" \  -H "Authorization: Bearer $GUEST_MACHINES_API_KEY"
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "status": "queued",  "source_kind": "url",  "source_run_id": 0,  "source_result_sequence": 0,  "artifact_id": "b7bd6bbb-c7f1-4314-8742-2aeeeece9d12",  "file_name": "string",  "max_bytes": 0,  "expected_media_type": "string",  "expected_sha256": "string",  "description": "string",  "attempts": 0,  "error_code": "string",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "completed_at": "2019-08-24T14:15:22Z"}