Source endpoints allow you to manage sources and their related portmaps in a specified environment. Portmaps include a port, virtual host (vhost), source, and list of host IPs.
You must be a member of the environment and be assigned to an engineer role to manage sources. Learn about roles.
Get sources
Retrieve a list of configured sources in the specified environment.
cURL request example
Path Parameters
- environmentIdrequired, string
Identifies the specific environment that you're operating in or on behalf of.
- metaobject
- versionstring
Lists the major and minor version number for the format of the returned payload. The payload format or shape may change between minor versions, like including additional or extended fields in later versions. We include the version data in each response so that you have the option to handle the signaled differences.
- payloadobject
Contains the payload with details about the requested source(s).
- sourcesArray of object
Contains an array of sources.
- namestring
Displays the human-readable name of the source.
- idstring
Displays the unique identifier (i.e., client ID) of the source.
- environmentobject
Contains metadata about the environment within the associated Redox organization.
- idstring
Contains the unique identifier of the Redox environment.
Format: uuid - environmentFlagstring
Indicates whether the environment is used for development, staging, or production.
Possible Values:Production
,Staging
,Development
- sftpUsernamestring
Contains a UUID that represents the username for this source's SFTP access. In order to view, this field must be enabled for your organization. Talk to your Technical Account Manager if your organization needs this field.
- hasSFTPPasswordboolean
Indicates whether an SFTP password exists for this source. In order to view, this field must be enabled for your organization. Talk to your Technical Account Manager if your organization needs this field.
- serviceRegionstring
Specifies the Redox service region where the source resides. You can't change this after creation.
Possible Values:AWS_USA_EAST_1
,AWS_CAN_CENTRAL
,GCP_USA_CENTRAL_1
- dataFormatstring
Displays the data format of the source.
Possible Values:HL7V2
,JSON
,Custom
,X12
,X12v2
,XML (to JSON)
- ehrstring
Displays the EHR or sending system type of the source.
- apiKeystring
Displays the API key of the source. This is server-generated when the source is created and can't be changed.
- hasSecretboolean
Displays whether the source has a secret.
- setupStatenullable, object
Describes the current state of configuration for a source in your Redox organization.
- steprequired, string
Indicates which step the user is on in the configuration process.
- namestring
Displays the human-readable name of the source, as configured during setup.
- dataFormatstring
Displays the data format of the source.
Possible Values:HL7V2
,JSON
,Custom
,X12
,X12v2
,XML (to JSON)
- ehrstring
Displays the EHR or sending system type of the source.
- serviceRegionstring
Specifies the Redox service region where the source resides. You can't change this after creation.
Possible Values:AWS_USA_EAST_1
,AWS_CAN_CENTRAL
,GCP_USA_CENTRAL_1
- timeZonestring
Specifies the time zone that should be used when parsing dates/times from the sending system.