Upload a pem certificate chain bundle using the Nexfs Management API

Added: Nexfs 1.02.01(23)

Uploads a new certificate chain bundle in pem format.

The pem must include the private key and one or more certificates that make up the complete chain. The private key can be at the start or the end of the pem, if a self signed certificate is used, only the singel cerificate should be included along with the corresponding private key.

The pem chain can also include if required, the intermendiate and a root certificate.

The format of the pem is:

-----BEGIN PRIVATE KEY-----

-----END PRIVATE KEY-----

-----BEGIN CERTIFICATE-----

-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----

-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----

-----END CERTIFICATE-----

(Intermediate and root certificates if required)

Action: PutCertificate

UpLoad a certificate pem chain bundle

Permissions

To update 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 PutConfiguration.

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

Action

PutCertificate

Cerfificate

uri encoded pem file

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>

<Message>

<PutCertificateResponse>

<PutCertificateResult>

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

</PutCertificateResult>

</PutCertificateResponse>

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

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

ca

True or False

SelfSigned

True or False

Resource

PutCertificateResponse

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

400 BadRequest Unable to parse certificate. Please ensure the certificate is in PEM format, including the matching privatekey

400 Could not validate the certificate with the certificate chain

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

The certificate in the following example request is:

-----BEGIN PRIVATE KEY-----

MIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQCSiKI+McyG8Ps2

+n52+FEAhWEX8uCg0lfVC+tdApBfgeqFJgl3SwocejssSowkXWFJz+3Z7C4U3JWK

O14C9RacX1yhef0GHXWKeOc9cA6GjTFKTYb09ffMI/3lDCrKPI+Yh+bP8gOPuFgl

0uSZYLbIt1NSnn9idhAfoNLa8/XzzWE9xcqTVby0ih67baUUjv6kx1yziSzBSDla

VNPIAEjGg5KAE5Gsqsb9bBKbVGiO0QmBBVA20t9XehbBKO1oiP7t1Ec2DgRmots9

sMiIjvUGb7vYDJKQdk+rAvhdt42FZqURWLaZTS+a/lgDmR/4cLBFoMVFBf4RTYsc

HUdt94qlAgMBAAECggEAMBJbB4RW0L4l6/dpnaYBDOa036JyRtA6uE3cvPqmWm7I

fT3pRRV9D7KZzwH1z8hCrnBkW2W8CGQFOwAW62l0LYCrZt4aP/NSKEdZtTIZ0dJo

JTQh3iMDVBlKpeXD8+zCPwv2kKmYuYGEiYQSMq8jx908nJIawDZzO60K/4GhYoWy

5ahrKf4XAgsms2zGhSjmFQwUnXoQsprlEtHJZ+XxlSeVVRSg7W8gO+9B0FpHgumh

BWGTGao/GNgKcYkP7CN3BM+D6wyglu3n2OQCOJKe3EvF8jttBGp6DA4saJXr690K

4Z6lAqYWhrmALqZaIEabg18cxgqc2La2BtYso6V90QKBgQDM0vb5EU2XJXAv6zpk

cm7wzQrJZtCIirIo1L4ezeyzk9z8dm13DsMHX7EGU1Eg2Vy4JIkGjaGvdWbE6phj

AGm9438PSW0fQPNWcaw+k6YThKFf23J8TENfm+Fa6Ohrq9CPdhYaiZ8PHdAVosC9

EiZiiTH79wkS1oe3wsLtsIpECwKBgQC3JUd/apV+ku72sFfnHg9YgAckEeqf92OJ

AAGInX7e78RrTrvMYyG9SyZhZaLiAk/uTphJhu5/t+MtJVjYpSQG4icCvbVhIMAP

aJKHPCapOUj5d+TrWwTN+ZnSh08B0p8Bec6m5674YGnCcqzwwHcHXbebkW+3IfbB

IwHRBrNqDwKBgFO+/lQgCwV9vT0ahKmFUG8Mpxhp/WGWs/mV4pZdxCY4kuZ21ZMU

ahGdwpe/gTBZL1vrNEuFpVJEQlzJPr1b8eA+IDlz4DYjLFtv5uk/HWxlkkXLSCgi

