{
  "opencollection": "1.0.0",
  "info": {
    "name": "API Reference subpackage_accounts subpackage_agents API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "subpackage_agents",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List agents",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.x.flatfile.com/v1/agents",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              },
              {
                "name": "X-Disable-Hooks",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "environmentId",
                "value": "",
                "type": "query"
              },
              {
                "name": "isSystem",
                "value": "",
                "type": "query"
              },
              {
                "name": "search",
                "value": "",
                "type": "query"
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query"
              },
              {
                "name": "pageNumber",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "List agents"
        },
        {
          "info": {
            "name": "Create an agent",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.x.flatfile.com/v1/agents",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              },
              {
                "name": "X-Disable-Hooks",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "environmentId",
                "value": "",
                "type": "query"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create an agent"
        },
        {
          "info": {
            "name": "Get an agent",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.x.flatfile.com/v1/agents/:agentId",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              },
              {
                "name": "X-Disable-Hooks",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "agentId",
                "value": "",
                "type": "path"
              },
              {
                "name": "environmentId",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Get an agent"
        },
        {
          "info": {
            "name": "Delete an agent",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.x.flatfile.com/v1/agents/:agentId",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              },
              {
                "name": "X-Disable-Hooks",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "agentId",
                "value": "",
                "type": "path"
              },
              {
                "name": "environmentId",
                "value": "",
                "type": "query",
                "description": "This environment variable is no longer needed or used"
              }
            ]
          },
          "docs": "Deletes a single agent"
        },
        {
          "info": {
            "name": "List agent versions for an agent",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.x.flatfile.com/v1/agents/:agentId/versions",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              },
              {
                "name": "X-Disable-Hooks",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "agentId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "List agent versions for an agent"
        },
        {
          "info": {
            "name": "Revert to a specific agent version",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.x.flatfile.com/v1/agents/:agentId/versions/:agentVersionId/revert",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              },
              {
                "name": "X-Disable-Hooks",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "agentId",
                "value": "",
                "type": "path"
              },
              {
                "name": "agentVersionId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Revert to a specific agent version"
        },
        {
          "info": {
            "name": "List Agent Roles",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.x.flatfile.com/v1/agents/:agentId/roles",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              },
              {
                "name": "X-Disable-Hooks",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "agentId",
                "value": "",
                "type": "path",
                "description": "The agent id"
              }
            ]
          },
          "docs": "Lists roles assigned to an agent."
        },
        {
          "info": {
            "name": "Assign Role to Agent",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.x.flatfile.com/v1/agents/:agentId/roles",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              },
              {
                "name": "X-Disable-Hooks",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "agentId",
                "value": "",
                "type": "path",
                "description": "The agent id"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Assigns a role to a agent."
        },
        {
          "info": {
            "name": "Remove Role from Agent",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.x.flatfile.com/v1/agents/:agentId/roles/:actorRoleId",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              },
              {
                "name": "X-Disable-Hooks",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "agentId",
                "value": "",
                "type": "path",
                "description": "The agent id"
              },
              {
                "name": "actorRoleId",
                "value": "",
                "type": "path",
                "description": "The actor role id"
              }
            ]
          },
          "docs": "Removes a role from an agent."
        },
        {
          "info": {
            "name": "Get logs for an agent",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.x.flatfile.com/v1/agents/:agentId/logs",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              },
              {
                "name": "X-Disable-Hooks",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "agentId",
                "value": "",
                "type": "path"
              },
              {
                "name": "environmentId",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Get logs for an agent"
        },
        {
          "info": {
            "name": "Get an agent log",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.x.flatfile.com/v1/agents/log/:eventId",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              },
              {
                "name": "X-Disable-Hooks",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "eventId",
                "value": "",
                "type": "path"
              },
              {
                "name": "environmentId",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Get an agent log"
        },
        {
          "info": {
            "name": "Get all agent logs in your environment",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.x.flatfile.com/v1/agents/logs",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              },
              {
                "name": "X-Disable-Hooks",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "environmentId",
                "value": "",
                "type": "query"
              },
              {
                "name": "spaceId",
                "value": "",
                "type": "query"
              },
              {
                "name": "success",
                "value": "",
                "type": "query"
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query"
              },
              {
                "name": "pageNumber",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Get all agent logs in your environment"
        },
        {
          "info": {
            "name": "Get all executions in your environment",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.x.flatfile.com/v1/agents/executions",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              },
              {
                "name": "X-Disable-Hooks",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "environmentId",
                "value": "",
                "type": "query"
              },
              {
                "name": "agentId",
                "value": "",
                "type": "query"
              },
              {
                "name": "spaceId",
                "value": "",
                "type": "query"
              },
              {
                "name": "success",
                "value": "",
                "type": "query"
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query"
              },
              {
                "name": "pageNumber",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Get all executions in your environment"
        }
      ]
    }
  ],
  "bundled": true
}