Get settingsorganizationsorganizationnamereceivers

v1

latestOpenAPI 3.0.22026-07-14141623.7 KB

A list of receivers and their current settings

get/settings/organizations/{organizationName}/receivers

Path parameters

organizationNamestring required

Fetch receivers with this organization name

Response

descriptionstring required

Display ready description of the receiver

namestring required

The unique name for the receiver. Should include the organization name as a prefix.

organizationNamestring

The name of the organization that this receiver belongs to

topicstring required

The topic of for this receiver. Must match the supported topics.

Example response

[
  {
    "description": "Arizona PHD ELR feed",
    "meta": {
      "createdBy": "jj@phd.gov",
      "version": 11
    },
    "name": "az-phd.elr",
    "organizationName": "az-phd",
    "topic": "covid-19",
    "translations": [
      {
        "transport": {
          "filePath": "/in/test",
          "host": "sftp.phd.gov",
          "port": 22,
          "type": "SFTP"
        },
        "type": "CUSTOM"
      }
    ]
  }
]