rules

Changed on

Get a list of all rulesets for the namespace

get/rulesets/{namespace}

Request

  • Base URL
    https://api.scalar.com/core
  • URL
    https://api.scalar.com/core/rulesets/{namespace}
  • Auth
    HTTP bearer

Path parameters

namespacestring required

Response

Default Response

uidstring required
titlestring required
descriptionstring required
slugstring required
namespacestring required
isPrivateboolean required

Example response

[
  {
    "uid": "UakgbKJ5m9gl0JDMbcJqL",
    "title": "Acme API",
    "description": "API for managing Acme products and orders.",
    "slug": "acme-api",
    "namespace": "acme"
  }
]

Changes

  • 5e4c47d6805bRevision changes
    • info

      the response's property default value randomManagedDocSlug() was removed for the status

    • info

      the response's property default value nanoid() was removed for the status

  • f6130fc9c357Revision changes
    • breaking

      the / response property's minLength was decreased from 3 to 2 for the response status