Skip to main content
POST
ValidateOsi

Authorizations

Authorization
string
header
required

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

Body

application/json
document
string

The OSI document, in YAML or JSON. string.max_bytes = 2097152

Minimum string length: 1

Response

200 - application/json

Success

valid
boolean

True when no finding has the ERROR severity. A document with only warnings is valid.

findings
OsiFinding · object[]

All the findings. The errors come first, then the warnings. Empty when the document has no findings.

osiVersion
string

The OSI specification version that the document was checked against.

Maximum string length: 64