📖 The Source Object

Fields' description and JSON of the Source Object.

FieldTypeDescription
keystring
Required
Identification key of the Source.
namestring
Required
Source custom name.
descriptionstring
Required
Source custom description.
type string
Required
Type of the Source (example: api).
subtype string
Required
Subtype of the Source (example: http_api or php).
environment stringEnvironment of the Source (example: production, staging, or test)
private booleanTurn to 1 to prevent other Workspace members from accessing the Source. Private=0 by default.
disable booleanTurn to 1 to stop accepting Profiles into the Source. Disable=0 by default.
status booleanTechnical uptime monitoring of the Source.
archived_at datetime ISO 8601Archive date of the Board. The value is null for unarchived Boards.
updated_at datetime ISO 8601Last update date of the Source.
created_at datetime ISO 8601Creation date of the Source.
membersarray of stringsList of Source members emails.
user userCreator of the Source.
sync_parsing intIndicates whether real-time parsing is activated for the Source or not. By default, only asynchronous parsing is activated at creation of the Source.