[{"label":"Latest (4.5.0)","version":"latest"},{"version":"4.4.0"},{"version":"4.3.1"},{"link":"https://developer.vmware.com/apis/1126/vmware-cloud-foundation","version":"4.3"},{"link":"https://developer.vmware.com/apis/1077/vmware-cloud-foundation","version":"4.2"},{"link":"https://developer.vmware.com/apis/1032/vmware-cloud-foundation","version":"4.1"},{"link":"https://developer.vmware.com/apis/1002/vmware-cloud-foundation","version":"4.0.1"},{"link":"https://developer.vmware.com/apis/921/vmware-cloud-foundation","version":"4.0"},{"link":"https://developer.vmware.com/apis/925/vmware-cloud-foundation","version":"3.10"},{"link":"https://developer.vmware.com/apis/891/vmware-cloud-foundation","version":"3.9.1"},{"link":"https://developer.vmware.com/apis/723/vmware-cloud-foundation","version":"3.9.0"},{"link":"https://developer.vmware.com/apis/711/vmware-cloud-foundation","version":"3.8.1"},{"link":"https://developer.vmware.com/apis/685/vmware-cloud-foundation","version":"3.8"}]

vcf

Replace Certificates

Description

Replace certificate(s) for the selected resource(s) in a domain

NOTE: Supported certificate resource types for this operation are: VCENTER, NSXT_MANAGER, SDDC_MANAGER, VRSLCM, VXRAIL_MANAGER ..

Request

URL

patch

https://sfo-vcf01.rainpole.io/v1/domains/{domainName}/certificates

Copy

Path Parameters

string

domainName Required

The domain name

Request Body

CertificateOperationSpec of type(s) application/json Required

certificateOperationSpec

Show optional properties

{
    "operationType": "One among: INSTALL"
}

{
    "operationType": "One among: INSTALL"
}

string

operationType Required

The Certificates operation type

array of Resource

resources Optional

Resource(s) in a domain

Response

200 OK Response Body>

Response Body

200 OK

Returns Task of type(s) application/json

{
    "resolutionStatus": "Can have only one of the two values: RESOLVED or UNRESOLVED",
    "status": "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
    "type": "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}

string

completionTimestamp Optional

Task completion timestamp

string

creationTimestamp Optional

Task creation timestamp

array of Error

errors Optional

List of errors in case of a failure

string

id Optional

Task ID

boolean

isCancellable Optional

Represents task can be cancellable or not.

MessagePack

localizableDescriptionPack Introduced Optional

Localizable Task description

string

name Optional

Task name

string

resolutionStatus Optional

Resolution state

array of Resource

resources Optional

List of resources associated with task

string

status Optional

Task status

array of SubTask

subTasks Optional

List of sub-tasks of the task

string

type Optional

Operation that is represented by the Task in machine readable format. The value is controlled by the owners/producers of the Task. The convention is _

202 Accepted Response Body>

Response Body

202 Accepted

Returns Task of type(s) application/json

{
    "resolutionStatus": "Can have only one of the two values: RESOLVED or UNRESOLVED",
    "status": "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
    "type": "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}

string

completionTimestamp Optional

Task completion timestamp

string

creationTimestamp Optional

Task creation timestamp

array of Error

errors Optional

List of errors in case of a failure

string

id Optional

Task ID

boolean

isCancellable Optional

Represents task can be cancellable or not.

MessagePack

localizableDescriptionPack Introduced Optional

Localizable Task description

string

name Optional

Task name

string

resolutionStatus Optional

Resolution state

array of Resource

resources Optional

List of resources associated with task

string

status Optional

Task status

array of SubTask

subTasks Optional

List of sub-tasks of the task

string

type Optional

Operation that is represented by the Task in machine readable format. The value is controlled by the owners/producers of the Task. The convention is _

Errors

Error

400

Bad request

Error

403

Forbidden

Error

404

Not Found

Error

409

Conflict

Error

500

Internal server error

Code Samples

cURL Command

curl -X PATCH -H "Content-Type: application/json" -d '{"operationType":"One among: INSTALL"}' https://sfo-vcf01.rainpole.io/v1/domains/{domainName}/certificates

vcf

Certificates Operations

patch

Configure Certificate Authority

put

Create Certificate Authority

delete

Delete CA Configuration

get

Download CSR

put

Generate Certificates

put

Generates CSRs

get

Get CSRs

get

Get Certificate Authorities

get

Get Certificate Authority By ID

get

Get Certificates

patch

Replace Certificates

put

Upload Certificates

get

View Certificate

Replace Certificates

Request

URL

Path Parameters

Request Body

Response

Response Body

200 OK

Response Body

202 Accepted

Errors

Code Samples

cURL Command

On This Page

Certificates Operations

Was this page helpful?