Manage Applications

    Get file watermark

    get
    https://api.box.com/2.0
    /files/:file_id/watermark

    Retrieve the watermark for a file.

    Request

    application/json

    Path Parameters

    stringin pathrequired
    12345

    The unique identifier that represent a file.

    The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the url https://*.app.box.com/files/123 the file_id is 123.

    Response

    application/jsonWatermark

    Returns an object containing information about the watermark associated for to this file.

    application/jsonClient Error

    Returns an error if the file does not have a watermark applied.

    You can now try out some of our APIs live, right here in the documentation.
    Log In

    Request Example

    cURL
    curl -X GET https://api.box.com/2.0/files/12345/watermark \
         -H "Authorization: Bearer <ACCESS_TOKEN>"
    .NET
    BoxWatermark watermark = await client.FilesManager.GetWatermarkAsync("11111");
    Java
    BoxFile file = new BoxFile(api, id);
    BoxWatermark watermark = file.getWatermark();
    Python
    watermark = client.file(file_id='12345').get_watermark()
    print('Watermark created at {0} and modified at {1}'.format(watermark.created_at, watermark.modified_at))
    Node
    client.files.getWatermark('11111')
    	.then(watermark => {
    		/* watermark -> {
    			watermark: 
    			{ created_at: '2016-10-31T15:33:33-07:00',
    				modified_at: '2016-10-31T15:33:33-07:00' } }
    		*/
    	});

    Response Example

    {
      "watermark": {
        "created_at": "2012-12-12T10:53:43-08:00",
        "modified_at": "2012-12-12T10:53:43-08:00"
      }
    }