List Resources

List Resources

curl --request GET \
  --url https://api.leen.dev/v2/resources \
  --header 'X-API-KEY: <api-key>' \
  --header 'X-CONNECTION-ID: <api-key>'

{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "type": "BRANCH",
      "state": "ACTIVE",
      "vendor": "<string>",
      "vendor_attributes": {
        "id": "<string>",
        "data": {
          "vendor": "qualys",
          "host_id": "<string>",
          "asset_id": "<string>",
          "tracking_method": "<string>"
        }
      },
      "tags": [
        {
          "key": "<string>",
          "value": "<string>",
          "source": "wiz_vms"
        }
      ],
      "groups": [
        {
          "name": "<string>",
          "uid": "<string>"
        }
      ],
      "data": {
        "hostnames": [
          "<string>"
        ],
        "image": "<string>"
      },
      "cloud_metadata": {
        "account_id": "<string>",
        "account_name": "<string>",
        "cloud_provider": "<string>",
        "image_id": "<string>",
        "instance_id": "<string>",
        "instance_type": "<string>",
        "region": "<string>",
        "subnet_id": "<string>",
        "vpc_id": "<string>"
      },
      "url": "<string>",
      "first_seen": "2023-11-07T05:31:56Z",
      "last_seen": "2023-11-07T05:31:56Z"
    }
  ],
  "next_cursor": "<string>",
  "previous_cursor": "<string>"
}

GET

resources

List Resources

curl --request GET \
  --url https://api.leen.dev/v2/resources \
  --header 'X-API-KEY: <api-key>' \
  --header 'X-CONNECTION-ID: <api-key>'

{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "type": "BRANCH",
      "state": "ACTIVE",
      "vendor": "<string>",
      "vendor_attributes": {
        "id": "<string>",
        "data": {
          "vendor": "qualys",
          "host_id": "<string>",
          "asset_id": "<string>",
          "tracking_method": "<string>"
        }
      },
      "tags": [
        {
          "key": "<string>",
          "value": "<string>",
          "source": "wiz_vms"
        }
      ],
      "groups": [
        {
          "name": "<string>",
          "uid": "<string>"
        }
      ],
      "data": {
        "hostnames": [
          "<string>"
        ],
        "image": "<string>"
      },
      "cloud_metadata": {
        "account_id": "<string>",
        "account_name": "<string>",
        "cloud_provider": "<string>",
        "image_id": "<string>",
        "instance_id": "<string>",
        "instance_type": "<string>",
        "region": "<string>",
        "subnet_id": "<string>",
        "vpc_id": "<string>"
      },
      "url": "<string>",
      "first_seen": "2023-11-07T05:31:56Z",
      "last_seen": "2023-11-07T05:31:56Z"
    }
  ],
  "next_cursor": "<string>",
  "previous_cursor": "<string>"
}

Authorizations

X-CONNECTION-ID

string

header

required

X-API-KEY

string

header

required

Query Parameters

updatedSince

string<date-time> | null

Datetime filter, only return items updated since this datetime. Example format: 2021-01-01T00:00:00+00:00 Datetime filter, only return items updated since this datetime. Example format: 2021-01-01T00:00:00+00:00

cursor

string | null

Skip token to continue from the last item in the previous page Skip token to continue from the last item in the previous page

limit

integer

default:100

Limit size (page size) Limit size (page size)

Required range: x >= 0

name

string | null

Filter resources by name (comma-separated values supported) Filter resources by name (comma-separated values supported)

vendor

string | null

Filter resources by vendor (comma-separated values supported) Filter resources by vendor (comma-separated values supported)

state

string | null

Filter resources by state (comma-separated values supported) Filter resources by state (comma-separated values supported)

Example:

"ACTIVE,DELETED,IGNORED"

type

string | null

Filter resources by type (comma-separated values supported) Filter resources by type (comma-separated values supported)

Example:

"branch,host,container,dependency,image,unknown"

use_pool

boolean

default:true

Response

Successful Response

items

Resource · object[]

required

List of items returned in the response

Show child attributes

items.id

string<uuid>

required

Leen's UUID for the resource

items.name

string

required

Resource name

items.type

enum<string>

required

Type of the resource

Available options:

BRANCH,

HOST,

CONTAINER,

DEPENDENCY,

IMAGE,

REPOSITORY,

UNKNOWN

items.state

enum<string>

required

State of the resource

Available options:

ACTIVE,

IGNORED,

DELETED,

INACTIVE,

QUARANTINED,

UNKNOWN

items.vendor

string

required

The source vendor of the resource

items.vendor_attributes

ResourceVendorAttributes · object

required

Vendor-specific attributes like IDs

Show child attributes

items.vendor_attributes.id

string

required

Vendor specific ID

items.vendor_attributes.data

QualysDeviceVendorData · object

Vendor specific data

QualysDeviceVendorData
TenableDeviceVendorData
OrcaResourceVendorAttributesData

Show child attributes

items.vendor_attributes.data.vendor

enum<string>

required

Available options:

qualys

Allowed value: "qualys"

items.vendor_attributes.data.host_id

string

required

items.vendor_attributes.data.asset_id

string | null

items.vendor_attributes.data.tracking_method

string | null

items.tags

ResourceTag · object[] | null

List of arbitrary tags/metadata for the resource

Show child attributes

items.tags.key

string

required

items.tags.value

string

required

items.tags.source

enum<string>

required

Available options:

wiz_vms,

gitlab,

checkmarx,

mend,

qualys,

aws,

insight_vm,

orca

items.groups

ResourceGroup · object[] | null

Groups associated with the resource

Show child attributes

items.groups.name

string

required

The name of the group.

items.groups.uid

string

required

The unique identifier of the group.

items.data

ResourceContainer · object

Additional data or properties about the resource

ResourceContainer
ResourceHost
ResourceImage
ResourceBranch

Show child attributes

items.data.hostnames

string[] | null

List of hostnames for the container

items.data.image

string | null

Container image identifier

items.cloud_metadata

ResourceCloudMetadata · object

Cloud metadata for the resource

Show child attributes

items.cloud_metadata.account_id

string | null

Cloud account identifier

items.cloud_metadata.account_name

string | null

Cloud account name

items.cloud_metadata.cloud_provider

string | null

Cloud service provider

items.cloud_metadata.image_id

string | null

Cloud image identifier

items.cloud_metadata.instance_id

string | null

Cloud instance identifier

items.cloud_metadata.instance_type

string | null

Type of cloud instance

items.cloud_metadata.region

string | null

Cloud region

items.cloud_metadata.subnet_id

string | null

Cloud subnet identifier

items.cloud_metadata.vpc_id

string | null

Cloud VPC identifier

items.url

string | null

URL associated with the resource

items.first_seen

string<date-time> | null

Timestamp when the resource was first seen

items.last_seen

string<date-time> | null

Timestamp when the resource was last seen

next_cursor

string | null

Skip token to continue from the last item in the previous page

previous_cursor

string | null

Skip token to continue from the first item in the previous page

Get Vulnerability Finding by ID Get Resource by ID

⌘I

API Documentation (V2)

Vulnerability Findings

Resources

Authorizations

Query Parameters

Response