Policies

Policies

This request returns all replication policies.

Request
URI
GET
https://{api_host}/policies
COPY
Query Parameters
string
site
Optional

The local or remote site of the policy(ies). When omitted, the local site is assumed.

site example
site1
Header Parameters
string
operationID
Optional

Operation ID for correlating logs across multiple services


Authentication
This operation uses the following authentication methods.
Responses
200

OK

[
    {
        "allowAdvancedRetentionRules": true,
        "allowCustomSlaSettings": true,
        "allowIncomingMigrations": true,
        "allowIncomingProtections": true,
        "allowNotificationConfiguration": true,
        "allowOutgoingMigrations": true,
        "allowOutgoingOnpremMigrations": true,
        "allowOutgoingOnpremProtections": true,
        "allowOutgoingProtections": true,
        "displayName": "Default Policy",
        "id": "1c82d607-5db5-46e5-a6f0-1823cc21e2f0",
        "maxIncoming": 0,
        "maxInstances": 24,
        "maxPinnedInstances": 24,
        "minRpo": 15,
        "orgs": 2
    }
]

401

The returned error codes include (but are not limited to): NotAuthenticated

Returns ApiError of type(s) application/vnd.vmware.h4-v4.7+json;charset=UTF-8
{
    "args": [],
    "code": "Forbidden",
    "msg": "Permission denied.",
    "stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
}
array of string
args
Optional

Positional arguments.

string
code
Optional

Specific error code.

string
msg
Optional

Detailed error message.

string
stacktrace
Optional

Exception stacktrace.


500

The returned error codes include (but are not limited to): GeneralServerFailure

Returns ApiError of type(s) application/vnd.vmware.h4-v4.7+json;charset=UTF-8
{
    "args": [],
    "code": "Forbidden",
    "msg": "Permission denied.",
    "stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
}
array of string
args
Optional

Positional arguments.

string
code
Optional

Specific error code.

string
msg
Optional

Detailed error message.

string
stacktrace
Optional

Exception stacktrace.