VnnFFoNBL6a2fXPq6Ga5Vlur6OSvwvaLcT5gshs/imo1ZRBxhZoB0Ma5AoGBAIWh

yuB6mafoeDpBg3Icqd/OUueLtyGPde4BthzDpk3urugJY9gHQRgInHGWolm8jCv6

5v1HWgCQ4U8QoBo7rOTk4MgMOisrpVfY2omYZzE0nj2AsOTV3dSY2hcWKZzP3LtL

8HAyPqX2W1TJLczg8jjKtezqGpSKUKyt6WZmOEUbAoGBAKKsdqkd0cptr21Di9Bw

G2psqMBjGxT2UWtjZJxOaamuaJjuonoCI6vaknNHs6aIBU+OLAdkZWmU5wtpbbRz

Yy2QUWtWkVpaFMZCm8Sbmmp0+8JTVPkn1WHWAIQUsxGl7x9iFz+nl4IvIARCN2SO

gRTorabqikHI5A8XwrE0+wjJ

-----END PRIVATE KEY-----

-----BEGIN CERTIFICATE-----

MIID8TCCAtmgAwIBAgIUQKxpIwMSbQTZ3TL6mUMnkw0L0BwwDQYJKoZIhvcNAQEL

BQAwgYcxCzAJBgNVBAYTAk5aMQ8wDQYDVQQIDAZLYXBpdGkxFDASBgNVBAcMC1Bh

cmFwYXJhdW11MRgwFgYDVQQKDA9OZXh1c3RvcmFnZSBMdGQxEjAQBgNVBAMMCW5l

eGZzLmNvbTEjMCEGCSqGSIb3DQEJARYUaW5mb0BuZXh1c3RvcmFnZS5jb20wHhcN

MjMwODA1MDcxOTU4WhcNMjQwODA0MDcxOTU4WjCBhzELMAkGA1UEBhMCTloxDzAN

BgNVBAgMBkthcGl0aTEUMBIGA1UEBwwLUGFyYXBhcmF1bXUxGDAWBgNVBAoMD05l

eHVzdG9yYWdlIEx0ZDESMBAGA1UEAwwJbmV4ZnMuY29tMSMwIQYJKoZIhvcNAQkB

FhRpbmZvQG5leHVzdG9yYWdlLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCC

AQoCggEBAJKIoj4xzIbw+zb6fnb4UQCFYRfy4KDSV9UL610CkF+B6oUmCXdLChx6

OyxKjCRdYUnP7dnsLhTclYo7XgL1FpxfXKF5/QYddYp45z1wDoaNMUpNhvT198wj

/eUMKso8j5iH5s/yA4+4WCXS5Jlgtsi3U1Kef2J2EB+g0trz9fPNYT3FypNVvLSK

HrttpRSO/qTHXLOJLMFIOVpU08gASMaDkoATkayqxv1sEptUaI7RCYEFUDbS31d6

FsEo7WiI/u3URzYOBGai2z2wyIiO9QZvu9gMkpB2T6sC+F23jYVmpRFYtplNL5r+

WAOZH/hwsEWgxUUF/hFNixwdR233iqUCAwEAAaNTMFEwHQYDVR0OBBYEFGLmEFB7

dFhh5HnPbyJoJg1GJr1oMB8GA1UdIwQYMBaAFGLmEFB7dFhh5HnPbyJoJg1GJr1o

MA8GA1UdEwEB/wQFMAMBAf8wDQYJKoZIhvcNAQELBQADggEBACJm4CHuO0yoMKEK

iS5FjnRU3DddPlenSKWpzKrXerkEdf/l+84wD2YUkJR3uMfi1ZkrGBZxFR0W34IC

26eRIT7PEbrCD7sNTraBxksh7j3coW7f3xb0q/yES+BvY9u0rsNq19qaIzoFP4HK

i5LOV0mpAG6RfACF+aja1E/ocHk9UZsot3OBfC2v+QavdjUzUkuDYLLnyL23QiYf

DGbuPKsvJ5lIYweGEUUVdVZNOLkz15P+CknGYLxHwzhXbvFoqVD2dDajWu3HWSF6

