PATCH
/
streaming
/
streams
/
{stream_id}
/
overlays
/
{overlay_id}
Change an overlay
curl --request PATCH \
  --url https://api.gcore.com/streaming/streams/{stream_id}/overlays/{overlay_id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "url": "http://domain.com/myoverlay_new_3.html",
  "width": null,
  "height": null,
  "x": null,
  "y": null,
  "stretch": true
}'
{
  "id": 1,
  "stream_id": 12345,
  "url": "http://domain.com/myoverlay1.html",
  "width": 120,
  "height": 40,
  "x": 30,
  "y": 30,
  "stretch": false,
  "created_at": "2023-09-20T00:01:01.000Z",
  "updated_at": "2023-10-01T12:01:01.000Z"
}

Authorizations

​
Authorization
string
header
required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234$abcdef

Path Parameters

​
stream_id
integer
required

Stream ID

​
overlay_id
integer
required

Overlay ID

Body

application/json
​
url
string

Valid http/https URL to an HTML page/widget

​
width
integer

Width of the widget

​
height
integer

Height of the widget

​
x
integer

Coordinate of left upper corner

​
y
integer

Coordinate of left upper corner

​
stretch
boolean
default:false

Switch of auto scaling the widget. Must not be used as "true" simultaneously with the coordinate installation method (w, h, x, y).

Response

Successful

​
url
string
required

Valid http/https URL to an HTML page/widget

​
id
integer
required

ID of the overlay

​
stream_id
integer
required

ID of a stream to which it is attached

​
created_at
string
required

Datetime of creation in ISO 8601

​
updated_at
string
required

Datetime of last update in ISO 8601

​
width
integer

Width of the widget

​
height
integer

Height of the widget

​
x
integer

Coordinate of left upper corner

​
y
integer

Coordinate of left upper corner

​
stretch
boolean
default:false

Switch of auto scaling the widget. Must not be used as "true" simultaneously with the coordinate installation method (w, h, x, y).