---
updatedAt: 2026-08-13T15:44:44.000Z
agentTools:
  projectIndex: https://replicated-vendor-api.readme.io/llms.txt
---

# Get current-month registry egress ranked by customer for an app.

Required RBAC Policy: kots/externalregistry/list
Required RBAC Policy: kots/app/[:appid]/read
Required RBAC Policy: kots/app/[:appid]/license/[:customerid]/read for every attributed customer

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "description": "List, create, update, archive customers and fetch customer licenses",
    "title": "Vendor API V3",
    "contact": {
      "name": "Replicated, Inc.",
      "url": "http://www.replicated.com/",
      "email": "info@replicated.com"
    },
    "version": "3.0.0"
  },
  "paths": {
    "/registry/egress/customers": {
      "get": {
        "security": [
          {
            "api_key": []
          }
        ],
        "description": "Required RBAC Policy: kots/externalregistry/list\nRequired RBAC Policy: kots/app/[:appid]/read\nRequired RBAC Policy: kots/app/[:appid]/license/[:customerid]/read for every attributed customer",
        "tags": [
          "registry"
        ],
        "summary": "Get current-month registry egress ranked by customer for an app.",
        "operationId": "getRegistryEgressCustomers",
        "parameters": [
          {
            "x-go-name": "PageSize",
            "description": "Page size",
            "name": "pageSize",
            "in": "query",
            "schema": {
              "type": "integer",
              "format": "int64",
              "default": 20
            }
          },
          {
            "x-go-name": "CurrentPage",
            "description": "Current page",
            "name": "currentPage",
            "in": "query",
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          },
          {
            "x-go-name": "SortColumn",
            "description": "Sort column",
            "name": "sortColumn",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "x-go-name": "SortDesc",
            "description": "Sort descending",
            "name": "sortDesc",
            "in": "query",
            "schema": {
              "type": "boolean"
            }
          },
          {
            "x-go-name": "AppID",
            "description": "App ID whose customer egress should be returned.",
            "name": "app_id",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/components/responses/getRegistryEgressCustomersResponse"
          },
          "400": {
            "$ref": "#/components/responses/responseErrBadRequest"
          },
          "401": {
            "$ref": "#/components/responses/responseErrUnauthorized"
          },
          "403": {
            "$ref": "#/components/responses/responseErrForbidden"
          }
        }
      }
    }
  },
  "servers": [
    {
      "url": "https://api.replicated.com/vendor/v3"
    }
  ],
  "components": {
    "responses": {
      "getRegistryEgressCustomersResponse": {
        "description": "GetEgressCustomersResponse contains a paginated customer egress ranking.",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "customers": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/RegistryEgressCustomerResponse"
                  },
                  "x-go-name": "Customers"
                },
                "period_end": {
                  "type": "string",
                  "x-go-name": "PeriodEnd"
                },
                "period_start": {
                  "type": "string",
                  "x-go-name": "PeriodStart"
                },
                "total_bytes": {
                  "type": "integer",
                  "format": "int64",
                  "x-go-name": "TotalBytes"
                },
                "total_count": {
                  "type": "integer",
                  "format": "int64",
                  "x-go-name": "TotalCount"
                }
              }
            }
          }
        }
      },
      "responseErrBadRequest": {
        "description": "Returned on bad input",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "error_code": {
                  "description": "Error code if available",
                  "type": "string",
                  "x-go-name": "ErrorCode"
                },
                "message": {
                  "description": "Error message text if available",
                  "type": "string",
                  "x-go-name": "Message"
                }
              }
            }
          }
        }
      },
      "responseErrForbidden": {
        "description": "Returned if the caller does not have the needed permission",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "error": {
                  "type": "object",
                  "properties": {
                    "message": {
                      "type": "string",
                      "x-go-name": "Message"
                    },
                    "messageCode": {
                      "type": "string",
                      "x-go-name": "MessageCode"
                    }
                  },
                  "x-go-name": "Error"
                }
              }
            }
          }
        }
      },
      "responseErrUnauthorized": {
        "description": "Return if the caller is not authorized",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "message": {
                  "type": "string",
                  "x-go-name": "Message"
                }
              }
            }
          }
        }
      }
    },
    "securitySchemes": {
      "api_key": {
        "type": "apiKey",
        "name": "Authorization",
        "in": "header"
      }
    },
    "schemas": {
      "RegistryEgressCustomerResponse": {
        "type": "object",
        "properties": {
          "bytes": {
            "type": "integer",
            "format": "int64",
            "x-go-name": "Bytes"
          },
          "customer_id": {
            "type": "string",
            "x-go-name": "CustomerID"
          },
          "customer_name": {
            "type": "string",
            "x-go-name": "CustomerName"
          },
          "is_archived": {
            "type": "boolean",
            "x-go-name": "IsArchived"
          },
          "share": {
            "type": "number",
            "format": "double",
            "x-go-name": "Share"
          }
        },
        "x-go-package": "github.com/replicatedhq/vandoor/handlers/vendor-api/replv3/registry"
      }
    }
  }
}
```