{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-products/prep/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Access OpenAPI documentation","description":"Hamilton's Developer Portal is used to help reference and understand the APIs of Hamilton products.","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"access-openapi-documentation"},"children":["Access OpenAPI documentation"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["API documentation is available locally on a Prep in the form of the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"../products/prep/api/openapi","target":"_blank"},"children":["OpenAPI documentation"]},". This tool is useful for easily testing API calls against the server and viewing the responses."]},{"$$mdtype":"Tag","name":"section","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{"className":"note"},"children":["Use the OpenAPI documentation to explore the ML Prep REST API's more advanced features, and interact with the API directly from the browser."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To ensure best network compatibility when establishing REST API connection, locate and use the IP address of the Prep connected to the PC. To accomplish this:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Turn on the Prep."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Locate and access ",{"$$mdtype":"Tag","name":"span","attributes":{"className":"item"},"children":["Settings"]},"."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Locate the ",{"$$mdtype":"Tag","name":"span","attributes":{"className":"tab"},"children":["Instrument"]}," tab."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Select ",{"$$mdtype":"Tag","name":"span","attributes":{"className":"item"},"children":["Configuration"]},"."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Wait for information to load, then locate and select the ",{"$$mdtype":"Tag","name":"span","attributes":{"className":"tab"},"children":["Network Settings"]}," tab."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Locate the IP address of the Internal PC, then perform a quick test."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Launch a web browser on a PC connected to the same network as the Prep."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Go to ",{"$$mdtype":"Tag","name":"span","attributes":{"className":"file"},"children":["http://","<","IP",">","/NimbusLite/api-docs/index.html"]}," to navigate to API documentation."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"span","attributes":{"className":"application"},"children":["Swagger"]}," application should launch."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Locate the OpenAPI documentation for the Prep REST API."]}]}]}]},"headings":[{"value":"Access OpenAPI documentation","id":"access-openapi-documentation","depth":1}],"frontmatter":{"seo":{"title":"Access OpenAPI documentation"}},"lastModified":"2026-07-30T19:22:04.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/pages/prep_guide_access_swagger","userData":{"isAuthenticated":false,"teams":["anonymous"]}}