- URL:
- https://<root>/machines/<machine>/sslcertificates/<certificate>/update
- Methods:
POST- Version Introduced:
- 12.1
Access requirements
Required privileges
The Sever Administrator API requires privilege-based access. An administrator must be assigned a specific user privilege, or role, to access any given endpoint. Listed below are the user privileges or roles an administrator can be assigned that provides access to this endpoint. If multiple privileges are listed, only one needs to be assigned to gain access.
Note that administrators assigned a custom role must also have the administrative View all content privilege assigned to them to access the API directory as an administrator.
Tokens
This API requires token-based authentication. A token is automatically generated for administrators who sign in to the ArcGIS Server Administrator API directory's HTML interface. Tokens generated in this way are stored for the entirety of the session.
Those accessing the API directory outside of the HTML interface will need to acquire a session token from the ArcGIS Server Administrator API generate operation. For security reasons, all POST requests made to the ArcGIS Server Administrator API must include a token in the request body.
Description
The update operation overwrites an existing SSL certificate. This operation can be used to update an active SSL certificate (the certificate being used over port 6443) before it expires. The new certificate will use the same alias as the original certificate, which will allow for the updated certificate to be used immediately without any downtime. This operation can only be used to update certificates with the Private entry type.
Request parameters
| Parameter | Details |
|---|---|
(Required) | The multipart POST parameter containing the certificate file. The file must use a PKCS12 format (.pfx, .p12). |
(Required) | The password to unlock the file containing the certificate. |
| The response format. The default format is Values: |
Example usage
The following is a sample POST request for the update operation:
POST /<context>/machines/MACHINE.EXAMPLE.COM/myCert/update HTTP/1.1
Host: organization.example.com
Content-Type: multipart/form-data; boudnary=----boundary
Content-Length: []
------boundary
Content-Disposition: form-data; name="file"; filename=""
Content-Type: application/octet-stream
mycertificate.pfx
------boundary
Content-Disposition: form-data; name="password"
certPassword
------boundary
Content-Disposition: form-data; name="token"
<token>
------boundary--JSON Response example
{"status": "success"}