Extend

Extend

To perform replication management operations for remote sites, provide the session with credentials (VMware Cloud Director auth cookie or access token or org user and password) for the specified remote site. The supported authentication methods are the following:

  • with VMware Cloud Director credentials: 
    {
    "type": "credentials",
    "site": "site1",
    "vcdUsername": "admin1@org2",
    "vcdPassword": "password"
}


  • with VMware Cloud Director auth cookie:

    {
    "type": "cookie",
    "site": "site1",
    "cookie": "f12977876fef48a6b032ffdb2cdf22d7"
}


  • with VMware Cloud Director access token (jwt):

    {
    "type": "vcdAccessToken",
    "site": "site1",
    "vcdAccessToken": "eyJhbGciOiJSUzI1NiJ9...."
}


  • with VMware Cloud Director Multisite:

    {
    "type": "multisite",
    "site": "site1",
    "org": "acme-dr"
}
Request
URI
POST
https://{api_host}/sessions/extend
COPY
Header Parameters
string
operationID
Optional

Operation ID for correlating logs across multiple services

Request Body 
{
    "type": "credentials",
    "site": "site1",
    "vcdUsername": "admin1@org2",
    "vcdPassword": "password"
}
Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns C4SessionDetails of type(s) application/json;charset=UTF-8
This response body class contains all of the following: SessionDetails 
{
    "roles": [
        "EVERYONE"
    ],
    "user": "admin1@Org1",
    "authenticatedSites": [
        {
            "org": "Org1",
            "site": "site1"
        }
    ]
}
array of AuthenticatedSiteDetails
authenticatedSites
Optional

VMware Cloud Director sites the current session has authenticated with. The site specified in the request should be present here


400

The returned error codes include (but are not limited to): BadRequest, BadUserInput

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.


401

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

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.


404

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

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
Session Operations
POST
Extend
GET
Get Session
POST
Login
DELETE
Logout
DELETE
Shrink