Versions Compared

Old Version 1

changes.mady.by.user Ramya Raman (Unlicensed)

Saved on

compared with

New Version 2

changes.mady.by.user Ramya Raman (Unlicensed)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

GET kms/config

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns a list of all KMS in the system, with its main configuration data.

Resource URL

https://{{ip_address}}:{{port}}/api/{{version}}/kms/config

Example Request

GET 

  1. https://192.168.010.2253/api/5.01/kms/config

Code Block
languagejson
{
    "data": [
        {
            "uuid": "c3060b163fad1318-493f58f0-45284023-aaf69967-8a86a429e6c849dd3eb38308",
            "label": "kms_simatd",
            "created": "20212023-0908-21T0624T12:0124:0053.489Z674Z",
            "modified": "20212023-0908-21T0624T12:0124:0053.489Z674Z",
            "kms_type": "SimulcryptATD-C",
            "attributes": {
                "networkhost_url": "c39393d6-3826-4e2f-9e8e-08e2c25e99a2"https://udrmv3.kaltura.com/cenc/widevine/encryption",
            }    "cpix_certificate": null,
   },            {
  "use_cpix_encryption": false,
          "uuid": "bc58cdd7-ae42-4e17-b04b-821f77ec54f4"      "tls_certificate": null,
                "labeloptions": "kms_sky",null,
                "createdasset_ids": "2021-09-21T05:55:09.080Z"[],
                "modifiednetwork": "2021-09-21T05:55:09.080Z",f74cc09c-5ad0-4cf1-ae30-e8911fe7362d",
                "kmsdownload_typerate": "SKY, CKSDisabled",
            "attributes    "tls_private_key_set": {false,
                "host_url": "https://sky.in",cpix_private_key_set": false
            }
       "username": null},
        {
            "passworduuid": null"560360b0-8e2c-46c6-978b-dc62098c979d",
                "download_rate"label": 30,
  "sim1",
             "networkcreated": "bbfd98b12023-f141-41e2-90d7-83771d10b2a404-13T11:08:38.310Z",
            "modified": "2023-04-13T11:08:38.310Z",
  "asset_ids": [          "kms_type": "Simulcrypt",
            "a1attributes",: {
                "network":   "a2"2a62e295-f305-4d98-b6bb-237467f2221d"
            }
   ]     }
    ],
  }  "metadata": {
     },   "item_count": 2,
    {    "total_items": 2,
        "uuidcurrent_page": "31e6df2f-ee8b-4169-bd3b-fb45048631de"1,
        "sort_by": [
  "label": "kms_vmx",          {
  "created": "2021-09-21T05:56:41.386Z",             "modifiedlabel": "2021-09-21T05:56:54.914Z",ASC"
            "kms_type": "Verimatrix, VMX",}
        ],
        "attributeslinks": {
   
            "source_url_tokencurrent": null,
                "replace_url_token": null,"http://192.168.10.53/api/5.1/kms/config"
        }
        "network": "bbfd98b1-f141-41e2-90d7-83771d10b2a4"
            }
        }
    ],
    "metadata": {
        "item_count": 3,
        "total_items": 3,
        "current_page": 1,
        "sort_by": [
            {
       }
}

GET kms/config/{uuid}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns an extended single KMS configuration view, specified by the required {uuid} parameter.

Resource URL

https://{{ip_address}}:{{port}}/api/{{version}}/kms/config/{{uuid}}

Parameters

Parameter

Data Type

Description

uuid
(required)

string

The UUID of the desired encoder.

Example Request

GET 

  1. https://192.168.10.53/api/5.0/kms/config/3fad1318-58f0-4023-9967-49dd3eb38308

Code Block
languagejson
{
    "data": {
        "fielduuid": "label3fad1318-58f0-4023-9967-49dd3eb38308",
        "label": "atd",
        "directioncreated": "ASC"2023-08-24T12:24:53.674Z",
        "modified": "2023-08-24T12:24:53.674Z",
  }         ]"kms_type": "CPIX",
        "linksattributes": {
            "currenthost_url": "https://192udrmv3.168kaltura.0.22com/apicenc/5.0/kms/config"widevine/encryption",
           } "certificate": null,
            }
}