ukGbK2HxEqdXA6HHXzKXWO+r6Qr36jaSdvsqSZIRd4wy01cUMXfA+RvFYb6Nlqlv

LgxWNpo=

-----END CERTIFICATE-----

GET http://macdev01.nexfs.com:9200/nexfsconsoleapi?Action=PutCertificate&Cerfificate=-----BEGIN%20CERTIFICATE-----%0AMIID8TCCAtmgAwIBAgIUQKxpIwMSbQTZ3TL6mUMnkw0L0BwwDQYJKoZIhvcNAQEL%0ABQAwgYcxCzAJBgNVBAYTAk5aMQ8wDQYDVQQIDAZLYXBpdGkxFDASBgNVBAcMC1Bh%0AcmFwYXJhdW11MRgwFgYDVQQKDA9OZXh1c3RvcmFnZSBMdGQxEjAQBgNVBAMMCW5l%0AeGZzLmNvbTEjMCEGCSqGSIb3DQEJARYUaW5mb0BuZXh1c3RvcmFnZS5jb20wHhcN%0AMjMwODA1MDcxOTU4WhcNMjQwODA0MDcxOTU4WjCBhzELMAkGA1UEBhMCTloxDzAN%0ABgNVBAgMBkthcGl0aTEUMBIGA1UEBwwLUGFyYXBhcmF1bXUxGDAWBgNVBAoMD05l%0AeHVzdG9yYWdlIEx0ZDESMBAGA1UEAwwJbmV4ZnMuY29tMSMwIQYJKoZIhvcNAQkB%0AFhRpbmZvQG5leHVzdG9yYWdlLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCC%0AAQoCggEBAJKIoj4xzIbw+zb6fnb4UQCFYRfy4KDSV9UL610CkF+B6oUmCXdLChx6%0AOyxKjCRdYUnP7dnsLhTclYo7XgL1FpxfXKF5/QYddYp45z1wDoaNMUpNhvT198wj%0A/eUMKso8j5iH5s/yA4+4WCXS5Jlgtsi3U1Kef2J2EB+g0trz9fPNYT3FypNVvLSK%0AHrttpRSO/qTHXLOJLMFIOVpU08gASMaDkoATkayqxv1sEptUaI7RCYEFUDbS31d6%0AFsEo7WiI/u3URzYOBGai2z2wyIiO9QZvu9gMkpB2T6sC+F23jYVmpRFYtplNL5r+%0AWAOZH/hwsEWgxUUF/hFNixwdR233iqUCAwEAAaNTMFEwHQYDVR0OBBYEFGLmEFB7%0AdFhh5HnPbyJoJg1GJr1oMB8GA1UdIwQYMBaAFGLmEFB7dFhh5HnPbyJoJg1GJr1o%0AMA8GA1UdEwEB/wQFMAMBAf8wDQYJKoZIhvcNAQELBQADggEBACJm4CHuO0yoMKEK%0AiS5FjnRU3DddPlenSKWpzKrXerkEdf/l+84wD2YUkJR3uMfi1ZkrGBZxFR0W34IC%0A26eRIT7PEbrCD7sNTraBxksh7j3coW7f3xb0q/yES+BvY9u0rsNq19qaIzoFP4HK%0Ai5LOV0mpAG6RfACF+aja1E/ocHk9UZsot3OBfC2v+QavdjUzUkuDYLLnyL23QiYf%0ADGbuPKsvJ5lIYweGEUUVdVZNOLkz15P+CknGYLxHwzhXbvFoqVD2dDajWu3HWSF6%0AukGbK2HxEqdXA6HHXzKXWO+r6Qr36jaSdvsqSZIRd4wy01cUMXfA+RvFYb6Nlqlv%0ALgxWNpo=%0A-----END%20CERTIFICATE-----%0A-----BEGIN%20PRIVATE%20KEY-----%0AMIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQCSiKI+McyG8Ps2%0A+n52+FEAhWEX8uCg0lfVC+tdApBfgeqFJgl3SwocejssSowkXWFJz+3Z7C4U3JWK%0AO14C9RacX1yhef0GHXWKeOc9cA6GjTFKTYb09ffMI/3lDCrKPI+Yh+bP8gOPuFgl%0A0uSZYLbIt1NSnn9idhAfoNLa8/XzzWE9xcqTVby0ih67baUUjv6kx1yziSzBSDla%0AVNPIAEjGg5KAE5Gsqsb9bBKbVGiO0QmBBVA20t9XehbBKO1oiP7t1Ec2DgRmots9%0AsMiIjvUGb7vYDJKQdk+rAvhdt42FZqURWLaZTS+a/lgDmR/4cLBFoMVFBf4RTYsc%0AHUdt94qlAgMBAAECggEAMBJbB4RW0L4l6/dpnaYBDOa036JyRtA6uE3cvPqmWm7I%0AfT3pRRV9D7KZzwH1z8hCrnBkW2W8CGQFOwAW62l0LYCrZt4aP/NSKEdZtTIZ0dJo%0AJTQh3iMDVBlKpeXD8+zCPwv2kKmYuYGEiYQSMq8jx908nJIawDZzO60K/4GhYoWy%0A5ahrKf4XAgsms2zGhSjmFQwUnXoQsprlEtHJZ+XxlSeVVRSg7W8gO+9B0FpHgumh%0ABWGTGao/GNgKcYkP7CN3BM+D6wyglu3n2OQCOJKe3EvF8jttBGp6DA4saJXr690K%0A4Z6lAqYWhrmALqZaIEabg18cxgqc2La2BtYso6V90QKBgQDM0vb5EU2XJXAv6zpk%0Acm7wzQrJZtCIirIo1L4ezeyzk9z8dm13DsMHX7EGU1Eg2Vy4JIkGjaGvdWbE6phj%0AAGm9438PSW0fQPNWcaw+k6YThKFf23J8TENfm+Fa6Ohrq9CPdhYaiZ8PHdAVosC9%0AEiZiiTH79wkS1oe3wsLtsIpECwKBgQC3JUd/apV+ku72sFfnHg9YgAckEeqf92OJ%0AAAGInX7e78RrTrvMYyG9SyZhZaLiAk/uTphJhu5/t+MtJVjYpSQG4icCvbVhIMAP%0AaJKHPCapOUj5d+TrWwTN+ZnSh08B0p8Bec6m5674YGnCcqzwwHcHXbebkW+3IfbB%0AIwHRBrNqDwKBgFO+/lQgCwV9vT0ahKmFUG8Mpxhp/WGWs/mV4pZdxCY4kuZ21ZMU%0AahGdwpe/gTBZL1vrNEuFpVJEQlzJPr1b8eA+IDlz4DYjLFtv5uk/HWxlkkXLSCgi%0AVnnFFoNBL6a2fXPq6Ga5Vlur6OSvwvaLcT5gshs/imo1ZRBxhZoB0Ma5AoGBAIWh%0AyuB6mafoeDpBg3Icqd/OUueLtyGPde4BthzDpk3urugJY9gHQRgInHGWolm8jCv6%0A5v1HWgCQ4U8QoBo7rOTk4MgMOisrpVfY2omYZzE0nj2AsOTV3dSY2hcWKZzP3LtL%0A8HAyPqX2W1TJLczg8jjKtezqGpSKUKyt6WZmOEUbAoGBAKKsdqkd0cptr21Di9Bw%0AG2psqMBjGxT2UWtjZJxOaamuaJjuonoCI6vaknNHs6aIBU+OLAdkZWmU5wtpbbRz%0AYy2QUWtWkVpaFMZCm8Sbmmp0+8JTVPkn1WHWAIQUsxGl7x9iFz+nl4IvIARCN2SO%0AgRTorabqikHI5A8XwrE0+wjJ%0A-----END%20PRIVATE%20KEY-----

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

<RequestCompleted>

<Code>Ok</Code>

<Message>

<PutCertificateResponse>

<PutCertificateResult>

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

</PutCertificateResult>

</PutCertificateResponse>

</Message>

<Resource>PutCertificateResponse</Resource>

<RequestId>11</RequestId>

</RequestCompleted>