Get Pairings
Get a list of all existing pairings.
Request
URI
GET
https://{api_host}/pairings
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
namestring
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
10string
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
Responses
200
A list of all pairings this Site Recovery Manager server has configured.
Returns PairingDrResponseList of type(s) application/json
{
"list": [
{
"pairing_id": "string",
"local_vc_server": {
"id": "string",
"url": "string",
"name": "string",
"server_status": "string",
"certificates": [
{
"serial_number": 0,
"not_after": "string",
"not_before": "string",
"signature": [
"string"
],
"version": 3,
"issuer_dn": "C=US, OU=DR Division, O=\"VMware, Inc.\", CN=\"VMware, Inc.\"",
"subject_dn": "C=US, OU=DR Division, O=\"VMware, Inc.\", CN=\"VMware, Inc.\"",
"sig_alg_name": "SHA256withRSA",
"sig_alg_oid": "1.2.840.10040.4.3",
"public_key": "string",
"public_key_format": "X.509",
"public_key_algorithm": "RSA",
"thumbprint": "string",
"certificate": "string",
"issuer_unique_id": [
false
],
"subject_unique_id": [
false
],
"key_usage": [
false
],
"issuer_alternative_names": [
"string"
],
"subject_alternative_names": [
"string"
],
"extended_key_usage": [
"string"
]
}
],
"certificate_warnings": [
{
"server_guid": "string",
"server_url": "string",
"certificate": {
"serial_number": 0,
"not_after": "string",
"not_before": "string",
"signature": [
"string"
],
"version": 3,
"issuer_dn": "C=US, OU=DR Division, O=\"VMware, Inc.\", CN=\"VMware, Inc.\"",
"subject_dn": "C=US, OU=DR Division, O=\"VMware, Inc.\", CN=\"VMware, Inc.\"",
"sig_alg_name": "SHA256withRSA",
"sig_alg_oid": "1.2.840.10040.4.3",
"public_key": "string",
"public_key_format": "X.509",
"public_key_algorithm": "RSA",
"thumbprint": "string",
"certificate": "string",
"issuer_unique_id": [
false
],
"subject_unique_id": [
false
],
"key_usage": [
false
],
"issuer_alternative_names": [
"string"
],
"subject_alternative_names": [
"string"
],
"extended_key_usage": [
"string"
]
}
}
],
"version": "string"
},
"remote_vc_server": {
"id": "string",
"url": "string",
"name": "string",
"server_status": "string",
"certificates": [
{
"serial_number": 0,
"not_after": "string",
"not_before": "string",
"signature": [
"string"
],
"version": 3,
"issuer_dn": "C=US, OU=DR Division, O=\"VMware, Inc.\", CN=\"VMware, Inc.\"",
"subject_dn": "C=US, OU=DR Division, O=\"VMware, Inc.\", CN=\"VMware, Inc.\"",
"sig_alg_name": "SHA256withRSA",
"sig_alg_oid": "1.2.840.10040.4.3",
"public_key": "string",
"public_key_format": "X.509",
"public_key_algorithm": "RSA",
"thumbprint": "string",
"certificate": "string",
"issuer_unique_id": [
false
],
"subject_unique_id": [
false
],
"key_usage": [
false
],
"issuer_alternative_names": [
"string"
],
"subject_alternative_names": [
"string"
],
"extended_key_usage": [
"string"
]
}
],
"certificate_warnings": [
{
"server_guid": "string",
"server_url": "string",
"certificate": {
"serial_number": 0,
"not_after": "string",
"not_before": "string",
"signature": [
"string"
],
"version": 3,
"issuer_dn": "C=US, OU=DR Division, O=\"VMware, Inc.\", CN=\"VMware, Inc.\"",
"subject_dn": "C=US, OU=DR Division, O=\"VMware, Inc.\", CN=\"VMware, Inc.\"",
"sig_alg_name": "SHA256withRSA",
"sig_alg_oid": "1.2.840.10040.4.3",
"public_key": "string",
"public_key_format": "X.509",
"public_key_algorithm": "RSA",
"thumbprint": "string",
"certificate": "string",
"issuer_unique_id": [
false
],
"subject_unique_id": [
false
],
"key_usage": [
false
],
"issuer_alternative_names": [
"string"
],
"subject_alternative_names": [
"string"
],
"extended_key_usage": [
"string"
]
}
}
],
"version": "string"
},
"local_srm_server": {
"id": "string",
"url": "string",
"name": "string",
"server_status": "string",
"certificates": [
{
"serial_number": 0,
"not_after": "string",
"not_before": "string",
"signature": [
"string"
],
"version": 3,
"issuer_dn": "C=US, OU=DR Division, O=\"VMware, Inc.\", CN=\"VMware, Inc.\"",
"subject_dn": "C=US, OU=DR Division, O=\"VMware, Inc.\", CN=\"VMware, Inc.\"",
"sig_alg_name": "SHA256withRSA",
"sig_alg_oid": "1.2.840.10040.4.3",
"public_key": "string",
"public_key_format": "X.509",
"public_key_algorithm": "RSA",
"thumbprint": "string",
"certificate": "string",
"issuer_unique_id": [
false
],
"subject_unique_id": [
false
],
"key_usage": [
false
],
"issuer_alternative_names": [
"string"
],
"subject_alternative_names": [
"string"
],
"extended_key_usage": [
"string"
]
}
],
"certificate_warnings": [
{
"server_guid": "string",
"server_url": "string",
"certificate": {
"serial_number": 0,
"not_after": "string",
"not_before": "string",
"signature": [
"string"
],
"version": 3,
"issuer_dn": "C=US, OU=DR Division, O=\"VMware, Inc.\", CN=\"VMware, Inc.\"",
"subject_dn": "C=US, OU=DR Division, O=\"VMware, Inc.\", CN=\"VMware, Inc.\"",
"sig_alg_name": "SHA256withRSA",
"sig_alg_oid": "1.2.840.10040.4.3",
"public_key": "string",
"public_key_format": "X.509",
"public_key_algorithm": "RSA",
"thumbprint": "string",
"certificate": "string",
"issuer_unique_id": [
false
],
"subject_unique_id": [
false
],
"key_usage": [
false
],
"issuer_alternative_names": [
"string"
],
"subject_alternative_names": [
"string"
],
"extended_key_usage": [
"string"
]
}
}
],
"version": "string"
},
"remote_srm_server": {
"id": "string",
"url": "string",
"name": "string",
"server_status": "string",
"certificates": [
{
"serial_number": 0,
"not_after": "string",
"not_before": "string",
"signature": [
"string"
],
"version": 3,
"issuer_dn": "C=US, OU=DR Division, O=\"VMware, Inc.\", CN=\"VMware, Inc.\"",
"subject_dn": "C=US, OU=DR Division, O=\"VMware, Inc.\", CN=\"VMware, Inc.\"",
"sig_alg_name": "SHA256withRSA",
"sig_alg_oid": "1.2.840.10040.4.3",
"public_key": "string",
"public_key_format": "X.509",
"public_key_algorithm": "RSA",
"thumbprint": "string",
"certificate": "string",
"issuer_unique_id": [
false
],
"subject_unique_id": [
false
],
"key_usage": [
false
],
"issuer_alternative_names": [
"string"
],
"subject_alternative_names": [
"string"
],
"extended_key_usage": [
"string"
]
}
],
"certificate_warnings": [
{
"server_guid": "string",
"server_url": "string",
"certificate": {
"serial_number": 0,
"not_after": "string",
"not_before": "string",
"signature": [
"string"
],
"version": 3,
"issuer_dn": "C=US, OU=DR Division, O=\"VMware, Inc.\", CN=\"VMware, Inc.\"",
"subject_dn": "C=US, OU=DR Division, O=\"VMware, Inc.\", CN=\"VMware, Inc.\"",
"sig_alg_name": "SHA256withRSA",
"sig_alg_oid": "1.2.840.10040.4.3",
"public_key": "string",
"public_key_format": "X.509",
"public_key_algorithm": "RSA",
"thumbprint": "string",
"certificate": "string",
"issuer_unique_id": [
false
],
"subject_unique_id": [
false
],
"key_usage": [
false
],
"issuer_alternative_names": [
"string"
],
"subject_alternative_names": [
"string"
],
"extended_key_usage": [
"string"
]
}
}
],
"version": "string"
}
}
],
"_meta": {
"errors": [
{
"code": "string",
"message": "string",
"field": "string"
}
],
"total": 0,
"offset": 0,
"limit": 0,
"links": {
"next": {
"href": "string"
},
"self": {
"href": "string"
},
"previous": {
"href": "string"
}
}
}
}
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
error_code
string
message
Optional
message
string As uuid As uuid
op_id
Optional
op_id
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
error_code
string
message
Optional
message
string As uuid As uuid
op_id
Optional
op_id
404
Not Found - server cannot find the requested in URL resource
Operation doesn't return any data structure
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
error_code
string
message
Optional
message
string As uuid As uuid
op_id
Optional
op_id