Versions Compared

Old Version 2

changes.mady.by.user Mark Unwin

Saved on

compared with

New Version Current

changes.mady.by.user Mark Unwin

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

...

When beginning a new request, we always logon and store the returned cookie for future use. In addition to the cookie, if we want to create a resource (Orgs, Locations, Credentials, Discoveries, et al) we need to provide an access token. An access token is generated with every request (except logon) and any of the last 20 (by default, settable in the configuration) will be accepted. You should always aim to use the last access token issued. An example token is in the Get Device List response, below.


Updated for Open-AudIT 3.5.4 onward on 2021-11-29.

Logon

Request

Section


URLPOSThttp://localhost/omk/open-audit/loginlogon
HeadersAcceptapplication/json
BodyTypeform-data

Keyusernameadmin

Keypasswordpassword

...

Code Block
{
    "message": "Authenticated as user admin",
    "ok": 1
}

...


Read Devices

Logon as above, then.

Request

Section

URLGEThttp://localhost/omk/open-audit/devices
HeadersAcceptapplication/json

...

Logon as above, then request list of devices (or any available endpoint) so we can use the meta → access_token in our request (see above response).

Request

Section


URLPOSThttp://localhost/omk/open-audit/discoveries
HeadersAcceptapplication/json
BodyTypeform-data

Keydata
    {
        "access_token": "
23652075c7660006c281bf33589620dc093bdbedf8eb7ed1223449a95748
bcb3f959c14f0daf959e3de92e4213201a56bc205e31b63f35c3f9299670",
        "type": "discoveries",
        "attributes":
        {
            "
name
description": "
My
Subnet
Testing Discovery
- 192.168.1.0/24",
            "
type
match_options":
"subnet", "network_address": "http://127.0.0.1/open-audit/", "org_id": 1, "other": { "subnet": "192.169.1.0/24" } } }

Response

...

"{\"match_dbus\":\"\",\"match_dns_fqdn\":\"\",\"match_dns_hostname\":\"\",\"match_fqdn\":\"\",\"match_hostname\":\"\",\"match_hostname_dbus\":\"\",\"match_hostname_serial\":\"\",\"match_hostname_uuid\":\"\",\"match_ip\":\"\",\"match_ip_no_data\":\"\",\"match_mac\":\"\",\"match_mac_vmware\":\"\",\"match_serial\":\"\",\"match_serial_type\":\"\",\"match_sysname\":\"\",\"match_sysname_serial\":\"\",\"match_uuid\":\"\"}",
            "name": "My Testing Discovery",
            "org_id": 1,
            "scan_options": "{\"exclude_ip\":\"\",\"exclude_tcp_ports\":\"\",\"exclude_udp_ports\":\"\",\"filtered\":\"\",\"id\":\"1\",\"nmap_tcp_ports\":\"\",\"nmap_udp_ports\":\"\",\"open|filtered\":\"\",\"ping\":\"\",\"service_version\":\"\",\"ssh_ports\":\"\",\"tcp_ports\":\"\",\"timeout\":\"\",\"timing\":\"\",\"udp_ports\":\"\",\"script_timeout\":\"\",\"snmp_timeout\":\"\",\"ssh_timeout\":\"\",\"wmi_timeout\":\"\"}",
            "subnet": "192.168.1.0/24",
            "type": "subnet"
        }
    }

Response

Note, generated from a discoveries read. The actual output should be almost identical.

