Skip to main content
POST
/
v1
/
engines
Create a new engine
curl --request POST \
  --url https://api-mycroft.sherlocker.com.br/api/v1/v1/engines \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "rules": {},
  "cloneFrom": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "description": "<string>",
  "isTemplate": true,
  "ruleCount": 0,
  "rules": [
    {
      "id": "<string>",
      "name": "<string>",
      "severity": "blocking",
      "enabled": true
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
name
string
required

Engine name (1-100 chars)

​
description
string

Engine description (max 500 chars)

​
rules
object

Rule configurations (required unless cloneFrom is set)

​
cloneFrom
string<uuid>

ID of engine to clone rules from

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Response

Engine created

​
id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
​
name
string
required
​
description
string | null
required
​
isTemplate
boolean
required
​
ruleCount
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
​
rules
object[]
required