Getting Started

If you really can't wait...

You can test access against a demo instance at e.g. https://demo.squid46.io/cmdb_ci_server_minimal?limit=10.

Click to see the response

{
  "metadata": {
    "powered_by": "arc46.io",
    "git": "squid-1.1.0.0+0-1f88b4a",
    "build": "2025-09-21T15:30:41.370Z",
    "license_max_entities": "Unlimited",
    "license_valid_till": "2050-12-31T23:59:59.000Z",
    "requested_by": "arc46_rest_demo",
    "request_received": "2025-10-09T06:50:22.315Z",
    "config": "cmdb_ci_server_minimal",
    "row_count": 10,
    "limit_request": 10
  },
  "data": [
    {
      "asset_tag": "P1000173",
      "name": "Service-now Production Sacramento",
      "sys_class_name": "cmdb_ci_server",
      "sys_id": "106c5c13c61122750194a1e96cfde951",
      "sys_mod_count": 34,
      "sys_updated_on": "2025-09-20T19:57:48Z"
    },
    {
      "asset_tag": "P1000114",
      "name": "Service-now Production San Diego",
      "sys_class_name": "cmdb_ci_server",
      "sys_id": "1072335fc611227500c0267a21be5dc5",
      "sys_mod_count": 35,
      "sys_updated_on": "2025-09-20T19:57:34Z"
    },
    {
      "asset_tag": "P1000030",
      "name": "DatabaseServer2",
      "sys_class_name": "cmdb_ci_server",
      "sys_id": "14a9e27bc61122750037b90c4d34da38",
      "sys_mod_count": 18,
      "sys_updated_on": "2025-09-20T19:57:28Z"
    },
    {
      "asset_tag": "P1000095",
      "name": "VMWARE-SD-04",
      "sys_class_name": "cmdb_ci_server",
      "sys_id": "27e52cc8c0a8000b0067d0b66b8a66de",
      "sys_mod_count": 23,
      "sys_updated_on": "2025-09-20T19:57:35Z"
    },
    {
      "asset_tag": "P1000021",
      "name": "VMWARE-SD-07",
      "sys_class_name": "cmdb_ci_server",
      "sys_id": "27e59e75c0a8000b003b3fab4211d2c2",
      "sys_mod_count": 25,
      "sys_updated_on": "2025-09-20T19:57:48Z"
    },
    {
      "asset_tag": "P1000201",
      "name": "INSIGHT-NY-03",
      "sys_class_name": "cmdb_ci_server",
      "sys_id": "27eabc4bc0a8000b0089fd512b3e8934",
      "sys_mod_count": 9,
      "sys_updated_on": "2025-09-20T19:57:34Z"
    },
    {
      "asset_tag": "P1000034",
      "name": "AS400",
      "sys_class_name": "cmdb_ci_server",
      "sys_id": "3a63d606c611222500487ae00a5bf3b8",
      "sys_mod_count": 42,
      "sys_updated_on": "2025-09-20T19:57:27Z"
    },
    {
      "name": "12345",
      "sys_class_name": "cmdb_ci_server",
      "sys_id": "561226f33b6e0210231c057f16e45a8f",
      "sys_mod_count": 6,
      "sys_updated_on": "2025-09-20T19:56:33Z"
    },
    {
      "asset_tag": "P1000171",
      "name": "Car-1",
      "sys_class_name": "cmdb_ci_server",
      "sys_id": "6cabe993c611222500bb025775ec8732",
      "sys_mod_count": 25,
      "sys_updated_on": "2025-09-20T19:57:35Z"
    },
    {
      "asset_tag": "P1000071",
      "name": "Car-2",
      "sys_class_name": "cmdb_ci_server",
      "sys_id": "6cb10db5c611222500bf34f43d2ff189",
      "sys_mod_count": 25,
      "sys_updated_on": "2025-09-20T19:57:28Z"
    }
  ],
  "relations": {},
  "referenced": {}
}

If that is all you are looking for right now, see API Call for details on how to request data and see Configs for a list of all available configurations. Try it out and see if it works out for you.

Install squid!

If you haven't already, head over to the ServiceNow Store and Try or Buy Squid and then install the app on your instance(s).

Get a License Key

Please contact sales@arc46.io and include the instance names you are requesting a license key for. (License keys are bound to one or more instances.)

Until you have a license key, Squid will work on non-production instances, albeit with a limitation of 50 entities.

Squid works on PDIs without any limitations. No license key required. However, installing applications from the ServiceNow store on PDIs is only available to ServiceNow employees. Sorry.

Deactivate Use of ServiceNow ACLs

While this might seem like a strange request - ACLs are a security feature and security is good, right? - deactivating the usage of ServiceNow ACLs is essential to the correct functioning of Squid. See System Property x_a46gh_squidx.allowAclOverride for details.

Grant Access

Accessing Squid will require the calling user to have the role x_a46gh_squidx.rest.

Squid configurations can be restricted to certain roles. All predefined configurations provided by Squid require the role x_a46gh_squidx.defaultAccess.

Please see Roles / ACLs for details.

Execute your First Data Request!

See API Call for details.