Rules

Rule management and versioning

post

Body

application/json

typestringRequired

versionstringRequired

iacLanguagestringRequired

namestringRequired

classificationNamesstring[]Optional

shortNamestringOptional

activebooleanOptionalDefault: false

Responses

200

POST /api/v1/rules/create Positive response

application/json

statusconst: successRequired

400

POST /api/v1/rules/create Negative response

application/json

post/api/v1/rules/create

HTTPcURLJavaScriptPython

POST /api/v1/rules/create HTTP/1.1
Host: rules.app.gomboc.ai
Content-Type: application/json
Accept: */*
Content-Length: 422

{
  "type": "text",
  "version": "text",
  "iacLanguage": "text",
  "name": "text",
  "classificationNames": [
    "text"
  ],
  "classifications": [
    {
      "name": "text",
      "accountId": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "shortName": "text",
  "annotations": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "revisionData": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "active": false
}

{
  "status": "text",
  "data": {
    "accountId": "123e4567-e89b-12d3-a456-426614174000",
    "type": "text",
    "version": "text",
    "iacLanguage": "text",
    "name": "text",
    "shortName": null,
    "revision": 1,
    "revisions": [
      1
    ],
    "classificationPaths": [
      [
        {
          "accountId": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "shortName": null
        }
      ]
    ],
    "annotations": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "metadata": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "body": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "createdAt": null,
    "updatedAt": null
  }
}

get

Query parameters

namestringRequired

GET /api/v1/rules/get Parameter

includeClassificationsnumberOptional

GET /api/v1/rules/get Parameter

Default: 1

Responses

200

GET /api/v1/rules/get Positive response

application/json

statusconst: successRequired

400

GET /api/v1/rules/get Negative response

application/json

get/api/v1/rules/get

HTTPcURLJavaScriptPython

GET /api/v1/rules/get?name=text HTTP/1.1
Host: rules.app.gomboc.ai
Accept: */*

{
  "status": "text",
  "data": {
    "accountId": "123e4567-e89b-12d3-a456-426614174000",
    "type": "text",
    "version": "text",
    "iacLanguage": "text",
    "name": "text",
    "shortName": null,
    "revision": 1,
    "revisions": [
      1
    ],
    "classificationPaths": [
      [
        {
          "accountId": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "shortName": null
        }
      ]
    ],
    "annotations": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "metadata": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "body": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "createdAt": null,
    "updatedAt": null
  }
}

head

Query parameters

namestringRequired

HEAD /api/v1/rules/get Parameter

includeClassificationsnumberOptional

HEAD /api/v1/rules/get Parameter

Default: 1

Responses

200

HEAD /api/v1/rules/get Positive response

No content

400

HEAD /api/v1/rules/get Negative response

head/api/v1/rules/get

HTTPcURLJavaScriptPython

HEAD /api/v1/rules/get?name=text HTTP/1.1
Host: rules.app.gomboc.ai
Accept: */*

No content

put

Body

application/json

typestringOptional

versionstringOptional

iacLanguagestringOptional

classificationNamesstring[]Optional

shortNamestringOptional

activebooleanOptionalDefault: false

namestringRequired

Responses

200

PUT /api/v1/rules/update Positive response

application/json

statusconst: successRequired

400

PUT /api/v1/rules/update Negative response

application/json

put/api/v1/rules/update

HTTPcURLJavaScriptPython

PUT /api/v1/rules/update HTTP/1.1
Host: rules.app.gomboc.ai
Content-Type: application/json
Accept: */*
Content-Length: 422

