Skip to main content

List protection policies in NetApp Console local deployment

GET /v1/organizations/{organizationId}/protectionpolicies

Retrieves the list of protection policies for the specified organization.

Parameters

Name Type In Required Description

organizationId

string

path

True

Organization ID

filter

string

query

False

Specifies which fields should be matched when listing resources.

Supported comparison operators:

  • eq - Equality

  • ne - Not equal

  • lt - Less than

  • le - Less than or equal to

  • gt - Greater than

  • ge - Greater than or equal to

  • re - Regular expression match

  • ex - Existence check (field exists)

  • in - Membership test (value in list)

Logical operators:

  • and - Logical AND

  • or - Logical OR

  • not - Logical NOT

Property names support:

  • Dot notation for nested fields: metadata.name

  • Array indexing: items[0].name or items[*].name or items.name

Value types:

  • Strings: wrapped in single quotes ('value') or double quotes ("value")

  • Numbers: integers (42) or floats (3.14)

  • Booleans: true or false

  • Null: null

Grouping:

  • Use parentheses to group expressions and control precedence

  • Example: (a eq 'x' or b eq 'y') and c eq 'z'

IN operator syntax:

  • Use parentheses with comma-separated quoted values

  • Example: resourceType in ('AWS','AZURE','GCP')

Examples:

  • Simple: resourceType eq 'cluster'

  • With negation: not (tags.internal:bxp:workingEnvironmentId ex)

  • Multiple conditions: resourceType eq 'cluster' and state ne 'INACTIVE'

  • With grouping: (resourceType eq 'organization' or state ne 'INACTIVE') and tier gt '1'

  • With IN operator: resourceType in ('AWS','AZURE','GCP') and state eq 'active'

URL-encoded example: "filter=field1%20eq%20'value1'%20or%20field2%20ne%20'value2'"

limit

string

query

False

Specifies the maximum number of resources to return when listing a collection.

URL examples: "limit=2"

OpenAPI examples: "2"

skip

string

query

False

Specifies the number of resources to skip when listing a collection.

URL examples: "skip=1"

OpenAPI examples: "1"

orderBy

string

query

False

Specifies the field and direction for sorting resources when listing a collection.

Format: field [asc/desc]

Direction keywords (case-insensitive):

  • asc - Ascending order (default if omitted)

  • desc - Descending order

Examples:

  • Field only: orderBy=name (defaults to ascending)

  • Ascending: orderBy=name asc

  • Descending: orderBy=name desc

Response

Status: 200, Successfully retrieved protection policies list.
Name Type Required Description

count

integer

True

Total number of resources in the collection that match the query.

items

array[protection_policy_1.0_get_response_body]

True

List of protection policies.
Example response 
{
  "count": 2,
  "items": [
    {
      "description": "Daily snapshot policy with 7 day retention",
      "id": "4fa85f64-5717-4562-b3fc-2c963f66afa7",
      "metadata": {
        "createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32",
        "creationTimestamp": "2022-10-06T20:58:16.305662Z",
        "labels": [],
        "modificationTimestamp": "2022-10-06T20:58:16.305662Z",
        "modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32"
      },
      "name": "Daily Backup Policy",
      "organizationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "policyType": "USER_DEFINED",
      "snapshotSchedules": [
        {
          "retentionCount": 7,
          "schedule": "DAILY"
        },
        {
          "retentionCount": 4,
          "schedule": "WEEKLY"
        }
      ],
      "tags": [
        {
          "internal:bxp:metric:associatedWorkloadCnt": "5"
        }
      ],
      "type": "application/vnd.netapp.bxp.protectionpolicy",
      "version": "1.0"
    },
    {
      "description": "Hourly snapshot policy for critical data",
      "id": "5fb96g75-6828-5673-c4gd-3d074g77bgb8",
      "metadata": {
        "createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32",
        "creationTimestamp": "2022-11-01T15:30:00.000Z",
        "labels": [],
        "modificationTimestamp": "2022-11-01T15:30:00.000Z",
        "modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32"
      },
      "name": "Hourly Snapshots",
      "organizationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "policyType": "USER_DEFINED",
      "snapshotSchedules": [
        {
          "retentionCount": 24,
          "schedule": "HOURLY"
        }
      ],
      "tags": [
        {
          "internal:bxp:metric:associatedWorkloadCnt": "3"
        }
      ],
      "type": "application/vnd.netapp.bxp.protectionpolicy",
      "version": "1.0"
    }
  ]
}

