Summary
Add a new certificate
Description
Add a new public certificate that is used to identify a gateway to the certificate store
Route
POST /gateway_manager/v1/certificates
Roles
certificate:create
Parameters
DetailsExampleSchema
Name |
Type |
Required |
Description |
raw_certificate |
string |
yes |
The raw certificate to upload into the store |
contract_id |
string |
yes |
The name of the certificate used to identify it |
alias |
string |
yes |
A display name for the certificate |
Copied to Clipboard
{
"raw_certificate": "-----BEGIN%20CERTIFICATE-----...",
"contract_id": "my-certificate-1",
"alias": "my-certificate-alias"
}
Copied to Clipboard
{
"type": "object",
"properties": {
"raw_certificate": {
"title": "raw_certificate",
"type": "string",
"examples": [
"-----BEGIN%20CERTIFICATE-----..."
]
},
"contract_id": {
"title": "contract_id",
"type": "string",
"examples": [
"my-certificate-1"
]
},
"alias": {
"title": "alias",
"type": "string",
"examples": [
"my-certificate-alias"
]
}
},
"required": [
"raw_certificate",
"contract_id",
"alias"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
Name |
Type |
Description |
response |
string |
Response from creating a certificate |
Copied to Clipboard
{
"state": "Success"
}
Copied to Clipboard
{
"title": "response",
"type": "object",
"properties": {
"state": {
"type": "string",
"examples": [
"Success"
]
},
"results": {
"type": "object",
"description": "The response from the database when the certificate was added",
"properties": {}
}
}
}