Sites Update

Sites Update

This request updates an existing peer site.

The result of this API call is a task which must be polled by using the respective APIs for task polling. If the task succeeds, then the result can be obtained from the result field. If the task fails, there is no result. The failure reason is in the error field.

Request
URI
PUT
https://{api_host}/sites/{site}
COPY
Path Parameters
string
site
Required

The site name.

site example 
site2
Header Parameters
string
operationID
Optional

Operation ID for correlating logs across multiple services

Request Body

Update site request.

UpdateSiteRequest of type(s) application/json
Required 
{
    "apiThumbprint": "SHA-256:F4:D6:17:37:FD:45:AF:D4:ED:15:BF:B3:52:2E:3D:41:48:29:71:42:B6:52:81:4B:24:97:5F:77:CF:20:4F:74",
    "apiUrl": "https://10.71.248.18:8048/",
    "description": "some description"
}
string
apiThumbprint
Optional

The fingerprint of the peer site's SSL certificate.

string
apiUrl
Optional

The URL of the peer site API endpoint.

string
description
Optional

Optional description of the peer site.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns C4ApiTask_of_PeerSiteInfo of type(s) application/vnd.vmware.h4-v4.7+json;charset=UTF-8 
{
    "endTime": 1499929558827,
    "error": {
        "args": [],
        "code": "Forbidden",
        "msg": "Permission denied.",
        "stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
    },
    "id": "f61d60d2-698a-46dc-a266-88df27644956",
    "lastUpdated": 1499929558827,
    "progress": 100,
    "result": {
        "apiPublicUrl": "https://vcdainstance.com:8048",
        "apiVersion": "4.6",
        "buildVersion": "4.5.0.5226630-ab9eb01ccb",
        "isLocal": true,
        "state": {
            "incomingCommError": {
                "args": [],
                "code": "Forbidden",
                "msg": "Permission denied.",
                "stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
            },
            "outgoingCommError": {
                "args": [],
                "code": "Forbidden",
                "msg": "Permission denied.",
                "stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
            }
        }
    },
    "resultType": "string",
    "site": "site2",
    "startTime": 1499929548951,
    "state": "string",
    "user": "root",
    "warnings": [],
    "workflowInfo": {}
}
integer As int64 As int64
endTime
Optional

Timestamp in msec of the completion time of the task. -1 indicates that the task did not complete yet.

ApiError
error
Optional

error

string As uuid As uuid
id
Optional

The unique identifier of the long-running task. It is unique and can be used for monitoring.

integer As int64 As int64
lastUpdated
Optional

Timestamp in msec of the last task status update.

integer As int32 As int32
progress
Optional

Percentage-based progress of the task.

PeerSiteInfo
result
Optional

result

string
resultType
Optional

Indicates the type of the task result. Populates only when the execution succeeds.

string
site
Optional

Site on which the task runs.

integer As int64 As int64
startTime
Optional

Timestamp in msec of the creation time of the task.

Task_State
state
Optional

state

string
user
Optional

The user who started the task.

array of ResultWarning
warnings
Optional

Warnings, which occurred during the task execution.

ApiWorkflowInfo
workflowInfo
Optional

workflowInfo


401

The returned error codes include (but are not limited to): NotAuthenticated

Returns ApiError of type(s) application/vnd.vmware.h4-v4.7+json;charset=UTF-8 
{
    "args": [],
    "code": "Forbidden",
    "msg": "Permission denied.",
    "stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
}
array of string
args
Optional

Positional arguments.

string
code
Optional

Specific error code.

string
msg
Optional

Detailed error message.

string
stacktrace
Optional

Exception stacktrace.


500

The returned error codes include (but are not limited to): GeneralServerFailure

Returns ApiError of type(s) application/vnd.vmware.h4-v4.7+json;charset=UTF-8 
{
    "args": [],
    "code": "Forbidden",
    "msg": "Permission denied.",
    "stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
}
array of string
args
Optional

Positional arguments.

string
code
Optional

Specific error code.

string
msg
Optional

Detailed error message.

string
stacktrace
Optional

Exception stacktrace.


On This Page
Sites Operations
POST
Sites Add
GET
Sites Capabilities
DELETE
Sites Delete
GET
Sites Get
GET
Sites List
PUT
Sites Update