Code Block
{
    "data":
    [
        {
            "attributes":
            {
                "ad_domain": "",
                "ad_server": "",
                "cloud_id": 1,
                "cloud_name": "",
                "command_options": "",
                "description": "Subnet - 192.168.1.0/24",
                "devices_assigned_to_location": null,
                "devices_assigned_to_org": null,
                "discard": "n",
                "duration": "00:00:00",
                "edited_by": "Administrator",
                "edited_date": "2021-11-29 13:16:53",
                "id": 3,
                "ip_all_count": 0,
                "ip_audited_count": 0,
                "ip_discovered_count": 0,
                "ip_responding_count": 0,
                "attributesip_scanned_count": {0,
                "descriptionlast_finished": "Subnet 2000-01- 192.169.1.0/2401 00:00:00",
                "devices_assigned_to_location": nulllast_run": "2000-01-01 00:00:00",
                "devices_assigned_to_orgmatch_options":
null,                {
  "discard": "n",                 "durationmatch_dbus": "00:00:00",
                "edited_by    "match_dns_fqdn": "Administrator",
                    "edited_date": "2020-03-24 13:53:08",match_dns_hostname": "",
                    "idmatch_fqdn": 5"",
                    "ipmatch_all_counthostname": 0"",
                    "ipmatch_auditedhostname_countdbus": 0"",
                    "ipmatch_discoveredhostname_countserial": 0"",
                    "ipmatch_respondinghostname_countuuid": 0"",
                    "match_ip_scanned_count": 0,"",
                    "last_finishedmatch_ip_no_data": "2000-01-01 00:00:00",",
                    "lastmatch_runmac": "2000-01-01 00:00:00",
                 "name   "match_mac_vmware": "My",
  Testing Discovery",                 "networkmatch_addressserial": "http://127.0.0.1/open-audit/",
                "options    "match_serial_type": "",
                    "orgmatch_idsysname": 1"",
                "orgs.id    "match_sysname_serial": 1"",
                 "other": {   "match_uuid": ""
                },
         "nmap":  {     "name": "My Testing Discovery",
                "discovery_scan_option_idnetwork_address": "1",
       
                "excludeorg_ipid": ""1,
                "orgs.id": 1,
      "exclude_tcp_ports": "",         "scan_options":
               "exclude_udp_ports": "",
   {
                     "filteredexclude_ip": "n",

                       "nmapexclude_tcp_ports": "0",

                       "nmapexclude_udp_ports": "0",
   
                    "pingfiltered": "y",
   
                    "service_versionid": "n1",
   
                    "sshnmap_tcp_ports": "22",
 
                      "tcpnmap_udp_ports": "22,135,62078",
  
                     "timeoutopen|filtered": "0",

                       "timingping": "4",
 
                      "udpscript_portstimeout": "161",
                     }"service_version": "",
                    "subnetsnmp_timeout": "192.169.1.0/24"
     ",
          },                 "status"ssh_ports": "",,
                    "system.idssh_timeout": 0,"",
                    "systemtcp_idports": 0"",
                    "typetimeout": "subnet"
 ,
          },             "idtiming": 5"",
            "links": {       "udp_ports": "",
        "self": "/omk/open-audit/discoveries/5"           "wmi_timeout": ""
},             "type": "discoveries"  },
      }     ],     "errorsseed_ip": [],
    "included": [],
      "links": {         "firstseed_ping": null"y",

       "last": null,         "nextseed_restrict_to_private": null"y",
        "prev": null,         "self"seed_restrict_to_subnet": "http://localhost/omk/open-audit/discoveries"y",
    },     "meta": {         "access_token"status": "94abae66d364697699d0a44e7cfba111c769882bf832014b2ea287623650",

       "action": "create",         "baseurlsubnet": "http://localhost/omk/open-audit",192.168.1.0/24",
                "collectionsystem.id": "discoveries"0,
        "current": "y",         "datasystem_orderid": 0,
  [              "discoveries.id",type": "subnet"
            "discoveries.name"},
            "discoveries.org_id": 3,
            "discoveries.description",links":
            {
    "discoveries.type",            "self": "discoveries.devices_assigned_to_org",http://dev.local/omk/open-audit/discoveries/3"
            "discoveries.devices_assigned_to_location",},
            "type": "discoveries.network_address","
        }
    ],
    "discoveries.system_id"included": [],
    "issues": [],
    "meta":
 "discoveries.options",   {
        "access_token": "discoveries.discardef4421add7e6f2741a2830a1b0262d3b678cc33efdacdd9442d5a871f474",
            "discoveries.last_run"action": "read",
           "as_at": "discoveries.last_finished",
            "discoveries.duration"baseurl": "http://dev.local/omk/open-audit",
            "collection": "discoveries.status",
            "discoveries.ip_all_count",
  "current": "y",
         "discoveries.ip_responding_count",data_order":
        [
   "discoveries.ip_scanned_count",
            "discoveries.ip_discovered_countid",
            "discoveries.ip_audited_countname",
            "discoveries.editedorg_byid",
            "discoveries.edited_datedescription",
            "orgsdiscoveries.idtype",
            "systemdiscoveries.idsubnet",
            "otherdiscoveries.subnetseed_ip",
            "other.nmap"
discoveries.seed_restrict_to_subnet",
       ],     "discoveries.seed_restrict_to_private",
   "debug": false,         "filter": [],discoveries.seed_ping",
           "filtered": "discoveries.ad_domain",
         "format":   "jsondiscoveries.ad_server",
         "groupby":   "discoveries.devices_assigned_to_org",
        "header": "HTTP/1.1 201 Created",    "discoveries.devices_assigned_to_location",
           "heading": "Discoveriesdiscoveries.network_address",
            "discoveries.system_id": 5,,
            "ids": 0,discoveries.scan_options",
           "include": "discoveries.match_options",
          "limit": 1000,  "discoveries.command_options",
            "offset": 0,discoveries.discard",
           "properties": "*discoveries.last_run",
        "query_parameters": [],    "discoveries.last_finished",
           "query_string": "discoveries.duration",
        "received_data": {    "discoveries.status",
            "access_token": "23652075c7660006c281bf33589620dc093bdbedf8eb7ed1223449a95748discoveries.ip_all_count",
            "attributes": {discoveries.ip_responding_count",
            "discoveries.ip_scanned_count",
    "description": "Subnet - 192.169.1.0/24",     "discoveries.ip_discovered_count",
           "name": "My Testing Discovery",
   "discoveries.ip_audited_count",
             "network_address": "http://127.0.0.1/open-audit/",
   discoveries.cloud_id",
            "orgdiscoveries.cloud_idname":,
1,            "discoveries.edited_by",
    "other": "{\"subnet\":\"192.169.1.0\\/24\",\"nmap\":{\"discovery_scan_option_id\":\"1\",\"ping\":\"y\",\"service_version\":\"n\",\"filtered\":\"n\",\"timeout\":\"0\",\"timing\":\"4\",\"nmap_tcp_ports\":\"0\",\"nmap_udp_ports\":\"0\",\"tcp_ports\":\"22,135,62078\",\"udp_ports\":\"161\",\"exclude_tcp_ports\":\"\",\"exclude_udp_ports\":\"\",\"exclude_ip\":\"\",\"ssh_ports\":\"22\"}}",        "discoveries.edited_date",
            "orgs.id",
            "system.id"
        ],
        "debug": false,
        "filter": [],
        "filtered": 1,
        "format": "json",
        "groupby": "",
        "header": "HTTP/1.1 200 OK",
        "heading": "Discoveries",
        "id": 3,
        "include": "",
        "limit": 1000,
        "typenmap_version": "subnet"7,
        "offset": 0,
        "properties": ".*",
   },      "query_parameters": [],
        "typequery_string": "discoveries",
         }"received_data": [],
        "request_method": "POSTGET",
        "requestor": "commercial",
        "sortserver_app_version": "4.3.0",
        "sub_resourceserver_platform": "Debian GNU/Linux 9 (stretch)",
        "sort": "",
        "sub_resource_id": 0"",
        "timestamp": "20202021-0311-2429 13:5324:0845",
        "timezone": "UTC +1000",
        "total": 01,
        "version": 1
    }
}

