Delete an overlay

DELETE /streaming/streams/{stream_id}/overlays/{overlay_id}

Python

Python

import os
from gcore import Gcore

client = Gcore(
    api_key=os.environ.get("GCORE_API_KEY"),  # This is the default and can be omitted
)
client.streaming.streams.overlays.delete(
    overlay_id=0,
    stream_id=0,
)

package main

import (
	"context"

	"github.com/G-Core/gcore-go"
	"github.com/G-Core/gcore-go/option"
	"github.com/G-Core/gcore-go/streaming"
)

func main() {
	client := gcore.NewClient(
		option.WithAPIKey("My API Key"),
	)
	err := client.Streaming.Streams.Overlays.Delete(
		context.TODO(),
		0,
		streaming.StreamOverlayDeleteParams{
			StreamID: 0,
		},
	)
	if err != nil {
		panic(err.Error())
	}
}

curl --request DELETE \
  --url https://api.gcore.com/streaming/streams/{stream_id}/overlays/{overlay_id} \
  --header 'Authorization: <api-key>'

const options = {method: 'DELETE', headers: {Authorization: '<api-key>'}};

fetch('https://api.gcore.com/streaming/streams/{stream_id}/overlays/{overlay_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.gcore.com/streaming/streams/{stream_id}/overlays/{overlay_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.delete("https://api.gcore.com/streaming/streams/{stream_id}/overlays/{overlay_id}")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gcore.com/streaming/streams/{stream_id}/overlays/{overlay_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

204

This response has no body data.

{
  "status": 404,
  "error": "Not Found. Entity you are looking for was not found, please check the initial parameters"
}

{
  "error": "Feature is disabled. Contact support to enable."
}

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

Response

204