{"docsConfig":{"$schema":"https://mintlify.com/docs.json","theme":"mint","name":"PathStack","colors":{"primary":"#2047FA","light":"#203dfa","dark":"#2047FA"},"favicon":"https://mintcdn.com/nuonic-39/IvvWU3allt6PGoB1/favicon.png?fit=max\u0026auto=format\u0026n=IvvWU3allt6PGoB1\u0026q=85\u0026s=13af1d1deb3e464f07af03b3c326ddd3","logo":{"light":"https://mintcdn.com/nuonic-39/syOOuB1ZSGS1zaSD/logo/light.png?fit=max\u0026auto=format\u0026n=syOOuB1ZSGS1zaSD\u0026q=85\u0026s=9b03c378d1fa1bbd0bfce37ccf17175c","dark":"https://mintcdn.com/nuonic-39/syOOuB1ZSGS1zaSD/logo/dark.png?fit=max\u0026auto=format\u0026n=syOOuB1ZSGS1zaSD\u0026q=85\u0026s=2e04739478900956a06ad5d8f726dfb1","href":"https://pathstack.io"},"api":{"openapi":["api-reference/openapi_2024-03-27.json","api-reference/openapi_2024-03-26.json"]},"navbar":{"links":[{"label":"Support","href":"mailto:support@pathstack.io"}],"primary":{"type":"button","label":"Sign up","href":"https://pathstack.io/register"}},"footer":{"socials":{"linkedin":"https://au.linkedin.com/company/nuonic"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"nuonic-39","hasAudioNarration":false,"actualSubdomain":"nuonic-39","customDomains":["docs.pathstack.io"],"gitSource":{"type":"github","owner":"nuonic","repo":"midland-docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6aa22862cf3ab925e991028c","collectionId":"26a2fba7-04c9-4265-8a37-e8d2acf3166e","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6aa22862cf3ab925e991028c"},"entitlements":{},"buildId":"6aa22862cf3ab925e991028c","clientVersion":"0.0.3990","searchFilterCounts":[{"language":"default","tag":"API Reference","count":83},{"language":"default","tag":"Endpoints","count":82},{"language":"default","tag":"Provider access guides","count":18},{"language":"default","tag":"Connections","count":14},{"language":"default","tag":"Milestones","count":12},{"language":"default","tag":"Documentation","count":12},{"language":"default","tag":"Devices","count":10},{"language":"default","tag":"Webhooks","count":10},{"language":"default","tag":"Legal","count":10},{"language":"default","tag":"Guides","count":9}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/2024-03-27/connections/create-connection","slug":"/api-reference/2024-03-27/connections/create-connection","pageMetadata":{"openapi":"openapi_2024-03-27 post /connection","title":"Create Connection","description":"This endpoint takes attributes for a new Connection and a tenant_id and creates and returns a new Connection.\n\nThe allowed values for integration_name can be found under ProviderEnum.","href":"/api-reference/2024-03-27/connections/create-connection"},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"This endpoint takes attributes for a new Connection and a tenant_id and creates and returns a new Connection.\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"The allowed values for integration_name can be found under ProviderEnum.\"\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi":"openapi_2024-03-27 post /connection","title":"Create Connection","description":"This endpoint takes attributes for a new Connection and a tenant_id and creates and returns a new Connection.\n\nThe allowed values for integration_name can be found under ProviderEnum.","href":"/api-reference/2024-03-27/connections/create-connection"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Connections"],"summary":"Create Connection","description":"This endpoint takes attributes for a new Connection and a tenant_id and creates and returns a new Connection.\n\nThe allowed values for integration_name can be found under ProviderEnum.","operationId":"create_connection_connection_post","security":["5df07e30-ceb2-46a8-aab6-cfa027af5351"],"parameters":["0a74fa5f-2730-480f-ac0b-cacd0fd077ee"],"requestBody":"5c54d3af-b691-4c1c-8b84-43f2f363cc99","responses":{"200":"ab215658-b436-4745-99cc-f09d85a8cf35","400":"6b255afe-e949-406a-96ce-9fe15a67c701","401":"9f71fe01-899e-47c4-b57f-3266473786fc","403":"9f745911-8b18-46ab-9eab-71f66dae48a8","422":"7ca2f53d-0c11-448f-af14-9afbce0e7ce0"},"method":"post","type":"path","servers":["d1803bc1-eb91-4a2e-b2b3-a72ddd7dd766"],"path":"/connection","baseUrlOptions":["https://api.pathstack.io"],"title":"Create Connection","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"0a74fa5f-2730-480f-ac0b-cacd0fd077ee":{"name":"x-api-version","in":"header","required":false,"schema":{"type":"string","format":"date","default":"2024-03-27","title":"X-Api-Version","isRequired":false,"uniqueKey":"","typeLabel":"string\u003cdate>"},"examples":{"default":{"value":"2024-03-27"}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"integration_name":{"type":"string","enum":["mtdata","geotab","navman","mixtelematics","radius","verizon_connect","volvo","fleetsu","digital_matter","netstar","netstar_v2","webfleet","scania","linxio","geoforce","michelin_connected_fleet","navixy","netcorp","mapon","v_daq"],"title":"ProviderEnum","isRequired":true,"uniqueKey":"integration_name","typeLabel":"enum\u003cstring>"},"credentials":{"additionalProperties":true,"type":"object","title":"Credentials","isRequired":true,"uniqueKey":"credentials","typeLabel":"Credentials · object"},"business_name":{"oneOf":[{"type":"string","title":"Business Name","isRequired":true,"uniqueKey":"business_name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Business Name","isRequired":true,"uniqueKey":"business_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"business_name","typeLabel":"string | null"},"abn":{"oneOf":[{"type":"string","title":"Abn","isRequired":true,"uniqueKey":"abn.oneOf.0","typeLabel":"string"},{"type":"null","title":"Abn","isRequired":true,"uniqueKey":"abn.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"abn","typeLabel":"string | null"},"email":{"oneOf":[{"type":"string","title":"Email","isRequired":true,"uniqueKey":"email.oneOf.0","typeLabel":"string"},{"type":"null","title":"Email","isRequired":true,"uniqueKey":"email.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"email","typeLabel":"string | null"},"active":{"type":"boolean","title":"Active","isRequired":true,"uniqueKey":"active","typeLabel":"boolean"},"collection_start_time":{"oneOf":[{"type":"string","title":"Collection Start Time","format":"date-time","uniqueKey":"collection_start_time.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Collection Start Time","uniqueKey":"collection_start_time.oneOf.1","typeLabel":"null"}],"uniqueKey":"collection_start_time","typeLabel":"string\u003cdate-time> | null"},"collection_end_time":{"oneOf":[{"type":"string","title":"Collection End Time","format":"date-time","uniqueKey":"collection_end_time.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Collection End Time","uniqueKey":"collection_end_time.oneOf.1","typeLabel":"null"}],"uniqueKey":"collection_end_time","typeLabel":"string\u003cdate-time> | null"},"tags":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"tags.oneOf.0.items.[INDEX]","typeLabel":"string"},"title":"Tags","uniqueKey":"tags.oneOf.0","typeLabel":"string[]"},{"type":"null","title":"Tags","uniqueKey":"tags.oneOf.1","typeLabel":"null"}],"uniqueKey":"tags","typeLabel":"string[] | null"}},"type":"object","required":["integration_name","credentials","business_name","abn","email","active"],"title":"ConnectionInput","uniqueKey":"","typeLabel":"ConnectionInput · object"},"examples":{"Example":{"title":"Example","value":{"credentials":{},"business_name":"\u003cstring>","abn":"\u003cstring>","email":"\u003cstring>","active":true,"collection_start_time":"2023-11-07T05:31:56Z","collection_end_time":"2023-11-07T05:31:56Z","tags":["\u003cstring>"]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"ab215658-b436-4745-99cc-f09d85a8cf35":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"data":{"properties":{"integration_name":{"type":"string","enum":["mtdata","geotab","navman","mixtelematics","radius","verizon_connect","volvo","fleetsu","digital_matter","netstar","netstar_v2","webfleet","scania","linxio","geoforce","michelin_connected_fleet","navixy","netcorp","mapon","v_daq"],"title":"ProviderEnum","isRequired":true,"uniqueKey":"data.integration_name","typeLabel":"enum\u003cstring>"},"business_name":{"oneOf":[{"type":"string","title":"Business Name","isRequired":true,"uniqueKey":"data.business_name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Business Name","isRequired":true,"uniqueKey":"data.business_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.business_name","typeLabel":"string | null"},"abn":{"oneOf":[{"type":"string","title":"Abn","isRequired":true,"uniqueKey":"data.abn.oneOf.0","typeLabel":"string"},{"type":"null","title":"Abn","isRequired":true,"uniqueKey":"data.abn.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.abn","typeLabel":"string | null"},"email":{"oneOf":[{"type":"string","title":"Email","isRequired":true,"uniqueKey":"data.email.oneOf.0","typeLabel":"string"},{"type":"null","title":"Email","isRequired":true,"uniqueKey":"data.email.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.email","typeLabel":"string | null"},"active":{"type":"boolean","title":"Active","isRequired":true,"uniqueKey":"data.active","typeLabel":"boolean"},"id":{"type":"string","format":"uuid4","title":"Id","isRequired":true,"uniqueKey":"data.id","typeLabel":"string\u003cuuid4>"},"tenant_id":{"type":"string","format":"uuid4","title":"Tenant Id","isRequired":true,"uniqueKey":"data.tenant_id","typeLabel":"string\u003cuuid4>"},"collection_start_time":{"oneOf":[{"type":"string","title":"Collection Start Time","format":"date-time","isRequired":true,"uniqueKey":"data.collection_start_time.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Collection Start Time","isRequired":true,"uniqueKey":"data.collection_start_time.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.collection_start_time","typeLabel":"string\u003cdate-time> | null"},"collection_end_time":{"oneOf":[{"type":"string","title":"Collection End Time","format":"date-time","isRequired":true,"uniqueKey":"data.collection_end_time.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Collection End Time","isRequired":true,"uniqueKey":"data.collection_end_time.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.collection_end_time","typeLabel":"string\u003cdate-time> | null"},"configuration":{"oneOf":[{"type":"object","title":"Configuration","additionalProperties":true,"isRequired":true,"uniqueKey":"data.configuration.oneOf.0","typeLabel":"Configuration · object"},{"type":"null","title":"Configuration","isRequired":true,"uniqueKey":"data.configuration.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.configuration","typeLabel":"Configuration · object | null"},"connection_tags":{"items":{"properties":{"id":{"type":"string","format":"uuid4","title":"Id","isRequired":true,"uniqueKey":"data.connection_tags.items.[INDEX].id","typeLabel":"string\u003cuuid4>"},"name":{"type":"string","title":"Name","isRequired":true,"uniqueKey":"data.connection_tags.items.[INDEX].name","typeLabel":"string"}},"type":"object","required":["id","name"],"title":"TenantTag","uniqueKey":"data.connection_tags.items.[INDEX]","typeLabel":"TenantTag · object"},"type":"array","title":"Connection Tags","default":[],"uniqueKey":"data.connection_tags","typeLabel":"TenantTag · object[]"}},"type":"object","required":["integration_name","business_name","abn","email","active","id","tenant_id","collection_start_time","collection_end_time","configuration"],"title":"ConnectionNoCredentials","isRequired":true,"uniqueKey":"data","typeLabel":"ConnectionNoCredentials · object"}},"type":"object","required":["data"],"title":"ConnectionSuccessResponse","uniqueKey":"","typeLabel":"ConnectionSuccessResponse · object"},"examples":{"Example":{"title":"Example","value":{"data":{"integration_name":"mtdata","business_name":"\u003cstring>","abn":"\u003cstring>","email":"\u003cstring>","active":true,"id":"\u003cstring>","tenant_id":"\u003cstring>","collection_start_time":"2023-11-07T05:31:56Z","collection_end_time":"2023-11-07T05:31:56Z","configuration":{},"connection_tags":[]}}}},"exampleType":"generated"}},"exampleType":"generated"},"6b255afe-e949-406a-96ce-9fe15a67c701":{"content":{"application/json":{"schema":{"properties":{"error":{"type":"object","properties":{"code":{"type":"integer","example":400,"title":"Error code","uniqueKey":"error.code","typeLabel":"integer"},"message":{"type":"string","example":"Invalid JWT format","title":"Error message","uniqueKey":"error.message","typeLabel":"string"}},"uniqueKey":"error","typeLabel":"object"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":400,"message":"Invalid JWT format"}}}},"exampleType":"generated"}},"description":"Bad Request","exampleType":"generated"},"9f71fe01-899e-47c4-b57f-3266473786fc":{"content":{"application/json":{"schema":{"properties":{"error":{"type":"object","properties":{"code":{"type":"integer","example":401,"title":"Error code","uniqueKey":"error.code","typeLabel":"integer"},"message":{"type":"string","example":"Authentication header is missing, or token is invalid/expired.","title":"Error message","uniqueKey":"error.message","typeLabel":"string"}},"uniqueKey":"error","typeLabel":"object"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":401,"message":"Authentication header is missing, or token is invalid/expired."}}}},"exampleType":"generated"}},"description":"Unauthorized","exampleType":"generated"},"9f745911-8b18-46ab-9eab-71f66dae48a8":{"content":{"application/json":{"schema":{"properties":{"error":{"type":"object","properties":{"code":{"type":"integer","example":403,"title":"Error code","uniqueKey":"error.code","typeLabel":"integer"},"message":{"type":"string","example":"You do not have access to this resource","title":"Error message","uniqueKey":"error.message","typeLabel":"string"}},"uniqueKey":"error","typeLabel":"object"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":403,"message":"You do not have access to this resource"}}}},"exampleType":"generated"}},"description":"Forbidden","exampleType":"generated"},"7ca2f53d-0c11-448f-af14-9afbce0e7ce0":{"content":{"application/json":{"schema":{"properties":{"error":{"type":"object","properties":{"code":{"type":"integer","example":422,"title":"Error code","uniqueKey":"error.code","typeLabel":"integer"},"message":{"type":"string","example":"Field required","title":"Error message","uniqueKey":"error.message","typeLabel":"string"},"loc":{"items":{"oneOf":[{"type":"string","uniqueKey":"error.loc.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"integer","uniqueKey":"error.loc.items.[INDEX].oneOf.1","typeLabel":"integer"}],"uniqueKey":"error.loc.items.[INDEX]","typeLabel":"string | integer"},"type":"array","title":"Location","uniqueKey":"error.loc","typeLabel":"(string | integer)[]"},"msg":{"type":"string","title":"Message","uniqueKey":"error.msg","typeLabel":"string"},"type":{"type":"string","title":"Error Type","uniqueKey":"error.type","typeLabel":"string"}},"uniqueKey":"error","typeLabel":"object"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":422,"message":"Field required","loc":["\u003cstring>"],"msg":"\u003cstring>","type":"\u003cstring>"}}}},"exampleType":"generated"}},"description":"Unprocessable Entity","exampleType":"generated"}},"security":{"5df07e30-ceb2-46a8-aab6-cfa027af5351":{"JWTBearer":{"type":"http","scheme":"bearer","scopes":[]}}},"servers":{"d1803bc1-eb91-4a2e-b2b3-a72ddd7dd766":{"url":"https://api.pathstack.io","description":"PathStack production environment"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"JWTBearer","name":"Authorization"}],"title":"JWTBearer"}]},"originalFileLocation":"api-reference/openapi_2024-03-27.json"},"subdomain":"nuonic-39","siteName":"PathStack","title":"Create Connection - PathStack","navMaps":{"firstHrefInVersion":{"2024-03-27":{"href":"/api-reference/2024-03-27/connections/create-connection","matchLevel":0},"2024-03-26":{"href":"/api-reference/2024-03-26/connections/create-connection","matchLevel":1}},"firstHrefInLanguage":{}},"lastModified":"2025-09-09T05:07:59.593Z","originalFileLocation":"api-reference/2024-03-27/connections/create-connection.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"This endpoint takes attributes for a new Connection and a tenant_id and creates and returns a new Connection. The allowed values for integration_name can be found under ProviderEnum.\">\u003cmeta data-mint-head name=\"application-name\" content=\"PathStack\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/nuonic-39/fYQpJWsv94JQUvWa/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/nuonic-39/fYQpJWsv94JQUvWa/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/nuonic-39/fYQpJWsv94JQUvWa/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/nuonic-39/fYQpJWsv94JQUvWa/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/nuonic-39/fYQpJWsv94JQUvWa/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/nuonic-39/fYQpJWsv94JQUvWa/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/nuonic-39/fYQpJWsv94JQUvWa/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/nuonic-39/fYQpJWsv94JQUvWa/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/nuonic-39/fYQpJWsv94JQUvWa/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create Connection - PathStack\">\u003cmeta data-mint-head property=\"og:description\" content=\"This endpoint takes attributes for a new Connection and a tenant_id and creates and returns a new Connection. The allowed values for integration_name can be found under ProviderEnum.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"PathStack\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.pathstack.io/api-reference/2024-03-27/connections/create-connection\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://nuonic-39.mintlify.app/_mintlify/api/og/v2?division=Connections\u0026amp;title=Create+Connection\u0026amp;description=This+endpoint+takes+attributes+for+a+new+Connection+and+a+tenant_id+and+creates+and+returns+a+new+Connection.%0A%0AThe+allowed+values+for+integration_name+can+be+fo\u0026amp;theme=cb7cc1e2641545070c649087\u0026amp;signature=889af34aa69c98d3347671eebe7efd72c1b5858c46c358412511a73b8a0c2d57\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Create Connection - PathStack\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"This endpoint takes attributes for a new Connection and a tenant_id and creates and returns a new Connection. The allowed values for integration_name can be found under ProviderEnum.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://nuonic-39.mintlify.app/_mintlify/api/og/v2?division=Connections\u0026amp;title=Create+Connection\u0026amp;description=This+endpoint+takes+attributes+for+a+new+Connection+and+a+tenant_id+and+creates+and+returns+a+new+Connection.%0A%0AThe+allowed+values+for+integration_name+can+be+fo\u0026amp;theme=cb7cc1e2641545070c649087\u0026amp;signature=889af34aa69c98d3347671eebe7efd72c1b5858c46c358412511a73b8a0c2d57\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/nuonic-39/fYQpJWsv94JQUvWa/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"PathStack\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#2047FA\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.pathstack.io/api-reference/2024-03-27/connections/create-connection\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/2024-03-27/connections/create-connection.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.pathstack.io/#organization\",\"name\":\"PathStack\",\"url\":\"https://docs.pathstack.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/nuonic-39/syOOuB1ZSGS1zaSD/logo/light.png?fit=max\u0026auto=format\u0026n=syOOuB1ZSGS1zaSD\u0026q=85\u0026s=9b03c378d1fa1bbd0bfce37ccf17175c\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.pathstack.io#website\",\"name\":\"PathStack\",\"url\":\"https://docs.pathstack.io\",\"publisher\":{\"@id\":\"https://docs.pathstack.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.pathstack.io/api-reference/2024-03-27/connections/create-connection#webpage\",\"url\":\"https://docs.pathstack.io/api-reference/2024-03-27/connections/create-connection\",\"name\":\"Create Connection\",\"description\":\"This endpoint takes attributes for a new Connection and a tenant_id and creates and returns a new Connection. The allowed values for integration_name can be found under ProviderEnum.\",\"dateModified\":\"2025-09-09T05:07:59.593Z\",\"isPartOf\":{\"@id\":\"https://docs.pathstack.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.pathstack.io/api-reference/2024-03-27/connections/create-connection#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.pathstack.io/api-reference/2024-03-27/connections/create-connection#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://docs.pathstack.io/api-reference/2024-03-27/account/account-summary\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Connections\",\"item\":\"https://docs.pathstack.io/api-reference/2024-03-27/connections/connections\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Create Connection\",\"item\":\"https://docs.pathstack.io/api-reference/2024-03-27/connections/create-connection\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.pathstack.io/api-reference/2024-03-27/connections/create-connection#apireference\",\"headline\":\"Create Connection\",\"name\":\"Create Connection\",\"description\":\"This endpoint takes attributes for a new Connection and a tenant_id and creates and returns a new Connection. The allowed values for integration_name can be found under ProviderEnum.\",\"url\":\"https://docs.pathstack.io/api-reference/2024-03-27/connections/create-connection\",\"mainEntityOfPage\":{\"@id\":\"https://docs.pathstack.io/api-reference/2024-03-27/connections/create-connection#webpage\"},\"dateModified\":\"2025-09-09T05:07:59.593Z\",\"publisher\":{\"@id\":\"https://docs.pathstack.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.pathstack.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"PathStack\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"PathStack","nav":{"global":null,"versions":[{"version":"2024-03-27","tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"API Reference","groups":[{"group":"API Documentation","pages":[{"title":"Introduction","href":"/api-reference/introduction"}]},{"group":"Endpoints","pages":[{"group":"Account","pages":[{"openapi":"openapi_2024-03-27 get /account/summary","title":"Account Summary","href":"/api-reference/2024-03-27/account/account-summary"},{"openapi":"openapi_2024-03-27 get /account/activity-summary","title":"Account Activity Summary","href":"/api-reference/2024-03-27/account/account-activity-summary"}]},{"group":"Auth","pages":[{"openapi":"openapi_2024-03-27 post /token","title":"Login","href":"/api-reference/2024-03-27/auth/login"},{"openapi":"openapi_2024-03-27 post /refresh","title":"Refresh","href":"/api-reference/2024-03-27/auth/refresh"}]},{"group":"Connections","pages":[{"openapi":"openapi_2024-03-27 get /connection","title":"Connections","description":"This endpoint returns all connections within your tenancy.\n\nYou can specify the telematics_provider, and it will return only Connections with that provider.","href":"/api-reference/2024-03-27/connections/connections"},{"openapi":"openapi_2024-03-27 post /connection","title":"Create Connection","href":"/api-reference/2024-03-27/connections/create-connection"},{"openapi":"openapi_2024-03-27 get /connection/{connection_id}","title":"Connection By Id","description":"This endpoint returns a Connection by ID.","href":"/api-reference/2024-03-27/connections/connection-by-id"},{"openapi":"openapi_2024-03-27 patch /connection/{connection_id}","title":"Update Connection","href":"/api-reference/2024-03-27/connections/update-connection"},{"openapi":"openapi_2024-03-27 get /connection/{connection_id}/credentials","title":"Connection Credentials By Id","href":"/api-reference/2024-03-27/connections/connection-credentials-by-id"},{"openapi":"openapi_2024-03-27 patch /connection/{connection_id}/credentials","title":"Update Connection Credentials","href":"/api-reference/2024-03-27/connections/update-connection-credentials"},{"openapi":"openapi_2024-03-27 get /connection-tag","title":"List Connection Tags","href":"/api-reference/2024-03-27/connections/list-connection-tags"}]},{"group":"Devices","pages":[{"openapi":"openapi_2024-03-27 get /device","title":"Devices","href":"/api-reference/2024-03-27/devices/devices"},{"openapi":"openapi_2024-03-27 post /device","title":"Create Device","href":"/api-reference/2024-03-27/devices/create-device"},{"openapi":"openapi_2024-03-27 get /device/{device_id}","title":"Device By Id","href":"/api-reference/2024-03-27/devices/device-by-id"},{"openapi":"openapi_2024-03-27 delete /device/{device_id}","title":"Delete Device By Id","href":"/api-reference/2024-03-27/devices/delete-device-by-id"},{"openapi":"openapi_2024-03-27 patch /device/{device_id}","title":"Update Device By Id","href":"/api-reference/2024-03-27/devices/update-device-by-id"}]},{"group":"Trips","pages":[{"openapi":"openapi_2024-03-27 get /device/{device_id}/trip","title":"Trips","href":"/api-reference/2024-03-27/trips/trips"},{"openapi":"openapi_2024-03-27 get /trip/{trip_id}","title":"Trip By Id","href":"/api-reference/2024-03-27/trips/trip-by-id"}]},{"group":"Positions","pages":[{"openapi":"openapi_2024-03-27 get /device/{device_id}/position","title":"Positions","href":"/api-reference/2024-03-27/positions/positions"},{"openapi":"openapi_2024-03-27 get /trip/{trip_id}/position","title":"Positions By Trip Id","href":"/api-reference/2024-03-27/positions/positions-by-trip-id"}]},{"group":"Real-time","pages":[{"openapi":"openapi_2024-03-27 post /realtime/device","title":"Get Realtime Positions","href":"/api-reference/2024-03-27/real-time/get-realtime-positions"},{"openapi":"openapi_2024-03-27 get /realtime/connect","title":"Get Connect","href":"/api-reference/2024-03-27/real-time/get-connect"}]},{"group":"Webhooks","pages":[{"openapi":"openapi_2024-03-27 get /webhook","title":"Get Webhooks","href":"/api-reference/2024-03-27/webhooks/get-webhooks"},{"openapi":"openapi_2024-03-27 post /webhook","title":"Create Webhook","href":"/api-reference/2024-03-27/webhooks/create-webhook"},{"openapi":"openapi_2024-03-27 get /webhook/{webhook_id}","title":"Get Webhook","href":"/api-reference/2024-03-27/webhooks/get-webhook"},{"openapi":"openapi_2024-03-27 delete /webhook/{webhook_id}","title":"Delete Webhook","href":"/api-reference/2024-03-27/webhooks/delete-webhook"},{"openapi":"openapi_2024-03-27 patch /webhook/{webhook_id}","title":"Patch Webhook","href":"/api-reference/2024-03-27/webhooks/patch-webhook"}]},{"group":"Tags","pages":[{"openapi":"openapi_2024-03-27 get /tag","title":"Get Tags","href":"/api-reference/2024-03-27/tags/get-tags"}]},{"group":"Events","pages":[{"openapi":"openapi_2024-03-27 get /device/{device_id}/event","title":"Events","href":"/api-reference/2024-03-27/events/events"},{"openapi":"openapi_2024-03-27 get /event/{event_id}","title":"Event By Id","href":"/api-reference/2024-03-27/events/event-by-id"}]},{"group":"Tenants","pages":[{"openapi":"openapi_2024-03-27 get /tenant","title":"Tenant By Id","href":"/api-reference/2024-03-27/tenants/tenant-by-id"},{"openapi":"openapi_2024-03-27 patch /tenant","title":"Update Tenant By Id","href":"/api-reference/2024-03-27/tenants/update-tenant-by-id"},{"openapi":"openapi_2024-03-27 get /tenant/configuration","title":"Tenant Configuration","href":"/api-reference/2024-03-27/tenants/tenant-configuration"}]},{"group":"Milestones","pages":[{"openapi":"openapi_2024-03-27 get /milestone","title":null,"href":"/api-reference/2024-03-27/milestones/get-milestones"},{"openapi":"openapi_2024-03-27 post /milestone","title":null,"href":"/api-reference/2024-03-27/milestones/create-milestone"},{"openapi":"openapi_2024-03-27 get /milestone/{milestone_id}","title":"Get Milestone","href":"/api-reference/2024-03-27/milestones/get-milestone"},{"openapi":"openapi_2024-03-27 delete /milestone/{milestone_id}","title":"Delete Milestone","href":"/api-reference/2024-03-27/milestones/delete-milestone"},{"openapi":"openapi_2024-03-27 patch /milestone/{milestone_id}","title":"Patch Milestone","href":"/api-reference/2024-03-27/milestones/patch-milestone"},{"openapi":"openapi_2024-03-27 get /milestone/{milestone_id}/update","title":"Get Milestone Update","href":"/api-reference/2024-03-27/milestones/get-milestone-update"}]},{"group":"Consumer","pages":[{"openapi":"openapi_2024-03-27 get /consumer/connection/share_request","title":"Get Share Requests","href":"/api-reference/2024-03-27/consumer/get-share-requests"},{"openapi":"openapi_2024-03-27 post /consumer/connection/share_request","title":"Create Share Request","href":"/api-reference/2024-03-27/consumer/create-share-request"}]}]}]},{"tab":"Provider access guides","pages":[{"title":"Provider access guides","href":"/integration-guides/verizon"}]},{"tab":"Legal","pages":[{"title":"Legal","href":"/legal/data-provider-terms"}]}]},{"version":"2024-03-26","pages":[{"title":"2024-03-26","href":"/api-reference/2024-03-26/connections/create-connection"}]}]},"title":"Create Connection - PathStack","buildId":"dpl_2oYXwqkEXirXBPk8wV1FtM5USFWi","deploymentId":"dpl_2oYXwqkEXirXBPk8wV1FtM5USFWi","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-WRhTSUDL.js","utils-ChMov4Kr.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-_REmC2bI.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Bp6nVRCu.js","snippetPresets-DZadmXoU.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CY2WdoTl.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-DwYG-Q4l.js","shallow-BXQIGwv4.js","getApiPlaygroundDisplay-CK5nK5B9.js","CodeSnippet-TH4a2aGW.js","CodeSnippets-DwsQiOFS.js","Page-R3M_BF4L.js","getPastedJson-DD7kUzi_.js","icon-holE3QoJ.js","MethodPill-DUW0T8us.js","DuplicateIcon-CI_p4be-.js","createIcon-BdbRvavb.js","DynamicMarkdown-DN96a4Ur.js","SectionHeading-SCu36A9d.js","axios-vUo_bRtp.js","Markdown-CCeGv-zI.js","clsx-BGBGWFTt.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-Cv_O2fky.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-2C5OB2eV.js"]}