Logo
30-day challenge API Documentation

Schema security validation

POST https://api.getpostman.com/security/api-validation

This endpoint will perform static analysis on the Schema specification. It will return the security misses in your schema definition and help you understand their implications and possible ways to patch the warnings. You can introduce this endpoint to your CI/CD process to automate your schema validation.

Request Body(max size 10MB)

Key Value Type Required Description
type Enum(openapi3, openapi2) Yes Type of Schema Specification
language Enum(json, yaml) Yes Format of Schema Specification
schema String Yes Stringified Schema Body

Visit Learning Center for more information

 

Body PARAM

Key Datatype Required Description 



HEADERS

Key Datatype Required Description 
Content-Type
string




RESPONSES

status OK

{ "warnings": [ { "severity": "MEDIUM", "message": "HTTP authentication scheme is using an unknown scheme.", "location": { "start": { "line": 1, "column": 1116 }, "end": { "line": 1, "column": 1118 } }, "dataPath": [ "components", "securitySchemes", "BasicAuth", "scheme" ], "possibleFixUrl": "https://go.pstmn.io/openapi3-security-warnings#http-authentication-scheme-is-using-an-unknown-scheme", "category": { "name": "Broken User Authentication" } } ] }



Curl
curl -X POST 'https://api.getpostman.com/security/api-validation' -H 'Content-Type: application/json' -d '{"schema":{"type":"undefined","language":"undefined","schema":"undefined"}}'

ENDPOINTS