Download OpenAPI specification:Download
Use this endpoint to authenticate using API credentials and obtain a short-lived token.
| apiKey | string The API key used to attain a short-lived token. |
| apiSecret | string The API secret used to authenticate the API key. |
{- "apiKey": "string",
- "apiSecret": "string"
}{- "token": "string"
}Use this endpoint to sign a new x.509 certificate for a specific connection.
New certificate details
| certificateName | string The desired name of the new certificate. |
| parentConnectionID | integer The unique identifier of the connection for which the certificate needs to be signed. |
| commonName | string The common name (CN) to be included in the certificate. |
| dnsNames | Array of strings An optional list of DNS names (subject alternative names) to be included in the certificate. |
{- "certificateName": "string",
- "parentConnectionID": 0,
- "commonName": "string",
- "dnsNames": [
- "string"
]
}{- "certificateId": 0,
- "certificateName": "string",
- "caConnectionId": 0,
- "certificateAuthorityId": 0,
- "expiration": "2019-08-24"
}Use this endpoint to retrieve a list of certificates for a specific connection.
| id required | string The unique identifier for the connection. |
{- "certificates": [
- {
- "certificateId": 0,
- "certificateName": "string",
- "caConnectionId": 0,
- "certificateAuthorityId": 0,
- "expiration": "2019-08-24"
}
]
}Use this endpoint to retrieve a certificate for a specific unique certificate identifier.
| id required | string The unique identifier for the certificate. |
{- "certificate": {
- "ID": 0,
- "certificateName": "string",
- "identityAssuranceLevel": 0,
- "caConnectionID": 0,
- "certificateAuthorityID": 0,
- "certificateType": 0,
- "signedWithCertificateID": 0,
- "certificatePEM": "string",
- "privateKeyPEM": "string",
- "expiration": "2019-08-24",
- "createdAt": "2019-08-24",
- "updatedAt": "2019-08-24",
- "revoked": true
}, - "intermediateCA": "string",
- "rootCA": "string"
}