Check Extension Key

Check Extension Key

Check whether the given extension key is already registered in SSO, lookup service, and as VC extension.

Request
URI
POST
https://{api_host}/appliance/configuration-manager/actions/check-extension-key-registration
COPY
Query Parameters
string
filter_property
Optional

The name of the field by which to filter the result data. Must be used in combination with filter parameter. Supports for nested fields. Example: https://dr-server/api/vms?filter_property=name&filter=vm-1

string of array
filter
Optional

The filter value by which to filter the result data. Must be used in combination with filter_prop parameter. Supports for nested fields. Example: https://dr-server/api/vms?filter_property=name&filter=vm-1&filter=vm-2

string
sort_by
Optional

Define desired sort by field of the result data. If order_by is not specified, ascending is used as default.

sort_by example 
name
string
order_by
Optional

Define desired sort order by field of the result data. Must be used in combination with sort_by. Supported values: asc, ascending, desc, descending.

string
limit
Optional

Specify the limit size of the result data. In combination with offset parameter provides paging functionality. If none - configuration property 'defaultResponsePageSize' in REST API configuration file is taken into account. If configuration property is not defined - default value of 100 is taken into account.

limit example 
10
string
offset
Optional

The amount of elements to skip in the response. In combination with limit parameter provides paging functionality. Must be used in combination with limit parameter. If none - default value of 0 is taken into account. Example: https://dr-server/api/vms?limit=10&offset=10

offset example 
10
Request Body

Check whether the extension key is already registered in SSO, lookup service, and as VC extension.

CheckExtensionKeyRegistrationSpec of type(s) application/json
Optional 
{
    "extension_key": "string",
    "connection_spec": {
        "credentials": {
            "admin_user": "string",
            "admin_password": "string"
        },
        "connection_spec": {
            "psc_uri": "string",
            "psc_thumbprint": "string",
            "vc_instance_id": "string",
            "vc_thumbprint": "string"
        }
    }
}
string
extension_key
Required

The extension key to be checked.

VcConnectionSpec
connection_spec
Required

connection_spec

Authentication
This operation uses the following authentication methods.
Responses
200

Hostname of the registered server, if any.

Returns StringDrData of type(s) application/json 
{
    "value": "string"
}
string
value
Optional

The string representation of a data.


400

Bad request - the server could not understand the request due to invalid syntax or invalid request body content

Returns ResponseError of type(s) application/json 
{
    "error_code": "string",
    "message": "string",
    "op_id": "string"
}
string
error_code
Optional

The code of the error.

string
message
Optional

The message of the error.

string As uuid As uuid
op_id
Optional

The ID of the operation.


401

Unauthorized - the client must authenticate itself to get the requested response

Operation doesn't return any data structure

403

Forbidden - not sufficient access rights to fulfill the request

Returns ResponseError of type(s) application/json 
{
    "error_code": "string",
    "message": "string",
    "op_id": "string"
}
string
error_code
Optional

The code of the error.

string
message
Optional

The message of the error.

string As uuid As uuid
op_id
Optional

The ID of the operation.


500

Internal server error - unexpected condition prevents fulfilling the request

Returns ResponseError of type(s) application/json 
{
    "error_code": "string",
    "message": "string",
    "op_id": "string"
}
string
error_code
Optional

The code of the error.

string
message
Optional

The message of the error.

string As uuid As uuid
op_id
Optional

The ID of the operation.


On This Page
Configuration Operations
POST
Check Extension Key
POST
Delete Configuration
GET
Get Configuration
GET
Get Reconfigure Required
POST
List Vc Services
PUT
Update Configuration
POST
Validate Connection