Skip to main content

Interface: ModelSecurityGroupListOptions

Defined in: src/model-security/security-groups-client.ts:36

Options for listing security groups.

Extends​

Properties​

skip?​

optional skip?: number;

Defined in: src/listing.ts:8

Number of records to skip from the start.

Inherited from​

ListingOptions.skip

limit?​

optional limit?: number;

Defined in: src/listing.ts:10

Max records to return.

Inherited from​

ListingOptions.limit

optional search?: string;

Defined in: src/listing.ts:12

Free-text search filter.

Inherited from​

ListingOptions.search

sort_field?​

optional sort_field?: string;

Defined in: src/model-security/security-groups-client.ts:38

Field to sort by: 'created_at' or 'updated_at'.

sort_dir?​

optional sort_dir?: string;

Defined in: src/model-security/security-groups-client.ts:40

Sort direction: 'asc' or 'desc'.

source_types?​

optional source_types?: string[];

Defined in: src/model-security/security-groups-client.ts:42

Filter by source types.

search_query?​

optional search_query?: string;

Defined in: src/model-security/security-groups-client.ts:44

Search term (matches UUID or Name, 3-1000 chars).

enabled_rules?​

optional enabled_rules?: string[];

Defined in: src/model-security/security-groups-client.ts:46

Filter by rule UUIDs with ALLOWING or BLOCKING state.