overlane bot list | Overlane Docs

Lists the bots registered for the team with their platform, webhook address and key version. Signing secrets are never listed. Any role may read the list.

Usage

overlane bot list [--service URL] [--team TENANT_ID]

Flags

Flag	Type	Required	Default	Description
`--service`	string	no		The service address (default: OVERLANE_SERVICE_URL, then the project’s binding, then the hosted service)
`--team`	string	no		The team (tenant) to act on (default: the one your token belongs to)

Examples

overlane bot list
overlane bot list --json

Behavior

Effect: read (changes nothing).
Needs credentials: yes. Uses the network: yes.
Supports --dry-run: no. Accepts --force: no.
Machine-readable description: overlane schema bot list.

Result

With --json (the default when stdout is not a terminal) the command prints this JSON Schema’s shape on stdout.

{
  "type": "object",
  "properties": {
    "bots": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "botId": {
            "type": "string",
            "pattern": "^bot_[A-Za-z0-9]{8,32}$",
            "description": "bot identifier"
          },
          "tenantId": {
            "type": "string",
            "minLength": 1,
            "maxLength": 128,
            "pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]*$",
            "description": "tenant identifier"
          },
          "name": {
            "type": "string",
            "minLength": 1,
            "maxLength": 100
          },
          "platform": {
            "type": "string",
            "enum": [
              "chatgpt-dots",
              "grok-bot",
              "slack",
              "teams",
              "generic"
            ]
          },
          "webhookUrl": {
            "type": "string",
            "maxLength": 2000
          },
          "keyVersion": {
            "type": "integer",
            "exclusiveMinimum": 0,
            "maximum": 9007199254740991
          },
          "createdBy": {
            "type": "string",
            "minLength": 1,
            "maxLength": 128
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
          },
          "revokedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
          }
        },
        "required": [
          "botId",
          "tenantId",
          "name",
          "platform",
          "webhookUrl",
          "keyVersion",
          "createdBy",
          "createdAt"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "bots"
  ],
  "additionalProperties": false
}

See exit codes for the status the process returns.