Extensions

Schema extensions are the expressions that can be found in the Veeam Service Provider Console RESTful API specification and that provide additional information on how extended operations function. The following table lists the current set of extensions.

Extension

Example Value

Description

x-veeam-vspc-patch-for

"$ref": "#/definitions/UserLogin"

Is specified for PATCH operations.

Refers to a resource that can be modified by the PATCH method.

x-veeam-vspc-get-for

"$ref": "#/definitions/User"

Is specified for GET operations that require to provide UID.

Refers to a resource collection that contains a resource with the specified UID.

x-ms-enum

"name": "AlarmCategoryType"

Allows to change enum name during code generation.

x-veeam-expandable

"true"

Indicates that the extended operation can return additional properties.

x-veeam-allow-anonymous

"true"

Indicates that the extended operation does not require authorization.

x-veeam-nullable

"true"

Indicates that properties in the extended schema can have null values.

x-veeam-vspc-deny-async-action-registration

"true"

Indicates that asynchronous processing cannot be enabled for the extended operation

For details, see Asynchronous Processing.

x-veeam-pagination

"true"

Indicates that pagination is enabled for the extended operation.

For details on pagination, see Pagination.

x-veeam-pagination-limit

"true"

Indicates that the $limit query parameter is enabled for the extended operation.

For details, see Limit System Query Option ($limit).

x-veeam-pagination-offset

"true"

Indicates that the $offset query parameter is enabled for the extended operation.

For details, see Offset System Query Option ($offset).

x-veeam-vspc-admitted-roles

"PortalAdministrator", "CompanyOwner", "ResellerOwner", "ResellerAdministrator", "CompanyAdministrator"

Array of user roles to whom the extended operation is available.

x-extensible-enum

"true"

Indicates that new values might appear in the extended enum. If client version of Veeam Service Provider Console RESTful API does not support new values, these values are displayed as Unknown.

x-veeam-fire-and-forget

"true"

Indicates that the extended operation returns a positive response if a request is received. Execution of requested operation cannot be guaranteed.

I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.