Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Method description

Upload Create a new image for a linklink for the client {instance_id}.

...

URI Parameters

None

Requests

...

Code Block
The image to be used for the link.

...


The proper Content Type must be specified on the request headers.

...


The file size is limited to 200KB

Response format and codes


...

Responses

204 - item has been created

Also, a Location header pointing to the actual image URL.

400 - Invalid parameters. Error response will include details

...

 

...

Type: application/json

Code Block
titleExample application/json
collapsetrue
{
  "code": "validation_error",
  "details": [
    {
      "message": "1 is not of type 'boolean'",
      "path": ".enabled"
    }
  ],
  "message": "Error validating JSON",
  "status": "error"
}
401 - the user performing the action doesn't meet the security criteria

Type: application/json

Code Block
titleExample application/json
collapsetrue
{
  "code": 401,
  "details": "The server could not verify that you are authorized to access the URL requested.  You either supplied the wrong credentials (e.g. a bad password), or your browser doesn't understand how to supply the credentials required.",
  "message": "Unauthorized",
  "status": "error"
}