Class OnPremAgents

Class providing methods for Make on-prem bridge agents. These agents run on customer infrastructure and connect to Make via the agency service.

Index

Constructors

Methods

create delete get getAppConfig list update

Constructors

constructor

new OnPremAgents(fetch: FetchFunction): OnPremAgents
Parameters
- fetch: FetchFunction
Returns OnPremAgents
- Defined in src/endpoints/on-prem-agents.ts:111

Methods

create

create(
organizationId: number,
body: CreateOnPremAgentBody,
): Promise<OnPremAgent>
Register a new on-prem agent. The server assigns id and clientSecret.
Parameters
- organizationId: number
  The organization ID
- body: CreateOnPremAgentBody
  Agent registration parameters (name only)
Returns Promise<OnPremAgent>
- Defined in src/endpoints/on-prem-agents.ts:145

delete

delete(organizationId: number, agentId: string): Promise<string>
Delete an on-prem agent.
Parameters
- organizationId: number
  The organization ID
- agentId: string
  The agent UUID
Returns Promise<string>
The deleted agent ID
- Defined in src/endpoints/on-prem-agents.ts:177

get

get(organizationId: number, agentId: string): Promise<OnPremAgent>
Get details of a specific on-prem agent.
Parameters
- organizationId: number
  The organization ID
- agentId: string
  The agent UUID
Returns Promise<OnPremAgent>
- Defined in src/endpoints/on-prem-agents.ts:132

getAppConfig

getAppConfig(
    organizationId: number,
    agentId: string,
    appName: string,
): Promise<OnPremAgentAppConfigInput[]>
Get dynamic input field definitions for creating a connected system on an agent app.
Parameters
- organizationId: number
  The organization ID
- agentId: string
  The agent UUID
- appName: string
  Connected-system app slug (e.g. http, sap-agent)
Returns Promise<OnPremAgentAppConfigInput[]>
- Defined in src/endpoints/on-prem-agents.ts:192

list

list(organizationId: number): Promise<OnPremAgent[]>
List on-prem agents for an organization.
Parameters
- organizationId: number
  The organization ID
Returns Promise<OnPremAgent[]>
- Defined in src/endpoints/on-prem-agents.ts:119

update

update(
    organizationId: number,
    agentId: string,
    body: UpdateOnPremAgentBody,
): Promise<OnPremAgent>
Update an on-prem agent (currently supports renaming via name).
Parameters
- organizationId: number
  The organization ID
- agentId: string
  The agent UUID
- body: UpdateOnPremAgentBody
  Fields to update
Returns Promise<OnPremAgent>
- Defined in src/endpoints/on-prem-agents.ts:161