GET kms/config/{uuid}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns an extended single KMS configuration view, specified by the required {uuid} parameter.

Resource URL

https://{{ip_address}}:{{port}}/api/{{version}}/kms/config/{{uuid}}

Parameters

Parameter

Data Type

Description

uuid
(required)

string

The UUID of the desired encoder.

Example Request

GET 

https://192.168.0.22/api/
"options": null,
            "asset_ids": [],
            "network": "f74cc09c-5ad0-4cf1-ae30-e8911fe7362d",
            "download_rate": "Disabled"
        }
    },
    "metadata": {}
}

GET kms/config/meta

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns all meta data used by KMS configuration.

Resource URL

https://{{ip_address}}:{{port}}/api/{{version}}/kms/config/meta

Example Request

GET 

  1. https://192.168.0.22/api/5.0/kms/config/c3060b16-493f-4528-aaf6-8a86a429e6c8meta

Code Block
languagejson
{
    "dataKmsTypes": [
        {
"Simulcrypt",
           "uuid": "c3060b16-493f-4528-aaf6-8a86a429e6c8""Huawei PlayReady",
            "label": "kms_sim""Verimatrix, VMX",
        "Verimatrix, MultiRights",
  "created": "2021-09-21T06:01:00.489Z",     "SKY, CKS",
       "modified": "2021-09-21T06:01:00.489ZIrdeto",
        "ATD-C",
   "kms_type": "Simulcrypt",    "BISS-2",
        "attributesSynMedia":,
{        "Axinom",
        "networkStatic": "c39393d6-3826-4e2f-9e8e-08e2c25e99a2",
        "Kaltura UDRM",
   }     "BuyDRM",
   }     ]"M7",
     "metadata": {}   "WBD-XH"
    ]
}

GET

DELETE kms/config/

meta

{uuid}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns all meta data used by

DELETE

Delete a specific KMS configuration.

Resource URL

https://{{ip_address}}:{{port}}/api/{{version}}/kms/config/meta{{uuid}}

Parameters

Parameter

Data Type

Description

uuid
(required)

string

The UUID of the output to be deleted.

Example Request

GETDELETE 

  1. https://192.168.010.2253/api/5.0/kms/config/meta

Code Block
languagejson
{
    "KmsTypes": [
        "Simulcrypt",
        "Huawei PlayReady",
        "Verimatrix, VMX",
        "Verimatrix, MultiRights",
        "SKY, CKS",
        "Irdeto",
        "CPIX",
        "BISS-2",
        "SynMedia",
        "Axinom"
    ]
}

DELETE kms/config/{uuid}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

DELETE

Delete a specific KMS configuration.

Resource URL

https://{{ip_address}}:{{port}}/api/{{version}}/kms/config/{{uuid}}

Parameters

Parameter

Data Type

Description

uuid
(required)

string

The UUID of the output to be deleted.

Example Request

DELETE 

  1. https://192.168.0.22/api/5.0/kms/config/c3060b16-493f-4528-aaf6-8a86a429e6c8

Code Block
languagejson
{
    "data": [
        {
            "success": true
        }
    ],
    "metadata": {}
}

 

PUT kms/config/{uuid}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

PUT

Edit a KMS configuration.

Resource URL

https://{{ip_address}}:{{port}}/api/{{version}}/kms/config/{{uuid}}

Parameters

Parameter

Data Type

Description

uuid
(required)

byte

The UUID of the encoder to be edited.

Example Request

PUT 

  1. https://192.168.0.22/api/5.0/kms/config/bc58cdd7-ae42-4e17-b04b-821f77ec54f4

Body

