Channels

Add a delivery target

POST
/v1/channels/{id}/delivery-targets

Formats: xmltv, schedule_json, playlist_json, transmission_xml, transmission_csv, transmission_json. A push target needs an https endpointUrl (private and internal addresses are refused) and answers with its signingSecret once — every delivery carries x-ingenee-signature: sha256=<HMAC-SHA256 of the body>. An sftp target takes endpointUrl sftp://host[:port]/folder/ (or a full file path), username and credential (a password or a private key), and optionally hostKeySha256. An s3 target takes s3://bucket/prefix/[?region=…], username (access key id) and credential (secret access key). A folder address gets a new timestamped file per delivery.

Scope: channels:write

Authorization

apiKey
headerAuthorizationBearer <ik_live_…>

An organisation API key from Settings → Organisation → API keys. Each operation names the one scope it needs — see https://developer.ingenee.ai/docs/authentication.

Path Parameters

id*string

Header Parameters

Idempotency-Key?string

Any unique string. A retry with the same key and the same request gets the first answer back instead of running twice (kept 24 hours).

Lengthlength <= 255

Request Body

application/json
  1. body
name*string
Length1 <= length <= 80
partnerKey?string
Default"custom"
Value in"custom""roku_dpf""samsung_tvplus""jsonld""lg""vizio""pluto""xumo""amazon""plex"
format*string
Value in"xmltv""schedule_json""playlist_json""transmission_xml""transmission_csv""transmission_json"
method*string
Value in"pull""https_push""sftp""s3"
endpointUrl?string
Formaturi
Lengthlength <= 2000
Defaultnull
authHeaderName?string
Match^[A-Za-z0-9-]+$
Lengthlength <= 60
Defaultnull
authValue?string
Length1 <= length <= 2000
Defaultnull
trigger?string
Default"on_publish"
Value in"on_publish""manual"
enabled?boolean
Defaulttrue
username?string
Length1 <= length <= 200
Defaultnull
credential?string
Length1 <= length <= 16000
Defaultnull
hostKeySha256?string
Match^SHA256:[A-Za-z0-9+/]{43}=?$
Defaultnull

Response Body

OK

application/json
  1. response
[key: string]?any
Example Request
curl -X POST 'https://dev.app.ingenee.ai/api/v1/channels/string/delivery-targets' \  -H 'Content-Type: application/json' \  -d '{  "name": "string",  "format": "xmltv",  "method": "pull"}'
Example Response
{}