SSL Certificate Plan¶
/ssl-certificate-plan¶
GET¶
Get a list of the SSL Plans available for reseller. These include the plans a reseller can buy from his parent as well as his own plans (in case a reseller is a provisioner of SSL products himself).
Request parameters
All values are optional.
|
string |
The UUID or coma-separated UUIDs of the SSL plan(s) |
|
string |
The name of the plan. A part of the name may be specified here as well. |
JSON response
array: SSL Certificate Plan
Possible errors
Sample
curl \
--request GET \
--user "{{api_username}}:{{api_key}}" \
"{{api_base_url}}/ssl-certificate-plan?name=comodo" | python -m json.tool
POST¶
Create a SSL Plan. Only product provisioner can create plans.
JSON request
|
string |
The name of the SSL Plan. |
|
integer |
The renew interval for the SSL Plan (in months). |
|
string |
The description of the SSL Plan. |
JSON response
object: SSL Certificate Plan
Possible errors
Sample
curl \
--request POST \
--user "{{api_username}}:{{api_key}}" \
--data '
{
"name": "Test SSL Certificate Plan",
"interval": "1",
"description": "Test description"
}
' \
"{{api_base_url}}/ssl-certificate-plan" | python -m json.tool
/ssl-certificate-plan/{id}¶
GET¶
Get the detailed information about a certain SSL Plan.
Request parameters
N/A
JSON response
object: SSL Certificate Plan
Possible errors
Sample
curl \
--request GET \
--user "{{api_username}}:{{api_key}}" \
"{{api_base_url}}/ssl-certificate-plan/{id}" | python -m json.tool
PUT¶
Update the SSL Plan. A provisioner can change the original name and description of his Plan. However, this action is also available for non-provisioning resellers. If a non-provisioning reseller invokes this API end-point, a custom Plan name and description will be assigned for this reseller without changing the original Plan’s name and description. In this case all of reseller’s customers will see this SSL Plan with the name and description a reseller has assigned. In that way a reseller can control the appearance of the SSL Plan for his customers.
JSON request
|
string |
The name of the SSL Plan. |
|
string |
The description of the SSL Plan. |
JSON response
object: SSL Certificate Plan
Possible errors
Sample
curl \
--request PUT \
--user "{{api_username}}:{{api_key}}" \
--data '
{
"name": "Test SSL Certificate Plan",
"description": "Test description"
}
' \
"{{api_base_url}}/ssl-certificate-plan/{id}" | python -m json.tool
DELETE¶
Delete the SSL Plan. The SSL Plan can be deleted only by provisioning reseller who owns this plan.
Request parameters
N/A
JSON response
object: SSL Certificate Plan
Possible errors
Sample
curl \
--request DELETE \
--user "{{api_username}}:{{api_key}}" \
"{{api_base_url}}/ssl-certificate-plan/{id}" | python -m json.tool