top of page

Nexfs Management API Documentation

Method Index

ListCertificates

Retrieve a list of stored certificates chain using the Nexfs Management API


Added: Nexfs 1.02.01(23)


Lists storaged certificates.


Action: ListCertificates

Retrieve a list of stored certificates


Permissions

To retrieve the certifcate list 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 PutConfiguration.


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


Action

ListCertificates


Request Body

The request does not have a request body.


Response Syntax

HTTP1/1 200

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

<RequestCompleted>

<Code>string</Code>

<GetCertificatesResponse>

<Certificates>

<Certificate>

<Index>integer</Index>

<Subject>string</Subject>

<Issuer>string</Issuer>

<Version>integer</Version>

<ValidFrom>string</ValidFrom>

<ValidUntil>string</ValidUntil>

<ca>string</ca>

<SelfSigned>string</SelfSigned>

</Certificate>

...

</Certificates>

</GetCertificatesResponse>

</Message>

<Resource>string</Resource>

<RequestId>integer</RequestId>

</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

OK

Message

GetCertificateResponse

Tag for the response

Certificates

Tag for the start of the certificates list

Certificate

Tag for the start a certificate

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

ca

True or False

SelfSigned

True or False

Resource

/nexfsconsoleapi

RequestId

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

Errors

Also See Rest Error Responses


401 Unauthorized The request cannot be authenticated

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

500 InternalServerError An Internal Error was encountered


Example Request


GET http://macdev01.nexfs.com:9200/nexfsconsoleapi?Action=ListCertificates

Authorization: AWS4-HMAC-SHA256 Credential=aeb482d07d2747718f16a5987d93049e/20230813/nexfs/nexfsconsoleapi/aws4_request, SignedHeaders=host;x-amz-content-sha256;x-amz-date, Signature=97ffa29462a4ce0ee02c103b69a4622e5d6b0b81253752431952e2c2239f27e8

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"?>

<RequestCompleted>

<Code>Ok</Code>

<GetCertificatesResponse>

<Certificates>

<Certificate>

<Index>0</Index>

<Subject>/C=NZ/ST=Kapiti/L=Paraparaumu/O=Nexustorage Ltd/CN=nexfs.com/emailAddress=info@nexustorage.com</Subject>

<Issuer>/C=NZ/ST=Kapiti/L=Paraparaumu/O=Nexustorage Ltd/CN=nexfs.com/emailAddress=info@nexustorage.com</Issuer>

<Version>3</Version>

<ValidFrom>Aug 5 07:19:58 2023 GMT</ValidFrom>

<ValidUntil>Aug 4 07:19:58 2024 GMT</ValidUntil>

<ca>True</ca>

<SelfSigned>True</SelfSigned>

</Certificate>

<Certificate>

<Index>1</Index>

<Subject>/C=NZ/ST=Kapiti/L=Paraparaumu/O=Nexustorage Ltd/CN=nexfs.net/emailAddress=info@nexustorage.com</Subject>

<Issuer>/C=NZ/ST=Kapiti/L=Paraparaumu/O=Nexustorage Ltd/CN=nexfs.net/emailAddress=info@nexustorage.com</Issuer>

<Version>3</Version>

<ValidFrom>Aug 5 07:19:58 2023 GMT</ValidFrom>

<ValidUntil>Aug 4 07:19:58 2024 GMT</ValidUntil>

<ca>True</ca>

<SelfSigned>True</SelfSigned>

</Certificate>

</Certificates>

<ResponseMetadata>

<RequestId>36</RequestId>

</ResponseMetadata>

</GetCertificatesResponse>

<Resource>/nexfsconsoleapi</Resource>

</RequestCompleted>



bottom of page