{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","results":{"codes":[]},"settings":"","params":[]},"next":{"description":"","pages":[]},"title":"About the Integration API","type":"basic","slug":"integration-api-reference","excerpt":"","body":"The Integration API is available to all of your containers when running from a Replicated deployment. This API is where you connect to your customers on-prem utilities.\n\nThe Integration API will be available to any container in your app at a custom, dynamic endpoint. To discover the endpoint from any container, simply query the environment variable named `REPLICATED_INTEGRATIONAPI`.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Discovering The Integration API Endpoint\"\n}\n[/block]\n### Go\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"import (\\n      \\\"os\\\"\\n)\\n\\n// Get the Replicated Integration API Endpoint\\nendpoint = os.Getenv(\\\"REPLICATED_INTEGRATIONAPI\\\")\",\n      \"language\": \"go\"\n    }\n  ]\n}\n[/block]","updates":[],"order":0,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5702deb796fc8d2b001a6639","version":{"version":"2.0","version_clean":"2.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5702deb696fc8d2b001a6616","5702deb696fc8d2b001a6617","5702deb696fc8d2b001a6618","5702deb696fc8d2b001a6619","5702deb696fc8d2b001a661a","5702deb696fc8d2b001a661b","5702deb696fc8d2b001a661c","5702deb696fc8d2b001a661d","5702deb696fc8d2b001a661e"],"_id":"5702deb696fc8d2b001a6615","createdAt":"2016-04-04T21:37:58.778Z","hasReference":true,"releaseDate":"2016-04-04T21:37:58.778Z","__v":1,"project":"550f1e4021de720d005b8cbb","hasDoc":true},"__v":0,"createdAt":"2015-03-22T20:32:12.299Z","parentDoc":null,"githubsync":"","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Integration API","slug":"integration-api","order":7,"from_sync":false,"reference":false,"_id":"5702deb696fc8d2b001a661d","project":"550f1e4021de720d005b8cbb","version":"5702deb696fc8d2b001a6615","createdAt":"2015-03-22T20:15:45.359Z","__v":0},"project":"550f1e4021de720d005b8cbb","user":"550f1e3161d9d30d00af9dc8"}

About the Integration API


The Integration API is available to all of your containers when running from a Replicated deployment. This API is where you connect to your customers on-prem utilities. The Integration API will be available to any container in your app at a custom, dynamic endpoint. To discover the endpoint from any container, simply query the environment variable named `REPLICATED_INTEGRATIONAPI`. [block:api-header] { "type": "basic", "title": "Discovering The Integration API Endpoint" } [/block] ### Go [block:code] { "codes": [ { "code": "import (\n \"os\"\n)\n\n// Get the Replicated Integration API Endpoint\nendpoint = os.Getenv(\"REPLICATED_INTEGRATIONAPI\")", "language": "go" } ] } [/block]