{
  "info": {
    "_postman_id": "eda2f290-f29e-45fe-8398-dcf6d0f7cf48",
    "name": "Zally - Zalando's API Linter Api Violations API",
    "description": "Zally is a quality assurance tool. It's main purpose is to check the complience of\nAPI specifications to a specific set of API design rules.\n\nThe service is able to lint the API specification in OpenAPI format. The result of\nthe linting is a set of Violations. A violation contains information about the violated\nrule, its severity, and path of the violation in the specification document.\n\nThe API also provides a result and statistics endpoint. It contains aggregated statics like\nthe number of linting requests and the number of checked endpoints. Additionally, all\nlinting results and the linted API specifications can be retrieved.\n\n\nContact Support:\n Name: Team API Management\n Email: team-api-management@zalando.de",
    "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
    "createdAt": "2026-07-28T03:36:56.000Z",
    "updatedAt": "2026-07-28T03:36:56.000Z",
    "lastUpdatedBy": "35240",
    "uid": "35240-eda2f290-f29e-45fe-8398-dcf6d0f7cf48"
  },
  "item": [
    {
      "name": "api-violations",
      "item": [
        {
          "name": "{externalId}",
          "item": [
            {
              "name": "Zally Get Previous Generated Validation Result",
              "id": "112d09b5-781c-4c2d-af1e-d9549286c205",
              "protocolProfileBehavior": {
                "disableBodyPruning": true
              },
              "request": {
                "auth": {
                  "type": "bearer",
                  "bearer": [
                    {
                      "key": "token",
                      "value": "{{bearerToken}}",
                      "type": "string"
                    }
                  ]
                },
                "method": "GET",
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "url": {
                  "raw": "{{baseUrl}}/api-violations/:externalId",
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "path": [
                    "api-violations",
                    ":externalId"
                  ],
                  "variable": [
                    {
                      "id": "37d00590-cf5e-4655-b0cb-0d71e1d2a96d",
                      "key": "externalId",
                      "value": "<uuid>",
                      "description": "(Required) Identifier of a previous validation result"
                    }
                  ]
                },
                "description": "Retreive a previous validation result in the same format as when\nit was originally processed.\n\nIf the idenfied validation result cannot be found then a\n`404 Not Found` response is returned.\n"
              },
              "response": [
                {
                  "id": "96608533-59d0-4571-9831-b0c821874daa",
                  "name": "API swagger is OK",
                  "originalRequest": {
                    "method": "GET",
                    "header": [
                      {
                        "key": "Accept",
                        "value": "application/json"
                      },
                      {
                        "description": "Added as a part of security scheme: bearer",
                        "key": "Authorization",
                        "value": "Bearer <token>"
                      }
                    ],
                    "url": {
                      "raw": "{{baseUrl}}/api-violations/:externalId",
                      "host": [
                        "{{baseUrl}}"
                      ],
                      "path": [
                        "api-violations",
                        ":externalId"
                      ],
                      "variable": [
                        {
                          "key": "externalId"
                        }
                      ]
                    }
                  },
                  "status": "OK",
                  "code": 200,
                  "_postman_previewlanguage": "json",
                  "header": [
                    {
                      "key": "Content-Type",
                      "value": "application/json"
                    }
                  ],
                  "cookie": [],
                  "responseTime": null,
                  "body": "{\n  \"violations\": [\n    {\n      \"title\": \"<string>\",\n      \"description\": \"<string>\",\n      \"violation_type\": \"<string>\",\n      \"paths\": [\n        \"<string>\",\n        \"<string>\"\n      ],\n      \"rule_link\": \"<string>\",\n      \"pointer\": \"<string>\",\n      \"start_line\": \"<integer>\",\n      \"end_line\": \"<integer>\"\n    },\n    {\n      \"title\": \"<string>\",\n      \"description\": \"<string>\",\n      \"violation_type\": \"<string>\",\n      \"paths\": [\n        \"<string>\",\n        \"<string>\"\n      ],\n      \"rule_link\": \"<string>\",\n      \"pointer\": \"<string>\",\n      \"start_line\": \"<integer>\",\n      \"end_line\": \"<integer>\"\n    }\n  ],\n  \"violations_count\": {\n    \"must\": \"<integer>\",\n    \"should\": \"<integer>\",\n    \"may\": \"<integer>\",\n    \"could\": \"<integer>\",\n    \"hint\": \"<integer>\"\n  },\n  \"message\": \"<string>\",\n  \"api_definition\": \"<string>\"\n}",
                  "createdAt": "2026-07-28T03:36:57.000Z",
                  "updatedAt": "2026-07-28T03:36:57.000Z",
                  "uid": "35240-96608533-59d0-4571-9831-b0c821874daa"
                },
                {
                  "id": "33b0a919-0898-4f57-b740-75bfc04d2888",
                  "name": "No such API review",
                  "originalRequest": {
                    "method": "GET",
                    "header": [
                      {
                        "key": "Accept",
                        "value": "application/problem+json"
                      },
                      {
                        "description": "Added as a part of security scheme: bearer",
                        "key": "Authorization",
                        "value": "Bearer <token>"
                      }
                    ],
                    "url": {
                      "raw": "{{baseUrl}}/api-violations/:externalId",
                      "host": [
                        "{{baseUrl}}"
                      ],
                      "path": [
                        "api-violations",
                        ":externalId"
                      ],
                      "variable": [
                        {
                          "key": "externalId"
                        }
                      ]
                    }
                  },
                  "status": "Not Found",
                  "code": 404,
                  "_postman_previewlanguage": "json",
                  "header": [
                    {
                      "key": "Content-Type",
                      "value": "application/problem+json"
                    }
                  ],
                  "cookie": [],
                  "responseTime": null,
                  "body": "{\n  \"value\": \"reference https://opensource.zalando.com/problem/schema.yaml#/Problem not found in the OpenAPI spec\"\n}",
                  "createdAt": "2026-07-28T03:36:57.000Z",
                  "updatedAt": "2026-07-28T03:36:57.000Z",
                  "uid": "35240-33b0a919-0898-4f57-b740-75bfc04d2888"
                },
                {
                  "id": "b5dfd7b4-246f-4166-86e9-9045e37f9cb5",
                  "name": "Error object",
                  "originalRequest": {
                    "method": "GET",
                    "header": [
                      {
                        "key": "Accept",
                        "value": "application/problem+json"
                      },
                      {
                        "description": "Added as a part of security scheme: bearer",
                        "key": "Authorization",
                        "value": "Bearer <token>"
                      }
                    ],
                    "url": {
                      "raw": "{{baseUrl}}/api-violations/:externalId",
                      "host": [
                        "{{baseUrl}}"
                      ],
                      "path": [
                        "api-violations",
                        ":externalId"
                      ],
                      "variable": [
                        {
                          "key": "externalId"
                        }
                      ]
                    }
                  },
                  "status": "Internal Server Error",
                  "code": 500,
                  "_postman_previewlanguage": "json",
                  "header": [
                    {
                      "key": "Content-Type",
                      "value": "application/problem+json"
                    }
                  ],
                  "cookie": [],
                  "responseTime": null,
                  "body": "{\n  \"value\": \"reference https://opensource.zalando.com/problem/schema.yaml#/Problem not found in the OpenAPI spec\"\n}",
                  "createdAt": "2026-07-28T03:36:57.000Z",
                  "updatedAt": "2026-07-28T03:36:57.000Z",
                  "uid": "35240-b5dfd7b4-246f-4166-86e9-9045e37f9cb5"
                }
              ],
              "createdAt": "2026-07-28T03:36:57.000Z",
              "updatedAt": "2026-07-28T03:36:57.000Z",
              "uid": "35240-112d09b5-781c-4c2d-af1e-d9549286c205"
            }
          ],
          "id": "362573a1-8369-4d62-9627-7c0e59d546e8",
          "createdAt": "2026-07-28T03:36:57.000Z",
          "updatedAt": "2026-07-28T03:36:57.000Z",
          "uid": "35240-362573a1-8369-4d62-9627-7c0e59d546e8"
        },
        {
          "name": "Zally API Violations",
          "id": "ca9a6e94-cca8-45bb-9855-fa95961634c8",
          "protocolProfileBehavior": {
            "disableBodyPruning": true
          },
          "request": {
            "auth": {
              "type": "bearer",
              "bearer": [
                {
                  "key": "token",
                  "value": "{{bearerToken}}",
                  "type": "string"
                }
              ]
            },
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"api_definition\": {},\n  \"api_definition_string\": \"<string>\",\n  \"api_definition_url\": \"<string>\",\n  \"ignore_rules\": [\n    \"<string>\",\n    \"<string>\"\n  ]\n}",
              "options": {
                "raw": {
                  "headerFamily": "json",
                  "language": "json"
                }
              }
            },
            "url": {
              "raw": "{{baseUrl}}/api-violations",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "api-violations"
              ]
            },
            "description": "The API Violations endpoint validates given Swagger Specification\nagainst the rules defined in *Zalando* RESTful API Guidelines\n(http://zalando.github.io/restful-api-guidelines/).\n\nA successful response includes the list of violations grouped by\nthe API Guidelines rules.\n\nIf an api definition is supplied via url then any non-successful\nresponses from that will be passed on. For example you may be\nusing Zally without authentication but supply a password\nprotected url and still get a `401 Unauthorized` response.\n"
          },
          "response": [
            {
              "id": "7d690586-2fdf-4cf4-b7f1-9e64b084f145",
              "name": "API swagger is OK",
              "originalRequest": {
                "method": "POST",
                "header": [
                  {
                    "key": "Content-Type",
                    "value": "application/json"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  },
                  {
                    "description": "Added as a part of security scheme: bearer",
                    "key": "Authorization",
                    "value": "Bearer <token>"
                  }
                ],
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"api_definition\": {},\n  \"api_definition_string\": \"<string>\",\n  \"api_definition_url\": \"<string>\",\n  \"ignore_rules\": [\n    \"<string>\",\n    \"<string>\"\n  ]\n}",
                  "options": {
                    "raw": {
                      "headerFamily": "json",
                      "language": "json"
                    }
                  }
                },
                "url": {
                  "raw": "{{baseUrl}}/api-violations",
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "path": [
                    "api-violations"
                  ]
                }
              },
              "status": "OK",
              "code": 200,
              "_postman_previewlanguage": "json",
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                },
                {
                  "disabled": false,
                  "description": {
                    "content": "The URI where the validation result can be rerequested.",
                    "type": "text/plain"
                  },
                  "key": "Location",
                  "value": "<uri>"
                }
              ],
              "cookie": [],
              "responseTime": null,
              "body": "{\n  \"violations\": [\n    {\n      \"title\": \"<string>\",\n      \"description\": \"<string>\",\n      \"violation_type\": \"<string>\",\n      \"paths\": [\n        \"<string>\",\n        \"<string>\"\n      ],\n      \"rule_link\": \"<string>\",\n      \"pointer\": \"<string>\",\n      \"start_line\": \"<integer>\",\n      \"end_line\": \"<integer>\"\n    },\n    {\n      \"title\": \"<string>\",\n      \"description\": \"<string>\",\n      \"violation_type\": \"<string>\",\n      \"paths\": [\n        \"<string>\",\n        \"<string>\"\n      ],\n      \"rule_link\": \"<string>\",\n      \"pointer\": \"<string>\",\n      \"start_line\": \"<integer>\",\n      \"end_line\": \"<integer>\"\n    }\n  ],\n  \"violations_count\": {\n    \"must\": \"<integer>\",\n    \"should\": \"<integer>\",\n    \"may\": \"<integer>\",\n    \"could\": \"<integer>\",\n    \"hint\": \"<integer>\"\n  },\n  \"message\": \"<string>\",\n  \"api_definition\": \"<string>\"\n}",
              "createdAt": "2026-07-28T03:36:57.000Z",
              "updatedAt": "2026-07-28T03:36:57.000Z",
              "uid": "35240-7d690586-2fdf-4cf4-b7f1-9e64b084f145"
            },
            {
              "id": "a143365b-cc5a-4e0d-b93d-5dcdf1b90d63",
              "name": "Input file not parsable",
              "originalRequest": {
                "method": "POST",
                "header": [
                  {
                    "key": "Content-Type",
                    "value": "application/json"
                  },
                  {
                    "key": "Accept",
                    "value": "application/problem+json"
                  },
                  {
                    "description": "Added as a part of security scheme: bearer",
                    "key": "Authorization",
                    "value": "Bearer <token>"
                  }
                ],
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"api_definition\": {},\n  \"api_definition_string\": \"<string>\",\n  \"api_definition_url\": \"<string>\",\n  \"ignore_rules\": [\n    \"<string>\",\n    \"<string>\"\n  ]\n}",
                  "options": {
                    "raw": {
                      "headerFamily": "json",
                      "language": "json"
                    }
                  }
                },
                "url": {
                  "raw": "{{baseUrl}}/api-violations",
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "path": [
                    "api-violations"
                  ]
                }
              },
              "status": "Bad Request",
              "code": 400,
              "_postman_previewlanguage": "json",
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/problem+json"
                }
              ],
              "cookie": [],
              "responseTime": null,
              "body": "{\n  \"value\": \"reference https://opensource.zalando.com/problem/schema.yaml#/Problem not found in the OpenAPI spec\"\n}",
              "createdAt": "2026-07-28T03:36:57.000Z",
              "updatedAt": "2026-07-28T03:36:57.000Z",
              "uid": "35240-a143365b-cc5a-4e0d-b93d-5dcdf1b90d63"
            },
            {
              "id": "66d3e30d-c0dc-4b48-86eb-de1d0f178c59",
              "name": "Error object",
              "originalRequest": {
                "method": "POST",
                "header": [
                  {
                    "key": "Content-Type",
                    "value": "application/json"
                  },
                  {
                    "key": "Accept",
                    "value": "application/problem+json"
                  },
                  {
                    "description": "Added as a part of security scheme: bearer",
                    "key": "Authorization",
                    "value": "Bearer <token>"
                  }
                ],
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"api_definition\": {},\n  \"api_definition_string\": \"<string>\",\n  \"api_definition_url\": \"<string>\",\n  \"ignore_rules\": [\n    \"<string>\",\n    \"<string>\"\n  ]\n}",
                  "options": {
                    "raw": {
                      "headerFamily": "json",
                      "language": "json"
                    }
                  }
                },
                "url": {
                  "raw": "{{baseUrl}}/api-violations",
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "path": [
                    "api-violations"
                  ]
                }
              },
              "status": "Internal Server Error",
              "code": 500,
              "_postman_previewlanguage": "json",
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/problem+json"
                }
              ],
              "cookie": [],
              "responseTime": null,
              "body": "{\n  \"value\": \"reference https://opensource.zalando.com/problem/schema.yaml#/Problem not found in the OpenAPI spec\"\n}",
              "createdAt": "2026-07-28T03:36:57.000Z",
              "updatedAt": "2026-07-28T03:36:57.000Z",
              "uid": "35240-66d3e30d-c0dc-4b48-86eb-de1d0f178c59"
            }
          ],
          "createdAt": "2026-07-28T03:36:57.000Z",
          "updatedAt": "2026-07-28T03:36:57.000Z",
          "uid": "35240-ca9a6e94-cca8-45bb-9855-fa95961634c8"
        }
      ],
      "id": "7ec8ef66-16c8-42bc-9c3a-4a71b0483ccc",
      "createdAt": "2026-07-28T03:36:57.000Z",
      "updatedAt": "2026-07-28T03:36:57.000Z",
      "uid": "35240-7ec8ef66-16c8-42bc-9c3a-4a71b0483ccc"
    }
  ],
  "variable": [
    {
      "key": "baseUrl",
      "value": "https://zally.on.inter.net"
    }
  ]
}