Fetch active certificate details

GET 
/api/v1/machines/:machineIdOrAlias/certificate

This API endpoint retrieve details of currently active certificate associated with the machine identified by the provided machineId or machine alias.

Request

Path Parameters

machineIdOrAlias stringrequired

The machineId - unique id of the machine, alias - machine alias

Responses

200

Success response

application/json

Schema

Schema

success boolean
message string
status string
statusCode int32
errorCode string
subErrors object[]

payload

object

Machine certificates schema

machineId string

privateKeyAlgo string

privateKeySize string

pubSignAlgo string

certSerialNumber string

certFingerprint string

certPkiName string

certCreatedAt date-time

certExpiresAt date-time

certCommonName string

certIssuingUrl string

certCrlUrl string

issuingCaSerialNumber string

issuingCaCommonName string

issuingCaExpiresAt date-time

rootCaCommonName string

rootCaExpiresAt date-time

isRevoked boolean

Example (from schema)

{
  "success": true,
  "message": "string",
  "status": "string",
  "statusCode": 0,
  "errorCode": "string",
  "subErrors": [
    {}
  ],
  "payload": {
    "machineId": "string",
    "privateKeyAlgo": "string",
    "privateKeySize": "string",
    "pubSignAlgo": "string",
    "certSerialNumber": "string",
    "certFingerprint": "string",
    "certPkiName": "string",
    "certCreatedAt": "2024-07-29T15:51:28.071Z",
    "certExpiresAt": "2024-07-29T15:51:28.071Z",
    "certCommonName": "string",
    "certIssuingUrl": "string",
    "certCrlUrl": "string",
    "issuingCaSerialNumber": "string",
    "issuingCaCommonName": "string",
    "issuingCaExpiresAt": "2024-07-29T15:51:28.071Z",
    "rootCaCommonName": "string",
    "rootCaExpiresAt": "2024-07-29T15:51:28.071Z",
    "isRevoked": true
  }
}

Fetch active certificate details example

Fetch active certificate details response example

{
  "success": true,
  "message": "Machine certificate fetched successfully",
  "status": "OK",
  "statusCode": 200,
  "errorCode": "",
  "subErrors": [
    {}
  ],
  "payload": {
    "machineId": "xxb63e2aaedx-xxxx-123",
    "privateKeyAlgo": "RSA",
    "privateKeySize": "2048",
    "pubSignAlgo": "SHA256",
    "certSerialNumber": "65:19:2e:a6:cd:18:09:49:ab:49:11:ea:b6:3e:c7:c0...",
    "certFingerprint": "[2e, d1, ea, e, cf, bc, 21, 6, e7, fa, 93, 7d, e9, 20, a2, 4d, ...]",
    "certPkiName": "string",
    "certCreatedAt": "2024-06-07T06:22:58.118Z",
    "certExpiresAt": "2024-06-07T06:22:58.118Z",
    "certCommonName": "xxb63e2aaedx-xxxx-123",
    "certIssuingUrl": "string",
    "certCrlUrl": "string",
    "issuingCaSerialNumber": "string",
    "issuingCaCommonName": "string",
    "issuingCaExpiresAt": "2024-06-07T06:22:58.118Z",
    "rootCaCommonName": "string",
    "rootCaExpiresAt": "2024-06-07T06:22:58.118Z",
    "isRevoked": false
  }
}

Loading...