REST API - remediate

vcenter hvc links sync: remediate

Remediates the sync state between the linked domains by initiating a fresh sync for certificate providers. If an existing sync is in progress this cancels the sync. Usage beyond VMware Cloud on AWS is not supported. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Request:

HTTP request

POST https://{server}/rest/hvc/links/{link}/sync?action=remediate

Path Parameters

Name	Type	Description
Required
link	string	Unique identifier of the link.

Request Body Structure:

{
    "credentials" : {
        "password" : "secret string",
        "user_name" : "string"
    }
}

Request Body Parameters:

Name	Type	Description
bold = required
credentials	credentials	Optional. Credentials to use for authentication to the remote system.
credentials.user_name	string	Name of the user to authenticate. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
credentials.password	secret	Password for the user. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Response:

HTTP Status Code: 200

Representation:

{
    "value" : {
        "status_message" : {
            "args" : [
                "string",
                "string"
            ],
            "default_message" : "string",
            "localized" : "string",
            "id" : "string",
            "params" : [
                {
                    "value" : {
                        "dt" : "2015-01-01T22:13:05.651Z",
                        "s" : "string",
                        "d" : 1.5,
                        "precision" : 1,
                        "format" : "SHORT_DATE",
                        "i" : 1,
                        "l" : {
                            "id" : "string",
                            "params" : [
                                {
                                    "value" : {
                                        "dt" : "2015-01-01T22:13:05.651Z",
                                        "s" : "string",
                                        "d" : 1.5,
                                        "precision" : 1,
                                        "format" : "SHORT_DATE",
                                        "i" : 1,
                                        "l" : {
                                            "id" : "string",
                                            "params" : [
                                                {
                                                    "key" : "string"
                                                }
                                            ]
                                        }
                                    },
                                    "key" : "string"
                                }
                            ]
                        }
                    },
                    "key" : "string"
                }
            ]
        }
    }
}

Response Type:

Name	Type	Description
bold = required
value	remediation_status
value.status_message	localizable_message	Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Optional.
value.status_message.id	string	Unique identifier of the localizable string or message template. This identifier is typically used to retrieve a locale-specific string or message template from a message catalog.
value.status_message.default_message	string	The value of this localizable string or message template in the `en_US` (English) locale. If vapi.std.localizable_message.id refers to a message template, the default message will contain the substituted arguments. This value can be used by clients that do not need to display strings and messages in the native language of the user. It could also be used as a fallback if a client is unable to access the appropriate message catalog.
value.status_message.args	string[]	Positional arguments to be substituted into the message template. This list will be empty if the message uses named arguments or has no arguments.
value.status_message.params	list	Named arguments to be substituted into the message template. This attribute was added in vSphere API 7.0.0.0. Optional. Unset means that the message template requires no arguments or positional arguments are used.
value.status_message.localized	string	Localized string value as per request requirements. This attribute was added in vSphere API 7.0.0.0. Optional. when the client has not requested specific locale the implementation may not populate this field to conserve resources.

Errors:

HTTP Status Code	Type	Description
500	error	if the system reports an error while responding to the request.
404	not_found	if the link Identifier associated with `link` does not exist.
403	unauthorized	if the user is not authorized to perform this operation.
500	resource_busy	if a sync is already running.
500	timed_out	if the remediate action times out.