filters - v1beta1

accounts - v1beta1

Operations

activation-keys - v1beta1

Operations

activation-tokens - v1beta1

Operations

activities - v1beta2

Operations

ahs-files - v1beta1

Operations

appliance-firmware-bundles - v1

Operations

appliance-firmware-bundles - v1beta1

Operations

async-operations - v1

Operations

async-operations - v1beta1

Operations

energy-over-time - v1beta1

Operations

energy-by-entity - v1beta1

Operations

external-services - v1beta1

Operations

filters - v1beta1

Operations

List all saved filters

Request

Retrieve a paginated collection of saved filter resources.

URI PATH PREFIX RENAME

This API now supports the URI path prefix /compute-ops-mgmt which used to be /compute-ops. The /compute-ops prefix is deprecated and might become unresponsive after Tuesday, April 1, 2025. The Guide provides more information about this change.

Security

Bearer

Query

offsetinteger>= 0

Zero-based resource offset to start the response from

Default 0

Example: offset=10

limitinteger[ 0 .. 10000 ]

The maximum number of records to return.

Default 50

Example: limit=10

filterstring

Limit the resources operated on by an endpoint or when used with a multiple-GET endpoint, return only the subset of resources that match the filter. The filter grammar is a subset of OData 4.0.

NOTE: The filter query parameter must use URL encoding. Most clients do this automatically with inputs provided to them specifically as query parameters. Encoding must be done manually for any query parameters provided as part of the URL.
The reserved characters ! # $ & ' ( ) * + , / : ; = ? @ [ ] must be encoded with percent encoded equivalents. Server IDs contain a +, which must be encoded as %2B.
For example: the value P06760-B21+2M212504P8 must be encoded as P06760-B21%2B2M212504P8 when it is used in a query parameter.

CLASS	EXAMPLES
Types	integer, decimal, timestamp, string, boolean, null
Operations	eq, ne, gt, ge, lt, le, in
Logic	and, or, not

Filters can be filtered by:

filterResourceType
id
type

The following examples are not an exhaustive list of all possible filtering options.

Examples:

Filter with equality check

Return filters where a property equals a value. <property> eq <value>

filter=type eq 'compute-ops/filter'

Filter with url encoding applied to all reserved characters (example is fully URL encoded)

Return filters where a property equals a value, using a url. <property>%20eq%20%27<value>

filter=id%20eq%20%27b870f080-6448-48c5-b23a-d04f2d489174

Filter on an inverted query

Return filters where a property does not equal a value not <property> eq <value>

filter=not type eq 'compute-ops/jobs'

Filter that a property contains a value

Return filters with populated property. not <property> eq null

filter=not filterResourceType eq null

Filter that field value contains a specific substring

Return filters where property contains a value. contains(<property>, <value>)

filter=contains(type,'filter')

Filter on multiple conditionals

Return filters where property is populated and property contains value. not <property> eq null and contains(<property>, <value>)

filter=not filterResourceType eq null and contains(type,'filter')

Filter for a value to have one of multiple possibilities

Return filters where property is one of multiple values. <property> in (<value>,<value>)

filter=type in ('compute-ops/filter','compute-ops/jobs')

sortstring

The order in which to return the resources in the collection.

The value of the sort query parameter is a comma separated list of sort expressions. Each sort expression is a property name optionally followed by a direction indicator asc (ascending) or desc (descending).

The first sort expression in the list defines the primary sort order, the second defines the secondary sort order, and so on. If a direciton indicator is omitted the default direction is ascending.

Default "createdAt asc"

Examples:

ascending by name

Order resources ascending by name

sort=name asc

ascending by name and then by descending by createdAt

Order resources ascending by name and then by descending by createdAt

sort=name,createdAt desc

Headers

Tenant-Acidstring(uuid)

Tenant-Acid header can be used by an MSP workspace to make API calls on behalf of their tenant by specifying the tenant's application customer ID.

In order to make such an API call, the Bearer token must belong to an MSP workspace and this header value must be the application customer ID of a tenant within the MSP workspace. Use the /compute-ops-mgmt/v1beta1/accounts API to determine the application customer IDs for your tenant accounts.

curl -i -X GET \
  https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/compute-ops-mgmt/v1beta1/filters \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json

countinteger>= 0required

Number of items returned

Example: 1

offsetinteger>= 0required

Zero-based resource offset

totalinteger>= 0required

Total number of items in the collection that match the filter query, if one was provided in the request

