Data types

Many of the data types that describe HCP management API resources and properties are named, unordered sets of properties. When you create a resource, some properties for the applicable data type are required and some are optional. You need to specify a value for each required property. If you omit an optional property, HCP supplies a default value for it.

When you modify a resource, all properties for the applicable data type are optional. If you omit a property, the current value of the property remains unchanged.

When you create or modify a resource, HCP returns an error if the request body includes:

Properties that are not valid for the resource

Properties that are not valid for the request type

Properties whose values cannot be set with the user account used for the request

Note: If a tenant has granted system-level users administrative access to itself, actions that can be performed with a tenant-level user account can also be performed with a system-level user account that includes the applicable roles.

Some resources also have required or optional query parameters. For information about specifying query parameters, see Query parameters.

© 2015, 2020 Hitachi Vantara LLC. All rights reserved.