REST API - get

vcenter settings namespaces: get

Retrieves the details of the namespace. System.Read privilege is required. Usage beyond VMware Cloud on AWS is not supported. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Request:

HTTP request

GET https://{server}/rest/vcenter/settings/namespaces/{namespace}

Path Parameters

Name Type Description
Required
namespace string identifier of the namespace.

Response:

HTTP Status Code: 200

Representation:

{
    "value"{
        "write_privilege""string",
        "is_syncable"true,
        "name""string",
        "description""string",
        "read_privilege""string"
    }
}

Response Type:

Name Type Description
bold = required
value info specific Info a namespace.
value.name string The name given to the namespace. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

value.description string A description of this namespace. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

value.read_privilege string The privilege that is required for reading into this namespace. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

value.write_privilege string The privilege that is required for writing into this namespace. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

value.is_syncable boolean The flag for enable sync. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Errors:

HTTP Status Code Type Description
403 unauthorized if the user is unauthorized to perform this operation.
500 error if the system reports an error while responding to the request.