{
  "type": "text",
  "version": "text",
  "iacLanguage": "text",
  "classificationNames": [
    "text"
  ],
  "classifications": [
    {
      "name": "text",
      "accountId": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "shortName": "text",
  "annotations": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "revisionData": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "active": false,
  "name": "text"
}

{
  "status": "text",
  "data": {
    "accountId": "123e4567-e89b-12d3-a456-426614174000",
    "type": "text",
    "version": "text",
    "iacLanguage": "text",
    "name": "text",
    "shortName": null,
    "revision": 1,
    "revisions": [
      1
    ],
    "classificationPaths": [
      [
        {
          "accountId": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "shortName": null
        }
      ]
    ],
    "annotations": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "metadata": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "body": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "createdAt": null,
    "updatedAt": null
  }
}

delete

Query parameters

namestringRequired

DELETE /api/v1/rules/delete Parameter

revisionnumberOptional

DELETE /api/v1/rules/delete Parameter

allbooleanOptional

DELETE /api/v1/rules/delete Parameter

Responses

200

DELETE /api/v1/rules/delete Positive response

application/json

statusconst: successRequired

400

DELETE /api/v1/rules/delete Negative response

application/json

delete/api/v1/rules/delete

HTTPcURLJavaScriptPython

DELETE /api/v1/rules/delete?name=text HTTP/1.1
Host: rules.app.gomboc.ai
Accept: */*

{
  "status": "text",
  "data": {
    "success": true
  }
}

get

Query parameters

pagenumberOptional

GET /api/v1/rules/search Parameter

Default: 1

perPagenumberOptional

GET /api/v1/rules/search Parameter

Default: 20

querystringOptional

GET /api/v1/rules/search Parameter

filtersany ofOptional

GET /api/v1/rules/search Parameter

stringOptional

or

string[]Optional

filters[]any ofOptional

GET /api/v1/rules/search Parameter

stringOptional

or

string[]Optional

typestringOptional

GET /api/v1/rules/search Parameter

iacLanguagestringOptional

GET /api/v1/rules/search Parameter

includeClassificationsnumberOptional

GET /api/v1/rules/search Parameter

Default: 1

Responses

200

GET /api/v1/rules/search Positive response

application/json

statusconst: successRequired

400

GET /api/v1/rules/search Negative response

application/json

get/api/v1/rules/search

HTTPcURLJavaScriptPython

GET /api/v1/rules/search HTTP/1.1
Host: rules.app.gomboc.ai
Accept: */*

{
  "status": "text",
  "data": {
    "rules": [
      {
        "accountId": "123e4567-e89b-12d3-a456-426614174000",
        "type": "text",
        "version": "text",
        "iacLanguage": "text",
        "name": "text",
        "shortName": null,
        "revision": 1,
        "revisions": [
          1
        ],
        "classificationPaths": [
          [
            {
              "accountId": "123e4567-e89b-12d3-a456-426614174000",
              "name": "text",
              "shortName": null
            }
          ]
        ],
        "annotations": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "metadata": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "body": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "createdAt": null,
        "updatedAt": null
      }
    ],
    "total": 1,
    "page": 1,
    "perPage": 1
  }
}

head

Query parameters

pagenumberOptional

HEAD /api/v1/rules/search Parameter

Default: 1

perPagenumberOptional

HEAD /api/v1/rules/search Parameter

Default: 20

querystringOptional

HEAD /api/v1/rules/search Parameter

filtersany ofOptional

HEAD /api/v1/rules/search Parameter

stringOptional

or

string[]Optional

filters[]any ofOptional

HEAD /api/v1/rules/search Parameter

stringOptional

or

string[]Optional

typestringOptional

HEAD /api/v1/rules/search Parameter

iacLanguagestringOptional

HEAD /api/v1/rules/search Parameter

includeClassificationsnumberOptional

HEAD /api/v1/rules/search Parameter

Default: 1

Responses

200

HEAD /api/v1/rules/search Positive response

No content

400

HEAD /api/v1/rules/search Negative response

head/api/v1/rules/search

HTTPcURLJavaScriptPython

HEAD /api/v1/rules/search HTTP/1.1
Host: rules.app.gomboc.ai
Accept: */*

No content

put

Body

application/json

namestringRequired

revisionnumberRequired

Responses

200

PUT /api/v1/rules/activate Positive response

application/json

statusconst: successRequired

400

PUT /api/v1/rules/activate Negative response

application/json

put/api/v1/rules/activate

HTTPcURLJavaScriptPython

PUT /api/v1/rules/activate HTTP/1.1
Host: rules.app.gomboc.ai
Content-Type: application/json
Accept: */*
Content-Length: 28

{
  "name": "text",
  "revision": 1
}

{
  "status": "text",
  "data": {
    "success": true
  }
}