- Created by Ramya Raman (Unlicensed), last modified on Aug 27, 2023
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 2 Current »
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
{
"data": [
{
"uuid": "3fad1318-58f0-4023-9967-49dd3eb38308",
"label": "atd",
"created": "2023-08-24T12:24:53.674Z",
"modified": "2023-08-24T12:24:53.674Z",
"kms_type": "ATD-C",
"attributes": {
"host_url": "https://udrmv3.kaltura.com/cenc/widevine/encryption",
"cpix_certificate": null,
"use_cpix_encryption": false,
"tls_certificate": null,
"options": null,
"asset_ids": [],
"network": "f74cc09c-5ad0-4cf1-ae30-e8911fe7362d",
"download_rate": "Disabled",
"tls_private_key_set": false,
"cpix_private_key_set": false
}
},
{
"uuid": "560360b0-8e2c-46c6-978b-dc62098c979d",
"label": "sim1",
"created": "2023-04-13T11:08:38.310Z",
"modified": "2023-04-13T11:08:38.310Z",
"kms_type": "Simulcrypt",
"attributes": {
"network": "2a62e295-f305-4d98-b6bb-237467f2221d"
}
}
],
"metadata": {
"item_count": 2,
"total_items": 2,
"current_page": 1,
"sort_by": [
{
"label": "ASC"
}
],
"links": {
"current": "http://192.168.10.53/api/5.1/kms/config"
}
}
}
GET kms/config/{uuid}
Resource Information
Requires Authentication? | |
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 | string | The UUID of the desired encoder. |
Example Request
GET
{
"data": {
"uuid": "3fad1318-58f0-4023-9967-49dd3eb38308",
"label": "atd",
"created": "2023-08-24T12:24:53.674Z",
"modified": "2023-08-24T12:24:53.674Z",
"kms_type": "CPIX",
"attributes": {
"host_url": "https://udrmv3.kaltura.com/cenc/widevine/encryption",
"certificate": null,
"options": null,
"asset_ids": [],
"network": "f74cc09c-5ad0-4cf1-ae30-e8911fe7362d",
"download_rate": "Disabled"
}
},
"metadata": {}
}
GET kms/config/meta
Resource Information
Requires Authentication? | |
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
{
"KmsTypes": [
"Simulcrypt",
"Huawei PlayReady",
"Verimatrix, VMX",
"Verimatrix, MultiRights",
"SKY, CKS",
"Irdeto",
"ATD-C",
"BISS-2",
"SynMedia",
"Axinom",
"Static",
"Kaltura UDRM",
"BuyDRM",
"M7",
"WBD-XH"
]
}
DELETE kms/config/{uuid}
Resource Information
Requires Authentication? | |
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 | string | The UUID of the output to be deleted. |
Example Request
DELETE
{
"data": [
{
"success": true
}
],
"metadata": {}
}
PUT kms/config/{uuid}
Resource Information
Requires Authentication? | |
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 | byte | The UUID of the encoder to be edited. |
Example Request
PUT
Body
{
"data": {
"label": "VMX_edited",
"kms_type": "Verimatrix, VMX",
"attributes": {
"network": "2a62e295-f305-4d98-b6bb-237467f2221d"
}
}
}
Response
{
"data": {
"uuid": "07df0acc-d48a-487f-ab90-1a1d7bbf0f74",
"label": "VMX_edited",
"created": "2023-08-27T06:17:33.952Z",
"modified": "2023-08-27T06:41:55.224Z",
"kms_type": "Verimatrix, VMX",
"attributes": {
"source_url_token": null,
"replace_url_token": null,
"network": "2a62e295-f305-4d98-b6bb-237467f2221d"
}
},
"metadata": {}
}
Add a new KMS, configured according to the attached data request.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/kms/config
Example Request
POST
Body
{
"label": "VMX Test I",
"kms_type": "Verimatrix, VMX",
"attributes": {
"source_url_token": "source",
"replace_url_token": "replacment",
"network": "bbfd98b1-f141-41e2-90d7-83771d10b2a4"
}
}
Response
{
"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? | |
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
Body
{
"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
{
"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? | |
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
Body
{
"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
{
"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? | |
Response Formats | json |
HTTP Methods | DELETE |
Delete multiple KMS configuration.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/kms/config/{{uuid}}
Example Request
DELETE
Body
{
"data": [
"05d6ebc8-b599-4f7c-8875-1ff7ce06ddf7",
"fbcc8f28-d939-430a-8679-f9c6b40c7308"
]
}
Response
{
"data": {
"success": true
},
"metadata": {}
}
- No labels