Home
API reference
Platform API
Platform API
Sources
Update source

Update source

patch/v1/sources/{sourceId}
Page View

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.

Update source

Update the human readable name of an existing source within the specified environment. You must use the correct source and environment identifiers.

Request parameters and payload

cURL request example

bash
1
curl 'https://api.redoxengine.com/platform/v1/sources/{sourceId}' \
2
--request PATCH \
3
--header 'Authorization: Bearer $API_TOKEN' \
4
--header 'accept: application/json' \
5
--header 'Content-Type: application/json' \
6
--data '{
7
  "name": "string",
8
  "setupState": {
9
    "step": "string",
10
    "name": "string",
11
    "dataFormat": "HL7V2",
12
    "ehr": "string",
13
    "serviceRegion": "AWS_USA_EAST_1"
14
  },
15
  "timeZone": "string"
16
}'

Path Parameters

  • sourceId
    required, string

    Displays the unique identifier of a source within a given environment.

Request Body Schema

    Contains the fields that can be used to update an existing source. You can populate one or more fields. Any new or changed data replaces existing entries. If you don't use one or more fields, the existing data stays the same; in other words, it's not overwritten with a blank entry.

  • name
    string

    Displays the human-readable name of the source.

  • setupState
    nullable, object

    Describes the current state of configuration for a source in your Redox organization.

    • step
      required, string

      Indicates which step the user is on in the configuration process.

    • name
      string

      Displays the human-readable name of the source, as configured during setup.

    • dataFormat
      string

      Displays the data format of the source.

      Possible Values: HL7V2, JSON, Custom, X12, X12v2, XML (to JSON)
    • ehr
      string

      Displays the EHR or sending system type of the source.

    • serviceRegion
      string

      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
  • timeZone
    string

    Specifies the time zone that should be used when parsing dates/times from the sending system.

Response fields and example

Example payload generated from schema
1
{
2
  "meta": {
3
    "version": "1.0.0"
4
  },
5
  "payload": {
6
    "source": {
7
      "name": "string",
8
      "id": "string",
9
      "environment": {
10
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
11
        "environmentFlag": "Staging"
12
      },
13
      "sftpUsername": "string",
14
      "hasSFTPPassword": true,
15
      "serviceRegion": "AWS_USA_EAST_1",
16
      "dataFormat": "HL7V2",
17
      "ehr": "string",
18
      "apiKey": "string",
19
      "hasSecret": true,
20
      "setupState": {
21
        "step": "string",
22
        "name": "string",
23
        "dataFormat": "HL7V2",
24
        "ehr": "string",
25
        "serviceRegion": "AWS_USA_EAST_1"
26
      },
27
      "timeZone": "string"
28
    }
29
  }
30
}
  • meta
    object
    • version
      string

      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.

  • payload
    object

    Contains the payload with details about the requested source(s).

    • source
      object

      Contains a source and its related details.

      • name
        string

        Displays the human-readable name of the source.

      • id
        string

        Displays the unique identifier (i.e., client ID) of the source.

      • environment
        object

        Contains metadata about the environment within the associated Redox organization.

        • id
          string

          Contains the unique identifier of the Redox environment.

          Format: uuid
        • environmentFlag
          string

          Indicates whether the environment is used for development, staging, or production.

          Possible Values: Production, Staging, Development
      • sftpUsername
        string

        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.

      • hasSFTPPassword
        boolean

        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.

      • serviceRegion
        string

        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
      • dataFormat
        string

        Displays the data format of the source.

        Possible Values: HL7V2, JSON, Custom, X12, X12v2, XML (to JSON)
      • ehr
        string

        Displays the EHR or sending system type of the source.

      • apiKey
        string

        Displays the API key of the source. This is server-generated when the source is created and can't be changed.

      • hasSecret
        boolean

        Displays whether the source has a secret.

      • setupState
        nullable, object

        Describes the current state of configuration for a source in your Redox organization.

        • step
          required, string

          Indicates which step the user is on in the configuration process.

        • name
          string

          Displays the human-readable name of the source, as configured during setup.

        • dataFormat
          string

          Displays the data format of the source.

          Possible Values: HL7V2, JSON, Custom, X12, X12v2, XML (to JSON)
        • ehr
          string

          Displays the EHR or sending system type of the source.

        • serviceRegion
          string

          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
      • timeZone
        string

        Specifies the time zone that should be used when parsing dates/times from the sending system.