...


Update Discovery

Logon as above, then.

Request

Section


URLPATCHhttp://localhost/omk/open-audit/discoveries/5
HeadersAcceptapplication/json
BodyTypex-www-form-urlencoded

Keydata
{
    "id": 5,
    "type": "discoveries",
    "attributes": {
         "name": "My New Name OMK"
    }
}

Response

Note - generated from pre 3.5.4. Attribute outputs will be as above for 3.5.4 onward.

Code Block
{
    "data": [
        {
            "attributes": {
                "description": "Subnet - 192.169.1.0/24",
                "devices_assigned_to_location": null,
                "devices_assigned_to_org": null,
                "discard": "n",
                "duration": "00:00:00",
                "edited_by": "Administrator",
                "edited_date": "2020-03-24 14:13:36",
                "id": 5,
                "ip_all_count": 0,
                "ip_audited_count": 0,
                "ip_discovered_count": 0,
                "ip_responding_count": 0,
                "ip_scanned_count": 0,
                "last_finished": "2000-01-01 00:00:00",
                "last_run": "2000-01-01 00:00:00",
                "name": "My New Name OMK",
                "network_address": "http://127.0.0.1/open-audit/",
                "options": "",
                "org_id": 1,
                "orgs.id": 1,
                "other": {
                    "nmap": {
                        "discovery_scan_option_id": "1",
                        "exclude_ip": "",
                        "exclude_tcp_ports": "",
                        "exclude_udp_ports": "",
                        "filtered": "n",
                        "nmap_tcp_ports": "0",
                        "nmap_udp_ports": "0",
                        "ping": "y",
                        "service_version": "n",
                        "ssh_ports": "22",
                        "tcp_ports": "22,135,62078",
                        "timeout": "0",
                        "timing": "4",
                        "udp_ports": "161"
                    },
                    "subnet": "192.169.1.0/24"
                },
                "status": "",
                "system.id": 0,
                "system_id": 0,
                "type": "subnet"
            },
            "id": 5,
            "links": {
                "self": "/omk/open-audit/discoveries/5"
            },
            "type": "discoveries"
        }
    ],
    "errors": [],
    "included": [],
    "links": {
        "first": null,
        "last": null,
        "next": null,
        "prev": null,
        "self": "http://localhost/omk/open-audit/discoveries/5"
    },
    "meta": {
        "access_token": "47049142d113e4e316ae4219afdf54d6a6d034ff779a42fd5198a720da2e",
        "action": "update",
        "baseurl": "http://localhost/omk/open-audit",
        "collection": "discoveries",
        "current": "y",
        "data_order": [
            "discoveries.id",
            "discoveries.name",
            "discoveries.org_id",
            "discoveries.description",
            "discoveries.type",
            "discoveries.devices_assigned_to_org",
            "discoveries.devices_assigned_to_location",
            "discoveries.network_address",
            "discoveries.system_id",
            "discoveries.options",
            "discoveries.discard",
            "discoveries.last_run",
            "discoveries.last_finished",
            "discoveries.duration",
            "discoveries.status",
            "discoveries.ip_all_count",
            "discoveries.ip_responding_count",
            "discoveries.ip_scanned_count",
            "discoveries.ip_discovered_count",
            "discoveries.ip_audited_count",
            "discoveries.edited_by",
            "discoveries.edited_date",
            "orgs.id",
            "system.id",
            "other.subnet",
            "other.nmap"
        ],
        "debug": false,
        "filter": [],
        "filtered": "",
        "format": "json",
        "groupby": "",
        "header": "HTTP/1.1 200 OK",
        "heading": "Discoveries",
        "id": 5,
        "ids": 0,
        "include": "",
        "limit": 1000,
        "offset": 0,
        "properties": "*",
        "query_parameters": [],
        "query_string": "",
        "received_data": {
            "attributes": {
                "id": 5,
                "name": "My New Name OMK"
            },
            "id": 5,
            "type": "discoveries"
        },
        "request_method": "PATCH",
        "requestor": "",
        "sort": "",
        "sub_resource": "",
        "sub_resource_id": 0,
        "timestamp": "2020-03-24 14:13:36",
        "timezone": "UTC +1000",
        "total": 0,
        "version": 1
    }
}