Example: 12

itemsArray of objectsrequired

Array of saved filter resources in the page of the collection.

items[].idstring(uuid)read-only

Primary identifier for the filter resource given by the system.

Example: "b870f080-6448-48c5-b23a-d04f2d489174"

items[].typestringread-only

The type of the resource.

Value "compute-ops-mgmt/filter"

items[].generationinteger>= 1read-only

Monotonically increasing update counter.

Example: 1

items[].createdAtstring(date-time)read-only

Time of filter resource creation.

Example: "2022-02-11T01:04:20.799937+00:00"

items[].updatedAtstring(date-time)read-only

Time of the last update to the filter resource.

Example: "2022-02-11T01:04:20.799937+00:00"

items[].resourceUristring(uri-reference)read-only

URI to the filter resource itself (i.e. a self link).

Example: "/compute-ops-mgmt/v1beta1/filters/b870f080-6448-48c5-b23a-d04f2d489174"

items[].namestring[ 1 .. 100 ] characters

The display name of the filter, must be unique.

items[].descriptionstring or null<= 10000 characters

An optional longer description of the filter.

items[].readOnlybooleanread-only

If true, the filter is pre-defined and cannot be edited or deleted.

Default false

items[].filterResourceTypestring

The type of the resource that the filter matches against. New resource types may be added as a backward compatible change to the API.

Default "compute-ops-mgmt/server"

Value"compute-ops-mgmt/server"

items[].enabledForRRPboolean

Flags the filter for use with resource restriction policies used by scope-based access control (SBAC). Only administrators with full access to all scopes can create, edit, or delete RRP-enabled filters. The use of some resource properties may be disallowed in RRP-enabled filters.

Default false

items[].filterstring or null<= 2000 characters

The filter expression, in the same syntax as the filter query parameter common to many collection endpoints. At least one of filter and filterTags must be specified. If both are specified, both filter expressions much match for a resource to match the filter.

items[].filterTagsstring or null<= 2000 characters

An optional filter expression for tags, in the same syntax as the filter-tags query parameter common to many collection endpoints. Used to handle tag keys with special characters. At least one of filter and filterTags must be specified. If both are specified, both filter expressions much match for a resource to match the filter.

items[].uiDataobject or nullread-only

Opaque JSON structure used by the Compute Ops Management UI. Other clients should not read or set this property. Note that the format of the data is subject to change without notice, even with the same API version of filters.

Default null

items[].matchesUristring(uri-reference)read-only

URI of collection of match entities that indicate which resources match the filter.

Example: "/compute-ops-mgmt/v1beta1/filters/b870f080-6448-48c5-b23a-d04f2d489174/matches"

Response

application/json

{
  "offset": 0,
  "count": 1,
  "total": 12,
  "items": [
    { … }
  ]
}

Save a filter

Request

Create a new saved filter resource.

URI PATH PREFIX RENAME

This API now supports the URI path prefix /compute-ops-mgmt which used to be /compute-ops. The /compute-ops prefix is deprecated and might become unresponsive after Tuesday, April 1, 2025. The Guide provides more information about this change.

Security

Bearer

Query

dry-runboolean

If true, do not create the saved filter - instead, perform validation of the filter name and syntax as if creating the filter.

Default false

Headers

Content-Typestringrequired

Content-Type header must designate 'application/json' in order for the request to be performed.

Value "application/json"

Idempotency-Keystring(uuid)

A unique value generated by the client which the server uses to recognize subsequent retries of the same request.

Example: 2c578105-adeb-4785-9113-8c577a0681fa

Tenant-Acidstring(uuid)

Tenant-Acid header can be used by an MSP workspace to make API calls on behalf of their tenant by specifying the tenant's application customer ID.

In order to make such an API call, the Bearer token must belong to an MSP workspace and this header value must be the application customer ID of a tenant within the MSP workspace. Use the /compute-ops-mgmt/v1beta1/accounts API to determine the application customer IDs for your tenant accounts.

Bodyapplication/jsonrequired

One of:

A saved filter on other resources.

namestring[ 1 .. 100 ] charactersrequired

The display name of the filter, must be unique.

filterstring or null<= 2000 charactersrequired

The filter expression, in the same syntax as the filter query parameter common to many collection endpoints. At least one of filter and filterTags must be specified. If both are specified, both filter expressions much match for a resource to match the filter.

descriptionstring or null<= 10000 characters

