Summary
Update a certificate by Id
Description
Update a certificate in the certificate store
Route
PUT /gateway_manager/v1/certificates/:id
Roles
certificate:update
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| id |
string |
yes |
Id of certificate (MongoDB ObjectId as string) |
| alias |
string |
yes |
arbitrary display name for certificate |
Copied to Clipboard
{
"alias": "random_cert"
}
Copied to Clipboard
{
"type": "object",
"properties": {
"alias": {
"title": "alias",
"type": "string",
"examples": [
"random_cert"
]
}
},
"required": [
"alias"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| response |
string |
Information about the certificate that was just updated |
Copied to Clipboard
{
"_id": "dolor reprehenderit est anim pariatur",
"certificate": "dolore Lorem sint nisi aute",
"alias": "deserunt culpa",
"contract_id": "ut incididunt mollit",
"host": "culpa",
"issuer": "aliquip dolor amet Excepteur",
"self_signed": true,
"type": "Host",
"validity": {
"notBefore": "1964-04-03T22:06:49.202Z",
"notAfter": "1969-09-17T14:41:26.169Z"
},
"updatedAt": "2021-04-19T12:05:40.138Z"
}
Copied to Clipboard
{
"title": "response",
"type": "object",
"properties": {
"_id": {
"type": "string",
"example": "6853177801de7d29d95c123b"
},
"certificate": {
"type": "string",
"description": "PEM-encoded certificate string"
},
"alias": {
"type": "string",
"example": "test"
},
"contract_id": {
"type": "string",
"example": "cluster-1"
},
"host": {
"type": "string",
"example": "host_name"
},
"issuer": {
"type": "string",
"example": "E6"
},
"self_signed": {
"type": "boolean"
},
"type": {
"type": "string",
"enum": [
"Host",
"Intermediate",
"Root"
]
},
"validity": {
"type": "object",
"properties": {
"notBefore": {
"type": "string",
"format": "date-time"
},
"notAfter": {
"type": "string",
"format": "date-time"
}
},
"required": [
"notBefore",
"notAfter"
]
},
"updatedAt": {
"type": "string",
"format": "date-time"
}
}
}
