Common Properties

In this article

    Use this section to list the properties of a resource collection. For each property, specify its type and provide a short description.

    Common Properties Note

    For reference topics in Veeam technical documentation, we use slightly different rules from those defined in section Articles. However, these rules apply only to articles used in descriptions of parameters and properties. Particularly, when listing the properties of a REST API resource collection, we omit an article in a property description if it is the first word in the description.

    Common PropertiesExample

    The resources in the /FailoverPlans collection have properties that represent failover plan settings. Properties can be used in POST requests as well as for query parameter values in GET requests.

    Property

    Type

    Description

    name

    string

    Name of a failover plan.

    id

    string

    System ID assigned to a failover plan in VAO RESTful API.

    contactName

    string

    Contact name of a person responsible for monitoring VAO performance.

    contactEmail

    string

    Contact email of a person responsible for monitoring VAO performance.

    contactTel

    string

    Telephone number of a person responsible for monitoring VAO performance.

    description

    string

    Description of a failover plan.