{
  "openapi": "3.0.4",
  "info": {
    "title": "IPThreat API",
    "description": "To use this api, you must <a href='https://ipthreat.net/requestpermissions'>request permissions</a>.<br/><br/><a href='https://ipthreat.net'>Ir para a página inicial do IPThreat</a>",
    "version": "v1"
  },
  "paths": {
    "/api": {
      "get": {
        "tags": [
          "Api"
        ],
        "summary": "Index",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/api/check": {
      "get": {
        "tags": [
          "Api"
        ],
        "summary": "Check status of a single ip. For high volume checks, please download a list from https://ipthreat.net/lists.\nRate limit: 30 day for regular user, 5000/day for bulk report users.",
        "description": "Always returns 200 for a valid ip. Check `found` to see if the ip has ever been reported.\n            Returns 400 for an invalid ip.",
        "parameters": [
          {
            "name": "ip",
            "in": "query",
            "description": "IP to check",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CheckResult"
                }
              }
            }
          }
        }
      }
    },
    "/api/checkphishing": {
      "get": {
        "tags": [
          "Api"
        ],
        "summary": "Check status of a url for phishing. For high volume checks, please download a list from https://ipthreat.net/phishinglists.\nRate limit: 30 day for regular user, 5000/day for bulk report users.",
        "description": "Always returns 200 for a valid url. Check `found` to see if the url has ever been reported\n            and `isPhishing` to see if reports indicate phishing or malware. Returns 400 for an invalid url.",
        "parameters": [
          {
            "name": "url",
            "in": "query",
            "description": "Url to check",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CheckPhishingResponse"
                }
              }
            }
          }
        }
      }
    },
    "/api/report": {
      "post": {
        "tags": [
          "Api"
        ],
        "summary": "Report a single attack using structured data. Rate limit is 5000 calls per day.\nIf you have not requested and been granted bulk report priviliges, you are limited to 30 calls per day.",
        "description": "Flags can be integer bitwise OR, or a comma separated list of string.  \n            ­  \n            Please reference [Csv format doc](https://ipthreat.net/bulkreportformat) for a detailed explanation of fields.",
        "requestBody": {
          "description": "Request",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ReportIPModel"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ReportResponse"
                }
              }
            }
          }
        }
      }
    },
    "/api/bulkreport": {
      "post": {
        "tags": [
          "Api"
        ],
        "summary": "Bulk report using structured data. This end point should not be called more than once per hour on average.\nYou must have requested and been granted bulk report priviliges first.",
        "description": "Flags can be integer bitwise OR, or a comma separated list of string.  \n            ­  \n            Please reference [Csv format doc](https://ipthreat.net/bulkreportformat) for a detailed explanation of fields.",
        "requestBody": {
          "description": "Request",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/BulkReportRequest"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BulkReportResponse"
                }
              }
            }
          }
        }
      }
    },
    "/api/bulkreportcsv": {
      "post": {
        "tags": [
          "Api"
        ],
        "summary": "Bulk report csv data. This end point should not be called more than once per hour on average.\nYou must have requested and been granted bulk report priviliges first.",
        "description": "Please reference [Csv format doc](https://ipthreat.net/bulkreportformat) for a detailed explanation of fields.",
        "requestBody": {
          "description": "CsvData",
          "content": {
            "application/octet-stream": {
              "schema": {
                "type": "string",
                "format": "binary"
              }
            },
            "text/csv": {
              "schema": {
                "type": "string",
                "format": "binary"
              }
            },
            "application/json": {
              "schema": {
                "type": "string",
                "format": "binary"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BulkReportResponse"
                }
              }
            }
          }
        }
      }
    },
    "/api/bulkreportphishingcsv": {
      "post": {
        "tags": [
          "Api"
        ],
        "summary": "Bulk report phishing csv data. This end point should not be called more than once per hour on average.\nYou must have requested and been granted bulk report priviliges first.",
        "description": "Fields: Url,Flags,Notes. Flags can be Legitimate (0), Phishing (1), Malware (2).",
        "requestBody": {
          "description": "CsvData",
          "content": {
            "application/octet-stream": {
              "schema": {
                "type": "string",
                "format": "binary"
              }
            },
            "text/csv": {
              "schema": {
                "type": "string",
                "format": "binary"
              }
            },
            "application/json": {
              "schema": {
                "type": "string",
                "format": "binary"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BulkReportResponse"
                }
              }
            }
          }
        }
      }
    },
    "/api/submissions": {
      "delete": {
        "tags": [
          "Api"
        ],
        "summary": "Delete user submissions.\nYou must have requested and been granted bulk report priviliges first.",
        "requestBody": {
          "description": "Request",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/DeleteSubmissionsRequest"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DeleteSubmissionsResponse"
                }
              }
            }
          }
        }
      }
    },
    "/api/list/{id}": {
      "get": {
        "tags": [
          "Api"
        ],
        "summary": "Get user list.\nYou must have requested and been granted bulk report priviliges first.",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "List id to get",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ReadUserListResponse"
                }
              }
            }
          }
        }
      }
    },
    "/api/lists/{id}": {
      "get": {
        "tags": [
          "Api"
        ],
        "summary": "Get user lists.\nYou must have requested and been granted bulk report priviliges first.",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "User id to get lists for or 0 for your own lists",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ReadUserListsResponse"
                }
              }
            }
          }
        }
      }
    },
    "/api/list": {
      "post": {
        "tags": [
          "Api"
        ],
        "summary": "User list upsert. Leave fields null/missing to not update them.\nSet id to 0 to create a new list, or to an existing list id to update it.\nIf ip addresses are specified, they are upserted as a whole, replacing the entire contents of the list.\nTo add or remove individual ip addresses without replacing the list, use PATCH /api/list.\nYou must have requested and been granted bulk report priviliges first.",
        "requestBody": {
          "description": "Request",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UpsertUserListRequest"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UpsertUserListResponse"
                }
              }
            }
          }
        }
      },
      "patch": {
        "tags": [
          "Api"
        ],
        "summary": "Add and/or remove ip addresses from an existing user list in one operation.\nRemovals are applied first, then additions. Duplicate entries are ignored.\nRemoved ips/ranges must match an existing entry exactly; a larger range containing the ip is not split.\nYou must have requested and been granted bulk report priviliges first.",
        "requestBody": {
          "description": "Request",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PatchUserListRequest"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PatchUserListResponse"
                }
              }
            }
          }
        }
      },
      "delete": {
        "tags": [
          "Api"
        ],
        "summary": "Delete user list.\nYou must have requested and been granted bulk report priviliges first.",
        "requestBody": {
          "description": "Request",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/DeleteUserListRequest"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DeleteUserListResponse"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "BulkReportRequest": {
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ReportIPModel"
            },
            "description": "IP addresses to report",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": "Bulk report request"
      },
      "BulkReportResponse": {
        "type": "object",
        "properties": {
          "error": {
            "type": "boolean",
            "description": "True if error, false otherwise",
            "example": false
          },
          "message": {
            "type": "string",
            "description": "Message. If Error is true, this is an error message.",
            "nullable": true
          },
          "status": {
            "type": "integer",
            "description": "Status code",
            "format": "int32"
          }
        },
        "additionalProperties": false,
        "description": "Bulk report response"
      },
      "CheckPhishingResponse": {
        "type": "object",
        "properties": {
          "error": {
            "type": "boolean",
            "description": "True if error, false otherwise",
            "example": false
          },
          "message": {
            "type": "string",
            "description": "Message. If Error is true, this is an error message.",
            "nullable": true
          },
          "status": {
            "type": "integer",
            "description": "Status code",
            "format": "int32"
          },
          "url": {
            "type": "string",
            "description": "Normalized url that was checked",
            "nullable": true,
            "example": "https://bad.example/login"
          },
          "found": {
            "type": "boolean",
            "description": "True if the url has been reported to IPThreat, false otherwise",
            "example": true
          },
          "isPhishing": {
            "type": "boolean",
            "description": "True if reports for this url indicate phishing or malware (more phishing/malware reports than legitimate reports)",
            "example": true
          },
          "id": {
            "type": "integer",
            "description": "Url id, 0 if not found. Url details can be viewed at https://ipthreat.net/url/{id}",
            "format": "int64",
            "example": 12345
          },
          "reportCount": {
            "type": "integer",
            "description": "Number of distinct users who have reported this url",
            "format": "int64",
            "example": 3
          },
          "threatScore": {
            "type": "integer",
            "description": "Threat score (0-100), percentage of reports flagging the url as phishing or malware",
            "format": "int32",
            "example": 100
          },
          "phishingCount": {
            "type": "integer",
            "description": "Number of reports flagging the url as phishing",
            "format": "int32",
            "example": 2
          },
          "malwareCount": {
            "type": "integer",
            "description": "Number of reports flagging the url as hosting malware",
            "format": "int32",
            "example": 1
          },
          "legitimateCount": {
            "type": "integer",
            "description": "Number of reports flagging the url as legitimate",
            "format": "int32",
            "example": 0
          },
          "firstReported": {
            "type": "string",
            "description": "When the url was first reported (utc), null if not found",
            "format": "date-time",
            "nullable": true
          },
          "lastReported": {
            "type": "string",
            "description": "When the url was last reported (utc), null if not found",
            "format": "date-time",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": "Check phishing api response"
      },
      "CheckResult": {
        "type": "object",
        "properties": {
          "error": {
            "type": "boolean",
            "description": "True if error, false otherwise",
            "example": false
          },
          "message": {
            "type": "string",
            "description": "Message. If Error is true, this is an error message.",
            "nullable": true
          },
          "status": {
            "type": "integer",
            "description": "Status code",
            "format": "int32"
          },
          "ip": {
            "type": "string",
            "description": "Normalized ip address that was checked",
            "nullable": true,
            "example": "1.2.3.4"
          },
          "found": {
            "type": "boolean",
            "description": "True if the ip has ever been reported to IPThreat, false otherwise",
            "example": true
          },
          "threatLevel": {
            "type": "integer",
            "description": "Threat level (0-100)",
            "format": "int32",
            "example": 75
          },
          "attackCount": {
            "type": "integer",
            "description": "Attack count in last 12 months",
            "format": "int32",
            "example": 12
          }
        },
        "additionalProperties": false,
        "description": "Check result"
      },
      "DeleteSubmissionsRequest": {
        "type": "object",
        "properties": {
          "ipAddresses": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "IP addresses of the submissions to delete",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": "Delete submissiosn request"
      },
      "DeleteSubmissionsResponse": {
        "type": "object",
        "properties": {
          "error": {
            "type": "boolean",
            "description": "True if error, false otherwise",
            "example": false
          },
          "message": {
            "type": "string",
            "description": "Message. If Error is true, this is an error message.",
            "nullable": true
          },
          "status": {
            "type": "integer",
            "description": "Status code",
            "format": "int32"
          },
          "count": {
            "type": "integer",
            "description": "Number of deleted submissions",
            "format": "int32"
          }
        },
        "additionalProperties": false,
        "description": "Delete submissions response"
      },
      "DeleteUserListRequest": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "List id. Leave as 0 for creating new lists.",
            "format": "int32"
          }
        },
        "additionalProperties": false,
        "description": "Delete user list request"
      },
      "DeleteUserListResponse": {
        "type": "object",
        "properties": {
          "error": {
            "type": "boolean",
            "description": "True if error, false otherwise",
            "example": false
          },
          "message": {
            "type": "string",
            "description": "Message. If Error is true, this is an error message.",
            "nullable": true
          },
          "status": {
            "type": "integer",
            "description": "Status code",
            "format": "int32"
          },
          "id": {
            "type": "integer",
            "description": "Id of the list",
            "format": "int32"
          },
          "userId": {
            "type": "integer",
            "description": "User id of the list",
            "format": "int32"
          },
          "name": {
            "type": "string",
            "description": "List name",
            "nullable": true
          },
          "url": {
            "type": "string",
            "description": "Url",
            "nullable": true
          },
          "description": {
            "type": "string",
            "description": "List description markdown",
            "nullable": true
          },
          "descriptionHtml": {
            "type": "string",
            "description": "List description html",
            "nullable": true
          },
          "ipAddresses": {
            "type": "string",
            "description": "IP addresses in the list",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": "Delete user list response"
      },
      "PatchUserListRequest": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "List id. Leave as 0 for creating new lists.",
            "format": "int32"
          },
          "add": {
            "type": "string",
            "description": "Ips, CIDRs, ranges, urls or comments to add to the list (100k max).\nSame delimiter, entry and comment rules as `ipAddresses` on POST /api/list.\nEntries already in the list are ignored, except that an added entry with an inline comment replaces the existing entry's comment.",
            "nullable": true,
            "example": "11.22.33.0/24 #Block these scammers, 1.1.1.1-1.1.255.255"
          },
          "remove": {
            "type": "string",
            "description": "Ips, CIDRs, ranges, urls or comments to remove from the list (100k max). Same delimiters as `add`.\nIps, CIDRs and ranges are subtracted from the existing list: any existing range that contains or overlaps a removed\nip or range is split, so the removed addresses are no longer in the list. This lets you allow an ip that is inside a larger block,\ne.g. removing `11.22.33.50` from `11.22.33.0/24` leaves `11.22.33.0-11.22.33.49` and `11.22.33.51-11.22.33.255`.\nSplit pieces keep the original entry's inline comment, and are written as CIDR when aligned, otherwise as a range.\nRemoving a range that covers an existing entry removes the entry entirely.\nUrls and standalone comments must match exactly (urls case insensitive, comments including the leading `#`).\nRemovals are applied to the existing list before additions, so an entry in both `remove` and `add` ends up in the list.",
            "nullable": true,
            "example": "11.22.33.50, 55.66.77.0/24"
          },
          "combine": {
            "type": "boolean",
            "description": "Whether to combine overlapping ip ranges or adjacent ip ranges. Default is false."
          }
        },
        "additionalProperties": false,
        "description": "Patch user list request, adds and/or removes entries from an existing list in one operation"
      },
      "PatchUserListResponse": {
        "type": "object",
        "properties": {
          "error": {
            "type": "boolean",
            "description": "True if error, false otherwise",
            "example": false
          },
          "message": {
            "type": "string",
            "description": "Message. If Error is true, this is an error message.",
            "nullable": true
          },
          "status": {
            "type": "integer",
            "description": "Status code",
            "format": "int32"
          },
          "id": {
            "type": "integer",
            "description": "Id of the list",
            "format": "int32"
          },
          "userId": {
            "type": "integer",
            "description": "User id of the list",
            "format": "int32"
          },
          "name": {
            "type": "string",
            "description": "List name",
            "nullable": true
          },
          "url": {
            "type": "string",
            "description": "Url",
            "nullable": true
          },
          "description": {
            "type": "string",
            "description": "List description markdown",
            "nullable": true
          },
          "descriptionHtml": {
            "type": "string",
            "description": "List description html",
            "nullable": true
          },
          "ipAddresses": {
            "type": "string",
            "description": "IP addresses in the list",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": "Patch user list response"
      },
      "ReadUserListResponse": {
        "type": "object",
        "properties": {
          "error": {
            "type": "boolean",
            "description": "True if error, false otherwise",
            "example": false
          },
          "message": {
            "type": "string",
            "description": "Message. If Error is true, this is an error message.",
            "nullable": true
          },
          "status": {
            "type": "integer",
            "description": "Status code",
            "format": "int32"
          },
          "id": {
            "type": "integer",
            "description": "Id of the list",
            "format": "int32"
          },
          "userId": {
            "type": "integer",
            "description": "User id of the list",
            "format": "int32"
          },
          "name": {
            "type": "string",
            "description": "List name",
            "nullable": true
          },
          "url": {
            "type": "string",
            "description": "Url",
            "nullable": true
          },
          "description": {
            "type": "string",
            "description": "List description markdown",
            "nullable": true
          },
          "descriptionHtml": {
            "type": "string",
            "description": "List description html",
            "nullable": true
          },
          "ipAddresses": {
            "type": "string",
            "description": "IP addresses in the list",
            "nullable": true
          },
          "combine": {
            "type": "boolean",
            "description": "Whether to combine ip address ranges"
          }
        },
        "additionalProperties": false,
        "description": "Read user list response"
      },
      "ReadUserListsResponse": {
        "type": "object",
        "properties": {
          "error": {
            "type": "boolean",
            "description": "True if error, false otherwise",
            "example": false
          },
          "message": {
            "type": "string",
            "description": "Message. If Error is true, this is an error message.",
            "nullable": true
          },
          "status": {
            "type": "integer",
            "description": "Status code",
            "format": "int32"
          },
          "lists": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/UserListEntry"
            },
            "description": "User lists (id, name)",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": "Read user lists response"
      },
      "ReportIPModel": {
        "type": "object",
        "properties": {
          "token": {
            "type": "string",
            "description": "Token if needed for captcha or other cases, otherwise empty",
            "nullable": true
          },
          "ip": {
            "type": "string",
            "description": "The ip address that performed the attack",
            "nullable": true,
            "example": "1.2.3.4"
          },
          "flags": {
            "$ref": "#/components/schemas/SubmissionFlags"
          },
          "system": {
            "type": "string",
            "description": "System attacked, short description i.e. SMTP, PHP, IIS, SSH, RDP, etc.",
            "nullable": true,
            "example": "SMTP"
          },
          "notes": {
            "type": "string",
            "description": "Notes, ok to leave blank. Can put a log snippet here, but please remove timestamps, user names and any other personally identifiable information.",
            "nullable": true,
            "example": "Failed password"
          },
          "ts": {
            "type": "string",
            "description": "Timestamp of the attack.",
            "format": "date-time"
          },
          "count": {
            "type": "integer",
            "description": "Counter if aggregating, otherwise default is 1.",
            "format": "int32",
            "example": 1
          }
        },
        "additionalProperties": false,
        "description": "Report an ip address"
      },
      "ReportResponse": {
        "type": "object",
        "properties": {
          "error": {
            "type": "boolean",
            "description": "True if error, false otherwise",
            "example": false
          },
          "message": {
            "type": "string",
            "description": "Message. If Error is true, this is an error message.",
            "nullable": true
          },
          "status": {
            "type": "integer",
            "description": "Status code",
            "format": "int32"
          }
        },
        "additionalProperties": false,
        "description": "Report response"
      },
      "SubmissionFlags": {
        "enum": [
          "None",
          "Dns",
          "Fraud",
          "DDos",
          "BruteForce",
          "Proxy",
          "Spam",
          "Vpn",
          "Hacking",
          "BadBot",
          "Compromised",
          "Phishing",
          "Iot",
          "PortScan",
          "AI"
        ],
        "type": "string",
        "description": "Submission flags"
      },
      "UpsertUserListRequest": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "List id. Leave as 0 for creating new lists.",
            "format": "int32"
          },
          "name": {
            "type": "string",
            "description": "User list name (128 char max)",
            "nullable": true
          },
          "description": {
            "type": "string",
            "description": "Description markdown (4096 char max)",
            "nullable": true
          },
          "ipAddresses": {
            "type": "string",
            "description": "List entries (100k max, 128 chars max per entry).\nIf specified, this replaces the entire contents of the list (the list's ip addresses are upserted as a whole).\nLeave null/missing to keep the existing ip addresses. Use the PATCH endpoint to add or remove individual entries.",
            "nullable": true,
            "example": "11.22.33.0/24 #Block these scammers, 55.66.77.88 #Bad UK Scraper, 1.1.1.1-1.1.255.255"
          },
          "combine": {
            "type": "boolean",
            "description": "Whether to combine overlapping ip ranges or adjacent ip ranges. Default is false."
          }
        },
        "additionalProperties": false,
        "description": "Upsert user list request"
      },
      "UpsertUserListResponse": {
        "type": "object",
        "properties": {
          "error": {
            "type": "boolean",
            "description": "True if error, false otherwise",
            "example": false
          },
          "message": {
            "type": "string",
            "description": "Message. If Error is true, this is an error message.",
            "nullable": true
          },
          "status": {
            "type": "integer",
            "description": "Status code",
            "format": "int32"
          },
          "id": {
            "type": "integer",
            "description": "Id of the list",
            "format": "int32"
          },
          "userId": {
            "type": "integer",
            "description": "User id of the list",
            "format": "int32"
          },
          "name": {
            "type": "string",
            "description": "List name",
            "nullable": true
          },
          "url": {
            "type": "string",
            "description": "Url",
            "nullable": true
          },
          "description": {
            "type": "string",
            "description": "List description markdown",
            "nullable": true
          },
          "descriptionHtml": {
            "type": "string",
            "description": "List description html",
            "nullable": true
          },
          "ipAddresses": {
            "type": "string",
            "description": "IP addresses in the list",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": "Upsert user list response"
      },
      "UserListEntry": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "Id",
            "format": "int32"
          },
          "name": {
            "type": "string",
            "description": "Name",
            "nullable": true
          },
          "url": {
            "type": "string",
            "description": "Url",
            "nullable": true
          },
          "count": {
            "type": "integer",
            "description": "Count of entries",
            "format": "int32"
          }
        },
        "additionalProperties": false,
        "description": "User list entry"
      }
    },
    "securitySchemes": {
      "ApiKey": {
        "type": "apiKey",
        "description": "Type into the textbox: {your api key}",
        "name": "X-API-KEY",
        "in": "header"
      }
    }
  },
  "security": [
    { }
  ],
  "tags": [
    {
      "name": "Api"
    }
  ]
}