Documentation Powered by ReDoc

services-amagi-tv API

Download OpenAPI specification:Download

E-mail: suvrojyoti@amagi.com

The purpose of this application is to provide documentation of the APIs in services-amagi-tv

Authentication

access-key

Security Scheme Type API Key
Header parameter name: access_key

secret-key

Security Scheme Type API Key
Header parameter name: secret_key

Creates a new customer, requires admin access_key and secret_key

Authorizations:
access-keysecret-key
Request Body schema: application/json
user
string

Customer Name

Responses

Request samples

Content type
application/json
{
  • "user": "CUSTOMER-NAME"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": null
}

Deletes a customer, requires admin access_key and secret_key

Authorizations:
access-keysecret-key
Request Body schema: application/json
user
string

Customer Name

Responses

Request samples

Content type
application/json
{
  • "user": "CUSTOMER-NAME"
}

Response samples

Content type
application/json
{
  • "data": "CUSTOMER-NAME is deleted",
  • "error": null
}

Sets key with provided value, requires user access_key and secret_key

Authorizations:
access-keysecret-key
Request Body schema: application/json
key
required
string

key where data needs to be written

data
required
string

data that the customer wants to write

Responses

Request samples

Content type
application/json
{
  • "key": "CUSTOMER-NAME/FEED/fileconfig.txt",
  • "data": "example configuration"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": null
}

Lists all keys having common prefix-key, requires user access_key and secret_key

Authorizations:
access-keysecret-key
query Parameters
key_prefix
required
string

Key Prefix

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "error": null
}

Gets value of a key

Authorizations:
access-keysecret-key
query Parameters
key
required
string

Key of the Object

Responses

Response samples

Content type
application/json
{
  • "data": "{Contents of the Key}",
  • "error": null
}

Get metadata of the key

Authorizations:
access-keysecret-key
query Parameters
key
required
string

Key of the Object

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "error": null
}

List versions of the key

Authorizations:
access-keysecret-key
query Parameters
key
required
string

Key of the Object

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "error": null
}