{
  "opencollection": "1.0.0",
  "info": {
    "name": "ALTR Sidecar/Agent Configuration Sidecars API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "Sidecars",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List all sidecars.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{orgID}.sc-control.live.altr.com/v1/sidecars",
            "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"
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "List all sidecars for your organization."
        },
        {
          "info": {
            "name": "Create a new Sidecar.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{orgID}.sc-control.live.altr.com/v1/sidecars",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Create a new Sidecar with the provided details."
        },
        {
          "info": {
            "name": "Get a Sidecar.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{orgID}.sc-control.live.altr.com/v1/sidecars/:sidecar_id",
            "params": [
              {
                "name": "sidecar_id",
                "value": "",
                "type": "path",
                "description": "ID of sidecar."
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Get the sidecar for a given sidecar ID."
        },
        {
          "info": {
            "name": "Update a Sidecar.",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://{orgID}.sc-control.live.altr.com/v1/sidecars/:sidecar_id",
            "params": [
              {
                "name": "sidecar_id",
                "value": "",
                "type": "path",
                "description": "The Sidecar ID"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Update a Sidecar."
        },
        {
          "info": {
            "name": "Delete a Sidecar.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{orgID}.sc-control.live.altr.com/v1/sidecars/:sidecar_id",
            "params": [
              {
                "name": "sidecar_id",
                "value": "",
                "type": "path",
                "description": "ID of sidecar."
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "A Sidecar cannot be deleted if its listener_count > 0."
        }
      ]
    }
  ],
  "bundled": true
}