{
  "opencollection": "1.0.0",
  "info": {
    "name": "ALTR Sidecar/Agent Configuration Agents API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "Agents",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Agents.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{orgID}.sc-control.live.altr.com/v1/agents",
            "params": [
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of items to return."
              },
              {
                "name": "contiguous_id",
                "value": "",
                "type": "query",
                "description": "The Contiguous ID for pagination"
              },
              {
                "name": "type",
                "value": "",
                "type": "query",
                "description": "Filter by Agent type"
              },
              {
                "name": "name_starts_with",
                "value": "",
                "type": "query",
                "description": "Filter by Agent name in a `starts with` fashion. (Case-insensitive)"
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "List Agents for your organization."
        },
        {
          "info": {
            "name": "Create a new Agent.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{orgID}.sc-control.live.altr.com/v1/agents",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Create a new Agent."
        },
        {
          "info": {
            "name": "Get an Agent.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{orgID}.sc-control.live.altr.com/v1/agents/:agent_id",
            "params": [
              {
                "name": "agent_id",
                "value": "",
                "type": "path",
                "description": "ID of the Agent."
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Get an Agent."
        },
        {
          "info": {
            "name": "Update an Agent.",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://{orgID}.sc-control.live.altr.com/v1/agents/:agent_id",
            "params": [
              {
                "name": "agent_id",
                "value": "",
                "type": "path",
                "description": "The Agent ID"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "If property is not included it will not be updated. If property included with null value, it will be removed."
        },
        {
          "info": {
            "name": "Delete Agent.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{orgID}.sc-control.live.altr.com/v1/agents/:agent_id",
            "params": [
              {
                "name": "agent_id",
                "value": "",
                "type": "path",
                "description": "ID of Agent."
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "An Agent cannot be deleted if its task_count > 0."
        }
      ]
    }
  ],
  "bundled": true
}