{"docsConfig":{"theme":"palm","$schema":"https://mintlify.com/docs.json","name":"Broker Panel Docs","colors":{"primary":"#0E3A8C","light":"#4F7FFF","dark":"#0A2B66"},"logo":{"light":"https://mintcdn.com/nycs-partner-portal/VNrdR5TP4VcU6sO6/logo/nyc-servers-black.gif?fit=max\u0026auto=format\u0026n=VNrdR5TP4VcU6sO6\u0026q=85\u0026s=70df48f74232b81c9a07e249bc62d013","dark":"https://mintcdn.com/nycs-partner-portal/VNrdR5TP4VcU6sO6/logo/nyc-servers-white.gif?fit=max\u0026auto=format\u0026n=VNrdR5TP4VcU6sO6\u0026q=85\u0026s=e00124760ad8c920a754347c54656f1a"},"favicon":"https://mintcdn.com/nycs-partner-portal/0o5Bk7WV4bw-FcD4/favicon.svg?fit=max\u0026auto=format\u0026n=0o5Bk7WV4bw-FcD4\u0026q=85\u0026s=31a029f8f5444e906067c2cf53fb7696","api":{"playground":{"display":"interactive"},"mdx":{"auth":{"method":"bearer"},"server":"https://brokers.newyorkcityservers.com/api"}},"navbar":{"primary":{"type":"button","label":"Contact Support","href":"https://brokers.newyorkcityservers.com/support"}},"footer":{"links":[{"header":"Help","items":[{"label":"Contact Support","href":"https://brokers.newyorkcityservers.com/support"},{"label":"FAQ \u0026 Troubleshooting","href":"/broker/faq"}]}]},"seo":{"indexing":"navigable"},"fonts":{"family":"Geist"},"styling":{"eyebrows":"breadcrumbs","latex":false},"metadata":{"timestamp":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"nycs-partner-portal","hasAudioNarration":false,"actualSubdomain":"nycs-partner-portal","customDomains":["broker-docs.newyorkcityservers.com"],"gitSource":{"type":"github","owner":"nycservers","repo":"broker-panel","deployBranch":"main","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"latestBuiltDeploymentHistoryId":"6adbaa91de4e168f98ba7d55","collectionId":"8cfbf04c-7977-4dfc-96f7-2442953a64ad","liveDeploymentHistoryId":"6adbaa91de4e168f98ba7d55","schemaVersion":"v3"},"entitlements":{},"buildId":"6adbaa91de4e168f98ba7d55","clientVersion":"0.0.4044","searchFilterCounts":[{"language":"default","tag":"Guides","count":25},{"language":"default","tag":"API Reference","count":21},{"language":"default","tag":"Getting Started","count":13},{"language":"default","tag":"Services","count":9},{"language":"default","tag":"Forms \u0026 API","count":5},{"language":"default","tag":"Services \u0026 Requests","count":5},{"language":"default","tag":"Billing","count":3},{"language":"default","tag":"Branding \u0026 Email","count":3},{"language":"default","tag":"Reports","count":2},{"language":"default","tag":"Requests","count":2}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"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":"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":"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":"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":"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":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","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":"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":"turbopuffer-dual-write","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},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[],"page":{"pagePath":"api/services/get-service","slug":"/api/services/get-service","pageMetadata":{"title":"Get Service","description":"Get one broker-owned service and its VPS credentials by service number.","openapi":"api/openapi.yaml GET /v1/services/{service_number}","href":"/api/services/get-service"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Get one broker-owned service and its VPS credentials by service number.\"\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{Heading,Table,Warning}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`The endpoint returns in depth service details and VPS credentials.`}),`\n`,_jsx(Warning,{children:_jsx(_components.p,{children:`The response can contain a VPS IP address, username, and password.`})}),`\n`,_jsx(Heading,{level:`2`,id:`endpoint-errors`,children:`Endpoint errors`}),`\n`,_jsxs(_components.p,{children:[`For authentication, permissions, rate limits, and safe retries, see `,_jsx(_components.a,{href:`/api/errors-and-retries`,children:`Errors and Retries`}),`.`]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`HTTP status`}),_jsx(_components.th,{children:`Error code`}),_jsx(_components.th,{children:`Cause`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`400`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`invalid_request`})}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`service_number`}),` does not produce a nonzero base-10 integer.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`404`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`not_found`})}),_jsx(_components.td,{children:`No service with this number belongs to the authenticated broker.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`500`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`server_error`})}),_jsx(_components.td,{children:`An unexpected authentication or route error occurred.`})]})]})]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get Service","description":"Get one broker-owned service and its VPS credentials by service number.","openapi":"api/openapi.yaml GET /v1/services/{service_number}","href":"/api/services/get-service"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Endpoint errors","slug":"endpoint-errors","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Services"],"summary":"Get Service","operationId":"getService","description":"Get one broker-owned service and its VPS credentials by service number.","parameters":["8681e1e4-d8c8-498b-b693-06a74a9608c3"],"responses":{"200":"b31dd371-f83a-421d-8166-563be53c2035","400":"685d7971-fe9c-4416-aee8-1d0de3468b0f","401":"663c34a0-590d-4679-b01a-ccd6f2a0ee0d","403":"7838a4b9-d993-479c-8ee0-6b6410bab639","404":"7e08c3c0-606f-4814-90db-71b057298b18","429":"46a615f4-d6ce-44ef-9adc-0730159c13fd","500":"05af9f6c-4f62-47db-bd61-a5b9a7ab6fc3"},"method":"get","type":"path","servers":["f4fe8460-6054-4f42-afdd-310d37353ffc"],"security":["93e63458-522f-4468-8dec-0e44525d4735"],"path":"/v1/services/{service_number}","baseUrlOptions":["https://brokers.newyorkcityservers.com/api"],"title":"Get Service","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"8681e1e4-d8c8-498b-b693-06a74a9608c3":{"name":"service_number","in":"path","required":true,"description":"Public service number parsed as a base-10 integer.","schema":{"type":"integer","format":"int64","isRequired":true,"description":"Public service number parsed as a base-10 integer.","uniqueKey":"","typeLabel":"integer\u003cint64>"}}},"responses":{"b31dd371-f83a-421d-8166-563be53c2035":{"description":"Service details.","content":{"application/json":{"schema":{"type":"object","required":["data","success"],"properties":{"success":{"type":"boolean","const":true,"isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"data":{"type":"object","required":["service_number","customer_name","customer_email","customer_phone","plan","service_status","created_date","next_billing_date","last_modified","notes"],"properties":{"service_number":{"oneOf":[{"type":"integer","isRequired":true,"uniqueKey":"data.service_number.oneOf.0","typeLabel":"integer"},{"type":"null","isRequired":true,"uniqueKey":"data.service_number.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.service_number","typeLabel":"integer | null"},"customer_name":{"type":"string","isRequired":true,"uniqueKey":"data.customer_name","typeLabel":"string"},"customer_email":{"type":"string","format":"email","isRequired":true,"uniqueKey":"data.customer_email","typeLabel":"string\u003cemail>"},"customer_phone":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.customer_phone.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.customer_phone.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.customer_phone","typeLabel":"string | null"},"plan":{"type":"string","isRequired":true,"uniqueKey":"data.plan","typeLabel":"string"},"service_status":{"type":"string","description":"Stored service state. Common values are active, pending, suspended, cancelled, and terminated.","isRequired":true,"uniqueKey":"data.service_status","typeLabel":"string"},"created_date":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"data.created_date","typeLabel":"string\u003cdate-time>"},"next_billing_date":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.next_billing_date.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.next_billing_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.next_billing_date","typeLabel":"string | null"},"last_modified":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"data.last_modified","typeLabel":"string\u003cdate-time>"},"notes":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.notes.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.notes.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.notes","typeLabel":"string | null"},"cancel_date":{"oneOf":[{"type":"string","uniqueKey":"data.cancel_date.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.cancel_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.cancel_date","typeLabel":"string | null"},"cancellation_reason":{"oneOf":[{"type":"string","uniqueKey":"data.cancellation_reason.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.cancellation_reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.cancellation_reason","typeLabel":"string | null"},"vps_ip":{"oneOf":[{"type":"string","uniqueKey":"data.vps_ip.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.vps_ip.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.vps_ip","typeLabel":"string | null"},"vps_username":{"oneOf":[{"type":"string","uniqueKey":"data.vps_username.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.vps_username.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.vps_username","typeLabel":"string | null"},"vps_password":{"oneOf":[{"type":"string","writeOnly":false,"description":"Sensitive cached service credential.","uniqueKey":"data.vps_password.oneOf.0","typeLabel":"string"},{"type":"null","writeOnly":false,"description":"Sensitive cached service credential.","uniqueKey":"data.vps_password.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.vps_password","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"data","typeLabel":"object"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"},"pagination":{"type":"object","required":["page","perPage","total","totalPages"],"properties":{"page":{"type":"integer","minimum":1,"isRequired":true,"uniqueKey":"pagination.page","typeLabel":"integer"},"perPage":{"type":"integer","minimum":1,"maximum":100,"isRequired":true,"uniqueKey":"pagination.perPage","typeLabel":"integer"},"total":{"type":"integer","minimum":0,"isRequired":true,"uniqueKey":"pagination.total","typeLabel":"integer"},"totalPages":{"type":"integer","minimum":0,"isRequired":true,"uniqueKey":"pagination.totalPages","typeLabel":"integer"}},"uniqueKey":"pagination","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"success":true,"data":{"service_number":971100004,"customer_name":"Example Trading LLC","customer_email":"[email protected]","customer_phone":"+1 212 555 0100","plan":"Standard VPS","service_status":"active","created_date":"2026-05-01T10:30:00.000Z","next_billing_date":"2026-06-01","last_modified":"2026-05-02T14:22:33.000Z","notes":"Primary trading service","vps_ip":"192.0.2.10","vps_username":"Administrator","vps_password":"\u003credacted>"}},"examples":{"Example":{"title":"Example","value":{"success":true,"data":{"service_number":971100004,"customer_name":"Example Trading LLC","customer_email":"[email protected]","customer_phone":"+1 212 555 0100","plan":"Standard VPS","service_status":"active","created_date":"2026-05-01T10:30:00.000Z","next_billing_date":"2026-06-01","last_modified":"2026-05-02T14:22:33.000Z","notes":"Primary trading service","vps_ip":"192.0.2.10","vps_username":"Administrator","vps_password":"\u003credacted>"}}}},"exampleType":"examples"}},"exampleType":"examples"},"685d7971-fe9c-4416-aee8-1d0de3468b0f":{"description":"Code `invalid_request` for an invalid service number.","content":{"application/json":{"schema":{"type":"object","required":["success","error"],"properties":{"success":{"type":"boolean","const":false,"isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"object","additionalProperties":true,"uniqueKey":"error.details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"success":false,"error":{"code":"invalid_request","message":"Invalid service number"}},"examples":{"Example":{"title":"Example","value":{"success":false,"error":{"code":"invalid_request","message":"Invalid service number"}}}},"exampleType":"examples"}},"exampleType":"examples"},"663c34a0-590d-4679-b01a-ccd6f2a0ee0d":{"description":"Code `authentication_failed` for a missing, malformed, invalid, inactive, or expired API key.","content":{"application/json":{"schema":{"type":"object","required":["success","error"],"properties":{"success":{"type":"boolean","const":false,"isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"object","additionalProperties":true,"uniqueKey":"error.details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"success":false,"error":{"code":"authentication_failed","message":"Invalid API key"}},"examples":{"Example":{"title":"Example","value":{"success":false,"error":{"code":"authentication_failed","message":"Invalid API key"}}}},"exampleType":"examples"}},"exampleType":"examples"},"7838a4b9-d993-479c-8ee0-6b6410bab639":{"description":"Code `insufficient_permissions` when the request IP is not whitelisted or a required scope is missing.","content":{"application/json":{"schema":{"type":"object","required":["success","error"],"properties":{"success":{"type":"boolean","const":false,"isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"object","additionalProperties":true,"uniqueKey":"error.details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"success":false,"error":{"code":"insufficient_permissions","message":"IP address not whitelisted"}},"examples":{"Example":{"title":"Example","value":{"success":false,"error":{"code":"insufficient_permissions","message":"IP address not whitelisted"}}}},"exampleType":"examples"}},"exampleType":"examples"},"7e08c3c0-606f-4814-90db-71b057298b18":{"description":"Code `not_found` when no broker-owned service matches.","content":{"application/json":{"schema":{"type":"object","required":["success","error"],"properties":{"success":{"type":"boolean","const":false,"isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"object","additionalProperties":true,"uniqueKey":"error.details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"success":false,"error":{"code":"not_found","message":"Service not found"}},"examples":{"Example":{"title":"Example","value":{"success":false,"error":{"code":"not_found","message":"Service not found"}}}},"exampleType":"examples"}},"exampleType":"examples"},"46a615f4-d6ce-44ef-9adc-0730159c13fd":{"description":"Code `rate_limit_exceeded` when the API key exceeds its rate limit.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer","minimum":1}}},"content":{"application/json":{"schema":{"type":"object","required":["success","error"],"properties":{"success":{"type":"boolean","const":false,"isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"object","additionalProperties":true,"uniqueKey":"error.details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded"}},"examples":{"Example":{"title":"Example","value":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded"}}}},"exampleType":"examples"}},"exampleType":"examples"},"05af9f6c-4f62-47db-bd61-a5b9a7ab6fc3":{"description":"Code `server_error` when authentication or internal processing cannot complete.","content":{"application/json":{"schema":{"type":"object","required":["success","error"],"properties":{"success":{"type":"boolean","const":false,"isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"object","additionalProperties":true,"uniqueKey":"error.details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"success":false,"error":{"code":"server_error","message":"Internal server error"}},"examples":{"Example":{"title":"Example","value":{"success":false,"error":{"code":"server_error","message":"Internal server error"}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"93e63458-522f-4468-8dec-0e44525d4735":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API key","description":"Send the API key in the Authorization bearer header. Production keys begin with `sk_live_`.","scopes":[]}}},"servers":{"f4fe8460-6054-4f42-afdd-310d37353ffc":{"url":"https://brokers.newyorkcityservers.com/api","description":"Broker Panel API"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"API key","description":"Send the API key in the Authorization bearer header. Production keys begin with `sk_live_`.","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Send the API key in the Authorization bearer header. Production keys begin with `sk_live_`.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api/openapi.yaml"},"subdomain":"nycs-partner-portal","siteName":"Broker Panel Docs","title":"Get Service - Broker Panel Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-08T03:13:23.613Z","gitLastModified":"2026-09-08T03:13:01.000Z","originalFileLocation":"api/services/get-service.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=\"Get one broker-owned service and its VPS credentials by service number.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Broker Panel Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/nycs-partner-portal/r-zWxzTcT_yMLD0g/_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/nycs-partner-portal/r-zWxzTcT_yMLD0g/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/nycs-partner-portal/r-zWxzTcT_yMLD0g/_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/nycs-partner-portal/r-zWxzTcT_yMLD0g/_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/nycs-partner-portal/r-zWxzTcT_yMLD0g/_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/nycs-partner-portal/r-zWxzTcT_yMLD0g/_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/nycs-partner-portal/r-zWxzTcT_yMLD0g/_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/nycs-partner-portal/r-zWxzTcT_yMLD0g/_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/nycs-partner-portal/r-zWxzTcT_yMLD0g/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get Service - Broker Panel Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Get one broker-owned service and its VPS credentials by service number.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Broker Panel Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://broker-docs.newyorkcityservers.com/api/services/get-service\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://nycs-partner-portal.mintlify.app/_mintlify/api/og/v2?division=Services\u0026amp;title=Get+Service\u0026amp;description=Get+one+broker-owned+service+and+its+VPS+credentials+by+service+number.\u0026amp;theme=74a662f2b66a16030d7b80a1\u0026amp;signature=d2462acfb99227dd63eae88eae847cf3a23ca62e9037b42710f4309501c11a3d\">\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=\"Get Service - Broker Panel Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Get one broker-owned service and its VPS credentials by service number.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://nycs-partner-portal.mintlify.app/_mintlify/api/og/v2?division=Services\u0026amp;title=Get+Service\u0026amp;description=Get+one+broker-owned+service+and+its+VPS+credentials+by+service+number.\u0026amp;theme=74a662f2b66a16030d7b80a1\u0026amp;signature=d2462acfb99227dd63eae88eae847cf3a23ca62e9037b42710f4309501c11a3d\">\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/nycs-partner-portal/r-zWxzTcT_yMLD0g/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Broker Panel Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0E3A8C\">\u003clink data-mint-head rel=\"canonical\" href=\"https://broker-docs.newyorkcityservers.com/api/services/get-service\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api/services/get-service.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://broker-docs.newyorkcityservers.com/#organization\",\"name\":\"Broker Panel Docs\",\"url\":\"https://broker-docs.newyorkcityservers.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/nycs-partner-portal/VNrdR5TP4VcU6sO6/logo/nyc-servers-black.gif?fit=max\u0026auto=format\u0026n=VNrdR5TP4VcU6sO6\u0026q=85\u0026s=70df48f74232b81c9a07e249bc62d013\"}},{\"@type\":\"WebSite\",\"@id\":\"https://broker-docs.newyorkcityservers.com#website\",\"name\":\"Broker Panel Docs\",\"url\":\"https://broker-docs.newyorkcityservers.com\",\"publisher\":{\"@id\":\"https://broker-docs.newyorkcityservers.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://broker-docs.newyorkcityservers.com/api/services/get-service#webpage\",\"url\":\"https://broker-docs.newyorkcityservers.com/api/services/get-service\",\"name\":\"Get Service\",\"description\":\"Get one broker-owned service and its VPS credentials by service number.\",\"dateModified\":\"2026-09-08T03:13:01.000Z\",\"isPartOf\":{\"@id\":\"https://broker-docs.newyorkcityservers.com#website\"},\"breadcrumb\":{\"@id\":\"https://broker-docs.newyorkcityservers.com/api/services/get-service#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://broker-docs.newyorkcityservers.com/api/services/get-service#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Services\",\"item\":\"https://broker-docs.newyorkcityservers.com/api/services/list-plans\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get Service\",\"item\":\"https://broker-docs.newyorkcityservers.com/api/services/get-service\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://broker-docs.newyorkcityservers.com/api/services/get-service#apireference\",\"headline\":\"Get Service\",\"name\":\"Get Service\",\"description\":\"Get one broker-owned service and its VPS credentials by service number.\",\"url\":\"https://broker-docs.newyorkcityservers.com/api/services/get-service\",\"mainEntityOfPage\":{\"@id\":\"https://broker-docs.newyorkcityservers.com/api/services/get-service#webpage\"},\"dateModified\":\"2026-09-08T03:13:01.000Z\",\"publisher\":{\"@id\":\"https://broker-docs.newyorkcityservers.com/#organization\"},\"isPartOf\":{\"@id\":\"https://broker-docs.newyorkcityservers.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Broker Panel Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Broker Panel Docs","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"API Reference","groups":[{"group":"Getting Started","pages":[{"title":"API Overview","href":"/api/overview"},{"title":"Authentication","href":"/api/authentication"},{"title":"Verify API Access","href":"/api/verify-api-access"},{"title":"General API Access Check","openapi":"api/openapi.yaml GET /v1/auth-check","href":"/api/auth-check"},{"title":"Service Creation Access Check","openapi":"api/openapi.yaml POST /v1/auth-check","href":"/api/auth-check-write-access"},{"title":"IP Firewall","href":"/api/firewall"},{"title":"Sandbox Mode","href":"/api/sandbox-mode"},{"title":"Errors and Retries","href":"/api/errors-and-retries"}]},{"group":"Services","pages":[{"title":"List Plans","openapi":"api/openapi.yaml GET /v1/plans","href":"/api/services/list-plans"},{"title":"Create Service","openapi":"api/openapi.yaml POST /v1/service-create","href":"/api/services/create-service"},{"title":"List Services","description":"List and filter the services in your broker account.","openapi":"api/openapi.yaml GET /v1/services","href":"/api/services/list-services"},{"title":"Get Service","openapi":"api/openapi.yaml GET /v1/services/{service_number}","href":"/api/services/get-service"},{"title":"Change Service Password","description":"Set or generate a new password for an eligible VPS service.","openapi":"api/openapi.yaml POST /v1/services/{service_number}/password","href":"/api/services/change-password"},{"title":"Upgrade Service","openapi":"api/openapi.yaml POST /v1/services/{service_number}/upgrade","href":"/api/services/upgrade"},{"title":"Downgrade Service","openapi":"api/openapi.yaml POST /v1/services/{service_number}/downgrade","href":"/api/services/downgrade"},{"title":"Cancel Service","openapi":"api/openapi.yaml POST /v1/services/{service_number}/cancel","href":"/api/services/cancel"},{"title":"Send Cancellation Warning","openapi":"api/openapi.yaml POST /v1/services/{service_number}/cancellation-warning","href":"/api/services/cancellation-warning"}]},{"group":"Requests","pages":[{"title":"List Requests","openapi":"api/openapi.yaml GET /v1/requests","href":"/api/requests/list-requests"},{"title":"Manage Request","openapi":"api/openapi.yaml POST /v1/requests/{request_id}/manage","href":"/api/requests/manage-request"}]},{"group":"Reports","pages":[{"title":"Services Report","openapi":"api/openapi.yaml POST /v1/reports/services","href":"/api/reports/services-report"},{"title":"Invoices Report","openapi":"api/openapi.yaml POST /v1/reports/invoices","href":"/api/reports/invoices-report"}]}]}]},"basePath":"","title":"Get Service - Broker Panel Docs","buildId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","deploymentId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CS552b7R.js","utils-DDTCYAF2.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-De8ttokP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DrwRDvAh.js","snippetPresets-DtAN0nWx.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D5rWArI6.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-O2i12wsz.js","shallow-DV8xABTt.js","getApiPlaygroundDisplay-DBZ0B5Jx.js","CodeSnippet-BVi0tPUX.js","CodeSnippets-CqASbIwY.js","Page-m07pfKpT.js","getPastedJson-DG9vsMS8.js","icon-CXzRSCr8.js","MethodPill-BdKVtEuX.js","DuplicateIcon-CZlmBrJI.js","createIcon-biFEUKPL.js","DynamicMarkdown-B54_zNBF.js","SectionHeading-DwwHK3Pt.js","axios-vUo_bRtp.js","Markdown-DfhCTwyA.js","clsx-xpJZXxdP.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BTZUMDnx.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-DqdKa2R4.js"]}