Error

Status: 400, Bad request
Name Type Required Description

correlationId

string

False

Internal UUID representing the request or trace ID related.

detail

string

False

Details about the problem.

invalidParams

array[invalidParams]

False

List of invalid parameters.

status

string

True

HTTP error code related to the problem.

title

string

True

Title description of the problem.

type

string

True

Content-type of the object.
Example error response 
{
  "detail": "The supplied query parameters are invalid.",
  "status": "400",
  "title": "Invalid query parameters",
  "type": "https://bluexp.netapp.io/problems/1"
}

Error

Status: 401, Unauthorized
Name Type Required Description

correlationId

string

False

Internal UUID representing the request or trace ID related.

detail

string

False

Details about the problem.

invalidParams

array[invalidParams]

False

List of invalid parameters.

status

string

True

HTTP error code related to the problem.

title

string

True

Title description of the problem.

type

string

True

Content-type of the object.
Example error response 
{
  "detail": "The request is missing the required bearer token.",
  "status": "401",
  "title": "Missing bearer token",
  "type": "https://bluexp.netapp.io/problems/1"
}

Error

Status: 403, Forbidden
Name Type Required Description

correlationId

string

False

Internal UUID representing the request or trace ID related.

detail

string

False

Details about the problem.

invalidParams

array[invalidParams]

False

List of invalid parameters.

status

string

True

HTTP error code related to the problem.

title

string

True

Title description of the problem.

type

string

True

Content-type of the object.
Example error response 
{
  "detail": "The requested operation isn't permitted.",
  "status": "403",
  "title": "Operation not permitted",
  "type": "https://bluexp.netapp.io/problems/11"
}

Error

Status: 404, Not found
Name Type Required Description

correlationId

string

False

Internal UUID representing the request or trace ID related.

detail

string

False

Details about the problem.

invalidParams

array[invalidParams]

False

List of invalid parameters.

status

string

True

HTTP error code related to the problem.

title

string

True

Title description of the problem.

type

string

True

Content-type of the object.
Example error response 
{
  "detail": "The collection specified in the request URI wasn't found.",
  "status": "404",
  "title": "Collection not found",
  "type": "https://bluexp.netapp.io/problems/2"
}

Definitions

See Definitions

type_bxp_label

Name/value pair.

Name Type Required Description

name

string

True

Name of the label.

value

string

True

Value of the label.

type_bxp_metadata

Metadata associated with the resource.

Name Type Required Description

createdBy

string

False

UUID of the user who created the resource.

creationTimestamp

string

False

Resource creation date.

labels

array[type_bxp_label]

False

Array of name/value pairs representing additional information for the resource.

modificationTimestamp

string

False

Resource modification date.

modifiedBy

string

False

UUID of the user who modified the resource.

snapshotSchedules

Name Type Required Description

retentionCount

integer

False

Number of snapshots to retain.

schedule

string

False

Type of schedule for snapshots.

tags Hash mapping strings to string

protection_policy_1.0_get_response_body

Name Type Required Description

description

string

False

Description of the protection policy.

id

string

True

Unique identifier of the protection policy.

metadata

type_bxp_metadata

False

Metadata associated with the resource.

name

string

True

Name of the protection policy.

organizationId

string

False

Organization ID that the policy is associated with.

policyType

string

False

Type of the protection policy.

snapshotSchedules

array[snapshotSchedules]

False

An array of snapshot schedules defined in the protection policy.

tags

array[tags]

False

JSON array of tags (name/value pairs) associated with the protection policy. Can be used to add any additional data related to the protection policy.

type

string

False

Media type of the resource. Defined values are:

  • "application/vnd.netapp.bxp.protectionpolicy"

version

string

False

Version of the resource schema. Defined values are:

  • "1.0"

invalidParams

Name Type Required Description

name

string

True

Name of the invalid parameter.

reason

string

True

Reason why the parameter is invalid.