Skip to main content

ApiSecurityService

A list of all methods in the ApiSecurityService service. Click on the method name to view detailed information about that method.

MethodsDescription
SchemaSecurityValidationAsyncPerforms an analysis on the given definition and returns any issues based on your predefined rulesets. This endpoint can help you understand the violations' impact and offers solutions to help you resolve any errors. You can include this endpoint to your CI/CD process to automate schema validation. For more information, see our Rule violations in the API definition documentation. Note: - The maximum allowed size of the definition is 10 MB. - You must import and enable Postman's OWASP security rules in Postman for this endpoint to return any security rule violations.

SchemaSecurityValidationAsync

Performs an analysis on the given definition and returns any issues based on your predefined rulesets. This endpoint can help you understand the violations' impact and offers solutions to help you resolve any errors. You can include this endpoint to your CI/CD process to automate schema validation. For more information, see our Rule violations in the API definition documentation. Note: - The maximum allowed size of the definition is 10 MB. - You must import and enable Postman's OWASP security rules in Postman for this endpoint to return any security rule violations.

  • HTTP Method: POST
  • Endpoint: /security/api-validation

Parameters

NameTypeRequiredDescription
inputSchemaSecurityValidationRequestThe request body.

Return Type

SchemaSecurityValidationOkResponse

Example Usage Code Snippet

using PostmanClient;
using PostmanClient.Models;

var client = new PostmanClientClient();

var input = new SchemaSecurityValidationRequest();

var response = await client.ApiSecurity.SchemaSecurityValidationAsync(input);

Console.WriteLine(response);

Build Your Own SDKs with  liblab

Build developer friendly SDKs in minutes from your APIs

Start for Free →