Skip to navigation

Validate an inventory document

Runs structural and semantic validation against a candidate inventory, node, action, or tag document. Does not create or change anything. Use it to confirm that a generated document is valid before you submit it for creation.

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Request

request body
documentTypeenumOptional
The type of document to validate
Allowed values:
documentobjectOptional

The complete candidate document to validate (not a partial update patch)

Response

Validation result
statusstringOptional
resultobjectOptional
messagestringOptional

Human-readable validation summary

Errors

500
Internal Server Error