ServiceNow Skill

Query and manage records on any ServiceNow instance via the REST Table API.

Setup

Set environment variables for your ServiceNow instance:

CODEBLOCK0

All tools below use scripts/sn.sh which reads these env vars.

Tools

sn_query — Query any table

CODEBLOCK1

Options:

• - --query "<encoded_query>" — ServiceNow encoded query (e.g. active=true^priority=1)
• INLINECODE3 — Comma-separated fields to return
• INLINECODE4 — Max records (default 20)
• INLINECODE5 — Pagination offset
• INLINECODE6 — Sort field (prefix with - for descending)
• INLINECODE8 — Display values mode

Examples:

CODEBLOCK2

snget — Get a single record by sysid

CODEBLOCK3

Options:

• - --fields "<field1,field2>" — Fields to return
• INLINECODE10 — Display values mode

Example:

CODEBLOCK4

sn_create — Create a record

CODEBLOCK5

Example:

CODEBLOCK6

sn_update — Update a record

CODEBLOCK7

Example:

CODEBLOCK8

sn_delete — Delete a record

CODEBLOCK9

The --confirm flag is required to prevent accidental deletions.

sn_aggregate — Aggregate queries

CODEBLOCK10

Types: COUNT, AVG, MIN, MAX, INLINECODE16

Options:

• - --type <TYPE> — Aggregation type (required)
• INLINECODE18 — Filter records
• INLINECODE19 — Field to aggregate on (required for AVG/MIN/MAX/SUM)
• INLINECODE20 — Group results by field
• INLINECODE21 — Display values mode

Examples:

CODEBLOCK11

sn_schema — Get table schema

CODEBLOCK12

Returns field names, types, max lengths, mandatory flags, reference targets, and choice values.

Use --fields-only for a compact field list.

sn_batch — Bulk update or delete records

CODEBLOCK13

Performs bulk update or delete operations on all records matching a query. Runs in dry-run mode by default — shows how many records match without making changes. Pass --confirm to execute.

Options:

• - --query "<encoded_query>" — Filter records to operate on (required)
• INLINECODE25 — Operation to perform (required)
• INLINECODE26 — JSON fields to set on each record (required for update)
• INLINECODE27 — Max records to affect per run (default 200, safety cap at 10000)
• INLINECODE28 — Show match count only, no changes (default behavior)
• INLINECODE29 — Actually execute the operation (disables dry-run)

Examples:

CODEBLOCK14

Output (JSON summary):
CODEBLOCK15

sn_health — Instance health check

CODEBLOCK16

Checks ServiceNow instance health across multiple dimensions. Default is --check all which runs every check.

Checks:

• - version — Instance build version, date, and tag from sysproperties
• nodes — Cluster node status (online/offline) from sysclusterstate
• jobs — Stuck/overdue scheduled jobs from systrigger (state=ready, nextaction > 30 min past)
• semaphores — Active semaphores (potential locks) from syssemaphore
• stats — Quick dashboard: active incidents, open P1s, active changes, open problems

Examples:

CODEBLOCK17

Output (JSON):
CODEBLOCK18

sn_attach — Manage attachments

CODEBLOCK19

Common Tables

Encoded Query Syntax

ServiceNow encoded queries use ^ as AND, ^OR as OR:

• - active=true^priority=1 — Active AND P1
• INLINECODE46 — Active OR inactive
• INLINECODE47 — Contains "server"
• INLINECODE48 — Created after date
• INLINECODE49 — Unassigned
• INLINECODE50 — State is 1, 2, or 3
• INLINECODE51 — Dot-walk through references

Notes

• - All API calls use Basic Auth via SN_USER / INLINECODE53
• Default result limit is 20 records; use --limit to adjust
• Use --display true to get human-readable values instead of sys_ids for reference fields
• The script auto-detects whether SN_INSTANCE includes the protocol prefix