An optional longer description of the filter.

filterResourceTypestring

The type of the resource that the filter matches against. New resource types may be added as a backward compatible change to the API.

Default "compute-ops-mgmt/server"

Value"compute-ops-mgmt/server"

enabledForRRPboolean

Flags the filter for use with resource restriction policies used by scope-based access control (SBAC). Only administrators with full access to all scopes can create, edit, or delete RRP-enabled filters. The use of some resource properties may be disallowed in RRP-enabled filters.

Default false

filterTagsstring or null<= 2000 characters

An optional filter expression for tags, in the same syntax as the filter-tags query parameter common to many collection endpoints. Used to handle tag keys with special characters. At least one of filter and filterTags must be specified. If both are specified, both filter expressions much match for a resource to match the filter.

curl -i -X POST \
  https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/compute-ops-mgmt/v1beta1/filters \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "filterTags": "'\''OS'\'' eq '\''Linux'\''"
  }'

Responses

Created

Headers

Locationstring(uri-reference)

The URI of the newly-created resource

Example: "/compute-ops-mgmt/v1beta1/filters/b870f080-6448-48c5-b23a-d04f2d489174"

Bodyapplication/json

idstring(uuid)read-only

Primary identifier for the filter resource given by the system.

Example: "b870f080-6448-48c5-b23a-d04f2d489174"

typestringread-only

The type of the resource.

Value "compute-ops-mgmt/filter"

generationinteger>= 1read-only

Monotonically increasing update counter.

Example: 1

createdAtstring(date-time)read-only

Time of filter resource creation.

Example: "2022-02-11T01:04:20.799937+00:00"

updatedAtstring(date-time)read-only

Time of the last update to the filter resource.

Example: "2022-02-11T01:04:20.799937+00:00"

resourceUristring(uri-reference)read-only

URI to the filter resource itself (i.e. a self link).

Example: "/compute-ops-mgmt/v1beta1/filters/b870f080-6448-48c5-b23a-d04f2d489174"

namestring[ 1 .. 100 ] characters

The display name of the filter, must be unique.

descriptionstring or null<= 10000 characters

An optional longer description of the filter.

readOnlybooleanread-only

If true, the filter is pre-defined and cannot be edited or deleted.

Default false

filterResourceTypestring

The type of the resource that the filter matches against. New resource types may be added as a backward compatible change to the API.

Default "compute-ops-mgmt/server"

Value"compute-ops-mgmt/server"

enabledForRRPboolean

Flags the filter for use with resource restriction policies used by scope-based access control (SBAC). Only administrators with full access to all scopes can create, edit, or delete RRP-enabled filters. The use of some resource properties may be disallowed in RRP-enabled filters.

Default false

filterstring or null<= 2000 characters

The filter expression, in the same syntax as the filter query parameter common to many collection endpoints. At least one of filter and filterTags must be specified. If both are specified, both filter expressions much match for a resource to match the filter.

filterTagsstring or null<= 2000 characters

An optional filter expression for tags, in the same syntax as the filter-tags query parameter common to many collection endpoints. Used to handle tag keys with special characters. At least one of filter and filterTags must be specified. If both are specified, both filter expressions much match for a resource to match the filter.

uiDataobject or nullread-only

Opaque JSON structure used by the Compute Ops Management UI. Other clients should not read or set this property. Note that the format of the data is subject to change without notice, even with the same API version of filters.

Default null

matchesUristring(uri-reference)read-only

URI of collection of match entities that indicate which resources match the filter.

Example: "/compute-ops-mgmt/v1beta1/filters/b870f080-6448-48c5-b23a-d04f2d489174/matches"

Response

application/json

{
  "id": "b870f080-6448-48c5-b23a-d04f2d489174",
  "type": "compute-ops-mgmt/filter",
  "generation": 1,
  "createdAt": "2022-02-11T01:04:20.799937+00:00",
  "updatedAt": "2022-02-11T01:04:20.799937+00:00",
  "resourceUri": "/compute-ops-mgmt/v1beta1/filters/b870f080-6448-48c5-b23a-d04f2d489174",
  "name": "string",
  "description": "string",
  "readOnly": false,
  "filterResourceType": "compute-ops-mgmt/server",
  "enabledForRRP": false,
  "filter": "group/id eq '031adad0-f77c-403d-84f5-e0bb46e0d927'",
  "filterTags": "'OS' eq 'Linux'",
  "uiData": null,
  "matchesUri": "/compute-ops-mgmt/v1beta1/filters/b870f080-6448-48c5-b23a-d04f2d489174/matches"
}

