getv1RulesetsNamespace

List all rules

Get a list of all rulesets for the namespace

Path Parameters
  • namespace
    Type: string
    required
Responses
  • 200
    Type: array object[]

    Default Response

    • description
      Type: string
      default: 
      ""
    • isPrivate
      Type: boolean
      default: 
      false
    • namespace
      Type: string
      min length:  
      3
      max length:  
      50
      Pattern: ^[a-zA-Z0-9-_]+$
      required
    • slug
      Type: string
      min length:  
      3
      max length:  
      60
      Pattern: ^[a-z](?:[a-z0-9-]*[a-z0-9])?$
      default: 
      "select-vapor-uw2trbi"
    • title
      Type: string
      max length:  
      100
      default: 
      ""
    • uid
      Type: string
      min length:  
      5
      default: 
      "IvAH525rwBfOMVz0QrKDo"
  • 400
    Type: object
    • code
      Type: string
      required
    • message
      Type: string
      required
  • 401
    Type: object
    • code
      Type: string
      required
    • message
      Type: string
      required
  • 403
    Type: object
    • code
      Type: string
      required
    • message
      Type: string
      required
  • 404
    Type: object
    • code
      Type: string
      required
    • message
      Type: string
      required
  • 422
    Type: object
    • code
      Type: string
      required
    • message
      Type: string
      required
  • 500
    Type: object
    • code
      Type: string
      required
    • message
      Type: string
      required
Request Example for get/v1/rulesets/{namespace}
import { Scalar } from "@scalar/sdk";

const scalar = new Scalar({
  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await scalar.rules.getv1RulesetsNamespace({
    namespace: "<value>",
  });

  console.log(result);
}

run();
[
  {
    "uid": "IvAH525rwBfOMVz0QrKDo",
    "title": "",
    "description": "",
    "slug": "select-vapor-uw2trbi",
    "namespace": "string",
    "isPrivate": false
  }
]