ANansible
rulebooks

GET /rulebooks/

Changed on

List all rulebooks

Request

  • Base URL
    /api/eda/v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/eda/v1/rulebooks/
  • Auth
    • API key in cookie sessionid
    • or HTTP basic
    • or HTTP bearer
    • or API key in header X-DAB-JW-TOKEN

Query parameters

namestring

Filter by rulebook name.

pageinteger

A page number within the paginated result set.

page_sizeinteger

Number of results to return per page.

project_idnumber

Filter by rulebook's project id.

Response

Return a list of rulebooks.

countinteger
nextstring uri nullable
previousstring uri nullable
page_sizeinteger nullable
pageinteger nullable

Example response

{
  "count": 123,
  "next": "/eda/api/v1/example/?page=51&page_size=100",
  "previous": "/eda/api/v1/example/?page=49&page_size=100",
  "page_size": 100,
  "page": 50
}

Changes

  • cbf68ddd9760Revision changes
    • info

      the endpoint scheme security EDAJWTAuthentication was added to the API

    • info

      the endpoint scheme security jwtAuth was added to the API

    • info

      added the required property // to the response with the status

  • c84b4813cab1Revision changes
    • info

      the endpoint scheme security cookieAuth was added to the API