$npx -y skills add grandcamel/Splunk-Assistant-Skills --skill splunk-rest-adminProgrammatic access to internal configurations via REST command.
| 1 | # splunk-rest-admin |
| 2 | |
| 3 | Programmatic access to internal configurations via REST command. |
| 4 | |
| 5 | ## Purpose |
| 6 | |
| 7 | Query and manage Splunk server configurations, users, roles, and system info. |
| 8 | |
| 9 | ## Risk Levels |
| 10 | |
| 11 | | Operation | Risk | Notes | |
| 12 | |-----------|------|-------| |
| 13 | | REST GET request | - | Read-only | |
| 14 | | Get server info | - | Read-only | |
| 15 | | List users/roles | - | Read-only | |
| 16 | | REST POST request | ⚠️⚠️ | May modify server config | |
| 17 | |
| 18 | ## Triggers |
| 19 | |
| 20 | - "rest", "admin", "config" |
| 21 | - "server", "settings", "info" |
| 22 | |
| 23 | ## CLI Commands |
| 24 | |
| 25 | | Command | Description | |
| 26 | |---------|-------------| |
| 27 | | `admin info` | Get server information | |
| 28 | | `admin status` | Get server status | |
| 29 | | `admin health` | Get server health | |
| 30 | | `admin list-users` | List all users | |
| 31 | | `admin list-roles` | List all roles | |
| 32 | | `admin rest-get` | Make GET request to REST endpoint | |
| 33 | | `admin rest-post` | Make POST request to REST endpoint | |
| 34 | |
| 35 | ## REST Options |
| 36 | |
| 37 | | Option | Description | |
| 38 | |--------|-------------| |
| 39 | | `-d`, `--data` | JSON data payload for POST requests | |
| 40 | | `-a`, `--app` | App context for REST requests | |
| 41 | | `--owner` | Owner context for REST requests | |
| 42 | | `-o`, `--output` | Output format (text, json) | |
| 43 | |
| 44 | ## Examples |
| 45 | |
| 46 | ```bash |
| 47 | # Get server info |
| 48 | splunk-as admin info |
| 49 | splunk-as admin info --output json |
| 50 | |
| 51 | # Get server status |
| 52 | splunk-as admin status |
| 53 | splunk-as admin status --output json |
| 54 | |
| 55 | # Get server health |
| 56 | splunk-as admin health |
| 57 | splunk-as admin health --output json |
| 58 | |
| 59 | # List users |
| 60 | splunk-as admin list-users |
| 61 | |
| 62 | # List roles |
| 63 | splunk-as admin list-roles |
| 64 | |
| 65 | # REST GET request - users |
| 66 | splunk-as admin rest-get /services/authentication/users |
| 67 | |
| 68 | # REST GET request - server info |
| 69 | splunk-as admin rest-get /services/server/info |
| 70 | |
| 71 | # REST GET request - apps with app/owner context |
| 72 | splunk-as admin rest-get /services/apps/local --app search --owner admin |
| 73 | |
| 74 | # REST POST request with app/owner context |
| 75 | splunk-as admin rest-post /services/saved/searches -d '{"name": "test"}' --app search --owner admin |
| 76 | ``` |
| 77 | |
| 78 | ## SPL Patterns |
| 79 | |
| 80 | ```spl |
| 81 | | rest /services/server/info |
| 82 | | rest /services/authentication/users |
| 83 | | rest /services/admin/conf-times |
| 84 | ``` |