SSL Certificates¶

8 endpoints. Authentication, errors, paging and rate limits are described once, in the API overview.

Action	Method	Description
`addsslorder`	POST	Create an SSL certificate order
`cancelsslorder`	POST	Revoke an SSL certificate
`configsslorder`	POST	Send the CSR and details for an SSL order
`getsslapproveremails`	GET	List the addresses that may approve a certificate
`getsslorder`	GET	Get one SSL order
`getsslorders`	GET	List SSL orders
`reissuesslorder`	POST	Reissue an SSL certificate
`resendsslvalidation`	POST	Resend the SSL validation email

addsslorder¶

Create an SSL certificate order.

POST /api/v1/addsslorder

Permission: full administrator only

Parameters

Name	Type	Required	Description
`client_id`	integer	yes	The client.
`module`	string	yes	An SSL module installed here, for example gogetssl.
`service_id`	integer	no	A service of this client.
`cert_type`	string	no	The certificate product at the provider.
`domain`	string	no	The name it is for; *.example.com for a wildcard.

Response

Field	Description
`result`	`success`
`order_id`	integer
`message`	string

Note

Created as Awaiting Configuration. Send the CSR with configsslorder.

Example

curl -X POST https://example.com/api/v1/addsslorder \
  -H "X-API-Key: $PNLCS_IDENTIFIER" \
  -H "X-API-Secret: $PNLCS_SECRET" \
  --data-urlencode "client_id=1" \
  --data-urlencode "module=gogetssl"

cancelsslorder¶

Revoke an SSL certificate.

POST /api/v1/cancelsslorder

Permission: full administrator only

Parameters

Name	Type	Required	Description
`order_id`	integer	yes	The SSL order.
`reason`	string	no	Why.

Response

Field	Description
`result`	`success`

Errors

Status	When
404	No such order.
502	The SSL provider could not be reached.

Note

Revokes the certificate at the provider.

Example

curl -X POST https://example.com/api/v1/cancelsslorder \
  -H "X-API-Key: $PNLCS_IDENTIFIER" \
  -H "X-API-Secret: $PNLCS_SECRET" \
  --data-urlencode "order_id=1"

configsslorder¶

Send the CSR and details for an SSL order.

POST /api/v1/configsslorder

Permission: full administrator only

Parameters

Name	Type	Required	Description
`order_id`	integer	yes	The SSL order.
`csr`	string	no	The certificate signing request.
`webserver_type`	string	no	As the provider names it.
`validation_method`	string	no	email, dns or http.
`approver_email`	email	no	For email validation (see getsslapproveremails).
`domain`	string	no	The main name.
`domains`	string	no	Extra names (SAN).
`admin_first_name`	string	no	Contact details the provider asks for: admin_first_name, admin_last_name, admin_email, admin_phone, admin_org, admin_address, admin_city, admin_state, admin_zip, admin_country.

Response

Field	Description
`result`	`success`

Errors

Status	When
404	No such order.
502	The SSL provider could not be reached.

Note

Answers result success or error with the provider message.

Example

curl -X POST https://example.com/api/v1/configsslorder \
  -H "X-API-Key: $PNLCS_IDENTIFIER" \
  -H "X-API-Secret: $PNLCS_SECRET" \
  --data-urlencode "order_id=1"

getsslapproveremails¶

List the addresses that may approve a certificate.

GET /api/v1/getsslapproveremails

Permission: full administrator only

Parameters

Name	Type	Required	Description
`domain`	string	yes	The domain.
`module`	string	no	The SSL module to ask. Default gogetssl.

Response

Field	Description
`result`	`success`
`emails`	array of addresses that may approve the certificate

Errors

Status	When
404	No such SSL module.
422	No domain was sent.
502	The SSL provider could not be reached.

Example

curl -G https://example.com/api/v1/getsslapproveremails \
  -H "X-API-Key: $PNLCS_IDENTIFIER" \
  -H "X-API-Secret: $PNLCS_SECRET" \
  --data-urlencode "domain=example.com"

getsslorder¶

Get one SSL order.

GET /api/v1/getsslorder

Permission: full administrator only

Parameters

Name	Type	Required	Description
`order_id`	integer	yes	The SSL order. id is accepted too.

Response

Field	Description
`result`	`success`
`order`	object: the order with its client and service

Errors

Status	When
404	No such order.

Example

curl -G https://example.com/api/v1/getsslorder \
  -H "X-API-Key: $PNLCS_IDENTIFIER" \
  -H "X-API-Secret: $PNLCS_SECRET" \
  --data-urlencode "order_id=1"

getsslorders¶

List SSL orders.

GET /api/v1/getsslorders

Permission: full administrator only

Parameters

Name	Type	Required	Description
`client_id`	integer	no	Only this client's certificates.
`status`	string	no	Only this status.
`limitnum`	integer	no	Page size, 1 to 100. Default 25.
`page`	integer	no	Page number. Default 1.

Response

Field	Description
`result`	`success`
`totalresults`	integer
`orders`	array of SSL orders, newest first, each with its client and service

Example

curl -G https://example.com/api/v1/getsslorders \
  -H "X-API-Key: $PNLCS_IDENTIFIER" \
  -H "X-API-Secret: $PNLCS_SECRET"

reissuesslorder¶

Reissue an SSL certificate.

POST /api/v1/reissuesslorder

Permission: full administrator only

Parameters

Name	Type	Required	Description
`order_id`	integer	yes	The SSL order.
`csr`	string	yes	The new certificate signing request.

Response

Field	Description
`result`	`success`

Errors

Status	When
404	No such order.
422	No CSR was sent.
502	The SSL provider could not be reached.

Example

curl -X POST https://example.com/api/v1/reissuesslorder \
  -H "X-API-Key: $PNLCS_IDENTIFIER" \
  -H "X-API-Secret: $PNLCS_SECRET" \
  --data-urlencode "order_id=1" \
  --data-urlencode "csr=example"

resendsslvalidation¶

Resend the SSL validation email.

POST /api/v1/resendsslvalidation

Permission: full administrator only

Parameters

Name	Type	Required	Description
`order_id`	integer	yes	The SSL order.

Response

Field	Description
`result`	`success`

Errors

Status	When
404	No such order.
502	The SSL provider could not be reached.

Example

curl -X POST https://example.com/api/v1/resendsslvalidation \
  -H "X-API-Key: $PNLCS_IDENTIFIER" \
  -H "X-API-Secret: $PNLCS_SECRET" \
  --data-urlencode "order_id=1"