Adding and Deleting Notes for License Keys

Adding Notes

Signature

Request:

  • URL: /30/keys/<KEY_ID>/notes
  • Method: POST
  • Body: JSON object with a value field, containing the text of the notes.

Response:

  • Success status code: 201
  • Body: empty.

Example

Request:

POST /30/keys/PLSK.12345678.1234/notes HTTP/1.1

{
  "value" : "Note message"
}

Response:

HTTP/1.1 201 Created

  

Deleting Notes

Signature

Request:

  • URL: /30/keys/<KEY_ID>/notes/<NOTE_ID>
  • Method: DELETE
  • Body: empty.

Response:

  • Success status code: 204
  • Body: empty.

Example

Request:

DELETE /30/keys/PLSK.12345678.1234/notes/123 HTTP/1.1

Response:

HTTP/1.1 204 No Content

  

Retrieving Notes

Signature

Request:

  • URL: /30/<KEY_ID>/notes
  • Method: GET
  • Body: empty.

Response:

Example

Request:

GET /30/keys/PLSK.12345678.1234/notes HTTP/1.1

Response:

HTTP/1.1 200 OK
[ {
  "id" : 123,
  "author" : "John Smith (Plesk)",
  "message" : "test message",
  "creationDate" : "2015-07-30T07:13:12.749Z"
}, {
  "id" : 124,
  "author" : "Mary Smith (Plesk)",
  "message" : "test message 1",
  "creationDate" : "2015-07-30T05:25:54.693Z"
}, {
  "id" : 125,
  "author" : "Kate Smith (Plesk)",
  "message" : "test message 2",
  "creationDate" : "2015-07-23T10:55:59.683Z"
} ]