GET api/SatellitePlugins?verbose={verbose}

Request Information

URI Parameters

Name	Description	Type	Additional information
verbose		boolean	Default value is False

Body Parameters

None.

Response Information

Resource Description

Collection of SatellitePlugin

Name	Type	Additional information
SatellitePluginId	integer	None.
Name	string	Required String length: inclusive between 0 and 100
Description	string	Required String length: inclusive between 0 and 500
PluginId	integer	Required
Plugin	Plugin	None.
CyclePatternId	integer	None.
CyclePattern	CyclePattern	None.
SatelliteId	integer	Required
Satellite	Satellite	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "SatellitePluginId": 1,
    "Name": "sample string 2",
    "Description": "sample string 3",
    "PluginId": 4,
    "Plugin": {
      "PluginId": 1,
      "Name": "sample string 2",
      "ShortName": "sample string 3",
      "Path": "sample string 4",
      "IsLatestVersion": true,
      "AllowAutoUpdate": true,
      "IsExecutable": true,
      "PluginSettings": [
        {
          "PluginSettingId": 1,
          "PluginId": 2,
          "SettingId": 3,
          "IsRequired": true,
          "Setting": {
            "SettingId": 1,
            "Name": "sample string 2",
            "Key": "sample string 3",
            "Default": "sample string 4",
            "IsAdvanced": true
          }
        },
        {
          "PluginSettingId": 1,
          "PluginId": 2,
          "SettingId": 3,
          "IsRequired": true,
          "Setting": {
            "SettingId": 1,
            "Name": "sample string 2",
            "Key": "sample string 3",
            "Default": "sample string 4",
            "IsAdvanced": true
          }
        }
      ]
    },
    "CyclePatternId": 1,
    "CyclePattern": {
      "CyclePatternId": 1,
      "StartDate": "2026-03-05T02:41:07.4382982+00:00",
      "Recurrence": 3,
      "NextRunDate": "2026-03-05T02:41:07.4382982+00:00",
      "SingleRunDate": "2026-03-05T02:41:07.4382982+00:00",
      "RecurrencePatternId": 5,
      "RecurrencePattern": {
        "RecurrencePatternId": 1,
        "Name": "sample string 2",
        "Alias": "sample string 3",
        "Key": "sample string 4"
      },
      "WeekdayId": 6,
      "Weekday": {
        "WeekdayId": 1,
        "Name": "sample string 2",
        "Key": "sample string 3",
        "Number": 4
      },
      "DayOfMonth": 7
    },
    "SatelliteId": 5,
    "Satellite": {
      "SatelliteId": 1,
      "ClientId": 1,
      "URL": "sample string 2",
      "Name": "sample string 3",
      "IPAddress": "sample string 4",
      "Protocol": "sample string 5",
      "PortNumber": "sample string 6",
      "ServiceContract": "sample string 7",
      "StarshipId": 8,
      "UniqueId": "963caa39-5a44-4d71-8e78-7390411ba4df",
      "SerialNumber": "sample string 10",
      "MacAddress": "sample string 11",
      "WindowsKey": "sample string 12",
      "Active": true,
      "Latitude": 14.0,
      "Longitude": 15.0,
      "IsOnline": true
    }
  },
  {
    "SatellitePluginId": 1,
    "Name": "sample string 2",
    "Description": "sample string 3",
    "PluginId": 4,
    "Plugin": {
      "PluginId": 1,
      "Name": "sample string 2",
      "ShortName": "sample string 3",
      "Path": "sample string 4",
      "IsLatestVersion": true,
      "AllowAutoUpdate": true,
      "IsExecutable": true,
      "PluginSettings": [
        {
          "PluginSettingId": 1,
          "PluginId": 2,
          "SettingId": 3,
          "IsRequired": true,
          "Setting": {
            "SettingId": 1,
            "Name": "sample string 2",
            "Key": "sample string 3",
            "Default": "sample string 4",
            "IsAdvanced": true
          }
        },
        {
          "PluginSettingId": 1,
          "PluginId": 2,
          "SettingId": 3,
          "IsRequired": true,
          "Setting": {
            "SettingId": 1,
            "Name": "sample string 2",
            "Key": "sample string 3",
            "Default": "sample string 4",
            "IsAdvanced": true
          }
        }
      ]
    },
    "CyclePatternId": 1,
    "CyclePattern": {
      "CyclePatternId": 1,
      "StartDate": "2026-03-05T02:41:07.4382982+00:00",
      "Recurrence": 3,
      "NextRunDate": "2026-03-05T02:41:07.4382982+00:00",
      "SingleRunDate": "2026-03-05T02:41:07.4382982+00:00",
      "RecurrencePatternId": 5,
      "RecurrencePattern": {
        "RecurrencePatternId": 1,
        "Name": "sample string 2",
        "Alias": "sample string 3",
        "Key": "sample string 4"
      },
      "WeekdayId": 6,
      "Weekday": {
        "WeekdayId": 1,
        "Name": "sample string 2",
        "Key": "sample string 3",
        "Number": 4
      },
      "DayOfMonth": 7
    },
    "SatelliteId": 5,
    "Satellite": {
      "SatelliteId": 1,
      "ClientId": 1,
      "URL": "sample string 2",
      "Name": "sample string 3",
      "IPAddress": "sample string 4",
      "Protocol": "sample string 5",
      "PortNumber": "sample string 6",
      "ServiceContract": "sample string 7",
      "StarshipId": 8,
      "UniqueId": "963caa39-5a44-4d71-8e78-7390411ba4df",
      "SerialNumber": "sample string 10",
      "MacAddress": "sample string 11",
      "WindowsKey": "sample string 12",
      "Active": true,
      "Latitude": 14.0,
      "Longitude": 15.0,
      "IsOnline": true
    }
  }
]

