On Prem Agents

List on-prem agents

get

/agents

Retrieves a collection of agents for a company with a given ID

Required scopes

This endpoint requires the following scopes:

Authorizations

AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Query parameters

organizationIdintegerOptionalExample: 11

Responses

200

Successful response

application/json

get/agents

GET /api/v2/agents HTTP/1.1
Host: eu1.make.com
Authorization: Token your-api-token
Accept: */*

200

Successful response

{
  "agents": [
    {
      "id": "text",
      "tenantId": "text",
      "name": "text",
      "clientSecret": "text",
      "status": "ACTIVE",
      "alerted": true,
      "connected": true,
      "version": "text",
      "createdDate": "2026-01-01T00:00:00.000Z",
      "lastConnectionDate": "2026-01-01T00:00:00.000Z",
      "systemConnectionsCount": 1
    }
  ]
}

Get on-prem agent details

get

/agents/{agentId}

Retrieves an agents for a agent with given ID

Required scopes

This endpoint requires the following scopes:

Authorizations

AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters

agentIdstring · uuidRequired

The ID of the agent.

Example: 78781d1f-8cc0-4f42-8e77-c02812f78b53

Query parameters

organizationIdintegerOptionalExample: 11

Responses

200

Successful response

application/json

get/agents/{agentId}

GET /api/v2/agents/{agentId} HTTP/1.1
Host: eu1.make.com
Authorization: Token your-api-token
Accept: */*

200

Successful response

{
  "agent": {
    "id": "text",
    "tenantId": "text",
    "name": "text",
    "clientSecret": "text",
    "status": "ACTIVE",
    "alerted": true,
    "connected": true,
    "version": "text",
    "createdDate": "2026-01-01T00:00:00.000Z",
    "lastConnectionDate": "2026-01-01T00:00:00.000Z",
    "systemConnectionsCount": 1
  }
}

Create on-prem agent

post

/agents/{agentId}

Creates a new agent

Required scopes

This endpoint requires the following scopes:

Authorizations

AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters

agentIdstring · uuidRequired

The ID of the agent.

Example: 78781d1f-8cc0-4f42-8e77-c02812f78b53

Query parameters

organizationIdintegerOptionalExample: 11

Body

namestringRequired

Responses

200

Successful response

application/json

post/agents/{agentId}

POST /api/v2/agents/{agentId} HTTP/1.1
Host: eu1.make.com
Authorization: Token your-api-token
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "text"
}

200

Successful response

{
  "agent": {
    "id": "text",
    "tenantId": "text",
    "name": "text",
    "clientSecret": "text",
    "status": "ACTIVE",
    "alerted": true,
    "connected": true,
    "version": "text",
    "createdDate": "2026-01-01T00:00:00.000Z",
    "lastConnectionDate": "2026-01-01T00:00:00.000Z",
    "systemConnectionsCount": 1
  }
}

Delete on-prem agent

delete

/agents/{agentId}

Removes an agent with a given ID.

Required scopes

This endpoint requires the following scopes:

Authorizations

AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters

agentIdstring · uuidRequired

The ID of the agent.

Example: 78781d1f-8cc0-4f42-8e77-c02812f78b53

Query parameters

organizationIdintegerOptionalExample: 11

Responses

200

Successful response

application/json

agentstring · uuidOptional

delete/agents/{agentId}

DELETE /api/v2/agents/{agentId} HTTP/1.1
Host: eu1.make.com
Authorization: Token your-api-token
Accept: */*

200

Successful response

{
  "agent": "78781d1f-8cc0-4f42-8e77-c02812f78b53"
}

Update on-prem agent

patch

/agents/{agentId}

Updates a new agent with given ID

Required scopes

This endpoint requires the following scopes:

Authorizations

AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters

agentIdstring · uuidRequired

The ID of the agent.

Example: 78781d1f-8cc0-4f42-8e77-c02812f78b53

Query parameters

organizationIdintegerOptionalExample: 11

Body

namestringOptional

Responses

200

Successful response

application/json

patch/agents/{agentId}

PATCH /api/v2/agents/{agentId} HTTP/1.1
Host: eu1.make.com
Authorization: Token your-api-token
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "text"
}

200

Successful response

{
  "agent": {
    "id": "text",
    "tenantId": "text",
    "name": "text",
    "clientSecret": "text",
    "status": "ACTIVE",
    "alerted": true,
    "connected": true,
    "version": "text",
    "createdDate": "2026-01-01T00:00:00.000Z",
    "lastConnectionDate": "2026-01-01T00:00:00.000Z",
    "systemConnectionsCount": 1
  }
}