...

Logon as above, then.

Request

Section

URLDELETEhttp://localhost/omk/open-audit/discoveries/5
HeadersAcceptapplication/json

Response


Code Block
{
    "meta": {
        "access_token": "530d34dc6304ebd361d088d7831e4ce9d276ac8a4826837bdf36e8e84c87",
        "action": "delete",
        "baseurl": "http://localhost/open-audit/",
        "collection": "discoveries",
        "current": "y",
        "debug": false,
        "filtered": "",
        "format": "json",
        "groupby": "",
        "header": "HTTP/1.1 200 OK",
        "id": 5,
        "ids": 0,
        "include": "",
        "limit": 1000,
        "offset": 0,
        "properties": "*",
        "query_string": "",
        "request_method": "DELETE",
        "requestor": "",
        "sort": "",
        "sub_resource": "",
        "sub_resource_id": 0,
        "total": 0,
        "timestamp": "2020-03-24 14:22:38",
        "timezone": "UTC +1000",
        "version": 1,
        "filter": [],
        "query_parameters": [],
        "received_data": [],
        "heading": "Discoveries",
        "data_order": []
    },
    "links": {
        "self": "http://localhost/open-audit/index.php/discoveries/5",
        "first": null,
        "last": null,
        "next": null,
        "prev": null
    },
    "included": [],
    "data": [
        {
            "type": "discoveries"
        }
    ]
}

...