Retrieve worklet from catalog by uuid or legacy id

Retrieves details for a specific Worklet by UUID or legacy ID

SecuritybearerAuth
Request
path Parameters
required
string or integer

This can be the UUID or the Legacy ID of the Worklet

Responses
200

Successful Operation

400

Invalid Request

401

Access token is missing or invalid

403

You do not have permission to perform this action.

404

Entity not found

429

Too many requests

503

Service Unavailable

default

Invalid Request

get/worklet-catalog/{UUID-legacy_id}
Request samples 
$apiKey = 'your_automox_api_key' $headers = @{ "Authorization" = "Bearer $apiKey" }

$url = "https://console.automox.com/api/worklet-catalog/10af9475-fd20-4189-bb9c-e1c707ff2670"
# The legacy_id can also be used here, for example `$url = "https://console.automox.com/api/worklet-catalog/123456"`
$response = (Invoke-WebRequest -Method Get -Uri $url -Headers $headers -ContentType "application/json").Content
Response samples
application/json
{
  • "uuid": "ab6a9bdc-95b8-5e82-a248-dafe2e40d5a7",
  • "name": "Add Network Printer",
  • "description": "This worklet will allow an Admin to add a network shared printer that installs at user logon.",
  • "category": "System Preferences",
  • "keywords": [
    • "task",
    • "logon",
    • "scheduled",
    • "printer",
    • "share",
    • "network"
    ],
  • "inputs": [ ],
  • "language": "PowerShell",
  • "status": "ACTIVE",
  • "creator": "Basil Fawlty",
  • "verified": true,
  • "version": "1.0.0",
  • "authors": [
    • {
      • "name": "Basil Fawlty",
      • "email": "example@automox.com"
      }
    ],
  • "categories": [
    • "System Preferences"
    ],
  • "bundles": [ ],
  • "refs": [ ],
  • "legacy_id": 4,
  • "user_interaction_required": false,
  • "os_family": "Windows",
  • "feature_compatibility": [ ],
  • "schema_version": "2.0.0",
  • "device_type": [
    • "SERVER",
    • "WORKSTATION"
    ],
  • "license_required": false,
  • "minimum_agent_required": "1.42.0",
  • "evaluation_code": "Exit 1",
  • "remediation_code": "Hello World",
  • "create_time": "2021-03-29T20:12:24Z",
  • "update_time": "2023-08-17T18:12:06Z"
}