Code Block
languagejson
{ "uuid": "bc58cdd7-ae42-4e17-b04b-821f77ec54f4", "label": "kms_sky_edited", "created": "2021-09-21T05:55:09.080Z", "modified": "2021-09-21T05:55:09.080Z", "kms_type": "SKY, CKS", "attributes": { "host_url": "https://sky.in", "username": null, "password": null, "download_rate": 30, "network": "bbfd98b1-f141-41e2-90d7-83771d10b2a4", "asset_ids

  1. kms/config/c3060b16-493f-4528-aaf6-8a86a429e6c8

Code Block
languagejson
{
    "data": [
               {
    "a1",                     "a2"
"success": true
        }
      ]
            }],
    "metadata":    }

Response

Code Block
languagejson
{
    "data": [
        {
            "uuid": "bc58cdd7-ae42-4e17-b04b-821f77ec54f4",
            "label": "kms_sky_edited",
            "created": "2021-09-21T05:55:09.080Z",
       {}
}

 

PUT kms/config/{uuid}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

PUT

Edit a KMS configuration.

Resource URL

https://{{ip_address}}:{{port}}/api/{{version}}/kms/config/{{uuid}}

Parameters

Parameter

Data Type

Description

uuid
(required)

byte

The UUID of the encoder to be edited.

Example Request

PUT 

  1. https://192.168.0.22/api/5.1/kms/config/07df0acc-d48a-487f-ab90-1a1d7bbf0f74

Body

Code Block
languagejson
{
    "modifieddata": "2021-09-21T06:08:39.907Z",{
            "kms_type"label": "SKY, CKSVMX_edited",
  
         "attributeskms_type": {
                "host_url": "https://sky.in",
       "Verimatrix, VMX",
        "username": null,
   attributes": {
            "passwordnetwork": null,"2a62e295-f305-4d98-b6bb-237467f2221d"
        }
    }
}

Response

Code Block
languagejson
{
    "download_ratedata": 30,
       {
        "networkuuid": "bbfd98b107df0acc-f141d48a-41e2487f-90d7ab90-83771d10b2a41a1d7bbf0f74",
        "label": "VMX_edited",
        "asset_idscreated": ["2023-08-27T06:17:33.952Z",
        "modified": "2023-08-27T06:41:55.224Z",
        "kms_type": "Verimatrix, VMX"a1",
        "attributes": {
            "a2source_url_token": null,
            "replace_url_token": null,
 ]           "network":  }"2a62e295-f305-4d98-b6bb-237467f2221d"
         }
    ]},
    "metadata": {}
}

POST kms/config

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

POST

Add a new KMS, configured according to the attached data request.

Resource URL

https://{{ip_address}}:{{port}}/api/{{version}}/kms/config

Example Request

POST 

  1. https://192.168.010.2253/api/5.01/kms/config

Body

Code Block
languagejson
{
    "label": "VMX Test I",
    "kms_type": "Verimatrix, VMX",
    "attributes": {
        "source_url_token": "source",
        "replace_url_token": "replacment",
        "network": "bbfd98b1-f141-41e2-90d7-83771d10b2a4"
    }
}

Response

Code Block
languagejson
{
    "data": [
        {
            "uuid": "ef33ea37-73c2-4920-af2b-f5406f36e208",
            "label": "VMX Test I",
            "created": "2021-09-21T06:11:14.678Z",
            "modified": "2021-09-21T06:11:14.678Z",
            "kms_type": "Verimatrix, VMX",
            "attributes": {
                "source_url_token": "source",
                "replace_url_token": "replacment",
                "network": "bbfd98b1-f141-41e2-90d7-83771d10b2a4"
            }
        }
    ],
    "metadata": {}
}

POST kms/config multi

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

POST

Add multiple KMS, configured according to the attached data request.

Resource URL

https://{{ip_address}}:{{port}}/api/{{version}}/kms/config

Example Request

POST 

  1. https://192.168.0.22/api/5.01/kms/config

Body

Code Block
languagejson
{
    "data": [
        {
    "label": "VMX_multi_test1",
    "kms_type": "Verimatrix, VMX",
    "attributes": {
        "source_url_token": "source",
        "replace_url_token": "replacment",
        "network": "2a62e295-f305-4d98-b6bb-237467f2221d"
    }
},
{
    "label": "VMX_multi_test2",
    "kms_type": "Verimatrix, VMX",
    "attributes": {
        "source_url_token": "source",
        "replace_url_token": "replacment",
        "network": "2a62e295-f305-4d98-b6bb-237467f2221d"
    }
}
    ]
}

