{
  "info": {
    "_postman_id": "d1209a19-0ba1-4dcb-bad2-f1bfc5592829",
    "name": "elastic.io Platform REST Agents API",
    "description": "The elastic.io Platform REST API v2 provides programmatic access to the elastic.io iPaaS platform. It allows you to manage integration flows, workspaces, contracts, credentials, components, recipes, users, and other platform resources. The API follows the JSON:API specification and uses Bearer token authentication.\n\nContact Support:\n Name: elastic.io",
    "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
    "createdAt": "2026-07-28T01:33:27.000Z",
    "updatedAt": "2026-07-28T01:33:27.000Z",
    "lastUpdatedBy": "35240",
    "uid": "35240-d1209a19-0ba1-4dcb-bad2-f1bfc5592829"
  },
  "item": [
    {
      "name": "agents",
      "item": [
        {
          "name": "{agent_id}",
          "item": [
            {
              "name": "Elastic.io Get an agent",
              "id": "a173ed95-6b57-4d2b-9e9f-574cca17b707",
              "protocolProfileBehavior": {
                "disableBodyPruning": true
              },
              "request": {
                "method": "GET",
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "url": {
                  "raw": "{{baseUrl}}/agents/:agent_id",
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "path": [
                    "agents",
                    ":agent_id"
                  ],
                  "variable": [
                    {
                      "id": "3efc7a22-1023-438a-92c3-f1a07cef0d9a",
                      "key": "agent_id",
                      "value": "<string>",
                      "description": "(Required) "
                    }
                  ]
                },
                "description": "Retrieve details of a specific agent."
              },
              "response": [
                {
                  "id": "0d33ac4f-c1f2-4a5b-be3a-6bc3cba2399e",
                  "name": "Successful response",
                  "originalRequest": {
                    "method": "GET",
                    "header": [
                      {
                        "key": "Accept",
                        "value": "application/json"
                      },
                      {
                        "description": "Added as a part of security scheme: bearer",
                        "key": "Authorization",
                        "value": "Bearer <token>"
                      }
                    ],
                    "url": {
                      "raw": "{{baseUrl}}/agents/:agent_id",
                      "host": [
                        "{{baseUrl}}"
                      ],
                      "path": [
                        "agents",
                        ":agent_id"
                      ],
                      "variable": [
                        {
                          "key": "agent_id"
                        }
                      ]
                    }
                  },
                  "status": "OK",
                  "code": 200,
                  "_postman_previewlanguage": "json",
                  "header": [
                    {
                      "key": "Content-Type",
                      "value": "application/json"
                    }
                  ],
                  "cookie": [],
                  "responseTime": null,
                  "body": "{\n  \"data\": {\n    \"id\": \"<string>\",\n    \"type\": \"agent\",\n    \"attributes\": {\n      \"name\": \"<string>\",\n      \"status\": \"<string>\",\n      \"created_at\": \"<dateTime>\",\n      \"updated_at\": \"<dateTime>\"\n    },\n    \"relationships\": {\n      \"workspace\": {\n        \"data\": {\n          \"id\": \"<string>\",\n          \"type\": \"<string>\"\n        }\n      }\n    }\n  }\n}",
                  "createdAt": "2026-07-28T01:33:28.000Z",
                  "updatedAt": "2026-07-28T01:33:28.000Z",
                  "uid": "35240-0d33ac4f-c1f2-4a5b-be3a-6bc3cba2399e"
                },
                {
                  "id": "f51eb703-6ca4-494c-92e9-2c18524d889b",
                  "name": "Authentication required or token is invalid",
                  "originalRequest": {
                    "method": "GET",
                    "header": [
                      {
                        "key": "Accept",
                        "value": "application/json"
                      },
                      {
                        "description": "Added as a part of security scheme: bearer",
                        "key": "Authorization",
                        "value": "Bearer <token>"
                      }
                    ],
                    "url": {
                      "raw": "{{baseUrl}}/agents/:agent_id",
                      "host": [
                        "{{baseUrl}}"
                      ],
                      "path": [
                        "agents",
                        ":agent_id"
                      ],
                      "variable": [
                        {
                          "key": "agent_id"
                        }
                      ]
                    }
                  },
                  "status": "Unauthorized",
                  "code": 401,
                  "_postman_previewlanguage": "json",
                  "header": [
                    {
                      "key": "Content-Type",
                      "value": "application/json"
                    }
                  ],
                  "cookie": [],
                  "responseTime": null,
                  "body": "{\n  \"errors\": [\n    {\n      \"status\": \"<integer>\",\n      \"title\": \"<string>\",\n      \"detail\": \"<string>\"\n    },\n    {\n      \"status\": \"<integer>\",\n      \"title\": \"<string>\",\n      \"detail\": \"<string>\"\n    }\n  ]\n}",
                  "createdAt": "2026-07-28T01:33:28.000Z",
                  "updatedAt": "2026-07-28T01:33:28.000Z",
                  "uid": "35240-f51eb703-6ca4-494c-92e9-2c18524d889b"
                },
                {
                  "id": "4e3d2cd9-8975-401a-8ef4-ec661491ab76",
                  "name": "The requested resource was not found",
                  "originalRequest": {
                    "method": "GET",
                    "header": [
                      {
                        "key": "Accept",
                        "value": "application/json"
                      },
                      {
                        "description": "Added as a part of security scheme: bearer",
                        "key": "Authorization",
                        "value": "Bearer <token>"
                      }
                    ],
                    "url": {
                      "raw": "{{baseUrl}}/agents/:agent_id",
                      "host": [
                        "{{baseUrl}}"
                      ],
                      "path": [
                        "agents",
                        ":agent_id"
                      ],
                      "variable": [
                        {
                          "key": "agent_id"
                        }
                      ]
                    }
                  },
                  "status": "Not Found",
                  "code": 404,
                  "_postman_previewlanguage": "json",
                  "header": [
                    {
                      "key": "Content-Type",
                      "value": "application/json"
                    }
                  ],
                  "cookie": [],
                  "responseTime": null,
                  "body": "{\n  \"errors\": [\n    {\n      \"status\": \"<integer>\",\n      \"title\": \"<string>\",\n      \"detail\": \"<string>\"\n    },\n    {\n      \"status\": \"<integer>\",\n      \"title\": \"<string>\",\n      \"detail\": \"<string>\"\n    }\n  ]\n}",
                  "createdAt": "2026-07-28T01:33:28.000Z",
                  "updatedAt": "2026-07-28T01:33:28.000Z",
                  "uid": "35240-4e3d2cd9-8975-401a-8ef4-ec661491ab76"
                }
              ],
              "createdAt": "2026-07-28T01:33:28.000Z",
              "updatedAt": "2026-07-28T01:33:28.000Z",
              "uid": "35240-a173ed95-6b57-4d2b-9e9f-574cca17b707"
            },
            {
              "name": "Elastic.io Delete an agent",
              "id": "27a8a369-3b99-4af1-bf38-4c1470a4b84f",
              "protocolProfileBehavior": {
                "disableBodyPruning": true
              },
              "request": {
                "method": "DELETE",
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "url": {
                  "raw": "{{baseUrl}}/agents/:agent_id",
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "path": [
                    "agents",
                    ":agent_id"
                  ],
                  "variable": [
                    {
                      "id": "7387ae43-e38d-414b-8508-4ff53bd22249",
                      "key": "agent_id",
                      "value": "<string>",
                      "description": "(Required) "
                    }
                  ]
                },
                "description": "Delete an on-premises integration agent."
              },
              "response": [
                {
                  "id": "bf655fcb-1a71-45f4-8c89-2e672b17479e",
                  "name": "Agent deleted successfully",
                  "originalRequest": {
                    "method": "DELETE",
                    "header": [
                      {
                        "description": "Added as a part of security scheme: bearer",
                        "key": "Authorization",
                        "value": "Bearer <token>"
                      }
                    ],
                    "url": {
                      "raw": "{{baseUrl}}/agents/:agent_id",
                      "host": [
                        "{{baseUrl}}"
                      ],
                      "path": [
                        "agents",
                        ":agent_id"
                      ],
                      "variable": [
                        {
                          "key": "agent_id"
                        }
                      ]
                    }
                  },
                  "status": "No Content",
                  "code": 204,
                  "_postman_previewlanguage": "text",
                  "header": [],
                  "cookie": [],
                  "responseTime": null,
                  "body": null,
                  "createdAt": "2026-07-28T01:33:28.000Z",
                  "updatedAt": "2026-07-28T01:33:28.000Z",
                  "uid": "35240-bf655fcb-1a71-45f4-8c89-2e672b17479e"
                },
                {
                  "id": "304c4eee-8ca9-44a7-923a-0c11694c39da",
                  "name": "Authentication required or token is invalid",
                  "originalRequest": {
                    "method": "DELETE",
                    "header": [
                      {
                        "key": "Accept",
                        "value": "application/json"
                      },
                      {
                        "description": "Added as a part of security scheme: bearer",
                        "key": "Authorization",
                        "value": "Bearer <token>"
                      }
                    ],
                    "url": {
                      "raw": "{{baseUrl}}/agents/:agent_id",
                      "host": [
                        "{{baseUrl}}"
                      ],
                      "path": [
                        "agents",
                        ":agent_id"
                      ],
                      "variable": [
                        {
                          "key": "agent_id"
                        }
                      ]
                    }
                  },
                  "status": "Unauthorized",
                  "code": 401,
                  "_postman_previewlanguage": "json",
                  "header": [
                    {
                      "key": "Content-Type",
                      "value": "application/json"
                    }
                  ],
                  "cookie": [],
                  "responseTime": null,
                  "body": "{\n  \"errors\": [\n    {\n      \"status\": \"<integer>\",\n      \"title\": \"<string>\",\n      \"detail\": \"<string>\"\n    },\n    {\n      \"status\": \"<integer>\",\n      \"title\": \"<string>\",\n      \"detail\": \"<string>\"\n    }\n  ]\n}",
                  "createdAt": "2026-07-28T01:33:28.000Z",
                  "updatedAt": "2026-07-28T01:33:28.000Z",
                  "uid": "35240-304c4eee-8ca9-44a7-923a-0c11694c39da"
                },
                {
                  "id": "102b9617-45fe-4182-8dfd-644e00ff82b9",
                  "name": "The requested resource was not found",
                  "originalRequest": {
                    "method": "DELETE",
                    "header": [
                      {
                        "key": "Accept",
                        "value": "application/json"
                      },
                      {
                        "description": "Added as a part of security scheme: bearer",
                        "key": "Authorization",
                        "value": "Bearer <token>"
                      }
                    ],
                    "url": {
                      "raw": "{{baseUrl}}/agents/:agent_id",
                      "host": [
                        "{{baseUrl}}"
                      ],
                      "path": [
                        "agents",
                        ":agent_id"
                      ],
                      "variable": [
                        {
                          "key": "agent_id"
                        }
                      ]
                    }
                  },
                  "status": "Not Found",
                  "code": 404,
                  "_postman_previewlanguage": "json",
                  "header": [
                    {
                      "key": "Content-Type",
                      "value": "application/json"
                    }
                  ],
                  "cookie": [],
                  "responseTime": null,
                  "body": "{\n  \"errors\": [\n    {\n      \"status\": \"<integer>\",\n      \"title\": \"<string>\",\n      \"detail\": \"<string>\"\n    },\n    {\n      \"status\": \"<integer>\",\n      \"title\": \"<string>\",\n      \"detail\": \"<string>\"\n    }\n  ]\n}",
                  "createdAt": "2026-07-28T01:33:28.000Z",
                  "updatedAt": "2026-07-28T01:33:28.000Z",
                  "uid": "35240-102b9617-45fe-4182-8dfd-644e00ff82b9"
                }
              ],
              "createdAt": "2026-07-28T01:33:28.000Z",
              "updatedAt": "2026-07-28T01:33:28.000Z",
              "uid": "35240-27a8a369-3b99-4af1-bf38-4c1470a4b84f"
            }
          ],
          "id": "a286aed6-483c-4e7c-80b4-f9b486380925",
          "createdAt": "2026-07-28T01:33:28.000Z",
          "updatedAt": "2026-07-28T01:33:28.000Z",
          "uid": "35240-a286aed6-483c-4e7c-80b4-f9b486380925"
        },
        {
          "name": "Elastic.io List agents",
          "id": "6b8295d7-4fd1-43f6-a69b-a0016e07ca0d",
          "protocolProfileBehavior": {
            "disableBodyPruning": true
          },
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/agents?page[size]=20&page[number]=1&filter[workspace_id]=<string>",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "agents"
              ],
              "query": [
                {
                  "description": "Number of items per page",
                  "key": "page[size]",
                  "value": "20"
                },
                {
                  "description": "Page number to retrieve",
                  "key": "page[number]",
                  "value": "1"
                },
                {
                  "description": "Filter by workspace ID",
                  "key": "filter[workspace_id]",
                  "value": "<string>"
                }
              ]
            },
            "description": "Retrieve a list of on-premises integration agents."
          },
          "response": [
            {
              "id": "c7f91eaf-12fa-409b-b50a-ceb8f7a43244",
              "name": "Successful response",
              "originalRequest": {
                "method": "GET",
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  },
                  {
                    "description": "Added as a part of security scheme: bearer",
                    "key": "Authorization",
                    "value": "Bearer <token>"
                  }
                ],
                "url": {
                  "raw": "{{baseUrl}}/agents?page[size]=20&page[number]=1&filter[workspace_id]=<string>",
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "path": [
                    "agents"
                  ],
                  "query": [
                    {
                      "description": "Number of items per page",
                      "key": "page[size]",
                      "value": "20"
                    },
                    {
                      "description": "Page number to retrieve",
                      "key": "page[number]",
                      "value": "1"
                    },
                    {
                      "description": "Filter by workspace ID",
                      "key": "filter[workspace_id]",
                      "value": "<string>"
                    }
                  ]
                }
              },
              "status": "OK",
              "code": 200,
              "_postman_previewlanguage": "json",
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "cookie": [],
              "responseTime": null,
              "body": "{\n  \"data\": [\n    {\n      \"id\": \"<string>\",\n      \"type\": \"agent\",\n      \"attributes\": {\n        \"name\": \"<string>\",\n        \"status\": \"<string>\",\n        \"created_at\": \"<dateTime>\",\n        \"updated_at\": \"<dateTime>\"\n      },\n      \"relationships\": {\n        \"workspace\": {\n          \"data\": {\n            \"id\": \"<string>\",\n            \"type\": \"<string>\"\n          }\n        }\n      }\n    },\n    {\n      \"id\": \"<string>\",\n      \"type\": \"agent\",\n      \"attributes\": {\n        \"name\": \"<string>\",\n        \"status\": \"<string>\",\n        \"created_at\": \"<dateTime>\",\n        \"updated_at\": \"<dateTime>\"\n      },\n      \"relationships\": {\n        \"workspace\": {\n          \"data\": {\n            \"id\": \"<string>\",\n            \"type\": \"<string>\"\n          }\n        }\n      }\n    }\n  ],\n  \"meta\": {\n    \"page\": \"<integer>\",\n    \"per_page\": \"<integer>\",\n    \"total\": \"<integer>\",\n    \"total_pages\": \"<integer>\"\n  },\n  \"links\": {\n    \"self\": \"<uri>\",\n    \"first\": \"<uri>\",\n    \"prev\": \"<uri>\",\n    \"next\": \"<uri>\",\n    \"last\": \"<uri>\"\n  }\n}",
              "createdAt": "2026-07-28T01:33:28.000Z",
              "updatedAt": "2026-07-28T01:33:28.000Z",
              "uid": "35240-c7f91eaf-12fa-409b-b50a-ceb8f7a43244"
            },
            {
              "id": "56c35830-6a3a-4940-87bb-21a700a1e02b",
              "name": "Authentication required or token is invalid",
              "originalRequest": {
                "method": "GET",
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  },
                  {
                    "description": "Added as a part of security scheme: bearer",
                    "key": "Authorization",
                    "value": "Bearer <token>"
                  }
                ],
                "url": {
                  "raw": "{{baseUrl}}/agents?page[size]=20&page[number]=1&filter[workspace_id]=<string>",
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "path": [
                    "agents"
                  ],
                  "query": [
                    {
                      "description": "Number of items per page",
                      "key": "page[size]",
                      "value": "20"
                    },
                    {
                      "description": "Page number to retrieve",
                      "key": "page[number]",
                      "value": "1"
                    },
                    {
                      "description": "Filter by workspace ID",
                      "key": "filter[workspace_id]",
                      "value": "<string>"
                    }
                  ]
                }
              },
              "status": "Unauthorized",
              "code": 401,
              "_postman_previewlanguage": "json",
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "cookie": [],
              "responseTime": null,
              "body": "{\n  \"errors\": [\n    {\n      \"status\": \"<integer>\",\n      \"title\": \"<string>\",\n      \"detail\": \"<string>\"\n    },\n    {\n      \"status\": \"<integer>\",\n      \"title\": \"<string>\",\n      \"detail\": \"<string>\"\n    }\n  ]\n}",
              "createdAt": "2026-07-28T01:33:28.000Z",
              "updatedAt": "2026-07-28T01:33:28.000Z",
              "uid": "35240-56c35830-6a3a-4940-87bb-21a700a1e02b"
            }
          ],
          "createdAt": "2026-07-28T01:33:28.000Z",
          "updatedAt": "2026-07-28T01:33:28.000Z",
          "uid": "35240-6b8295d7-4fd1-43f6-a69b-a0016e07ca0d"
        },
        {
          "name": "Elastic.io Create an agent",
          "id": "6f062176-46e4-432f-a111-0f3a410794d1",
          "protocolProfileBehavior": {
            "disableBodyPruning": true
          },
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"data\": {\n    \"type\": \"agent\",\n    \"attributes\": {\n      \"name\": \"<string>\"\n    },\n    \"relationships\": {\n      \"workspace\": {\n        \"data\": {\n          \"id\": \"<string>\",\n          \"type\": \"<string>\"\n        }\n      }\n    }\n  }\n}",
              "options": {
                "raw": {
                  "headerFamily": "json",
                  "language": "json"
                }
              }
            },
            "url": {
              "raw": "{{baseUrl}}/agents",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "agents"
              ]
            },
            "description": "Create a new on-premises integration agent."
          },
          "response": [
            {
              "id": "97b73313-add4-4734-aaaa-38571281524d",
              "name": "Agent created successfully",
              "originalRequest": {
                "method": "POST",
                "header": [
                  {
                    "key": "Content-Type",
                    "value": "application/json"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  },
                  {
                    "description": "Added as a part of security scheme: bearer",
                    "key": "Authorization",
                    "value": "Bearer <token>"
                  }
                ],
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"data\": {\n    \"type\": \"agent\",\n    \"attributes\": {\n      \"name\": \"<string>\"\n    },\n    \"relationships\": {\n      \"workspace\": {\n        \"data\": {\n          \"id\": \"<string>\",\n          \"type\": \"<string>\"\n        }\n      }\n    }\n  }\n}",
                  "options": {
                    "raw": {
                      "headerFamily": "json",
                      "language": "json"
                    }
                  }
                },
                "url": {
                  "raw": "{{baseUrl}}/agents",
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "path": [
                    "agents"
                  ]
                }
              },
              "status": "Created",
              "code": 201,
              "_postman_previewlanguage": "json",
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "cookie": [],
              "responseTime": null,
              "body": "{\n  \"data\": {\n    \"id\": \"<string>\",\n    \"type\": \"agent\",\n    \"attributes\": {\n      \"name\": \"<string>\",\n      \"status\": \"<string>\",\n      \"created_at\": \"<dateTime>\",\n      \"updated_at\": \"<dateTime>\"\n    },\n    \"relationships\": {\n      \"workspace\": {\n        \"data\": {\n          \"id\": \"<string>\",\n          \"type\": \"<string>\"\n        }\n      }\n    }\n  }\n}",
              "createdAt": "2026-07-28T01:33:28.000Z",
              "updatedAt": "2026-07-28T01:33:28.000Z",
              "uid": "35240-97b73313-add4-4734-aaaa-38571281524d"
            },
            {
              "id": "268d954d-eb3f-4e2b-89ad-6147c909875e",
              "name": "Authentication required or token is invalid",
              "originalRequest": {
                "method": "POST",
                "header": [
                  {
                    "key": "Content-Type",
                    "value": "application/json"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  },
                  {
                    "description": "Added as a part of security scheme: bearer",
                    "key": "Authorization",
                    "value": "Bearer <token>"
                  }
                ],
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"data\": {\n    \"type\": \"agent\",\n    \"attributes\": {\n      \"name\": \"<string>\"\n    },\n    \"relationships\": {\n      \"workspace\": {\n        \"data\": {\n          \"id\": \"<string>\",\n          \"type\": \"<string>\"\n        }\n      }\n    }\n  }\n}",
                  "options": {
                    "raw": {
                      "headerFamily": "json",
                      "language": "json"
                    }
                  }
                },
                "url": {
                  "raw": "{{baseUrl}}/agents",
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "path": [
                    "agents"
                  ]
                }
              },
              "status": "Unauthorized",
              "code": 401,
              "_postman_previewlanguage": "json",
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "cookie": [],
              "responseTime": null,
              "body": "{\n  \"errors\": [\n    {\n      \"status\": \"<integer>\",\n      \"title\": \"<string>\",\n      \"detail\": \"<string>\"\n    },\n    {\n      \"status\": \"<integer>\",\n      \"title\": \"<string>\",\n      \"detail\": \"<string>\"\n    }\n  ]\n}",
              "createdAt": "2026-07-28T01:33:28.000Z",
              "updatedAt": "2026-07-28T01:33:28.000Z",
              "uid": "35240-268d954d-eb3f-4e2b-89ad-6147c909875e"
            }
          ],
          "createdAt": "2026-07-28T01:33:28.000Z",
          "updatedAt": "2026-07-28T01:33:28.000Z",
          "uid": "35240-6f062176-46e4-432f-a111-0f3a410794d1"
        }
      ],
      "id": "46e2c5b5-0840-4fab-8049-20a6374a6efb",
      "createdAt": "2026-07-28T01:33:28.000Z",
      "updatedAt": "2026-07-28T01:33:28.000Z",
      "uid": "35240-46e2c5b5-0840-4fab-8049-20a6374a6efb"
    }
  ],
  "auth": {
    "type": "bearer",
    "bearer": [
      {
        "key": "token",
        "value": "{{bearerToken}}",
        "type": "string"
      }
    ]
  },
  "variable": [
    {
      "key": "baseUrl",
      "value": "https://api.elastic.io/v2"
    }
  ]
}