Get Channel Details

Request details of one or more channels such as available datetime ranges, download filetype, and the size of data available. Channel data is always in motion so the details represent a moving window of data available for download.

post/siebatchd/v1/siebatch/chdetails

Request

Base URL
https://batch.sie-remote.net
Auth
none required
TypeScript
https://skmtc.dev/domaintools/apis/sie-batch-rest-api/docs/siebatchd/v1/siebatch/chdetails/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

apikeystring password required

Your Farsight SIE Batch API Key (UUID format)

channelsinteger[] required

List of one or more channel numbers (integers). Valid channels are 1-255.

Example request

{
  "apikey": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "channels": [
    212,
    213
  ]
}

Response

Channel details returned successfully.

channelsobject

Dictionary of channel objects keyed by channel name (e.g. "ch212").

_status'OK'

_messagestring

Changes

No recorded changes to this operation across all 1 revision of this API.