Agents

The TIBCO Scribe® Agent facilitates communication between the data sources used by a Solution. It provides secure communications to TIBCO Scribe® without opening security holes in your corporate firewall. An Agent is required to communicate with both your source and target data, and with TIBCO Scribe® in the cloud. See TIBCO Scribe® Agents in the TIBCO Scribe® Help.

There are two types of agents available:

  • On-Premise Agent — This Agent is installed on a computer at your site. You can install multiple On-Premise Agents on a single computer.
  • Cloud Agent — This Agent resides in the cloud. Only one Cloud Agent can be provisioned per Organization. When Cloud Agents are used, TIBCO Scribe® dynamically manages the load to optimize Solution performance, therefore only one Cloud Agent is needed.

Endpoints — Use the links in the Endpoints section below to access the TIBCO Scribe® Swagger page and try out the API against your Organization.

Fields For Agent Endpoints — Review the fields table below the list of Endpoints for detailed field level information.

Considerations

In some cases there are special considerations or use cases for specific endpoints that you should know about before you use the endpoint.

Note: For information on Agent Logs, see Logs.

POST /v1/orgs/{orgId}/agents/provision_onpremise_agent

  • Use the download URL and installation key returned by this call to manually install an on-premise Agent.

Endpoints

Return a list of Agents

Restart an Agent

Delete an Agent

Return information about an Agent

Modify an Agent

Provision a cloud Agent

Return installation information for an on-premise Agent

Fields For Agent Endpoints

The list of fields defined in this table is comprehensive across all Agents endpoints. See Endpoints for a list of Agents Endpoints with links to the associated Swagger page.

Name
Type
Data Type

Description

Endpoints

Parameters

agentId

query

string

ID of the Agent. Required
  • POST /v1/orgs/{orgId}/agents/{agentId}/restart

connectorId

query

string

ID of a Connector that is installed for this Agent. Filters the list of Agents returned by Connector.

  • GET /v1/orgs/{orgId}/agents

id

query

string

ID of the Agent. Required
  • DELETE /v1/orgs/{orgId}/agents/{id}
  • GET /v1/orgs/{orgId}/agents/{id}
  • PUT /v1/orgs/{orgId}/agents/{id}

limit

query

integer

Maximum number of Agents to return. Default value is 100.

  • GET /v1/orgs/{orgId}/agents

model

body

model

Model for the Agent. Required
  • PUT /v1/orgs/{orgId}/agents/{id}

name

query

string

Name of the Agent. For On-Premise Agents, default Agent name is the name of the machine where it is installed. If more than one Agent is installed, a number is added to the default Agent name. Cloud Agents are always named Cloud Agent, since there can only be one per Organization.

  • GET /v1/orgs/{orgId}/agents

offset

query

integer

Number of Agents to skip before returning results. Default value is 0. See Reading Resources for more information on offset and limit parameters.
  • GET /v1/orgs/{orgId}/agents

orgId

query

integer

Unique ID for each Organization. Required

All

restartNow

query

boolean

Controls when to restart the selected Agent. Default value is false.

  • true — Interrupts any Solutions that are running and then restarts the Agent. Interrupting running Solutions may result in errors.
  • false — Restarts the Agent after any Solutions that are currently running have completed. Solutions are paused if they are scheduled or selected to start after this Restart option is selected.
  • POST /v1/orgs/{orgId}/agents/{agentId}/restart

Response

agentInstallationKey

response

string

GUID/UUID of the Agent. Use this Agent key during the manual installation process for an On-Premise Agent. See Installing An On-Premise Agent in the TIBCO Scribe® Help.

  • POST /v1/orgs/{orgId}/agents/provision_onpremise_agent

agentInstallerLocation

response

string

Location on the TIBCO Scribe® server where the Agent installation program, ScribeInstaller.exe, is stored. See Installing An On-Premise Agent in the TIBCO Scribe® Help.

  • POST /v1/orgs/{orgId}/agents/provision_onpremise_agent

id

response

string

GUID/UUID of the installed Agent.

ID of the installed Connector. See installedConnectors.

  • GET /v1/orgs/{orgId}/agents
  • GET /v1/orgs/{orgId}/agents/{id}
  • PUT /v1/orgs/{orgId}/agents/{id}

installedConnectors

response

string

Array of Connectors installed on the Agent. Includes the following for each Connector:

  • GET /v1/orgs/{orgId}/agents
  • GET /v1/orgs/{orgId}/agents/{id}
  • PUT /v1/orgs/{orgId}/agents/{id}

isCloudAgent

response

boolean

Indicates whether or not the Agent is a Cloud Agent. Default is false.

  • true — Agent is a Cloud Agent.
  • false — Agent is an On-Premise Agent.
  • GET /v1/orgs/{orgId}/agents
  • GET /v1/orgs/{orgId}/agents/{id}
  • PUT /v1/orgs/{orgId}/agents/{id}

isUpdating

response

boolean