Get filterable properties

Request

Retrieve information about resource properties usable in saved filters.

URI PATH PREFIX RENAME

This API now supports the URI path prefix /compute-ops-mgmt which used to be /compute-ops. The /compute-ops prefix is deprecated and might become unresponsive after Tuesday, April 1, 2025. The Guide provides more information about this change.

Security

Bearer

Headers

Tenant-Acidstring(uuid)

Tenant-Acid header can be used by an MSP workspace to make API calls on behalf of their tenant by specifying the tenant's application customer ID.

In order to make such an API call, the Bearer token must belong to an MSP workspace and this header value must be the application customer ID of a tenant within the MSP workspace. Use the /compute-ops-mgmt/v1beta1/accounts API to determine the application customer IDs for your tenant accounts.

curl -i -X GET \
  https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/compute-ops-mgmt/v1beta1/filters/properties \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json

idstring

Value "properties"

typestring

Value "compute-ops-mgmt/filters-properties"

filterResourceTypesobject

Information about resource properties usable in filters, for each filterResourceType value supported by saved filters.

Response

application/json

{
  "id": "properties",
  "type": "compute-ops-mgmt/filters-properties",
  "filterResourceTypes": {
    "compute-ops-mgmt/server": { … }
  }
}

Get a saved filter

Request

Retrieve a single saved filter resource by ID.

URI PATH PREFIX RENAME

This API now supports the URI path prefix /compute-ops-mgmt which used to be /compute-ops. The /compute-ops prefix is deprecated and might become unresponsive after Tuesday, April 1, 2025. The Guide provides more information about this change.

Security

Bearer

Path

idstring(uuid)required

Filter ID

Headers

Tenant-Acidstring(uuid)

Tenant-Acid header can be used by an MSP workspace to make API calls on behalf of their tenant by specifying the tenant's application customer ID.

In order to make such an API call, the Bearer token must belong to an MSP workspace and this header value must be the application customer ID of a tenant within the MSP workspace. Use the /compute-ops-mgmt/v1beta1/accounts API to determine the application customer IDs for your tenant accounts.

curl -i -X GET \
  'https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/compute-ops-mgmt/v1beta1/filters/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json

idstring(uuid)read-only

Primary identifier for the filter resource given by the system.

Example: "b870f080-6448-48c5-b23a-d04f2d489174"

typestringread-only

The type of the resource.

Value "compute-ops-mgmt/filter"

generationinteger>= 1read-only

Monotonically increasing update counter.

Example: 1

createdAtstring(date-time)read-only

Time of filter resource creation.

Example: "2022-02-11T01:04:20.799937+00:00"

updatedAtstring(date-time)read-only

Time of the last update to the filter resource.

Example: "2022-02-11T01:04:20.799937+00:00"

resourceUristring(uri-reference)read-only

URI to the filter resource itself (i.e. a self link).

Example: "/compute-ops-mgmt/v1beta1/filters/b870f080-6448-48c5-b23a-d04f2d489174"

namestring[ 1 .. 100 ] characters

The display name of the filter, must be unique.

descriptionstring or null<= 10000 characters

An optional longer description of the filter.

readOnlybooleanread-only

If true, the filter is pre-defined and cannot be edited or deleted.

Default false

filterResourceTypestring

The type of the resource that the filter matches against. New resource types may be added as a backward compatible change to the API.

Default "compute-ops-mgmt/server"

Value"compute-ops-mgmt/server"

enabledForRRPboolean

Flags the filter for use with resource restriction policies used by scope-based access control (SBAC). Only administrators with full access to all scopes can create, edit, or delete RRP-enabled filters. The use of some resource properties may be disallowed in RRP-enabled filters.

Default false

filterstring or null<= 2000 characters

The filter expression, in the same syntax as the filter query parameter common to many collection endpoints. At least one of filter and filterTags must be specified. If both are specified, both filter expressions much match for a resource to match the filter.

filterTagsstring or null<= 2000 characters

An optional filter expression for tags, in the same syntax as the filter-tags query parameter common to many collection endpoints. Used to handle tag keys with special characters. At least one of filter and filterTags must be specified. If both are specified, both filter expressions much match for a resource to match the filter.

uiDataobject or nullread-only

