List watermark profiles

Lists all watermark profiles for an account.

application/json

Body

result

required

Any of

allOf {2}

array[object (Cloudflare Client API_watermarks) {11}]

allOf {2}

One of

array[object (Cloudflare Client API_watermarks) {11}]

object

created

string <date-time>

components-schemas-created

read-onlyoptional

The date and a time a watermark profile was created.

Example:

2014-01-02T02:20:00Z

downloadedFrom

string

downloadedFrom

read-onlyoptional

The source URL for a downloaded image. If the watermark profile was created via direct upload, this field is null.

Example:

https://company.com/logo.png

height

integer

height

read-onlyoptional

The height of the image in pixels.

name

string

watermarks_components-schemas-name

read-onlyoptional

A short description of the watermark profile.

Default:

Example:

Marketing Videos

opacity

number

opacity

read-onlyoptional

The translucency of the image. A value of 0.0 makes the image completely transparent, and 1.0 makes the image completely opaque. Note that if the image is already semi-transparent, setting this to 1.0 will not make the image completely opaque.

>= 0<= 1

Default:

Example:

0.75

padding

number

padding

read-onlyoptional

The whitespace between the adjacent edges (determined by position) of the video and the image. 0.0 indicates no padding, and 1.0 indicates a fully padded video width or length, as determined by the algorithm.

>= 0<= 1

Default:

0.05

Example:

0.1

position

string

position

read-onlyoptional

The location of the image. Valid positions are: upperRight, upperLeft, lowerLeft, lowerRight, and center. Note that center ignores the padding parameter.

Default:

upperRight

Example:

center

scale

number

scale

read-onlyoptional

The size of the image relative to the overall size of the video. This parameter will adapt to horizontal and vertical videos automatically. 0.0 indicates no scaling (use the size of the image as-is), and 1.0 fills the entire video.

>= 0<= 1

Default:

0.15

Example:

0.1

size

number

schemas-size

read-onlyoptional

The size of the image in bytes.

Example:

29472

uid

string

watermarks_components-schemas-identifier

read-onlyoptional

The unique identifier for a watermark profile.

<= 32 characters

Example:

ea95132c15732412d22c1476fa83f27a

width

integer

width

read-onlyoptional

The width of the image in pixels.

errors

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

messages

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

success

enum<boolean>

required

Whether the API call was successful

Allowed value:

true

Example:

true

result_info

object

result_info

optional

count

number

optional

Total number of results for the requested service

Example:

page

number

optional

Current page within paginated list of results

Example:

per_page

number

optional

Number of results per page of results

Example:

total_count

number

optional

Total results available without any search parameters

Example:

2000

Example

{
    "errors": [],
    "messages": [],
    "result": [
        {
            "created": "2014-01-02T02:20:00Z",
            "downloadedFrom": "https://company.com/logo.png",
            "height": 0,
            "name": "Marketing Videos",
            "opacity": 0.75,
            "padding": 0.1,
            "position": "center",
            "scale": 0.1,
            "size": 29472,
            "uid": "ea95132c15732412d22c1476fa83f27a",
            "width": 0
        }
    ],
    "success": true,
    "result_info": {
        "count": 1,
        "page": 1,
        "per_page": 20,
        "total_count": 2000
    }
}

List watermark profiles

Request

Request samples

Responses