KMS API

GET kms

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	GET

Returns a list of KMS configurations.

Resource URL

http://{host}/api/2.0/kms/config/.format

Example Request

GET

http://192.168.10.132/api/2.0/kms/config/.json

[
    {
        "KeyManagerServer": {
            "id": 3,
            "title": "play",
            "key_manager_type_id": 3,
            "modified": "1662983515505",
            "created": "1662983513993",
            "manifest_url": null,
            "server_url": null,
            "network_id": 1
        }
    },
    {
        "KeyManagerServer": {
            "id": 4,
            "title": "sim",
            "key_manager_type_id": 1,
            "modified": "1662983513995",
            "created": "1662983513995",
            "network_id": 1
        }
    },
    {
        "KeyManagerServer": {
            "id": 5,
            "title": "syn",
            "key_manager_type_id": 10,
            "modified": "1662983515505",
            "created": "1662983513997",
            "server_url": "https://synmedia.in",
            "asset_ids": "a1,a2",
            "network_id": 1,
            "download_rate": 30
        }
    }
]

GET kms/{id}

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	GET

Returns a single KMS configuration.

Resource URL

http://{host}/api/2.0/kms/config/{id}/.format

Parameters

Parameter	Data Type	Description
id (required)	integer	The ID of the desired KMS configuration.

Example Request

GET

http://192.168.10.132/api/2.0/kms/config/3/.json

{
    "KeyManagerServer": {
        "id": 3,
        "title": "play",
        "key_manager_type_id": 3,
        "modified": "1662983515505",
        "created": "1662983513993",
        "manifest_url": null,
        "server_url": null,
        "network_id": 1
    }
}

POST kms

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	POST

Adds a new KMS.

Resource URL

http://{host}/api/2.0/kms/config/.format

Example Request

POST

http://192.168.10.132/api/2.0/kms/config/.json

Body

{
    "KeyManagerServer": {
        "title": "sim_2",
        "key_manager_type_id": 1,
        "network_id": 1
    }
}

Response

{
    "KeyManagerServer": {
        "id": 1,
        "title": "sim_2",
        "key_manager_type_id": 1,
        "modified": "1664363654499",
        "created": "1664363654499",
        "network_id": 1
    }
}

PUT kms/{id}

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	PUT

Updates an existing KMS configuration.

Resource URL

http://{host}/api/2.0/kms/config/{id}/.format

Parameters

Parameter	Data Type	Description
id (required)	integer	The ID of the desired KMS to be updated.

Example Request

PUT

http://192.168.10.132/api/2.0/kms/config/1/.json

Body

{
    "KeyManagerServer": {
        "id": 1,
        "title": "sim_2_ed",
        "key_manager_type_id": 1,
        "modified": "1664371585658",
        "created": "1664371585658",
        "network_id": 1
    }
}

Response

{
    "KeyManagerServer": {
        "id": 1,
        "title": "sim_2_ed",
        "key_manager_type_id": 1,
        "modified": "1664377683935",
        "created": "1664377679037",
        "network_id": 1
    }
}

DELETE kms/{id}

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	DELETE

Deletes an existing Display Agent.

Resource URL

http://{host}/api/2.0/kms/{id}/.format

Parameters

Parameter	Data Type	Description
id (required)	integer	The ID of the desired KMS configuration to be deleted.

Example Request

DELETE

http://192.168.10.132/api/2.0/kms/config/3/.json

{
    "success": true
}