Changed1

[{"label":"Latest (5.0.0)","version":"latest"},{"version":"4.5.1"},{"version":"4.5.0"},{"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

Generate Certificates

Description

Generate certificate(s) for the selected resource(s) in a domain. CA must be configured and CSR must be generated beforehand.

Request

URL

put

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

Copy

Path Parameters

string

id Required

Domain ID or Name

Request Body

CertificatesGenerationSpec of type(s) application/json Required

certificateGenerationSpec

Show optional properties

{
    "caType": "One among: OpenSSL, Microsoft"
}

{
    "caType": "One among: OpenSSL, Microsoft"
}

string

caType Required

CA type. Only supports Microsoft and OpenSSL CAs

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, COMPLETED_WITH_WARNING, SKIPPED",
    "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 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, COMPLETED_WITH_WARNING, SKIPPED",
    "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 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

404

Not Found

Error

409

Conflict

Error

500

Internal server error

Code Samples

cURL Command

curl -X PUT -H "Content-Type: application/json" -d '{"caType":"One among: OpenSSL, Microsoft"}' https://sfo-vcf01.rainpole.io/v1/domains/{id}/certificates

vcf

What's changed in latest?

INTRODUCED

Certificates Operations

patch

Configure Certificate Authority

put

Create Certificate Authority

delete

Delete CA Configuration Introduced

get

Download CSR Introduced

put

Generate Certificates Introduced

put

Generates CSRs Introduced

get

Get CSRs Introduced

get

Get Certificate Authorities

get

Get Certificate Authority By ID

get

Get Certificates Introduced

get

Get Resource Certificates Validation Result

patch

Replace Certificates Introduced

put

Replace Resource Certificates

put

Upload Certificates Introduced

put

Validate Resource Certificates

get

View Certificate Introduced

Generate Certificates

Request

URL

Path Parameters

Request Body

Response

Response Body

200 OK

Response Body

202 Accepted

Errors

Code Samples

cURL Command

What's changed in latest?

On This Page

Certificates Operations

Was this page helpful?