CertificatesResource

The following resources are part of this group:

/certificates

GET

Gets the certificates. The list of certificates could be narrowed by specifying a type, usage, account.

Parameters

name description type default
limit the limit query
offset the offset query
type the certificate type to search for. Possible values are "pgp" and "x509". query
usage the certificate usage to search for. Possible values are "private", "local", "partner", "login" and "trusted". query
account the account name to filter by query
name the certificate name to filter by query
version (no documentation provided) path

Response Body

element: certificates

the response with certificates listed.

POST

Generate a new certificate.

Parameters

name description type default
version (no documentation provided) path

Request Body

element: certificate

the certificate generation information.

Response Body

element: (custom)

response with listed certificate data

/certificates/certificateRequests

GET

Gets the certificate requests. The list of certificate requests could be narrowed by specifying an account, usage.

Parameters

name description type default
limit the limit query
offset the offset query
usage the certificate request usage to search for. Possible values are "private", "local". query
account the account name to filter by query
version (no documentation provided) path

Response Body

element: certificateRequests

the response with certificate requests listed.

POST

Generates Certificate Signing Request.

Parameters

name description type default
version (no documentation provided) path

Request Body

element: certificateRequest

the certificate request info

Response Body

element: (custom)

the response

/certificates/export

POST

Export a certificate.

Parameters

name description type default
version (no documentation provided) path

Request Body

element: certificate

the certificate information.

Response Body

element: (custom)

(no documentation provided)

/certificates/import

POST

Import X509, SSH or PGP key.

Parameters

name description type default
version (no documentation provided) path

Request Body

element: (custom)

holds the certificate info and certificate data in different body parts.

Response Body

element: (custom)

the response holding the newly created Certificate bean

/certificates/{id}

GET

Gets the certificate details.

Parameters

name description type default
id the certificate id path
version (no documentation provided) path

Response Body

element: certificate

the certificate details

DELETE

Deletes a certificate.

Parameters

name description type default
id - the certificate id. path
version (no documentation provided) path

/certificates/certificateRequests/complete

POST

Completes Certificate Signing Request.

Parameters

name description type default
version (no documentation provided) path

Request Body

element: (custom)

holds the certificate info and signed data in different body parts.

Response Body

element: (custom)

the response holding the newly created Certificate bean

/certificates/certificateRequests/{id}

DELETE

Deletes a certificate request.

Parameters

name description type default
id - the certificate request id. path
version (no documentation provided) path

/certificates/{id}/duplicate

POST

Duplicate the certificate with the given id and saves it by different name.

Parameters

name description type default
id the certificate id path
version (no documentation provided) path

Request Body

element: certificate

the certificate info, should give new certificate name

Response Body

element: (custom)

the response holding information for the duplicate certificate, line new id

/certificates/{id}/updateAccess

POST

Update certificate access level. Valid values are PRIVATE, BUSINESS_UNIT and PUBLIC.

Parameters

name description type default
id the id path
version (no documentation provided) path

Request Body

element: certificateAccessLevel

the certificate access level

/zones/{name}/edges/{title}/certificates/{id}

DELETE

Deletes a certificate.

Parameters

name description type default
id - the certificate id. path
version (no documentation provided) path
name (no documentation provided) path
title (no documentation provided) path
version (no documentation provided) path

/zones/{name}/edges/{title}/certificates/certificateRequests/{id}

DELETE

Deletes a certificate request.

Parameters

name description type default
id - the certificate request id. path
version (no documentation provided) path
name (no documentation provided) path
title (no documentation provided) path
version (no documentation provided) path

/zones/{name}/edges/{title}/certificates/{id}/updateAccess

POST

Update certificate access level. Valid values are PRIVATE, BUSINESS_UNIT and PUBLIC.

Parameters

name description type default
id the id path
version (no documentation provided) path
name (no documentation provided) path
title (no documentation provided) path
version (no documentation provided) path

Request Body

element: certificateAccessLevel

the certificate access level