Summary
Delete a certificate by Id
Description
Deletes a particular certificate from the certificate store
Route
DELETE /gateway_manager/v1/certificates/:id
Roles
certificate:delete
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| id |
string |
yes |
Id of certificate (MongoDB ObjectId as string) |
Copied to Clipboard
{
"type": "object",
"properties": {},
"required": [],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| response |
string |
Information about the certificate that was just deleted |
Copied to Clipboard
{
"_id": "66ff56c9fcbec46997145abd",
"certificate": "-----BEGIN CERTIFICATE--...",
"contract_id": "my-certificate-1",
"host": "localhost",
"issuer": "localhost",
"self_signed": true,
"type": "Root",
"validity": {
"notBefore": "2024-10-03T20:52:55.0Z",
"notAfter": "2025-10-03T20:52:55.0Z"
}
}
Copied to Clipboard
{
"title": "response",
"type": "object",
"properties": {
"_id": {
"type": "string",
"description": "The Id of the certificate within the database",
"examples": [
"66ff56c9fcbec46997145abd"
]
},
"certificate": {
"type": "string",
"description": "The raw certificate data",
"examples": [
"-----BEGIN CERTIFICATE--..."
]
},
"contract_id": {
"type": "string",
"description": "The name of the certificate",
"examples": [
"my-certificate-1"
]
},
"host": {
"type": "string",
"examples": [
"localhost"
]
},
"issuer": {
"type": "string",
"examples": [
"localhost"
]
},
"self_signed": {
"type": "boolean"
},
"type": {
"type": "string",
"examples": [
"Root"
]
},
"validity": {
"type": "object",
"properties": {
"notBefore": {
"type": "string",
"examples": [
"2024-10-03T20:52:55.000Z"
],
"format": "date-time"
},
"notAfter": {
"type": "string",
"examples": [
"2025-10-03T20:52:55.000Z"
],
"format": "date-time"
}
}
}
}
}
