Harness

Filter Resource Groups [Beta]

This contains the filter endpoint for Resource Groups.

Filter Resource Groups

Returns a list of Resource Groups based on filter criteria.

Securityx-api-key
Request
query Parameters
page
integer
Default: 0

Pagination page number strategy: Specify the page number within the paginated collection related to the number of items on each page.

limit
integer <= 100
Default: 30

Pagination: Number of items to return.

sort
string

Parameter on the basis of which sorting is done.

Enum: "identifier" "name" "created" "updated"
order
string

Order on the basis of which sorting is done.

Enum: "ASC" "DESC"
header Parameters
Harness-Account
string

Identifier field of the account the resource is scoped to.

Request Body schema:
required

Filter Resource Group request body

account
string [ 1 .. 128 ] characters

Filter by Account identifier.

org
string [ 1 .. 128 ] characters ^[a-zA-Z_][0-9a-zA-Z_$]{0,127}$

Filter by Organization identifier.

project
string [ 1 .. 128 ] characters ^[a-zA-Z_][0-9a-zA-Z_$]{0,127}$

Filter by Project identifier.

search_term
string

Filter Resource Group matching by identifier/name.

identifier_filter
Array of strings unique

Filter by Resource Group identifiers

Array of objects (Resource Selector Filter) unique

Filter based on whether it has a particular Resource.

managed_filter
string

Filter based on whether the Resource Group is Harness Managed.

Enum: "NO_FILTER" "ONLY_MANAGED" "ONLY_CUSTOM"
Responses
200

Resource Groups List response body

post/v1/resource-groups/filter
Request samples
{
  • "account": "example_account",
  • "org": "example_organization",
  • "project": "example_project",
  • "search_term": "search",
  • "identifier_filter": [
    ],
  • "resource_selector_filter": [
    ],
  • "managed_filter": "NO_FILTER"
}
Response samples
[
  • {
    }
]
➔ Next to Harness Resource Group