Indicates whether the Agent is being updated or not. Default is false.

  • true — Agent is updating.
  • false — Agent is not updating.
  • GET /v1/orgs/{orgId}/agents
  • GET /v1/orgs/{orgId}/agents/{id}
  • PUT /v1/orgs/{orgId}/agents/{id}

lastContactTime

response

string

Date and time in UTC time that the Agent last contacted TIBCO Scribe®.

  • GET /v1/orgs/{orgId}/agents
  • GET /v1/orgs/{orgId}/agents/{id}
  • PUT /v1/orgs/{orgId}/agents/{id}

lastShutdownTime

response

string

Date and time in UTC time that the Agent was last shut down.
  • GET /v1/orgs/{orgId}/agents
  • GET /v1/orgs/{orgId}/agents/{id}
  • PUT /v1/orgs/{orgId}/agents/{id}

lastStartTime

response

string

Date and time in UTC time that the Agent last started.
  • GET /v1/orgs/{orgId}/agents
  • GET /v1/orgs/{orgId}/agents/{id}
  • PUT /v1/orgs/{orgId}/agents/{id}

machineName

response

string

Computer name of the machine where the On-Premise Agent is installed.

  • GET /v1/orgs/{orgId}/agents
  • GET /v1/orgs/{orgId}/agents/{id}
  • PUT /v1/orgs/{orgId}/agents/{id}

name

response

string

Name of the Agent. For On-Premise Agents, default Agent name is the name of the machine where it is installed. Cloud Agents are always named Cloud Agent, since there can only be one per Organization.

  • GET /v1/orgs/{orgId}/agents
  • GET /v1/orgs/{orgId}/agents/{id}
  • PUT /v1/orgs/{orgId}/agents/{id}

serviceName

response

string

Name of the Windows service that represents this Agent. This also indicates the name of the installation folder for the Agent and associated Connectors. For Cloud Agents, this represents the order in which it was installed. For example, if you install two On-Premise Agents, their serviceName values are TIBCO Scribe® Agent and TIBCO Scribe® Agent 1. If you then provision a Cloud Agent, its serviceName value is TIBCO Scribe® Agent3.

  • GET /v1/orgs/{orgId}/agents
  • GET /v1/orgs/{orgId}/agents/{id}
  • PUT /v1/orgs/{orgId}/agents/{id}

status

response

string

Current state of the Agent. Responses include: 

  • AgentUpdating — TIBCO Scribe® is updating the Agent.
  • HeartbeatFailed — Agent failed to contact TIBCO Scribe® for 60 minutes or more. Agent service may not be running.
  • HeartbeatLate — Agent failed to contact TIBCO Scribe® for 15 to 59 minutes. Agent service may not be running.
  • Obsolete, install new Agent — Agent and installed Connectors cannot be automatically updated because the version of the installed Agent is too old. Install a new Agent manually and edit your Solutions to use that Agent.
  • Restarting — Agent is restarting.
  • Running — Agent is running normally.
  • Shutdown — Agent service has been shut down and has successfully contacted TIBCO Scribe® to communicate the shutdown.
  • ShutdownCloud — Cloud Agent has been shut down.
  • Unknown — Agent has not responded to TIBCO Scribe®.
  • UpdatingConnector — Agent is installing Connector updates.
  • WaitingToRestartAgentMemoryLimit — TIBCO Scribe® detects when an Agent's memory limits are being exceeded and requests an Agent restart. Agent completes any running Solutions and updates Execution History for those Solutions before restarting.
  • WaitingToRestartAgentUserRequest — A user has requested an Agent restart. Depending on the type of restart selected by the user, the Agent restarts immediately or after all running Solutions are complete and Execution History has been updated. See Restarting An On-Premise Agent in the TIBCO Scribe® Help.
  • WaitingToUpdateAgent — Agent completes any Solution executions that are running and updates Execution History for running Solutions, but does not start any Solutions or contact TIBCO Scribe®. Agent then goes to UpdatingAgent status.
  • WaitingToUpdateConnector — Agent completes any Solution executions that are running and updates Execution History for running Solutions, but does not start any new Solutions or contact TIBCO Scribe®. Agent then goes to UpdatingConnector status.

 
  • GET /v1/orgs/{orgId}/agents
  • GET /v1/orgs/{orgId}/agents/{id}
  • PUT /v1/orgs/{orgId}/agents/{id}

usedInSolutions

response

string

List of Solutions configured to be executed by this Agent. An Agent cannot be deleted if a Solution is configured to use the Agent.

  • GET /v1/orgs/{orgId}/agents
  • GET /v1/orgs/{orgId}/agents/{id}
  • PUT /v1/orgs/{orgId}/agents/{id}

version

response

string

Agent version number.

Installed Connector version number. See installedConnectors.
  • GET /v1/orgs/{orgId}/agents
  • GET /v1/orgs/{orgId}/agents/{id}
  • PUT /v1/orgs/{orgId}/agents/{id}

 

See

Endpoints

API Basics

Logs