Validate Resource Certificates

Validate resource certificates

Request

URI

PUT

https://{api_host}/v1/domains/{id}/resource-certificates/validations

COPY

Path Parameters

string

Required

Domain ID

id example

3E86FBAD-8984-4D4B-992D-F0C49857572A

Request Body

Array of ResourceCertificateSpec of type(s) application/json

Optional

[
    {
        "resourceId": "BE8A5E04-92A0-43F6-A166-AA041F4327CC",
        "resourceFqdn": "sfo-vc01.rainpole.io",
        "resourceCertificate": "-----BEGIN CERTIFICATE-----\nMIIFq...\n-----END CERTIFICATE-----",
        "caCertificate": "-----BEGIN CERTIFICATE-----\nMIIFq...\n-----END CERTIFICATE-----",
        "certificateChain": "-----BEGIN CERTIFICATE-----\nMIIFq...\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\nMIIFq...\n-----END CERTIFICATE-----"
    }
]

Responses

201

Created

Returns CertificateValidationTask of type(s) application/json

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

string

validationId

Required

Validation ID

string

startTimestamp

Optional

Validation Task Start Time

string

endTimestamp

Optional

Validation Task End Time

boolean

completed

Required

Validation Task Completed

array of CertificateValidation

validations

Required

Resource Certificate Validations

Response Headers

undefined

location

API to fetch certificate validation status

404

Not Found

Returns Error of type(s) application/json

{
    "errorCode": "string",
    "errorType": "string",
    "arguments": [
        "string"
    ],
    "context": {
        "context": "string"
    },
    "message": "string",
    "remediationMessage": "string",
    "causes": [
        {
            "type": "string",
            "message": "string"
        }
    ],
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string"
}

string

errorCode

Optional

The minor error code

string

errorType

Optional

The error type

array of string

arguments

Optional

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

object

context

Optional

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

string

message

Optional

The localized error message

string

remediationMessage

Optional

The localized remediation error message

array of ErrorCause

causes

Optional

The underlying cause exceptions.

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.

500

InternalServerError

Returns Error of type(s) application/json

{
    "errorCode": "string",
    "errorType": "string",
    "arguments": [
        "string"
    ],
    "context": {
        "context": "string"
    },
    "message": "string",
    "remediationMessage": "string",
    "causes": [
        {
            "type": "string",
            "message": "string"
        }
    ],
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string"
}

string

errorCode

Optional

The minor error code

string

errorType

Optional

The error type

array of string

arguments

Optional

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