API reference / Profiles

Profiles

Transcoding profiles served to the transcoder via the public, unauthenticated index.yml endpoint.

GET /api/v1/profiles/

List transcoding profiles (names for the picker, plus full items).

Response

Response 200 (application/json)
{
  "profiles": [
    "string"
  ],
  "items": [
    {
      "name": "string",
      "yaml": "string",
      "runnable": true,
      "createdAt": "string",
      "updatedAt": "string"
    }
  ]
}

POST /api/v1/profiles/

Create a transcoding profile from raw transcoder-format YAML.

Request

Request body (application/json)
{
  "name": "string",
  "yaml": "string"
}

Response

Response 201 (application/json)
{
  "name": "string",
  "yaml": "string",
  "runnable": true,
  "createdAt": "string",
  "updatedAt": "string"
}

POST /api/v1/profiles/bootstrap

Seed the profile store from the default transcoder test-profiles index. Pass `?force=true` to re-seed over existing profiles.

Parameters

NameInTypeRequired
forcequerybooleanoptional

Response

Response 200 (application/json)
{
  "seeded": 0,
  "skipped": true,
  "builtinSeeded": 0
}

GET /api/v1/profiles/index.yml

Public, unauthenticated profile index consumed by transcoder instances at transcode time.

Response

Response 200 (application/json)
"string"

GET /api/v1/profiles/{name}

Get a single profile.

Parameters

NameInTypeRequired
namepathstringrequired

Response

Response 200 (application/json)
{
  "name": "string",
  "yaml": "string",
  "runnable": true,
  "createdAt": "string",
  "updatedAt": "string"
}

PUT /api/v1/profiles/{name}

Replace a profile's YAML.

Parameters

NameInTypeRequired
namepathstringrequired

Request

Request body (application/json)
{
  "yaml": "string"
}

Response

Response 200 (application/json)
{
  "name": "string",
  "yaml": "string",
  "runnable": true,
  "createdAt": "string",
  "updatedAt": "string"
}

DELETE /api/v1/profiles/{name}

Delete a profile.

Parameters

NameInTypeRequired
namepathstringrequired

Response

Response 204 (application/json)
"null"

GET /api/v1/profiles/{name}/yaml

Get a profile's raw YAML body.

Parameters

NameInTypeRequired
namepathstringrequired

Response

Response 200 (application/json)
"string"