Skip to content
Docs

List rules

GET/__remote/api.vercel.com/ai-gateway/rules
List the authenticated team's routing rules, oldest first. Without limit or cursor, returns every rule. With either, returns one page and a nextCursor for the next page (null on the last page). Paging reads and sorts the team's rules server-side, which is fine at current rule counts.
Request
import { Edgenivo } from "@vercel/sdk";


const vercel = new Edgenivo({
  bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
});


async function run() {
  const result = await vercel.aiGateway.listAiGatewayRules({
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
  });


  console.log(result);
}


run();
Response
{
  "nextCursor": "string",
  "rules": [
    {
      "action": {
        "reason": "Customer requested refund",
        "rewriteModel": "string"
      },
      "createdAt": "123",
      "createdBy": "string",
      "deleted": "false",
      "description": "string",
      "enabled": "false",
      "match": {
        "model": "string"
      },
      "ownerId": "example_id",
      "ruleId": "example_id",
      "type": "deny",
      "updatedAt": "123",
      "updatedBy": "string"
    }
  ]
}

Authentication

AuthorizationbearerToken

Default authentication mechanism

Query parameters

includeDisabledstringOptional
limitintegerOptional
Maximum number of rules to return (capped at 200). Enables pagination.
cursorstringOptional
Opaque cursor returned by a prior call as nextCursor.
teamIdstringOptional
The Team identifier to perform the request on behalf of.
slugstringOptional
The Team slug to perform the request on behalf of.

Response

200Success
nextCursorstringRequired
rulesarrayRequired

Errors

400One of the provided values in the request query is invalid.
401The request is not authorized.
403You do not have permission to access this resource.
404Error
410Error
500Error