Page Comparison

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

https://192.168.0.22/api/5.0/kms/config

Code Block

language	json

{
    "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?	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)	bytestring	The UUID of the desired encoder.

Example Request

GET

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

Code Block

language	json

{
    "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?	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

https://192.168.0.22/api/5.0/kms/config/meta

Code Block

language	json

{
    "KmsTypes": [
        "Simulcrypt",
        "Huawei PlayReady",
        "Verimatrix, VMX",
        "Generic",
        "Verimatrix, MultiRights",
        "SKY, CKS",
        "Irdeto"
    ]
}

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)	bytestring	The UUID of the output to be deleted.

Example Request

DELETE

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

Code Block

language	json

{
    "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

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

Body

Code Block

language	json

        {
            "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

language	json

{
    "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": {}
}

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

https://192.168.0.22/api/5.0/kms/config

Body

Code Block

language	json

{
    "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

language	json

{
    "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": {}
}

Versions Compared

Old Version 2

New Version 3

Key

GET kms/config

Resource Information

Resource URL

Example Request

GET kms/config/{uuid}

Resource Information

Resource URL

Parameters

Example Request

GET kms/config/meta

Resource Information

Resource URL

Example Request

DELETE kms/config/{uuid}

Resource Information

Resource URL

Parameters

Example Request

PUT kms/config/{uuid}

Resource Information

Resource URL

Parameters

Example Request

POST kms/config

Resource Information

Resource URL

Example Request