Properties
| Name | Type | Description |
|---|---|---|
| command | string | The command to execute, currently either path, url, server, resolution or address |
| path | string | path command only: the path to test |
| check_type | string | path command only: the type of path to test for, either file or dir |
| check_access | array | path command only: a list of access permissions to check for |
| allow_create_dir | boolean | path command and checktype of dir only: whether to allow creation of the directory if it doesn't yet exist |
| check_writable_dir | boolean | path command and checktype of dir only: whether to test if the directory is writable by also trying to create a test file in it |
| url | string | url command only: the URL to test |
| status | string | url command only: one or more expected status codes |
| method | string | url command only: the HTTP method to use for the check |
| timeout | number | url and server commands only: the timeout for the test request |
| response | string | url command only: whether to include response data and if so in what form |
| validSsl | boolean | url command only: whether to validate the SSL connection if the url happens to be an HTTPS URL or not |
| basicAuth | object | url command only: a dictionary with the keys username and password to use for basic authentication |
| digestAuth | object | url command only: a dictionary with the keys username and password to use for digest authentication |
| bearerAuth | string | url command only: a string with the bearer token to use for bearer authentication |
| content_type_whitelist | array | url command only: optional array of supported content types |
| content_type_blacklist | array | url command only: optional array of unsupported content types |
| host | string | server command only: the server to test |
| port | integer | server command only: the port to test |
| protocol | string | server command only: the protocol to test |
| name | string | resolution command only: the host name to test |
| address | string | address command only: the address to test |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/octoprint/json-schema/octoprint-post-api-util-test-request-schema.json",
"title": "PostApiUtilTestRequest",
"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/PostApiUtilTestRequest",
"type": "object",
"properties": {
"command": {
"type": "string",
"description": "The command to execute, currently either path, url, server, resolution or address"
},
"path": {
"type": "string",
"description": "path command only: the path to test"
},
"check_type": {
"type": "string",
"description": "path command only: the type of path to test for, either file or dir"
},
"check_access": {
"type": "array",
"description": "path command only: a list of access permissions to check for"
},
"allow_create_dir": {
"type": "boolean",
"description": "path command and checktype of dir only: whether to allow creation of the directory if it doesn't yet exist"
},
"check_writable_dir": {
"type": "boolean",
"description": "path command and checktype of dir only: whether to test if the directory is writable by also trying to create a test file in it"
},
"url": {
"type": "string",
"description": "url command only: the URL to test"
},
"status": {
"type": "string",
"description": "url command only: one or more expected status codes"
},
"method": {
"type": "string",
"description": "url command only: the HTTP method to use for the check"
},
"timeout": {
"type": "number",
"description": "url and server commands only: the timeout for the test request"
},
"response": {
"type": "string",
"description": "url command only: whether to include response data and if so in what form"
},
"validSsl": {
"type": "boolean",
"description": "url command only: whether to validate the SSL connection if the url happens to be an HTTPS URL or not"
},
"basicAuth": {
"type": "object",
"description": "url command only: a dictionary with the keys username and password to use for basic authentication"
},
"digestAuth": {
"type": "object",
"description": "url command only: a dictionary with the keys username and password to use for digest authentication"
},
"bearerAuth": {
"type": "string",
"description": "url command only: a string with the bearer token to use for bearer authentication"
},
"content_type_whitelist": {
"type": "array",
"description": "url command only: optional array of supported content types"
},
"content_type_blacklist": {
"type": "array",
"description": "url command only: optional array of unsupported content types"
},
"host": {
"type": "string",
"description": "server command only: the server to test"
},
"port": {
"type": "integer",
"description": "server command only: the port to test"
},
"protocol": {
"type": "string",
"description": "server command only: the protocol to test"
},
"name": {
"type": "string",
"description": "resolution command only: the host name to test"
},
"address": {
"type": "string",
"description": "address command only: the address to test"
}
},
"required": [
"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.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/octoprint-post-api-util-test-request"
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.