API docs by Redocly

APIFlask (0.1.0)

Download OpenAPI specification:Download

URL: https://m2amedia.tv/docs License: MIT

Template service to simplify the way we define configuration for services such M2A Live or M2A Packager

It should provide flexibility to use all available AWS media services features such as media live with NO code changes

Service will allow you to upload and render jinja templates. The jinja and rendered templates will be stored and accessible by the api.

Template API

Template service to simplify the way we define configuration for services such M2A Live or M2A Packager

It should provide flexibility to use all available AWS media services features such as media live with NO code changes

Service will allow you to upload and render jinja templates. The jinja and rendered templates will be stored and accessible by the api.

Retrieve a list of all templates of an owner

This API will allow user to get a list of templates of an owner

Authorizations:
BearerAuth
query Parameters
owner
required
string <uuid>
Example: owner=7845419f-ca72-4cb1-b769-1bed5d8700b0

Target account ID

filter[last_modified]
string <date-time>
Example: filter[last_modified]=2023-06-14T14:00:00.000+00:00

"A datetime to filter the result. The result will contain templates updated at/after this datetime

header Parameters
Accept
required
string
Example: application/vnd.api+json

Content type (expressed as MIME types)the client is able to understand.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "links": {
    },
  • "data": [
    ]
}

Store details of a template

POST Template API will allow user to create a template.

Authorizations:
BearerAuth
header Parameters
Accept
required
string
Example: application/vnd.api+json

Content type (expressed as MIME types)the client is able to understand.

Request Body schema: application/json
required
object

description of a template

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Render a template

POST Render Template API will allow user to render a template.

Authorizations:
BearerAuth
header Parameters
Accept
required
string
Example: application/vnd.api+json

Content type (expressed as MIME types)the client is able to understand.

Request Body schema: application/json
required
object

Details of a rendered template

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Retrieve details of a template by ID

GET Template API will allow user to get a specific template by it's ID

Authorizations:
BearerAuth
path Parameters
template_id
required
string
query Parameters
owner
required
string <uuid>
Example: owner=7845419f-ca72-4cb1-b769-1bed5d8700b0

Target account ID

header Parameters
Accept
required
string
Example: application/vnd.api+json

Content type (expressed as MIME types)the client is able to understand.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Delete a template by ID

Delete Template API will allow user to remove/delete a specific template by it's ID

Authorizations:
BearerAuth
path Parameters
template_id
required
string
query Parameters
owner
required
string <uuid>
Example: owner=7845419f-ca72-4cb1-b769-1bed5d8700b0

Target account ID

header Parameters
Accept
required
string
Example: application/vnd.api+json

Content type (expressed as MIME types)the client is able to understand.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "errors": [
    ]
}

Retrieve details of a rendered template by ID

GET Render Template API will allow user to get a specific rendered template by it's ID

Authorizations:
BearerAuth
path Parameters
rendered_template_id
required
string
query Parameters
owner
required
string <uuid>
Example: owner=7845419f-ca72-4cb1-b769-1bed5d8700b0

Target account ID

header Parameters
Accept
required
string
Example: application/vnd.api+json

Content type (expressed as MIME types)the client is able to understand.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Retrieve details of a template by name

GET Template API will allow user to get a specific template by it's NAME

Authorizations:
BearerAuth
path Parameters
template_name
required
string
query Parameters
owner
required
string <uuid>
Example: owner=7845419f-ca72-4cb1-b769-1bed5d8700b0

Target account ID

header Parameters
Accept
required
string
Example: application/vnd.api+json

Content type (expressed as MIME types)the client is able to understand.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}