Opaque JSON structure used by the Compute Ops Management UI. Other clients should not read or set this property. Note that the format of the data is subject to change without notice, even with the same API version of filters.

Default null

matchesUristring(uri-reference)read-only

URI of collection of match entities that indicate which resources match the filter.

Example: "/compute-ops-mgmt/v1beta1/filters/b870f080-6448-48c5-b23a-d04f2d489174/matches"

Response

application/json

{
  "id": "b870f080-6448-48c5-b23a-d04f2d489174",
  "type": "compute-ops-mgmt/filter",
  "generation": 1,
  "createdAt": "2022-02-11T01:04:20.799937+00:00",
  "updatedAt": "2022-02-11T01:04:20.799937+00:00",
  "resourceUri": "/compute-ops-mgmt/v1beta1/filters/b870f080-6448-48c5-b23a-d04f2d489174",
  "name": "string",
  "description": "string",
  "readOnly": false,
  "filterResourceType": "compute-ops-mgmt/server",
  "enabledForRRP": false,
  "filter": "group/id eq '031adad0-f77c-403d-84f5-e0bb46e0d927'",
  "filterTags": "'OS' eq 'Linux'",
  "uiData": null,
  "matchesUri": "/compute-ops-mgmt/v1beta1/filters/b870f080-6448-48c5-b23a-d04f2d489174/matches"
}

Delete a saved filter

Request

Delete a saved filter resource.

URI PATH PREFIX RENAME

This API now supports the URI path prefix /compute-ops-mgmt which used to be /compute-ops. The /compute-ops prefix is deprecated and might become unresponsive after Tuesday, April 1, 2025. The Guide provides more information about this change.

Security

Bearer

Path

idstring(uuid)required

Filter ID

Headers

Tenant-Acidstring(uuid)

Tenant-Acid header can be used by an MSP workspace to make API calls on behalf of their tenant by specifying the tenant's application customer ID.

In order to make such an API call, the Bearer token must belong to an MSP workspace and this header value must be the application customer ID of a tenant within the MSP workspace. Use the /compute-ops-mgmt/v1beta1/accounts API to determine the application customer IDs for your tenant accounts.

curl -i -X DELETE \
  'https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/compute-ops-mgmt/v1beta1/filters/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

No Content

Response

No content

Update a saved filter

Request

Update a saved filter resource by using the RFC 7396 (JSON Merge Patch) format.

URI PATH PREFIX RENAME

This API now supports the URI path prefix /compute-ops-mgmt which used to be /compute-ops. The /compute-ops prefix is deprecated and might become unresponsive after Tuesday, April 1, 2025. The Guide provides more information about this change.

Security

Bearer

Path

idstring(uuid)required

Filter ID

Headers

Content-Typestringrequired

Content-Type header must designate 'application/merge-patch+json' in order for the request to be performed.

Value "application/merge-patch+json"

If-Matchstring

Value which must match the "generation" property of the resource in order for the request to be performed.

Example: "3"

Tenant-Acidstring(uuid)

Tenant-Acid header can be used by an MSP workspace to make API calls on behalf of their tenant by specifying the tenant's application customer ID.

In order to make such an API call, the Bearer token must belong to an MSP workspace and this header value must be the application customer ID of a tenant within the MSP workspace. Use the /compute-ops-mgmt/v1beta1/accounts API to determine the application customer IDs for your tenant accounts.

Bodyapplication/merge-patch+jsonrequired

namestring[ 1 .. 100 ] characters

The display name of the filter, must be unique.

descriptionstring or null<= 10000 characters

An optional longer description of the filter.

filterResourceTypestring

The type of the resource that the filter matches against. New resource types may be added as a backward compatible change to the API.

Default "compute-ops-mgmt/server"

Value"compute-ops-mgmt/server"

enabledForRRPboolean

Flags the filter for use with resource restriction policies used by scope-based access control (SBAC). Only administrators with full access to all scopes can create, edit, or delete RRP-enabled filters. The use of some resource properties may be disallowed in RRP-enabled filters.

Default false

filterstring or null<= 2000 characters

The filter expression, in the same syntax as the filter query parameter common to many collection endpoints. At least one of filter and filterTags must be specified. If both are specified, both filter expressions much match for a resource to match the filter.

filterTagsstring or null<= 2000 characters

An optional filter expression for tags, in the same syntax as the filter-tags query parameter common to many collection endpoints. Used to handle tag keys with special characters. At least one of filter and filterTags must be specified. If both are specified, both filter expressions much match for a resource to match the filter.

