OctoPrint · Schema

PostApiUtilTestResponse

Company3D PrintingOpen SourceIoTMaker

Properties

Name Type Description
path string The path that was tested (for path command)
exists boolean true if the path exists, false otherwise (for path command)
typeok boolean true if a type check was not requested or it passed, false otherwise (for path command)
access boolean true if a permission check was not requested or it passed, false otherwise (for path command)
result boolean true if the overall check passed, false otherwise
url string The URL that was tested (for url command)
status integer The status code returned by the URL, 0 in case of a timeout (for url command)
response string The response body of the checked URL's response (for url command)
headers object A dictionary with all headers of the checked URL's response (for url command)
host string The host that was tested (for server command)
port integer The port that was tested (for server command)
protocol string The protocol that was tested, tcp or udp (for server command)
name string The host name that was tested (for resolution command)
address string The address that was tested (for address command)
is_lan_address boolean true if the address is a LAN address, false otherwise (for address command)
subnet string The detected subnet, if address is a LAN address (for address command)
View JSON Schema on GitHub

JSON Schema

octoprint-post-api-util-test-response-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/octoprint/json-schema/octoprint-post-api-util-test-response-schema.json",
  "title": "PostApiUtilTestResponse",
  "x-generated": "2026-10-28",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/_ae-authored/octoprint-openapi-generated.yml#/components/schemas/PostApiUtilTestResponse",
  "type": "object",
  "properties": {
    "path": {
      "type": "string",
      "description": "The path that was tested (for path command)"
    },
    "exists": {
      "type": "boolean",
      "description": "true if the path exists, false otherwise (for path command)"
    },
    "typeok": {
      "type": "boolean",
      "description": "true if a type check was not requested or it passed, false otherwise (for path command)"
    },
    "access": {
      "type": "boolean",
      "description": "true if a permission check was not requested or it passed, false otherwise (for path command)"
    },
    "result": {
      "type": "boolean",
      "description": "true if the overall check passed, false otherwise"
    },
    "url": {
      "type": "string",
      "description": "The URL that was tested (for url command)"
    },
    "status": {
      "type": "integer",
      "description": "The status code returned by the URL, 0 in case of a timeout (for url command)"
    },
    "response": {
      "type": "string",
      "description": "The response body of the checked URL's response (for url command)"
    },
    "headers": {
      "type": "object",
      "description": "A dictionary with all headers of the checked URL's response (for url command)"
    },
    "host": {
      "type": "string",
      "description": "The host that was tested (for server command)"
    },
    "port": {
      "type": "integer",
      "description": "The port that was tested (for server command)"
    },
    "protocol": {
      "type": "string",
      "description": "The protocol that was tested, tcp or udp (for server command)"
    },
    "name": {
      "type": "string",
      "description": "The host name that was tested (for resolution command)"
    },
    "address": {
      "type": "string",
      "description": "The address that was tested (for address command)"
    },
    "is_lan_address": {
      "type": "boolean",
      "description": "true if the address is a LAN address, false otherwise (for address command)"
    },
    "subnet": {
      "type": "string",
      "description": "The detected subnet, if address is a LAN address (for address command)"
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/octoprint-post-api-util-test-response"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.