Vcenter NamespaceManagement SupervisorServices checkContent
Perform validation checks on the content of a Supervisor Service version defined in the spec. The operation returns the validation status and relevant Supervisor Service version information that are available in the content. A custom format will always return a VALID status. Only vSphere and Carvel packages can return multiple validation statuses.
This operation was added in vSphere API 7.0.3.0.
Returns an authorization error if you do not have all of the privileges described as follows:
- Operation execution requires
System.Read.
Request body for invoking operation: checkContent
Show optional properties
{
"spec": {}
}{
"spec": {
"content": "string"
}
}The Vcenter NamespaceManagement SupervisorServices ContentCheckSpec schema provides a specification required for validation checks on the content of a Supervisor Service version.
This schema was added in vSphere API 7.0.3.0.
A check result containing validation status and relevant Supervisor Service version information from the provided content, if the content is valid. In case of invalid content, it will return a list of error messages.
"Vcenter NamespaceManagement SupervisorServices CheckResult Object"Indicates if the provided content is valid.
For more information see: Vcenter NamespaceManagement SupervisorServices ValidationStatus.
This property was added in vSphere API 7.0.3.0.
The type of the provided content. When this content_type is Vcenter NamespaceManagement SupervisorServices Versions ContentType.CUSTOM_YAML, the status is always VALID because a custom format is not validated.
For more information see: Vcenter NamespaceManagement SupervisorServices Versions ContentType.
This property was added in vSphere API 7.0.3.0.
If missing or null, the content type cannot be determined from the provided content.
The information about the Supervisor Service version retrieved from the provided content as a result of validation checks if the content is in the vSphere application format.
This property was added in vSphere API 7.0.3.0.
If missing or null, the content is not in the vSphere application service format, or the status is INVALID.
The information about the Supervisor Service version retrieved from the provided content as a result of validation checks if the content is in the Carvel application format.
This property was added in vSphere API 8.0.0.1.
If missing or null, the content is not in the Carvel application package format, or the status is INVALID.
A list of messages indicating why the content was considered valid but contains information that should be reviewed closely.
This property was added in vSphere API 7.0.3.0.
This property is optional and it is only relevant when the value of status is Vcenter NamespaceManagement SupervisorServices ValidationStatus.VALID_WITH_WARNINGS.
A list of messages indicating why the content was considered invalid.
This property was added in vSphere API 7.0.3.0.
This property is optional and it is only relevant when the value of status is Vcenter NamespaceManagement SupervisorServices ValidationStatus.INVALID.
if the provided spec is invalid. For example, the provided Vcenter NamespaceManagement SupervisorServices ContentCheckSpec.content is empty or not base64 encoded.
"Vapi Std Errors InvalidArgument Object"if the user cannot be authenticated.
"Vapi Std Errors Unauthenticated Object"Indicates the authentication challenges applicable to the target API provider. It can be used by a client to discover the correct authentication scheme to use. The exact syntax of the value is defined by the specific provider, the protocol and authentication schemes used.
For example, a provider using REST may adhere to the WWW-Authenticate HTTP header specification, RFC7235, section 4.1. In this case an example challenge value may be: SIGN realm="27da1358-2ba4-11e9-b210-d663bd873d93",sts="http://vcenter/sso?vsphere.local", Basic realm="vCenter"
This property was added in vSphere API 7.0.0.0.
This property is optional because it was added in a newer version than its parent node.
if the user does not have the System.Read privilege.
"Vapi Std Errors Unauthorized Object"if the system reports an error while responding to the request.
"Vapi Std Errors Error Object"Stack of one or more localizable messages for human error consumers.
The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.
Each subsequent message in the stack describes the "cause" of the prior message.
Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully.
Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.
The Vapi Std Errors ArgumentLocations, Vapi Std Errors FileLocations, and Vapi Std Errors TransientIndication schemas are intended as possible values for this property. Vapi Std DynamicID may also be useful as a value for this property (although that is not its primary purpose). Some resources may provide their own specific schemas for use as the value of this property when reporting errors from their operations.
Some operations will not set this property when reporting errors.
Discriminator field to help API consumers identify the structure type.
For more information see: Vapi Std Errors Error Type.
This property was added in vSphere API 6.7.2.
Can be missing or null for compatibility with preceding implementations.
curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"spec:"object"}' https://{api_host}/api/vcenter/namespace-management/supervisor-services?action=checkContent