To upload or update a plugin, complete the following steps. To update a plugin, upload a new version. Starting with version 6.4, you can also delete plugins using the REST API. For details, see Delete a plugin.

1. Open a transaction.

   For more information, see Open a transaction.

2. POST the plugin as a zip file (application/zip) to the https://<IP-address-of-SPS>/api/upload/plugins endpoint, for example:

   curl -X POST -H "Content-Type: application/zip" --cookie cookies https://<IP-address-of-SPS>/api/upload/plugins --data-binary @<path-to-plugin.zip>

   If the POST request is successful, the response includes the key of the new plugin, as well as information about the uploaded plugin. For example:

   {
       "meta": {
           "href": "/api/configuration/plugins/aa/aa423b72-0d0f-4275-be30-494e9a99ffad",
           "parent": "/api/configuration/plugins/aa"
       },
       "key": "aa423b72-0d0f-4275-be30-494e9a99ffad",
       "body": {
           "name": "Sample-Authentication-Plugin",
           "description": "My custom authentication plugin",
           "version": "1.12",
           "path": "/opt/scb/var/plugins/aa/Sample-Authentication-Plugin",
           "api": "1.0"
       }
   }

3. Commit your changes.

   For more information, see Commit a transaction.

Note the following points.

• Re-uploading an already existing plugin overwrites the existing plugin.

• Uploading a newer version of an already existing plugin overwrites the existing plugin.

Status and error codes

The following table lists the typical status and error codes for this request. For a complete list of error codes, see Application level error codes.

Code	Description	Notes
201	Created	The plugin has been successfully uploaded. The response should include the key of the created object.
400		The plugin does not support this version of SPS.
400	InvalidPlugin	The type or some other value in the Manifest file of the plugin is invalid, or this version of SPS does not support this type of plugin. Check the error key in the response for details.
401	Unauthenticated	The requested resource cannot be retrieved because the client is not authenticated and the resource requires authorization to access it. The details section contains the path that was attempted to be accessed, but could not be retrieved.
422	TransactionProcessingError	The plugin was uploaded but deploying the plugin failed for some reason.