curl -i -X PATCH \
  'https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/compute-ops-mgmt/v1beta1/filters/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/merge-patch+json' \
  -d '{}'

Responses

OK

Bodyapplication/json

idstring(uuid)read-only

Primary identifier for the filter resource given by the system.

Example: "b870f080-6448-48c5-b23a-d04f2d489174"

typestringread-only

The type of the resource.

Value "compute-ops-mgmt/filter"

generationinteger>= 1read-only

Monotonically increasing update counter.

Example: 1

createdAtstring(date-time)read-only

Time of filter resource creation.

Example: "2022-02-11T01:04:20.799937+00:00"

updatedAtstring(date-time)read-only

Time of the last update to the filter resource.

Example: "2022-02-11T01:04:20.799937+00:00"

resourceUristring(uri-reference)read-only

URI to the filter resource itself (i.e. a self link).

Example: "/compute-ops-mgmt/v1beta1/filters/b870f080-6448-48c5-b23a-d04f2d489174"

namestring[ 1 .. 100 ] characters

The display name of the filter, must be unique.

descriptionstring or null<= 10000 characters

An optional longer description of the filter.

readOnlybooleanread-only

If true, the filter is pre-defined and cannot be edited or deleted.

Default false

filterResourceTypestring

The type of the resource that the filter matches against. New resource types may be added as a backward compatible change to the API.

Default "compute-ops-mgmt/server"

Value"compute-ops-mgmt/server"

enabledForRRPboolean

Flags the filter for use with resource restriction policies used by scope-based access control (SBAC). Only administrators with full access to all scopes can create, edit, or delete RRP-enabled filters. The use of some resource properties may be disallowed in RRP-enabled filters.

Default false

filterstring or null<= 2000 characters

The filter expression, in the same syntax as the filter query parameter common to many collection endpoints. At least one of filter and filterTags must be specified. If both are specified, both filter expressions much match for a resource to match the filter.

filterTagsstring or null<= 2000 characters

An optional filter expression for tags, in the same syntax as the filter-tags query parameter common to many collection endpoints. Used to handle tag keys with special characters. At least one of filter and filterTags must be specified. If both are specified, both filter expressions much match for a resource to match the filter.

uiDataobject or nullread-only

Opaque JSON structure used by the Compute Ops Management UI. Other clients should not read or set this property. Note that the format of the data is subject to change without notice, even with the same API version of filters.

Default null

matchesUristring(uri-reference)read-only

URI of collection of match entities that indicate which resources match the filter.

Example: "/compute-ops-mgmt/v1beta1/filters/b870f080-6448-48c5-b23a-d04f2d489174/matches"

Response

application/json

{
  "id": "b870f080-6448-48c5-b23a-d04f2d489174",
  "type": "compute-ops-mgmt/filter",
  "generation": 1,
  "createdAt": "2022-02-11T01:04:20.799937+00:00",
  "updatedAt": "2022-02-11T01:04:20.799937+00:00",
  "resourceUri": "/compute-ops-mgmt/v1beta1/filters/b870f080-6448-48c5-b23a-d04f2d489174",
  "name": "string",
  "description": "string",
  "readOnly": false,
  "filterResourceType": "compute-ops-mgmt/server",
  "enabledForRRP": false,
  "filter": "group/id eq '031adad0-f77c-403d-84f5-e0bb46e0d927'",
  "filterTags": "'OS' eq 'Linux'",
  "uiData": null,
  "matchesUri": "/compute-ops-mgmt/v1beta1/filters/b870f080-6448-48c5-b23a-d04f2d489174/matches"
}

List resources matching a filter

Request

Retrieve a paginated collection of match entries that indicate which resources match a saved filter.

URI PATH PREFIX RENAME

This API now supports the URI path prefix /compute-ops-mgmt which used to be /compute-ops. The /compute-ops prefix is deprecated and might become unresponsive after Tuesday, April 1, 2025. The Guide provides more information about this change.

Security

Bearer

Path

idstring(uuid)required

Filter ID

Query

offsetinteger>= 0

Zero-based resource offset to start the response from

Default 0

Example: offset=10

limitinteger[ 0 .. 10000 ]

The maximum number of records to return.

Default 50

Example: limit=10

sortstring

The order in which to return the resources in the collection.

The value of the sort query parameter is a comma separated list of sort expressions. Each sort expression is a property name optionally followed by a direction indicator asc (ascending) or desc (descending).

