Renew Clients Certificate

Renew client certificate

Request

URI

POST

https://{api_host}/suite-api/api/applications/agents/certificates/renew

COPY

Request Body

IDs of resources

resource-parameters of type(s) application/json

Required

Show optional properties

{
    "contextResourceIDs": [
        {}
    ]
}

"{\n  \"contextResourceIDs\" : [ \"3902b93e-422a-4c4e-888e-28e0bf82f5d0\", \"a9775cec-fa83-4fa5-81b6-864cbf2506dd\" ]\n}"

array of string

contextResourceIDs

Required

Collection of resource IDs

Authentication

This operation uses the following authentication methods.

Token-based-authorization

Responses

200

The result of task status

Returns agent-task-statuses of type(s) application/json

"{\n  \"taskStatuses\" : [ {\n    \"taskID\" : \"task_id_1\",\n    \"resources\" : [ \"vm_id_1\", \"vm_id_2\" ]\n  }, {\n    \"taskID\" : \"task_id_2\",\n    \"resources\" : [ \"vm_id_3\", \"vm_id_4\" ]\n  }, {\n    \"resources\" : [ ],\n    \"errorMessage\" : \"[Resource IDs are duplicated :: vm_id_1],[Provided resources are not virtual machines or Endpoints::vm_id_2][Resources with ID is not found :: vm_id_1,vm_id_2],[VMware Adapter instance(s) monitoring specified resources is/are not found],[Resources powered off::vm_id_1,vm_id_2],[Certificate Renewal is not pending on resources::vm_id_1,vm_id_2]\"\n  } ]\n}"

array of object

taskStatuses

Required

Collection of agent task statuses

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"contextResourceIDs":["string"]}' https://{api_host}/suite-api/api/applications/agents/certificates/renew

On This Page

Description

Request

Request Body

Authentication

Response

200 Response Body

Applications Operations

GET

Get Configuration Details

DELETE

Uninstall Agent