RunZero

the runzero connector enables automated exports of user, software, and asset inventories in json or csv formats, integrating seamlessly with security workflows runzero is a comprehensive network discovery and asset inventory platform that provides detailed insights into networked assets the runzero turbine connector allows users to export asset, software, and user inventories in json and csv formats directly into swimlane turbine, facilitating enhanced security automation and asset management by integrating with runzero, swimlane turbine users can leverage detailed asset data to enrich security playbooks, streamline incident response, and maintain up to date asset inventories for compliance and risk management limitations export tokens provide read only access to the export api only when using an account api token (ct prefix) for organization scoped export endpoints, you must specify the organization by including the oid query parameter with the organization id supported version the runzero connector supports the following authentication and api usage export token (et) read only access to export api endpoints organization is encoded in the token; no oid required organization token (ot) read and write access to a single organization; can also call export api for that organization account token (ct) account level access (platform license) for export or org specific calls, include oid=\<organization id> in the query parameters configuration prerequisites to effectively utilize the runzero connector for turbine, ensure you have the following bearer token authentication with these parameters url endpoint for the runzero api token a valid export, organization, or account api token from runzero oauth 2 0 client credentials with these parameters url endpoint for the runzero api client id your specific client identifier for oauth 2 0 client secret the secret key associated with your client id for oauth 2 0 token url the endpoint url to obtain the oauth 2 0 access token authentication methods http bearer token authentication setup instructions you need a runzero account and an api token export tokens are recommended for read only export use cases follow the steps below log in to the runzero console at https //console runzero com for an export token go to organizations, select the desired organization, then edit organization and scroll to the export tokens section generate or copy the token (et prefix) for an organization token from the organization details page, edit organization and use the organization api tokens section to generate a named token (ot prefix) for an account token (platform license) go to account settings and create an account api token (ct prefix) use oid=\<organization id> in query parameters when calling export or org specific endpoints all api requests must include the header authorization bearer \<your token> document references https //help runzero com/docs/leveraging the api/#authentication troubleshoot tips api calls are rate limited per day based on licensed assets response headers include x api usage remaining , x api usage limit , and x api usage today if you receive http 429, wait before retrying; there is also a limit of 2,000 requests per 5 minutes per source ip capabilities export assets (json) export software (json) export assets os (csv) export directory users (json) export assets (json) exports the asset inventory in json format supports optional query parameters such as search , fields , page size , and start key for filtering and pagination when page size is set, the response is an object with an assets array and next key for pagination; otherwise the response is a json array of assets more details can be found https //app swaggerhub com/apis/runzero/runzero/4 0 251021 0#/export/exportassetsjson export software (json) exports the software inventory in json format supports optional query parameters such as search , fields , page size , and start key for filtering and pagination when page size is set, the response is an object with a software array and next key ; otherwise the response is a json array of software more details can be found https //app swaggerhub com/apis/runzero/runzero/4 0 251021 0#/export/exportsoftwarejson export assets os (csv) exports top asset operating systems and counts as csv optional oid query parameter specifies the organization when using an account token more details can be found https //app swaggerhub com/apis/runzero/runzero/4 0 251021 0#/export/exportassettoposcsv export directory users (json) exports the user (directory) inventory in json format supports optional query parameters such as oid , search , and fields for filtering and field selection more details can be found https //app swaggerhub com/apis/runzero/runzero/4 0 251021 0#/export/exportdirectoryusersjson configurations http bearer authentication authenticates using a bearer token (export, organization, or account api token) configuration parameters parameter description type required url runzero console base url string required token api token with et ot or ct prefix string required verify ssl verify ssl certificate boolean optional http proxy proxy url to route requests through string optional headers additional headers per request object optional oauth 2 0 client credentials authenticates using oauth 2 0 client credentials configuration parameters parameter description type required url a url to the target host string required token url string required client id the client id string required client secret the client secret string required scope permission scopes for this action array optional verify ssl verify ssl certificate boolean optional http proxy a proxy to route requests through string optional actions export assets (json) exports the asset inventory from runzero as a json file, providing a comprehensive overview of networked assets endpoint url api/v1 0/export/org/assets json method get input argument name type required description parameters oid string optional current organization id for account tokens parameters search string optional search query in runzero search query syntax parameters fields string optional comma separated list of fields to export parameters page size integer optional number of results per request for pagination parameters start key string optional next page key from previous response next key input example {"parameters" {" oid" "string","search" "string","fields" "string","page size" 123,"start key" "string"}} output parameter type description status code number http status code of the response reason string response reason phrase output example {"status code" 200,"reason" "ok","response headers" {"content type" "application/json"},"json body" \[{"id" "e77602e0 3fb8 4734 aef9 fbc6fdcb0fa8","created at" 1576300370,"updated at" 1576300370,"organization id" "e77602e0 3fb8 4734 aef9 fbc6fdcb0fa8","site id" "e77602e0 3fb8 4734 aef9 fbc6fdcb0fa8","scanned"\ true,"alive"\ true,"first seen" 1576300370,"last seen" 1576300370,"detected by" "icmp","type" "server","os" "ubuntu linux","os version" "18 04","hw" "dell poweredge 2500","addresses" \[]}]} export assets os (csv) exports a csv file listing the top asset operating systems along with their counts from runzero endpoint url api/v1 0/org/assets/os csv method get input argument name type required description parameters oid string optional current organization id for account tokens input example {"parameters" {" oid" "string"}} output parameter type description status code number http status code of the response reason string response reason phrase output example {"status code" 200,"reason" "ok","response headers" {"content type" "text/csv"},"json body" "id,name,os\n123,asset 1,windows\n456,asset 2,linux"} export software (json) exports the software inventory from runzero as a json file, providing a comprehensive overview of installed applications endpoint url api/v1 0/export/org/software json method get input argument name type required description parameters oid string optional current organization id for account tokens parameters search string optional search query in runzero search query syntax parameters fields string optional comma separated list of fields to export parameters page size integer optional number of results per request for pagination parameters start key string optional next page key from previous response next key input example {"parameters" {" oid" "string","search" "string","fields" "string","page size" 123,"start key" "string"}} output parameter type description status code number http status code of the response reason string response reason phrase output example {"status code" 200,"reason" "ok","response headers" {"content type" "text/csv"},"json body" \[{"id" "e77602e0 3fb8 4734 aef9 fbc6fdcb0fa8","software id" "e77602e0 3fb8 4734 aef9 fbc6fdcb0fa8","software asset id" "e77602e0 3fb8 4734 aef9 fbc6fdcb0fa8","software organization id" "e77602e0 3fb8 4734 aef9 fbc6fdcb0fa8","software source id" 1,"software created at" 1576300370,"software updated at" 1576300370,"software service address" "192 168 0 1","software service transport" "tcp","software service p export directory users (json) exports the user inventory from runzero as a json file, providing a comprehensive list of users endpoint url api/v1 0/export/org/users json method get input argument name type required description parameters oid string optional current organization id for account tokens parameters search string optional search query in runzero search query syntax parameters fields string optional comma separated list of fields to export input example {"parameters" {" oid" "string","search" "string","fields" "string"}} output parameter type description status code number http status code of the response reason string response reason phrase output example {"status code" 200,"reason" "ok","response headers" {"content type" "application/json"},"json body" \[{"id" "e77602e0 3fb8 4734 aef9 fbc6fdcb0fa8","directory user id" "e77602e0 3fb8 4734 aef9 fbc6fdcb0fa8","directory user organization id" "e77602e0 3fb8 4734 aef9 fbc6fdcb0fa8","directory user site id" "e77602e0 3fb8 4734 aef9 fbc6fdcb0fa8","directory user source id" 1,"directory user created at" 1576300370,"directory user updated at" 1576300370,"directory user user id" "e77602e0 3fb8 4734 aef9 fb response headers header description example content type the media type of the resource application/json