Validate Resource Certificates

Validate Resource Certificates

Validate resource certificates

Request
URI
PUT
https://sfo-vcf01.rainpole.io/v1/domains/{id}/resource-certificates/validations
COPY
Path Parameters
string
id
Required

Domain ID

Request Body
ResourceCertificateSpecArray of type(s) application/json
Optional 
[
    {
        "caCertificate": "-----BEGIN CERTIFICATE-----\nMIIFq...\n-----END CERTIFICATE-----",
        "certificateChain": "-----BEGIN CERTIFICATE-----\nMIIFq...\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\nMIIFq...\n-----END CERTIFICATE-----",
        "resourceCertificate": "-----BEGIN CERTIFICATE-----\nMIIFq...\n-----END CERTIFICATE-----",
        "resourceFqdn": "sfo-vc01.rainpole.io",
        "resourceId": "BE8A5E04-92A0-43F6-A166-AA041F4327CC"
    }
]
Responses
200

OK

Returns CertificateValidationTask of type(s) application/json 
{
    "completed": "One among: true, false",
    "endTimestamp": "2021-02-02T00:00:00.000Z",
    "startTimestamp": "2021-02-02T00:00:00.000Z",
    "validationId": "B1930850-7D1A-4BAA-89D7-52FD5DAD196A",
    "validations": [
        {
            "endTimestamp": "2021-02-02T00:00:00.000Z",
            "resourceFqdn": "sfo-vc01.rainpole.io",
            "resourceId": "BE8A5E04-92A0-43F6-A166-AA041F4327CC",
            "startTimestamp": "2020-01-01T00:00:00.000Z",
            "validationMessage": "Certificate Expired",
            "validationStatus": "One among: INPROGRESS, SUCCESSFUL, FAILED"
        }
    ]
}
boolean
completed
Required

Validation Task Completed

string
endTimestamp
Optional

Validation Task End Time

string
startTimestamp
Optional

Validation Task Start Time

string
validationId
Required

Validation ID

array of CertificateValidation
validations
Required

Resource Certificate Validations


201

Created

Returns CertificateValidationTask of type(s) application/json 
{
    "completed": "One among: true, false",
    "endTimestamp": "2021-02-02T00:00:00.000Z",
    "startTimestamp": "2021-02-02T00:00:00.000Z",
    "validationId": "B1930850-7D1A-4BAA-89D7-52FD5DAD196A",
    "validations": [
        {
            "endTimestamp": "2021-02-02T00:00:00.000Z",
            "resourceFqdn": "sfo-vc01.rainpole.io",
            "resourceId": "BE8A5E04-92A0-43F6-A166-AA041F4327CC",
            "startTimestamp": "2020-01-01T00:00:00.000Z",
            "validationMessage": "Certificate Expired",
            "validationStatus": "One among: INPROGRESS, SUCCESSFUL, FAILED"
        }
    ]
}
boolean
completed
Required

Validation Task Completed

string
endTimestamp
Optional

Validation Task End Time

string
startTimestamp
Optional

Validation Task Start Time

string
validationId
Required

Validation ID

array of CertificateValidation
validations
Required

Resource Certificate Validations


404

Not Found

Returns Error of type(s) application/json 
{
    "arguments": [
        "string"
    ],
    "causes": [
        {
            "message": "string",
            "type": "string"
        }
    ],
    "context": {
        "context": "string"
    },
    "errorCode": "string",
    "errorType": "string",
    "message": "string",
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string",
    "remediationMessage": "string"
}
array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

array of ErrorCause
causes
Optional

The underlying cause exceptions.

object
context
Optional

The error context (e.g. the component where it occurred).

string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

string
message
Optional

The localized error message

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.

string
remediationMessage
Optional

The localized remediation error message


500

Internal server error

Returns Error of type(s) application/json 
{
    "arguments": [
        "string"
    ],
    "causes": [
        {
            "message": "string",
            "type": "string"
        }
    ],
    "context": {
        "context": "string"
    },
    "errorCode": "string",
    "errorType": "string",
    "message": "string",
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string",
    "remediationMessage": "string"
}
array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

array of ErrorCause
causes
Optional

The underlying cause exceptions.

object
context
Optional

The error context (e.g. the component where it occurred).

string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

string
message
Optional

The localized error message

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.

string
remediationMessage
Optional

The localized remediation error message


On This Page
Certificates Operations
PATCH
Configure Certificate Authority
PUT
Create Certificate Authority
PUT
Decode Cert Chain Using PUT
DELETE
Delete Ca Configuration
GET
Download CSR
Deprecated
PUT
Generate Certificates
PUT
Generates CS Rs
GET
Get Certificate Authorities
GET
Get Certificate Authority By Id
GET
Get Certificates
GET
Get CS Rs
GET
Get Resource Certificates Validation Result
PATCH
Replace Certificates
Deprecated
PUT
Replace Resource Certificates
PUT
Upload Certificates
Deprecated
PUT
Validate Resource Certificates
GET
View Certificate