Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
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
| Code Block | ||
|---|---|---|
| ||
{
"data": [
{
"uuid": "c3060b16-493f-4528-aaf6-8a86a429e6c8",
"label": "kms_sim",
"created": "2021-09-21T06:01:00.489Z",
"modified": "2021-09-21T06:01:00.489Z",
"kms_type": "Simulcrypt",
"attributes": {
"network": "c39393d6-3826-4e2f-9e8e-08e2c25e99a2"
}
},
{
"uuid": "bc58cdd7-ae42-4e17-b04b-821f77ec54f4",
"label": "kms_sky",
"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": [
"a1",
"a2"
]
}
},
{
"uuid": "31e6df2f-ee8b-4169-bd3b-fb45048631de",
"label": "kms_vmx",
"created": "2021-09-21T05:56:41.386Z",
"modified": "2021-09-21T05:56:54.914Z",
"kms_type": "Verimatrix, VMX",
"attributes": {
"source_url_token": null,
"replace_url_token": null,
"network": "bbfd98b1-f141-41e2-90d7-83771d10b2a4"
}
}
],
"metadata": {
"item_count": 3,
"total_items": 3,
"current_page": 1,
"sort_by": [
{
"field": "label",
"direction": "ASC"
}
],
"links": {
"current": "https://192.168.0.22/api/5.0/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
| Code Block | ||
|---|---|---|
| ||
{
"data": [
{
"uuid": "c3060b16-493f-4528-aaf6-8a86a429e6c8",
"label": "kms_sim",
"created": "2021-09-21T06:01:00.489Z",
"modified": "2021-09-21T06:01:00.489Z",
"kms_type": "Simulcrypt",
"attributes": {
"network": "c39393d6-3826-4e2f-9e8e-08e2c25e99a2"
}
}
],
"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
| Code Block | ||
|---|---|---|
| ||
{
"KmsTypes": [
"Simulcrypt",
"Huawei PlayReady",
"Verimatrix, VMX",
"Verimatrix, MultiRights",
"SKY, CKS",
"Irdeto",
"CPIX",
"BISS-2",
"SynMedia",
"Axinom"
]
} |
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
| Code Block | ||
|---|---|---|
| ||
{
"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
| Code Block | ||
|---|---|---|
| ||
{
"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": [
"a1",
"a2"
]
}
} |
Response
| Code Block | ||
|---|---|---|
| ||
{
"data": [
{
"uuid": "bc58cdd7-ae42-4e17-b04b-821f77ec54f4",
"label": "kms_sky_edited",
"created": "2021-09-21T05:55:09.080Z",
"modified": "2021-09-21T06:08:39.907Z",
"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": [
"a1",
"a2"
]
}
}
],
"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
| Code Block | ||
|---|---|---|
| ||
{
"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 | ||
|---|---|---|
| ||
{
"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
| Code Block | ||
|---|---|---|
| ||
{
"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 | ||
|---|---|---|
| ||
{
"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
| Code Block | ||
|---|---|---|
| ||
{
"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 | ||
|---|---|---|
| ||
{
"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 a specific multiple KMS configuration.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/kms/config/{{uuid}}
Example Request
DELETE
Body
| Code Block | ||
|---|---|---|
| ||
{
"data": [
"05d6ebc8-b599-4f7c-8875-1ff7ce06ddf7",
"fbcc8f28-d939-430a-8679-f9c6b40c7308"
]
} |
Response
| Code Block | ||
|---|---|---|
| ||
{
"data": {
"success": true
},
"metadata": {}
} |