Get Security Tagged Entities

Retrieves the list of entities that have at least one tag assigned to it. Besides entityType, additional supported filters are:

tag - The tag to search by

Example: filter=(tag==Web;entityType==vm)

Request

URI

GET

https://{api_host}/cloudapi/1.0.0/securityTags/entities

COPY

Query Parameters

string

filter

Optional

Filter for a query. FIQL format.

string

sortAsc

Optional

Field to use for ascending sort

string

sortDesc

Optional

Field to use for descending sort

integer

page

Required

Page to fetch, zero offset.

integer

pageSize

Required

Results per page to fetch.

Authentication

This operation uses the following authentication methods.

ApiKeyAuth

Responses

200

Returns SecurityTaggedEntities of type(s) application/json;version=37.0

This response body class contains all of the following: Page , InlineSecurityTaggedEntities1

{
    "resultTotal": 0,
    "pageCount": 0,
    "page": 0,
    "pageSize": 0,
    "associations": [
        {
            "entityId": "string",
            "associationId": "string"
        }
    ],
    "values": [
        {
            "id": "string",
            "name": "string",
            "parentRef": {
                "name": "string",
                "id": "string"
            },
            "ownerRef": {
                "name": "string",
                "id": "string"
            },
            "entityType": "string"
        }
    ]
}

Availability

Added in 36.0

On This Page

Description

Request

Query Parameters

Authentication

Response

200 Response Body

Security Tags Operations

GET

Get Security Tagged Entities