Delete Home Sites

Delete Home Sites

Required Privileges : (This server version allows only Administrators on Root access group to login. These privileges are NOT relevant currently but will be applicable in later server versions.)

All the listed privileges are required -

Privileges Description
FEDERATED_LDAP_MANAGE Global LDAP management privilege is required for deleting Home Sites.
Request
URI
DELETE
https://{api_host}//localhost/rest/federation/v1/home-sites
COPY
Request Body

List of home site IDs to be deleted.

Array of string of type(s) application/json
Optional
[
    {}
]
Authentication
This operation uses the following authentication methods.
Responses
200

OK

[
    {
        "access_group": "/",
        "error_messages": [
            "Entity does not exists.",
            "Property is mandatory."
        ],
        "id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
        "privileges": [
            "POOL_VIEW",
            "MACHINE_VIEW"
        ],
        "status_code": 200,
        "timestamp": 1561939200000
    }
]

400

Bad Request

Operation doesn't return any data structure

401

User is not authenticated

Operation doesn't return any data structure

403

Access to the resource is forbidden

Operation doesn't return any data structure

409

Conflict | CPA not initialized for the pod

Operation doesn't return any data structure