Response

Code Block
languagejson
{
    "data": [
        {
            "uuid": "18e2ab24-ebb7-4ba5-b6e0-33d1ad2eee53",
            "label": "VMX_multi_test1",
            "created": "2022-03-03T08:23:16.786Z",
            "modified": "2022-03-03T08:23:16.786Z",
            "kms_type": "Verimatrix, VMX",
            "attributes": {
                "source_url_token": "source",
                "replace_url_token": "replacment",
                "network": "2a62e295-f305-4d98-b6bb-237467f2221d"
            }
        },
        {
            "uuid": "c90c9bbd-f64c-4913-9710-8d6cdd171a3c",
            "label": "VMX_multi_test2",
            "created": "2022-03-03T08:23:16.786Z",
            "modified": "2022-03-03T08:23:16.786Z",
            "kms_type": "Verimatrix, VMX",
            "attributes": {
                "source_url_token": "source",
                "replace_url_token": "replacment",
                "network": "2a62e295-f305-4d98-b6bb-237467f2221d"
            }
        }
    ],
    "metadata": {}
}

PUT kms/config multi

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

PUT

Edit multiple KMS, configured according to the attached data request.

Resource URL

https://{{ip_address}}:{{port}}/api/{{version}}/kms/config

Example Request

PUT 

  1. https://192.168.0.22/api/5.01/kms/config

Body

Code Block
languagejson
{
    "data": [
        {
            "uuid": "05d6ebc8-b599-4f7c-8875-1ff7ce06ddf7",
            "label": "VMX_multi_test1_edited",
            "kms_type": "Verimatrix, VMX",
            "attributes": {
                "source_url_token": "source",
                "replace_url_token": "replacment",
                "network": "2a62e295-f305-4d98-b6bb-237467f2221d"
            }
        },
        {
            "uuid": "fbcc8f28-d939-430a-8679-f9c6b40c7308",
            "label": "VMX_multi_test2_edited",
            "kms_type": "Verimatrix, VMX",
            "attributes": {
                "source_url_token": "source",
                "replace_url_token": "replacment",
                "network": "2a62e295-f305-4d98-b6bb-237467f2221d"
            }
        }
    ]
}

Response

Code Block
languagejson
{
    "data": [
        {
            "uuid": "05d6ebc8-b599-4f7c-8875-1ff7ce06ddf7",
            "label": "VMX_multi_test1_edited",
            "created": "2022-02-23T11:11:33.397Z",
            "modified": "2022-02-23T11:15:19.401Z",
            "kms_type": "Verimatrix, VMX",
            "attributes": {
                "source_url_token": "source",
                "replace_url_token": "replacment",
                "network": "2a62e295-f305-4d98-b6bb-237467f2221d"
            }
        },
        {
            "uuid": "fbcc8f28-d939-430a-8679-f9c6b40c7308",
            "label": "VMX_multi_test2_edited",
            "created": "2022-02-23T11:11:33.397Z",
            "modified": "2022-02-23T11:15:19.401Z",
            "kms_type": "Verimatrix, VMX",
            "attributes": {
                "source_url_token": "source",
                "replace_url_token": "replacment",
                "network": "2a62e295-f305-4d98-b6bb-237467f2221d"
            }
        }
    ],
    "metadata": {}
}

DELETE kms/config multi

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

DELETE

Delete multiple KMS configuration.

Resource URL

https://{{ip_address}}:{{port}}/api/{{version}}/kms/config/{{uuid}}

Example Request

DELETE 

  1. https://192.168.0.22/api/5.01/kms/config

Body

Code Block
languagejson
{
    "data": [
        "05d6ebc8-b599-4f7c-8875-1ff7ce06ddf7",
        "fbcc8f28-d939-430a-8679-f9c6b40c7308"
    ]
}

Response

Code Block
languagejson
{
    "data": {
        "success": true
    },
    "metadata": {}
}