application/xml, text/xml

Sample:

<ArrayOfSatellitePlugin xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Starship.WebAPI.Models">
  <SatellitePlugin>
    <CyclePattern>
      <CyclePatternId>1</CyclePatternId>
      <DayOfMonth>7</DayOfMonth>
      <NextRunDate>2026-03-05T02:41:07.4382982+00:00</NextRunDate>
      <Recurrence>3</Recurrence>
      <RecurrencePattern>
        <Alias>sample string 3</Alias>
        <Key>sample string 4</Key>
        <Name>sample string 2</Name>
        <RecurrencePatternId>1</RecurrencePatternId>
      </RecurrencePattern>
      <RecurrencePatternId>5</RecurrencePatternId>
      <SingleRunDate>2026-03-05T02:41:07.4382982+00:00</SingleRunDate>
      <StartDate>2026-03-05T02:41:07.4382982+00:00</StartDate>
      <Weekday>
        <Key>sample string 3</Key>
        <Name>sample string 2</Name>
        <Number>4</Number>
        <WeekdayId>1</WeekdayId>
      </Weekday>
      <WeekdayId>6</WeekdayId>
    </CyclePattern>
    <CyclePatternId>1</CyclePatternId>
    <Description>sample string 3</Description>
    <Name>sample string 2</Name>
    <Plugin>
      <AllowAutoUpdate>true</AllowAutoUpdate>
      <IsExecutable>true</IsExecutable>
      <IsLatestVersion>true</IsLatestVersion>
      <Name>sample string 2</Name>
      <Path>sample string 4</Path>
      <PluginId>1</PluginId>
      <PluginSettings>
        <PluginSetting>
          <IsRequired>true</IsRequired>
          <PluginId>2</PluginId>
          <PluginSettingId>1</PluginSettingId>
          <Setting>
            <Default>sample string 4</Default>
            <IsAdvanced>true</IsAdvanced>
            <Key>sample string 3</Key>
            <Name>sample string 2</Name>
            <SettingId>1</SettingId>
          </Setting>
          <SettingId>3</SettingId>
        </PluginSetting>
        <PluginSetting>
          <IsRequired>true</IsRequired>
          <PluginId>2</PluginId>
          <PluginSettingId>1</PluginSettingId>
          <Setting>
            <Default>sample string 4</Default>
            <IsAdvanced>true</IsAdvanced>
            <Key>sample string 3</Key>
            <Name>sample string 2</Name>
            <SettingId>1</SettingId>
          </Setting>
          <SettingId>3</SettingId>
        </PluginSetting>
      </PluginSettings>
      <ShortName>sample string 3</ShortName>
    </Plugin>
    <PluginId>4</PluginId>
    <Satellite>
      <Active>true</Active>
      <ClientId>1</ClientId>
      <IPAddress>sample string 4</IPAddress>
      <IsOnline>true</IsOnline>
      <Latitude>14</Latitude>
      <Longitude>15</Longitude>
      <MacAddress>sample string 11</MacAddress>
      <Name>sample string 3</Name>
      <PortNumber>sample string 6</PortNumber>
      <Protocol>sample string 5</Protocol>
      <SatelliteId>1</SatelliteId>
      <SerialNumber>sample string 10</SerialNumber>
      <ServiceContract>sample string 7</ServiceContract>
      <StarshipId>8</StarshipId>
      <URL>sample string 2</URL>
      <UniqueId>963caa39-5a44-4d71-8e78-7390411ba4df</UniqueId>
      <WindowsKey>sample string 12</WindowsKey>
    </Satellite>
    <SatelliteId>5</SatelliteId>
    <SatellitePluginId>1</SatellitePluginId>
  </SatellitePlugin>
  <SatellitePlugin>
    <CyclePattern>
      <CyclePatternId>1</CyclePatternId>
      <DayOfMonth>7</DayOfMonth>
      <NextRunDate>2026-03-05T02:41:07.4382982+00:00</NextRunDate>
      <Recurrence>3</Recurrence>
      <RecurrencePattern>
        <Alias>sample string 3</Alias>
        <Key>sample string 4</Key>
        <Name>sample string 2</Name>
        <RecurrencePatternId>1</RecurrencePatternId>
      </RecurrencePattern>
      <RecurrencePatternId>5</RecurrencePatternId>
      <SingleRunDate>2026-03-05T02:41:07.4382982+00:00</SingleRunDate>
      <StartDate>2026-03-05T02:41:07.4382982+00:00</StartDate>
      <Weekday>
        <Key>sample string 3</Key>
        <Name>sample string 2</Name>
        <Number>4</Number>
        <WeekdayId>1</WeekdayId>
      </Weekday>
      <WeekdayId>6</WeekdayId>
    </CyclePattern>
    <CyclePatternId>1</CyclePatternId>
    <Description>sample string 3</Description>
    <Name>sample string 2</Name>
    <Plugin>
      <AllowAutoUpdate>true</AllowAutoUpdate>
      <IsExecutable>true</IsExecutable>
      <IsLatestVersion>true</IsLatestVersion>
      <Name>sample string 2</Name>
      <Path>sample string 4</Path>
      <PluginId>1</PluginId>
      <PluginSettings>
        <PluginSetting>
          <IsRequired>true</IsRequired>
          <PluginId>2</PluginId>
          <PluginSettingId>1</PluginSettingId>
          <Setting>
            <Default>sample string 4</Default>
            <IsAdvanced>true</IsAdvanced>
            <Key>sample string 3</Key>
            <Name>sample string 2</Name>
            <SettingId>1</SettingId>
          </Setting>
          <SettingId>3</SettingId>
        </PluginSetting>
        <PluginSetting>
          <IsRequired>true</IsRequired>
          <PluginId>2</PluginId>
          <PluginSettingId>1</PluginSettingId>
          <Setting>
            <Default>sample string 4</Default>
            <IsAdvanced>true</IsAdvanced>
            <Key>sample string 3</Key>
            <Name>sample string 2</Name>
            <SettingId>1</SettingId>
          </Setting>
          <SettingId>3</SettingId>
        </PluginSetting>
      </PluginSettings>
      <ShortName>sample string 3</ShortName>
    </Plugin>
    <PluginId>4</PluginId>
    <Satellite>
      <Active>true</Active>
      <ClientId>1</ClientId>
      <IPAddress>sample string 4</IPAddress>
      <IsOnline>true</IsOnline>
      <Latitude>14</Latitude>
      <Longitude>15</Longitude>
      <MacAddress>sample string 11</MacAddress>
      <Name>sample string 3</Name>
      <PortNumber>sample string 6</PortNumber>
      <Protocol>sample string 5</Protocol>
      <SatelliteId>1</SatelliteId>
      <SerialNumber>sample string 10</SerialNumber>
      <ServiceContract>sample string 7</ServiceContract>
      <StarshipId>8</StarshipId>
      <URL>sample string 2</URL>
      <UniqueId>963caa39-5a44-4d71-8e78-7390411ba4df</UniqueId>
      <WindowsKey>sample string 12</WindowsKey>
    </Satellite>
    <SatelliteId>5</SatelliteId>
    <SatellitePluginId>1</SatellitePluginId>
  </SatellitePlugin>
</ArrayOfSatellitePlugin>