v1

latestOpenAPI 3.1.02026-07-24650272.2 KB
API Endpoints

Update Workspace

This endpoint allows users to update video workspace that has previously been created.

post/video/workspaces/{workspace_id}

Path parameters

workspace_idstring required

Request body

namestring

video workspace name

default_profile_idstring

Gumlet provides the functionality of creating multiple video assets using the same set of parameters.

temp_cnamestring[]

cname for channel

insight_property_idstring

The five to ten character unique identifier of the Gumlet Insight Property available on the dashboard.

type'proxy' | 'direct-upload' | 'webfolder' | 'aws' | 'gcs' | 'dostorage' | 'wasabi' | 'cloudinary' | 'azure' | 'linode' | 'backblaze' | 'cloudflare' | 'zoom'

Video workspaces are top-level entities in Gumlet. You can use them to organize videos for different teams/departments or use cases.

Response

200

idstring
namestring
typestring
created_atstring
updated_atstring
default_profile_idstring
insight_property_idstring
foldersstring[]

Example response

{
  "id": "646df1c9173a4a2fcac180b4",
  "name": "aws-source",
  "type": "aws",
  "created_at": "2023-05-24T11:15:21.624Z",
  "updated_at": "2024-01-24T11:24:16.003Z",
  "video_protection": {
    "signed_url": true,
    "signed_url_secret": "87a2e2fbb2318f902b882c532bc703a8"
  },
  "player_config": {
    "player_color": "#6658ea",
    "include_seo": true,
    "logo_width": 100,
    "logo_height": 100,
    "watermark_font_size": 20,
    "watermark_font_color": "#ff0000",
    "watermark_bg_color": "transparent",
    "watermark_interval": 1000
  },
  "default_profile_id": "646df1c9173a4a2fcac180b7",
  "insight_property_id": "646df0aa173a4a2fcac18009",
  "aws": {
    "bucket_name": "my-bucket-test",
    "bucket_region": "ap-southeast-1",
    "access_key": "BQUA6QFXVWHAAB6IO2X1",
    "secret": "****************"
  },
  "embed_details": {
    "logo_width": 100,
    "logo_height": 100,
    "player_color": "#6658ea",
    "is_seo": true,
    "watermark_font_size": 20,
    "watermark_font_color": "#ff0000",
    "watermark_bg_color": "transparent",
    "watermark_interval": 1000
  },
  "folders": [
    "folder"
  ],
  "channel_settings": {
    "title": "myTitle",
    "description": "desc",
    "privacy_type": "private",
    "custom_logo": true,
    "logo_url": "https://dev-video.gumlet.io/626d21c3473a4a2faac180b4/channel/logo.png",
    "cname": [
      "okj.com"
    ],
    "temp_cname": [
      "okj.com"
    ]
  }
}