Config Reconciler APIs
APIs for managing configs
Table of Contents
1. Get All Applicable Config Drifts
1.1. Steps
- Invoke the API.
cURL Request
$ curl 'https://sfo-vcf-1.rainpole.io/v1/config-drifts' -i -X GET \
-H 'Content-Type: application/json'
HTTP Request
GET /v1/config-drifts HTTP/1.1
Content-Type: application/json
Host: sfo-vcf-1.rainpole.io
HTTP Response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1393
{
"elements" : [ {
"id" : "55eeb985-67a3-420b-b7e2-3d3608900cb2",
"name" : "Config drift A",
"description" : "Config drift A desc",
"resourceType" : "DOMAIN",
"type" : "feature",
"applicability" : {
"versionApplicability" : [ {
"productType" : "VCENTER",
"minVersion" : "4.2.0.0",
"maxVersion" : "4.3.0.0"
} ]
}
}, {
"id" : "e5de23a3-3f7a-4859-841c-7dd46f136653",
"name" : "Config drift B",
"description" : "Config drift B desc",
"resourceType" : "DOMAIN",
"type" : "feature",
"applicability" : {
"versionApplicability" : [ {
"productType" : "VCENTER",
"minVersion" : "4.2.0.0",
"maxVersion" : "4.3.0.0"
} ]
},
"applicabilityStatus" : {
"applicable" : true
}
}, {
"id" : "6a7d6d25-a2b8-4ee6-93d1-61b1e952d2b0",
"name" : "Config drift C",
"description" : "Config drift C desc",
"resourceType" : "DOMAIN",
"type" : "feature",
"applicability" : {
"versionApplicability" : [ {
"productType" : "VCENTER",
"minVersion" : "4.2.0.0",
"maxVersion" : "4.3.0.0"
} ]
},
"applicabilityStatus" : {
"applicable" : false,
"cause" : "CONFIG_CHECK_FAILED"
}
} ],
"pageMetadata" : {
"pageNumber" : 1,
"pageSize" : 3,
"totalElements" : 3,
"totalPages" : 1
}
}
1.2. Related APIs
Get Applicable Config Drifts by Filter Parameters Config Drift Reconciliation Request Get Reconciliation Task
2. Get Applicable Config Drifts by Filter Parameters
2.1. Prerequisites
The following query parameters may be used for selective config drift retrieval. Parameters can be combined.
resourceId: Get applicable Config Drifts by resource id
resourceType: Get applicable Config Drifts by resource type
configId: Get applicable Config Drifts by drift id
driftType: Get applicable Config Drifts by drift type
Pagination support is available (Optional parameters).
page: Page number to retrieve.
size: Number of elements per page.
2.2. Steps
- Invoke the API.
cURL Request
$ curl 'https://sfo-vcf-1.rainpole.io/v1/config-drifts?resourceId=fab79abd-31ec-4bb6-9922-def83de9bccb&page=1&size=2' -i -X GET \
-H 'Content-Type: application/json'
HTTP Request
GET /v1/config-drifts?resourceId=fab79abd-31ec-4bb6-9922-def83de9bccb&page=1&size=2 HTTP/1.1
Content-Type: application/json
Host: sfo-vcf-1.rainpole.io
HTTP Response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 926
{
"elements" : [ {
"id" : "55eeb985-67a3-420b-b7e2-3d3608900cb2",
"name" : "Config drift A",
"description" : "Config drift A desc",
"resourceType" : "DOMAIN",
"type" : "feature",
"applicability" : {
"versionApplicability" : [ {
"productType" : "VCENTER",
"minVersion" : "4.2.0.0",
"maxVersion" : "4.3.0.0"
} ]
}
}, {
"id" : "e5de23a3-3f7a-4859-841c-7dd46f136653",
"name" : "Config drift B",
"description" : "Config drift B desc",
"resourceType" : "DOMAIN",
"type" : "feature",
"applicability" : {
"versionApplicability" : [ {
"productType" : "VCENTER",
"minVersion" : "4.2.0.0",
"maxVersion" : "4.3.0.0"
} ]
},
"applicabilityStatus" : {
"applicable" : true
}
} ],
"pageMetadata" : {
"pageNumber" : 1,
"pageSize" : 2,
"totalElements" : 2,
"totalPages" : 1
}
}
2.3. Related APIs
Get All Applicable Config Drifts Config Drift Reconciliation Request Get Reconciliation Task
3. Config Drift Reconciliation Request
3.1. Steps
- Invoke the API.
cURL Request
$ curl 'https://sfo-vcf-1.rainpole.io/v1/config-drift-reconciliations' -i -X POST \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{
"reconciliationForResources" : [ {
"resourceId" : "fab79abd-31ec-4bb6-9922-def83de9bccb",
"applyAll" : true
} ]
}'
HTTP Request
POST /v1/config-drift-reconciliations HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 127
Host: sfo-vcf-1.rainpole.io
{
"reconciliationForResources" : [ {
"resourceId" : "fab79abd-31ec-4bb6-9922-def83de9bccb",
"applyAll" : true
} ]
}
HTTP Response
HTTP/1.1 202 Accepted
Content-Type: application/json
Location: /v1/tasks/034c8b85-a08b-4c6f-b16b-b4699f244828
Content-Length: 218
{
"id" : "034c8b85-a08b-4c6f-b16b-b4699f244828",
"name" : "Sample Response Task",
"status" : "IN_PROGRESS",
"creationTimestamp" : "2022-10-26T08:12:59.349Z",
"isCancellable" : false,
"isRetryable" : false
}
3.2. Related APIs
Get All Applicable Config Drifts Get Applicable Config Drifts by Filter Parameters Get Reconciliation Task
4. Get Reconciliation Task
4.1. Prerequisites
To retrieve the config reconciliation task associated with a given task Id the following path variable is required:
- taskId: task Id to be retrieved
4.2. Steps
- Invoke the API.
cURL Request
$ curl 'https://sfo-vcf-1.rainpole.io/v1/config-drift-reconciliations/034c8b85-a08b-4c6f-b16b-b4699f244828' -i -X GET \
-H 'Content-Type: application/json'
HTTP Request
GET /v1/config-drift-reconciliations/034c8b85-a08b-4c6f-b16b-b4699f244828 HTTP/1.1
Content-Type: application/json
Host: sfo-vcf-1.rainpole.io
HTTP Response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 218
{
"id" : "034c8b85-a08b-4c6f-b16b-b4699f244828",
"name" : "Sample Response Task",
"status" : "IN_PROGRESS",
"creationTimestamp" : "2022-10-26T08:12:59.349Z",
"isCancellable" : false,
"isRetryable" : false
}
4.3. Related APIs
Get All Applicable Config Drifts
Get Applicable Config Drifts by Filter Parameters
Config Drift Reconciliation Request
Last updated 2025-03-21 15:13:04 +0530