{ "openapi": "3.1.0", "info": { "title": "", "version": "1.0.0" }, "paths": { "/catalog/{nodename}": { "get": { "tags": [ "Catalog" ], "operationId": "getCatalogNodename", "description": "The parameters and request body are for method: getCatalogNodename. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "tags": { "type": "array", "items": { "type": "string" } }, "name": { "type": "string" }, "version": { "type": "number" }, "code_id": { "type": "string" }, "catalog_uuid": { "type": "string" }, "catalog_format": { "type": "number" }, "environment": { "type": "string" }, "resources": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "exported": { "type": "boolean" }, "parameters": { "type": "object", "properties": { "name": { "type": "string" } } } } } }, "edges": { "type": "array", "items": { "type": "object", "properties": { "source": { "type": "string" }, "target": { "type": "string" } } } }, "classes": { "type": "array", "items": { "type": "string" } } } }, "example": { "tags": [ "string", "string", "string", "string", "string", "string", "string", "string" ], "name": "string", "version": 4, "code_id": "string", "catalog_uuid": "string", "catalog_format": 8, "environment": "string", "resources": [ { "type": "string", "title": "string", "tags": [ "string", "string" ], "exported": false, "parameters": { "name": "string" } } ], "edges": [ { "source": "string", "target": "string" } ], "classes": [ "string", "string", "string", "string", "string", "string", "string", "string", "string" ] } } } } }, "parameters": [ { "name": "nodename", "in": "path", "required": true, "schema": { "title": "nodename", "type": "string" } }, { "name": "environment", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "factsFormat", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "facts", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "transactionUuid", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "staticCatalog", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "checksumType", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "configuredEnvironment", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "jobId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "post": { "tags": [ "Catalog" ], "operationId": "postCatalogNodename", "description": "The parameters and request body are for method: postCatalogNodename. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "tags": { "type": "array", "items": { "type": "string" } }, "name": { "type": "string" }, "version": { "type": "number" }, "code_id": { "type": "string" }, "catalog_uuid": { "type": "string" }, "catalog_format": { "type": "number" }, "environment": { "type": "string" }, "resources": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "exported": { "type": "boolean" }, "parameters": { "type": "object", "properties": { "name": { "type": "string" } } } } } }, "edges": { "type": "array", "items": { "type": "object", "properties": { "source": { "type": "string" }, "target": { "type": "string" } } } }, "classes": { "type": "array", "items": { "type": "string" } } } }, "example": { "tags": [ "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "name": "string", "version": 8, "code_id": "string", "catalog_uuid": "string", "catalog_format": 8, "environment": "string", "resources": [ { "type": "string", "title": "string", "tags": [ "string", "string", "string", "string" ], "exported": true, "parameters": { "name": "string" } }, { "type": "string", "title": "string", "tags": [ "string", "string" ], "exported": true, "parameters": { "name": "string" } } ], "edges": [ { "source": "string", "target": "string" }, { "source": "string", "target": "string" }, { "source": "string", "target": "string" }, { "source": "string", "target": "string" }, { "source": "string", "target": "string" }, { "source": "string", "target": "string" }, { "source": "string", "target": "string" }, { "source": "string", "target": "string" }, { "source": "string", "target": "string" }, { "source": "string", "target": "string" } ], "classes": [ "string" ] } } } } }, "parameters": [ { "name": "nodename", "in": "path", "required": true, "schema": { "title": "nodename", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/node/{certname}": { "get": { "tags": [ "Node" ], "operationId": "getNodeCertname", "description": "The parameters and request body are for method: getNodeCertname. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "parameters": { "type": "object", "properties": { "architecture": { "type": "string" }, "kernel": { "type": "string" }, "blockdevices": { "type": "string" }, "clientversion": { "type": "string" }, "clientnoop": { "type": "string" }, "environment": { "type": "string" } } }, "environment": { "type": "string" } } }, "example": { "name": "string", "parameters": { "architecture": "string", "kernel": "string", "blockdevices": "string", "clientversion": "string", "clientnoop": "string", "environment": "string" }, "environment": "string" } } } } }, "parameters": [ { "name": "certname", "in": "path", "required": true, "schema": { "title": "certname", "type": "string" } }, { "name": "environment", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "transactionUuid", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "configuredEnvironment", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/environments": { "get": { "tags": [ "Environments" ], "operationId": "getEnvironments", "description": "The parameters and request body are for method: getEnvironments. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "search_paths": { "type": "array", "items": { "type": "string" } }, "environments": { "type": "object", "properties": { "production": { "type": "object", "properties": { "settings": { "type": "object", "properties": { "modulepath": { "type": "array", "items": { "type": "string" } }, "manifest": { "type": "array", "items": { "type": "string" } }, "environment_timeout": { "type": "number" }, "config_version": { "type": "string" } } } } } } } } }, "example": { "search_paths": [ "string", "string" ], "environments": { "production": { "settings": { "modulepath": [ "string", "string" ], "manifest": [ "string", "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "environment_timeout": 7, "config_version": "string" } } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/report/{nodename}": { "put": { "tags": [ "Report" ], "operationId": "putReportNodename", "description": "The parameters and request body are for method: putReportNodename. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "host": { "type": "string" }, "time": { "type": "string" }, "configuration_version": { "type": "number" }, "transaction_uuid": { "type": "string" }, "code_id": { "type": "string" }, "job_id": { "type": "string" }, "catalog_uuid": { "type": "string" }, "catalog_format": { "type": "number" }, "report_format": { "type": "number" }, "puppet_version": { "type": "string" }, "status": { "type": "string" }, "transaction_completed": { "type": "boolean" }, "noop": { "type": "boolean" }, "noop_pending": { "type": "boolean" }, "environment": { "type": "string" }, "logs": { "type": "array", "items": { "type": "object", "properties": { "level": { "type": "string" }, "message": { "type": "string" }, "source": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "time": { "type": "string" }, "file": { "type": "string" }, "line": { "type": "string" } } } }, "metrics": { "type": "object", "properties": { "resources": { "type": "object", "properties": { "name": { "type": "string" }, "label": { "type": "string" }, "values": { "type": "array", "items": { "type": "array", "items": { "type": "string" } } } } }, "time": { "type": "object", "properties": { "name": { "type": "string" }, "label": { "type": "string" }, "values": { "type": "array", "items": { "type": "array", "items": { "type": "string" } } } } }, "changes": { "type": "object", "properties": { "name": { "type": "string" }, "label": { "type": "string" }, "values": { "type": "array", "items": { "type": "array", "items": { "type": "string" } } } } }, "events": { "type": "object", "properties": { "name": { "type": "string" }, "label": { "type": "string" }, "values": { "type": "array", "items": { "type": "array", "items": { "type": "string" } } } } } } }, "resource_statuses": { "type": "object", "properties": { "Notify[a resource]": { "type": "object", "properties": { "title": { "type": "string" }, "file": { "type": "string" }, "line": { "type": "string" }, "resource": { "type": "string" }, "resource_type": { "type": "string" }, "provider_used": { "type": "string" }, "containment_path": { "type": "array", "items": { "type": "string" } }, "evaluation_time": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "time": { "type": "string" }, "failed": { "type": "boolean" }, "changed": { "type": "boolean" }, "out_of_sync": { "type": "boolean" }, "skipped": { "type": "boolean" }, "change_count": { "type": "number" }, "out_of_sync_count": { "type": "number" }, "events": { "type": "array", "items": { "type": "object" } } } } } }, "cached_catalog_status": { "type": "string" } } }, "example": { "host": "string", "time": "string", "configuration_version": 9, "transaction_uuid": "string", "code_id": "string", "job_id": "string", "catalog_uuid": "string", "catalog_format": 5, "report_format": 5, "puppet_version": "string", "status": "string", "transaction_completed": true, "noop": true, "noop_pending": false, "environment": "string", "logs": [ { "level": "string", "message": "string", "source": "string", "tags": [ "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "time": "string", "file": "string", "line": "string" }, { "level": "string", "message": "string", "source": "string", "tags": [ "string", "string", "string", "string", "string", "string" ], "time": "string", "file": "string", "line": "string" }, { "level": "string", "message": "string", "source": "string", "tags": [ "string", "string", "string", "string", "string" ], "time": "string", "file": "string", "line": "string" }, { "level": "string", "message": "string", "source": "string", "tags": [ "string", "string" ], "time": "string", "file": "string", "line": "string" }, { "level": "string", "message": "string", "source": "string", "tags": [ "string", "string" ], "time": "string", "file": "string", "line": "string" } ], "metrics": { "resources": { "name": "string", "label": "string", "values": [ [ "string", "string", "string", "string", "string", "string" ], [ "string", "string", "string", "string", "string", "string", "string", "string", "string" ], [ "string", "string", "string", "string", "string", "string", "string", "string", "string" ], [ "string", "string", "string" ], [ "string", "string" ], [ "string", "string", "string", "string", "string" ], [ "string", "string", "string", "string", "string", "string", "string", "string", "string", "string" ], [ "string", "string", "string", "string", "string", "string", "string", "string", "string", "string" ] ] }, "time": { "name": "string", "label": "string", "values": [ [ "string", "string", "string", "string", "string", "string", "string" ], [ "string" ], [ "string" ], [ "string", "string", "string", "string", "string", "string", "string", "string", "string" ], [ "string", "string", "string", "string", "string", "string", "string", "string" ], [ "string", "string", "string", "string" ] ] }, "changes": { "name": "string", "label": "string", "values": [ [ "string", "string", "string", "string", "string", "string", "string" ], [ "string", "string", "string", "string", "string" ], [ "string", "string", "string", "string", "string", "string", "string" ], [ "string", "string", "string", "string", "string", "string" ] ] }, "events": { "name": "string", "label": "string", "values": [ [ "string", "string", "string", "string", "string", "string", "string", "string" ], [ "string", "string", "string" ], [ "string", "string", "string", "string", "string", "string" ] ] } }, "resource_statuses": { "Notify[a resource]": { "title": "string", "file": "string", "line": "string", "resource": "string", "resource_type": "string", "provider_used": "string", "containment_path": [ "string", "string", "string", "string", "string" ], "evaluation_time": "string", "tags": [ "string", "string", "string" ], "time": "string", "failed": false, "changed": true, "out_of_sync": true, "skipped": true, "change_count": 1, "out_of_sync_count": 5, "events": [ null, null, null, null, null, null, null, null, null ] } }, "cached_catalog_status": "string" } } } } }, "parameters": [ { "name": "nodename", "in": "path", "required": true, "schema": { "title": "nodename", "type": "number" } }, { "name": "environment", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/status/{name}": { "get": { "tags": [ "Status" ], "operationId": "getStatusName", "description": "The parameters and request body are for method: getStatusName. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "is_alive": { "type": "boolean" }, "version": { "type": "string" } } }, "example": { "is_alive": true, "version": "string" } } } } }, "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "title": "name", "type": "string" } }, { "name": "environment", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/file_content/{mountPoint}/{name}": { "get": { "tags": [ "FileContent" ], "operationId": "getFilecontentMountpointName", "description": "The parameters and request body are for method: getFilecontentMountpointName. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "mountPoint", "in": "path", "required": true, "schema": { "title": "mountPoint", "type": "string" } }, { "name": "name", "in": "path", "required": true, "schema": { "title": "name", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/file_metadata/{mount}/{pathParam}": { "get": { "tags": [ "FileMetadata" ], "operationId": "getFilemetadataMountPath", "description": "The parameters and request body are for method: getFilemetadataMountPath. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "checksum": { "type": "object", "properties": { "type": { "type": "string" }, "value": { "type": "string" } } }, "destination": { "type": "string" }, "group": { "type": "number" }, "links": { "type": "string" }, "mode": { "type": "number" }, "owner": { "type": "number" }, "path": { "type": "string" }, "relative_path": { "type": "string" }, "type": { "type": "string" } } }, "example": { "checksum": { "type": "string", "value": "string" }, "destination": "string", "group": 7, "links": "string", "mode": 5, "owner": 8, "path": "string", "relative_path": "string", "type": "string" } } } } }, "parameters": [ { "name": "mount", "in": "path", "required": true, "schema": { "title": "mount", "type": "string" } }, { "name": "pathParam", "in": "path", "required": true, "schema": { "title": "pathParam", "type": "string" } }, { "name": "environment", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "links", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "checksumType", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "sourcePermissions", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/file_bucket_file/md5/{checksum}": { "get": { "tags": [ "FileBucketfile" ], "operationId": "getFilebucketfileMd5Checksum", "description": "The parameters and request body are for method: getFilebucketfileMd5Checksum. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "checksum", "in": "path", "required": true, "schema": { "title": "checksum", "type": "string" } }, { "name": "environment", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "put": { "tags": [ "FileBucketfile" ], "operationId": "putFilebucketfileMd5Checksum", "description": "The parameters and request body are for method: putFilebucketfileMd5Checksum. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "checksum", "in": "path", "required": true, "schema": { "title": "checksum", "type": "string" } }, { "name": "environment", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } }, "head": { "tags": [ "FileBucketfile" ], "operationId": "headFilebucketfileMd5Checksum", "description": "The parameters and request body are for method: headFilebucketfileMd5Checksum. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "checksum", "in": "path", "required": true, "schema": { "title": "checksum", "type": "string" } }, { "name": "environment", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/file_bucket_file/md5/{checksum}/{originalPath}": { "get": { "tags": [ "FileBucketfile" ], "operationId": "getFilebucketfileMd5ChecksumOriginalPath", "description": "The parameters and request body are for method: getFilebucketfileMd5ChecksumOriginalPath. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "checksum", "in": "path", "required": true, "schema": { "title": "checksum", "type": "string" } }, { "name": "originalPath", "in": "path", "required": true, "schema": { "title": "originalPath", "type": "string" } }, { "name": "environment", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "put": { "tags": [ "FileBucketfile" ], "operationId": "putFilebucketfileMd5ChecksumOriginalPath", "description": "The parameters and request body are for method: putFilebucketfileMd5ChecksumOriginalPath. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "checksum", "in": "path", "required": true, "schema": { "title": "checksum", "type": "string" } }, { "name": "originalPath", "in": "path", "required": true, "schema": { "title": "originalPath", "type": "string" } }, { "name": "environment", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } }, "head": { "tags": [ "FileBucketfile" ], "operationId": "headFilebucketfileMd5ChecksumOriginalPath", "description": "The parameters and request body are for method: headFilebucketfileMd5ChecksumOriginalPath. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "checksum", "in": "path", "required": true, "schema": { "title": "checksum", "type": "string" } }, { "name": "originalPath", "in": "path", "required": true, "schema": { "title": "originalPath", "type": "string" } }, { "name": "environment", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } } }, "components": { "schemas": {} } }