Nexfs Management API Documentation

Method Index

GetCertificate

Retrieve a loaded Certificate chain bundle using the Nexfs Management API

Added: Nexfs 1.02.01(23)

Retrieves a certificate chain bundle previously loaded into Nexfs

Action: GetCertificate

Get a loaded certificate pem chain bundle

Permissions

To retrieve the certifcate pem a requesting session must have the nexfs/ManageCertificate role enabled.

Request Parameters

A GET request must be made against the nexfs management console api with the GetCertificate action.

The request must be signed with a valid AWS V4 style Signature using an active temporary session security token.

Action

GetCertificate

CertificateIDX

The nexfs Index number of the Certificate

Request Body

The request does not have a request body.

Response Syntax

HTTP1/1 200

<?xml version="1.0" encoding="UTF-8"?>

<Code>string</Code>

<Index>integer</Index>

<Subject>string</Subject>

<Issuer>string</Issuer>

<Version>integer</Version>

<ValidFrom>string</ValidFrom>

<ValidUntil>string</ValidUntil>

<ca>string</ca>

<SelfSigned>string</SelfSigned>

<ContentServer>string</ContentServer>

<ManagementServer>string</ManagementServer>

</Certificate>

<RequestId>string</RequestId>

</ResponseMetaData>

</GetCertificateResponse>

<Resource>string</Resource>

</RequestCompleted>

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in XML format by the service:

RequestCompleted

Root Level tag for the successful response

Code

Message

PutCertificateResponse

Tag for the response

PutCertificateResult

Tag for the request result

Certificate

Tag for the start of the loaded certificate information

Index

The index number Nexfs has assigned to the certificate, this index number will remain for the life of the certificate in Nexfs, and remains static between nexfs restarts. This index is used to identify the certifcate in an last management api calls.

Subject

Details of the certificate subject

Issuer

Details of the certificate issuer

Version

The certificate version

ValidFrom

Date the certificate is valid from

ValidUntil

Date the certificate is valid until

True or False

SelfSigned

True or False

ContentServer

True or False - True if this is the active ContentServer Certificate

ManagementServer

True or False - True if this is the active ManagementServer Certificate

Resource

/nexfsconsoleapi

ResponseMetadata

Tag marking the start of the response metadata

RequestId

A requestid number that identifies the request made against the management api

Errors

Also See Rest Error Responses

400 BadRequest The request was Malformed

401 Unauthorized The request cannot be authenticated

403 Forbidden Session does not have the rights to perform the requested action

409 NoSuchEntity No Certificate was found with the request index

500 InternalServerError An Internal Error was encountered

Example Request

GET http://nexfs.example.com:9200/nexfsconsoleapi?Action=GetCertificate&CertificateIDX=2

Authorization: AWS4-HMAC-SHA256 Credential=fe34e1be46d3422ba81bc5865d512bcb/20230813/nexfs/nexfsconsoleapi/aws4_request, SignedHeaders=host;x-amz-content-sha256;x-amz-date, Signature=9ce264d3a4a743587db0c100f9347d58c1eb3cb293f1b1800cad760fac56a6d2

content-type: application/x-www-form-urlencoded; charset=utf-8

host: nexfs.example.com

x-amz-date: 20220905T122912Z

Example Response

<?xml version="1.0" encoding="UTF-8"?>

<Subject>/CN=*.nexfsbuild02.nexfs.com</Subject>

<Issuer>/C=US/O=Let's Encrypt/CN=R10</Issuer>

<ca>False</ca>

<SelfSigned>False</SelfSigned>

</Certificate>

</ResponseMetadata>

</GetCertificatesResponse>

<Resource>/nexfsconsoleapi</Resource>

</RequestCompleted>