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
curl -X POST 'https://api.getpostman.com/security/api-validation' -H 'Content-Type: application/json' -d '{"schema":{"type":"openapi3","language":"json","schema":"{\"openapi\":\"3.0.0\",\"info\":{\"version\":\"1\",\"title\":\"temp\",\"license\":{\"name\":\"MIT\"}},\"servers\":[{\"url\":\"https://petstore.swagger.io/v1\"}],\"paths\":{\"/user\":{\"get\":{\"summary\":\"Details about a user\",\"operationId\":\"listUser\",\"tags\":[\"user\"],\"parameters\":[{\"name\":\"id\",\"in\":\"query\",\"description\":\"ID of the user\",\"required\":true,\"schema\":{\"type\":\"integer\",\"format\":\"int32\"}}],\"responses\":{\"200\":{\"description\":\"Details about a user\",\"headers\":{\"x-next\":{\"description\":\"A link to the next page of responses\",\"schema\":{\"type\":\"string\"}}},\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/User\"}}}},\"default\":{\"description\":\"unexpected error\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Error\"}}}}}}}},\"components\":{\"schemas\":{\"User\":{\"type\":\"object\",\"required\":[\"id\",\"name\"],\"properties\":{\"id\":{\"type\":\"integer\",\"format\":\"int64\"},\"name\":{\"type\":\"string\"},\"tag\":{\"type\":\"string\"}}},\"Error\":{\"type\":\"object\",\"required\":[\"code\",\"message\"],\"properties\":{\"code\":{\"type\":\"integer\",\"format\":\"int32\"},\"message\":{\"type\":\"string\"}}}},\"securitySchemes\":{\"BasicAuth\":{\"type\":\"http\",\"scheme\":\"basic\"}}},\"security\":[{\"BasicAuth\":[]}]}"}}'