The first sort expression in the list defines the primary sort order, the second defines the secondary sort order, and so on. If a direciton indicator is omitted the default direction is ascending.

Default "id asc"

Examples:

ascending by name

Order resources ascending by name

sort=name asc

ascending by name and then by descending by createdAt

Order resources ascending by name and then by descending by createdAt

sort=name,createdAt desc

Headers

Tenant-Acidstring(uuid)

Tenant-Acid header can be used by an MSP workspace to make API calls on behalf of their tenant by specifying the tenant's application customer ID.

In order to make such an API call, the Bearer token must belong to an MSP workspace and this header value must be the application customer ID of a tenant within the MSP workspace. Use the /compute-ops-mgmt/v1beta1/accounts API to determine the application customer IDs for your tenant accounts.

curl -i -X GET \
  'https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/compute-ops-mgmt/v1beta1/filters/{id}/matches' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json

countinteger>= 0required

Number of items returned

Example: 1

offsetinteger>= 0required

Zero-based resource offset

totalinteger>= 0required

Total number of items in the collection that match the filter query, if one was provided in the request

Example: 12

itemsArray of objectsrequired

Array of resources in the page of the collection.

items[].idstring

The id of the resource that matches the filter.

Example: "875765-S01+1M512501AB"

items[].typestring

The type of the resource that matches the filter. New resource types may be added as a backward compatible change to the API.

Value"compute-ops-mgmt/server"

Response

application/json

{
  "offset": 0,
  "count": 1,
  "total": 12,
  "items": [
    { … }
  ]
}

firmware-bundles - v1

Operations

firmware-bundles - v1beta2

Operations

groups - v1

Operations

groups - v1beta3

Operations

groups - v1beta2

Operations

job-templates - v1beta2

Operations

jobs - v1

Operations

jobs - v1beta3

Operations

jobs - v1beta2

Operations

metrics-configurations - v1

Operations

oneview-appliances - v1beta1

Operations

oneview-settings - v1beta1

Operations

oneview-server-templates - v1beta1

Operations

reports - v1beta2

Operations

schedules - v1beta2

Operations

server-locations - v1beta1

Operations

server-settings - v1beta1

Operations

settings - v1

Operations

settings - v1beta1

Operations

servers - v1

Operations

servers - v1beta2

Operations

server-warranty - v1beta2

Operations

user-preferences - v1

Operations

user-preferences - v1beta1

Operations

utilization-over-time - v1beta1

Operations

utilization-by-entity - v1beta1

Operations

webhooks - v1beta1

Operations

HPE Compute Ops Management API (latest)

UPDATED API ENDPOINTS

accounts - v1beta1

activation-keys - v1beta1

activation-tokens - v1beta1

activities - v1beta2

ahs-files - v1beta1

appliance-firmware-bundles - v1

appliance-firmware-bundles - v1beta1

async-operations - v1

async-operations - v1beta1

energy-over-time - v1beta1

energy-by-entity - v1beta1

external-services - v1beta1

filters - v1beta1

List all saved filters

Request

URI PATH PREFIX RENAME

Responses

Was this helpful?

Save a filter

Request

URI PATH PREFIX RENAME

Responses

Was this helpful?

Get filterable properties

Request

URI PATH PREFIX RENAME

Responses

Was this helpful?

Get a saved filter

Request

URI PATH PREFIX RENAME

Responses

Was this helpful?

Delete a saved filter

Request

URI PATH PREFIX RENAME

Responses

Was this helpful?

Update a saved filter

Request

URI PATH PREFIX RENAME

Responses

Was this helpful?

List resources matching a filter

Request

URI PATH PREFIX RENAME

Responses

Was this helpful?

firmware-bundles - v1

firmware-bundles - v1beta2

groups - v1

groups - v1beta3

groups - v1beta2

job-templates - v1beta2

jobs - v1

jobs - v1beta3

jobs - v1beta2

metrics-configurations - v1

oneview-appliances - v1beta1

oneview-settings - v1beta1

oneview-server-templates - v1beta1

reports - v1beta2

schedules - v1beta2

server-locations - v1beta1

server-settings - v1beta1

settings - v1

settings - v1beta1

servers - v1

servers - v1beta2

server-warranty - v1beta2

user-preferences - v1

user-preferences - v1beta1

utilization-over-time - v1beta1

utilization-by-entity - v1beta1

webhooks - v1beta1