{
"classifier": "UNAUTHORIZED",
"code": 401,
"message": "No valid means of authentication was provided"
}
{
"classifier": "FORBIDDEN",
"code": 403,
"message": "Not allowed to access this resource or feature"
}
{
"classifier": "NOT_FOUND",
"code": 404,
"message": "The requested resource does not exist"
}
Authorizations
Authorization
string
header
required
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
id
string
required
Response
Backend detail
auth_pipeline
AuthPipeline · object
How outbound requests to the provider are authenticated. An empty object (or omitting the pipeline) adds no authentication. A non-empty pipeline requires source_type and credential_type.
Optional per-backend message-level encryption (MLE). When set, the mapped request body is JWE-encrypted before dispatch and the response body is decrypted before response mapping. Key material is managed via /api/admin/keys.
Optional client certificate for two-way TLS. Every call to the backend presents the certificate chain of the referenced client_tls key, over HTTP/1.1. The key is managed via /api/admin/keys and cannot be deleted while a backend references it.
{
"classifier": "UNAUTHORIZED",
"code": 401,
"message": "No valid means of authentication was provided"
}
{
"classifier": "FORBIDDEN",
"code": 403,
"message": "Not allowed to access this resource or feature"
}
{
"classifier": "NOT_FOUND",
"code": 404,
"message": "The requested resource does not exist"
}
{"docsConfig":{"theme":"maple","$schema":"https://mintlify.com/docs.json","name":"Hellgate Cloud Platform","colors":{"primary":"#16A34A","light":"#07C983","dark":"#15803D"},"logo":{"light":"https://mintcdn.com/starfishgmbhcokg/fao_mR6VDpBCxc3o/logo/light.svg?fit=max\u0026auto=format\u0026n=fao_mR6VDpBCxc3o\u0026q=85\u0026s=1f2caba60febae2b0dcaddf3e196a132","dark":"https://mintcdn.com/starfishgmbhcokg/fao_mR6VDpBCxc3o/logo/dark.svg?fit=max\u0026auto=format\u0026n=fao_mR6VDpBCxc3o\u0026q=85\u0026s=a89c19b7c5f7607499a161a2db5b0f74","href":"https://developer.hellgate.io"},"favicon":"https://mintcdn.com/starfishgmbhcokg/dfhj2Hm84A9ik5S0/favicon.svg?fit=max\u0026auto=format\u0026n=dfhj2Hm84A9ik5S0\u0026q=85\u0026s=d897b485a1cd938d6af772ddd4885368","api":{"params":{"post":["x-data-classification"]}},"background":{"decoration":"gradient"},"navbar":{"links":[{"href":"https://hellgate.io","label":"Visit hellgate.io"}],"primary":{"type":"button","label":"Write our Support","href":"mailto:support@hellgate.io"}},"footer":{"socials":{"website":"https://hellgate.io","github":"https://github.com/starfish-codes","linkedin":"https://www.linkedin.com/company/hellgate-io","youtube":"https://www.youtube.com/@hellgate-io"}},"seo":{"metatags":{"google-site-verification":"OJ_nWFren-zsecLNqkmvOGrnXjmCZ_fPg5ov1mM8Tno"}},"contextual":{"options":["copy","view","download-spec","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"starfishgmbhcokg","hasAudioNarration":false,"actualSubdomain":"starfishgmbhcokg","customDomains":["developer.hellgate.io"],"gitSource":{"type":"github","owner":"starfish-codes","repo":"cpa-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af5b00e55654e521ba20207","clientVersion":"0.0.4128","searchFilterCounts":[{"language":"default","tag":"API Reference","count":244},{"language":"default","tag":"Commerce","count":181},{"language":"default","tag":"Documentation","count":82},{"language":"default","tag":"Guardian","count":77},{"language":"default","tag":"Tokens","count":67},{"language":"default","tag":"Specter","count":60},{"language":"default","tag":"Admin","count":50},{"language":"default","tag":"Payments","count":36},{"language":"default","tag":"Configuration","count":29},{"language":"default","tag":"Wallet Tokens","count":28}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","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":"rbac-expansion","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":"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":"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":"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":"editor-metadata","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},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","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}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":":root{--hg-classification-bg: #fef3c7;--hg-classification-fg: #92400e}.dark{--hg-classification-bg: rgb(245 158 11 / 0.15);--hg-classification-fg: #fcd34d}div[data-component-part=\"field-meta-post\"]{background-color:var(--hg-classification-bg);color:var(--hg-classification-fg)}.dark div[data-component-part=\"field-meta-post\"]{background-color:var(--hg-classification-bg);color:var(--hg-classification-fg)}.classification-badge{display:inline-block;padding:0.125rem 0.5rem;border-radius:0.375rem;font-family:ui-monospace, SFMono-Regular, Menlo, Consolas, monospace;font-size:0.875em;white-space:nowrap;background-color:var(--hg-classification-bg);color:var(--hg-classification-fg)}"}],"page":{"pagePath":"products/link/api-reference/backends/get-backend","slug":"/products/link/api-reference/backends/get-backend","pageMetadata":{"title":"Get backend","description":null,"deprecated":null,"version":null,"openapi":"/products/link/openapi.yaml get /api/admin/backends/{id}","href":"/products/link/api-reference/backends/get-backend","autogeneratedByOpenApi":true},"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":{"title":"Get backend","description":null,"deprecated":null,"version":null,"openapi":"/products/link/openapi.yaml get /api/admin/backends/{id}","href":"/products/link/api-reference/backends/get-backend","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"callbacks":{},"operationId":"backends_get","parameters":["f9ae6cbe-efdc-47fc-bf9f-ee26b36e5f5f"],"responses":{"200":"09b8226b-f1ec-40f9-b8a6-1d33770c93f5","401":"d20d5d1c-d58e-4955-a7ed-2e40a5c63d33","403":"96e60289-78fb-4b41-b51e-dd6773aff35b","404":"63a4e162-0562-497f-9729-c4e9230b6339"},"security":["a8f55260-0004-45d3-94aa-b0e50a643fff"],"summary":"Get backend","tags":["Backends"],"method":"get","type":"path","servers":["10dcffcd-6804-4143-a8c6-c178578b781d"],"path":"/api/admin/backends/{id}","baseUrlOptions":["https://{instance}.{env}.on-hellgate.cloud"],"title":"Get backend","description":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"f9ae6cbe-efdc-47fc-bf9f-ee26b36e5f5f":{"description":"","in":"path","name":"id","required":true,"schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"responses":{"09b8226b-f1ec-40f9-b8a6-1d33770c93f5":{"content":{"application/json":{"schema":{"properties":{"auth_pipeline":{"description":"How outbound requests to the provider are authenticated. An empty object (or omitting the pipeline) adds no authentication. A non-empty pipeline requires `source_type` and `credential_type`.","example":{"source_type":"inline","credential_type":"bearer","token_prefix":"token"},"properties":{"credential_type":{"description":"Authentication strategy","enum":["hmac_sha256","basic","bearer"],"type":"string","isRequired":true,"uniqueKey":"auth_pipeline.credential_type","typeLabel":"enum\u003cstring>"},"source_type":{"description":"Where the credentials come from — inline (encrypted at rest in the backend record) or a Vault pointer resolved at request time.","enum":["inline","vault"],"type":"string","isRequired":true,"uniqueKey":"auth_pipeline.source_type","typeLabel":"enum\u003cstring>"},"date_header":{"example":"Date","description":"Header name for the date value (`hmac_sha256` only)","type":"string","uniqueKey":"auth_pipeline.date_header","typeLabel":"string"},"extra_headers":{"example":{"x-client-id":"acme-partner"},"additionalProperties":{"type":"string","uniqueKey":"auth_pipeline.extra_headers.additionalProperties","typeLabel":"string"},"description":"Additional headers appended to requests","type":"object","uniqueKey":"auth_pipeline.extra_headers","typeLabel":"object"},"header_values":{"example":{"x-api-key":"YOUR_PROVIDER_API_KEY"},"additionalProperties":{"type":"string","uniqueKey":"auth_pipeline.header_values.additionalProperties","typeLabel":"string"},"description":"Static header values (`hmac_sha256` only)","type":"object","uniqueKey":"auth_pipeline.header_values","typeLabel":"object"},"method":{"example":"POST","description":"HTTP method override for the signature (`hmac_sha256` only, default POST)","type":"string","uniqueKey":"auth_pipeline.method","typeLabel":"string"},"signed_headers":{"example":["date","digest"],"description":"Headers to include in the HMAC signature. Required when `credential_type` is `hmac_sha256`.","items":{"type":"string","uniqueKey":"auth_pipeline.signed_headers.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueKey":"auth_pipeline.signed_headers","typeLabel":"string[]"},"token_prefix":{"example":"token","description":"Token prefix for bearer auth (default: \"Bearer\", use \"token\" for Ravelin). `bearer` only.","type":"string","uniqueKey":"auth_pipeline.token_prefix","typeLabel":"string"}},"required":["source_type","credential_type"],"title":"AuthPipeline","type":"object","uniqueKey":"auth_pipeline","typeLabel":"AuthPipeline · object"},"connections":{"example":{"assess.pan":{"endpoint":{"method":"POST","path":"/v1/decisions","content_type":"application/json","timeout_ms":5000},"request_mapping":{"body":{"cardNumber":"{{ $.request.body.credential.pan.value | required }}","amount":"{{ $.request.body.transaction.amount | required }}","currency":"{{ $.request.body.transaction.currency | required }}"}},"response_mapping":{"200":{"return":"200","body":{"type":"enum","value":"{{ $.response.body.status | map({ ACCEPTED: ALLOW, REJECTED: BLOCK, PENDING: REVIEW }) | required }}","backend_reference":"{{ $.response.body.id | omit_if_null }}"}}}}},"additionalProperties":{"description":"Configuration for a single connection. Must have either mocks or live mapping (endpoint/request_mapping/response_mapping).","properties":{"endpoint":{"example":{"method":"POST","path":"/v1/decisions","content_type":"application/json","timeout_ms":5000},"additionalProperties":true,"description":"Live endpoint configuration","properties":{"timeout_ms":{"description":"Milliseconds Link waits for response data from the backend before it gives up with a 502 transport error (code `:timeout`). Over HTTP/1.1 it limits the wait for the response to start and between later parts of it. It does not cover connecting or the TLS handshake. Without it, the instance default applies.","maximum":60000,"minimum":1,"type":"integer","uniqueKey":"connections.additionalProperties.endpoint.timeout_ms","typeLabel":"integer"}},"type":"object","uniqueKey":"connections.additionalProperties.endpoint","typeLabel":"object"},"mocks":{"example":[{"match":{},"respond":{"type":"enum","value":"ALLOW"}}],"description":"Mock response definitions","items":{"additionalProperties":true,"type":"object","uniqueKey":"connections.additionalProperties.mocks.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"connections.additionalProperties.mocks","typeLabel":"object[]"},"request_mapping":{"description":"Template-shaped request mapping. Both `body` and `headers` carry template strings resolved against the caller's invoke body and headers at runtime.","properties":{"body":{"example":{"amount":"{{ $.request.body.transaction.amount | required }}","currency":"{{ $.request.body.transaction.currency | required }}"},"additionalProperties":true,"description":"Recursive object mirroring the backend's expected request body. Leaves\nare plain JSON values: strings carry the mustache-style template grammar\n(`{{ $req.body.x | filter }}`), other primitives are literals. See\n`Link.Mapping.Parser` for the full grammar and filter catalogue.\n","type":"object","uniqueKey":"connections.additionalProperties.request_mapping.body","typeLabel":"object"},"headers":{"example":{"x-correlation-id":"{{ $.request.header.x-correlation-id | omit_if_null }}"},"additionalProperties":{"type":"string","uniqueKey":"connections.additionalProperties.request_mapping.headers.additionalProperties","typeLabel":"string"},"description":"Outbound HTTP headers, keyed by header name. Each value is a template\nstring that must resolve to a scalar coercible to a string. Auth-pipeline\nheaders (HMAC `Digest`, etc.) override mapped headers on conflict.\n","type":"object","uniqueKey":"connections.additionalProperties.request_mapping.headers","typeLabel":"object"}},"title":"RequestMapping","type":"object","uniqueKey":"connections.additionalProperties.request_mapping","typeLabel":"RequestMapping · object"},"response_mapping":{"additionalProperties":{"properties":{"body":{"additionalProperties":true,"description":"Recursive template; leaves are plain JSON values where strings follow the\nmustache-style template grammar. Response templates may reference all\nfour scoped roots: `$req.body.*`, `$req.header.*`, `$res.body.*`, and\n`$res.header.*`.\n","type":"object","isRequired":true,"uniqueKey":"connections.additionalProperties.response_mapping.additionalProperties.body","typeLabel":"object"},"return":{"description":"Protocol HTTP status code to return to the caller.","type":"string","isRequired":true,"uniqueKey":"connections.additionalProperties.response_mapping.additionalProperties.return","typeLabel":"string"}},"required":["return","body"],"type":"object","uniqueKey":"connections.additionalProperties.response_mapping.additionalProperties","typeLabel":"object"},"description":"Map of backend HTTP status patterns (`201`, `4xx`, `default`, ...) to response rules. Each rule has a `return` (the protocol HTTP status to return to the caller) and a `body` template that produces the protocol-shaped response.","example":{"200":{"return":"200","body":{"type":"enum","value":"{{ $.response.body.status | map({ ACCEPTED: ALLOW, REJECTED: BLOCK }) | required }}","backend_reference":"{{ $.response.body.id | omit_if_null }}"}}},"title":"ResponseMapping","type":"object","uniqueKey":"connections.additionalProperties.response_mapping","typeLabel":"ResponseMapping · object"}},"title":"ConnectionConfig","type":"object","uniqueKey":"connections.additionalProperties","typeLabel":"ConnectionConfig · object"},"description":"Map of action keys to connection configurations","type":"object","uniqueKey":"connections","typeLabel":"object"},"enabled":{"example":true,"type":"boolean","uniqueKey":"enabled","typeLabel":"boolean"},"encryption":{"oneOf":[{"description":"Optional per-backend message-level encryption (MLE). When set, the mapped request body is JWE-encrypted before dispatch and the response body is decrypted before response mapping. Key material is managed via /api/admin/keys.","properties":{"algorithm":{"description":"JWE key-management algorithm (JOSE `alg`).","example":"RSA-OAEP-256","type":"string","isRequired":true,"uniqueKey":"encryption.oneOf.0.algorithm","typeLabel":"string"},"encryption_method":{"description":"JWE content-encryption algorithm (JOSE `enc`).","example":"A256GCM","type":"string","isRequired":true,"uniqueKey":"encryption.oneOf.0.encryption_method","typeLabel":"string"},"mode":{"description":"Envelope mode. `whole_body` wraps the entire JSON body in `{request_field: \u003cJWE>}`.","enum":["whole_body"],"type":"string","isRequired":true,"uniqueKey":"encryption.oneOf.0.mode","typeLabel":"enum\u003cstring>"},"request_key_kid":{"example":"a1b2c3d4e5f6","description":"`kid` of an encryption key with purpose `encrypt_request`.","type":"string","isRequired":true,"uniqueKey":"encryption.oneOf.0.request_key_kid","typeLabel":"string"},"response_key_kids":{"example":["f6e5d4c3b2a1"],"description":"Ordered list of `kid`s (purpose `decrypt_response`) tried in order when decrypting responses. Allows rotation overlap.","items":{"type":"string","uniqueKey":"encryption.oneOf.0.response_key_kids.items.[INDEX]","typeLabel":"string"},"type":"array","isRequired":true,"uniqueKey":"encryption.oneOf.0.response_key_kids","typeLabel":"string[]"},"extra_header_claims":{"description":"Additional JOSE header claims to include (currently supports `iat`).","items":{"enum":["iat"],"type":"string","uniqueKey":"encryption.oneOf.0.extra_header_claims.items.[INDEX]","typeLabel":"enum\u003cstring>"},"type":"array","uniqueKey":"encryption.oneOf.0.extra_header_claims","typeLabel":"enum\u003cstring>[]"},"request_field":{"description":"Envelope field name for the outbound JWE (default `encryptedRequest`).","example":"encryptedRequest","type":"string","uniqueKey":"encryption.oneOf.0.request_field","typeLabel":"string"},"response_field":{"description":"Envelope field name for the inbound JWE (default `encryptedResponse`).","example":"encryptedResponse","type":"string","uniqueKey":"encryption.oneOf.0.response_field","typeLabel":"string"}},"required":["mode","algorithm","encryption_method","request_key_kid","response_key_kids"],"title":"EncryptionConfig","type":"object","uniqueKey":"encryption.oneOf.0","typeLabel":"EncryptionConfig · object"},{"description":"Optional per-backend message-level encryption (MLE). When set, the mapped request body is JWE-encrypted before dispatch and the response body is decrypted before response mapping. Key material is managed via /api/admin/keys.","properties":{"algorithm":{"description":"JWE key-management algorithm (JOSE `alg`).","example":"RSA-OAEP-256","type":"string"},"encryption_method":{"description":"JWE content-encryption algorithm (JOSE `enc`).","example":"A256GCM","type":"string"},"extra_header_claims":{"description":"Additional JOSE header claims to include (currently supports `iat`).","items":{"enum":["iat"],"type":"string"},"type":"array"},"mode":{"description":"Envelope mode. `whole_body` wraps the entire JSON body in `{request_field: \u003cJWE>}`.","enum":["whole_body"],"type":"string"},"request_field":{"description":"Envelope field name for the outbound JWE (default `encryptedRequest`).","example":"encryptedRequest","type":"string"},"request_key_kid":{"example":"a1b2c3d4e5f6","description":"`kid` of an encryption key with purpose `encrypt_request`.","type":"string"},"response_field":{"description":"Envelope field name for the inbound JWE (default `encryptedResponse`).","example":"encryptedResponse","type":"string"},"response_key_kids":{"example":["f6e5d4c3b2a1"],"description":"Ordered list of `kid`s (purpose `decrypt_response`) tried in order when decrypting responses. Allows rotation overlap.","items":{"type":"string"},"type":"array"}},"required":["mode","algorithm","encryption_method","request_key_kid","response_key_kids"],"title":"EncryptionConfig","type":"null","uniqueKey":"encryption.oneOf.1","typeLabel":"null"}],"uniqueKey":"encryption","typeLabel":"EncryptionConfig · object | null"},"host":{"example":"api.acme.example","type":"string","uniqueKey":"host","typeLabel":"string"},"id":{"example":"acme-risk","type":"string","uniqueKey":"id","typeLabel":"string"},"inserted_at":{"example":"2026-05-12T09:30:00Z","format":"date-time","type":"string","uniqueKey":"inserted_at","typeLabel":"string\u003cdate-time>"},"name":{"example":"Acme Risk","type":"string","uniqueKey":"name","typeLabel":"string"},"protocol":{"example":"https://developer.hellgate.io/protocols/specter/v1","type":"string","uniqueKey":"protocol","typeLabel":"string"},"tls":{"oneOf":[{"additionalProperties":false,"description":"Optional client certificate for two-way TLS. Every call to the backend presents the certificate chain of the referenced `client_tls` key, over HTTP/1.1. The key is managed via /api/admin/keys and cannot be deleted while a backend references it.","properties":{"client_key_kid":{"description":"`kid` of an encryption key with purpose `client_tls`.","example":"acme-client-2026","minLength":1,"type":"string","isRequired":true,"uniqueKey":"tls.oneOf.0.client_key_kid","typeLabel":"string"}},"required":["client_key_kid"],"title":"TlsConfig","type":"object","uniqueKey":"tls.oneOf.0","typeLabel":"TlsConfig · object"},{"additionalProperties":false,"description":"Optional client certificate for two-way TLS. Every call to the backend presents the certificate chain of the referenced `client_tls` key, over HTTP/1.1. The key is managed via /api/admin/keys and cannot be deleted while a backend references it.","properties":{"client_key_kid":{"description":"`kid` of an encryption key with purpose `client_tls`.","example":"acme-client-2026","minLength":1,"type":"string"}},"required":["client_key_kid"],"title":"TlsConfig","type":"null","uniqueKey":"tls.oneOf.1","typeLabel":"null"}],"uniqueKey":"tls","typeLabel":"TlsConfig · object | null"}},"title":"BackendDetail","type":"object","uniqueKey":"","typeLabel":"BackendDetail · object"},"examples":{"Example":{"title":"Example","value":{"auth_pipeline":{"source_type":"inline","credential_type":"bearer","token_prefix":"token"},"connections":{"assess.pan":{"endpoint":{"method":"POST","path":"/v1/decisions","content_type":"application/json","timeout_ms":5000},"request_mapping":{"body":{"cardNumber":"{{ $.request.body.credential.pan.value | required }}","amount":"{{ $.request.body.transaction.amount | required }}","currency":"{{ $.request.body.transaction.currency | required }}"}},"response_mapping":{"200":{"return":"200","body":{"type":"enum","value":"{{ $.response.body.status | map({ ACCEPTED: ALLOW, REJECTED: BLOCK, PENDING: REVIEW }) | required }}","backend_reference":"{{ $.response.body.id | omit_if_null }}"}}}}},"enabled":true,"encryption":{"algorithm":"RSA-OAEP-256","encryption_method":"A256GCM","mode":"whole_body","request_key_kid":"a1b2c3d4e5f6","response_key_kids":["f6e5d4c3b2a1"],"extra_header_claims":["iat"],"request_field":"encryptedRequest","response_field":"encryptedResponse"},"host":"api.acme.example","id":"acme-risk","inserted_at":"2026-05-12T09:30:00Z","name":"Acme Risk","protocol":"https://developer.hellgate.io/protocols/specter/v1","tls":{"client_key_kid":"acme-client-2026"}}}},"exampleType":"generated"}},"description":"Backend detail","exampleType":"generated"},"d20d5d1c-d58e-4955-a7ed-2e40a5c63d33":{"content":{"application/json":{"schema":{"description":"No valid authentication was provided.","example":{"classifier":"UNAUTHORIZED","code":401,"message":"No valid means of authentication was provided"},"properties":{"classifier":{"enum":["UNAUTHORIZED"],"type":"string","isRequired":true,"uniqueKey":"classifier","typeLabel":"enum\u003cstring>"},"code":{"enum":[401],"type":"integer","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cinteger>"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["classifier","code","message"],"title":"Unauthorized","type":"object","uniqueKey":"","typeLabel":"Unauthorized · object"},"examples":{"Example":{"title":"Example","value":{"classifier":"UNAUTHORIZED","code":401,"message":"No valid means of authentication was provided"}}},"exampleType":"generated"}},"description":"Unauthorized","exampleType":"generated"},"96e60289-78fb-4b41-b51e-dd6773aff35b":{"content":{"application/json":{"schema":{"description":"The token lacks the scope required for this operation.","example":{"classifier":"FORBIDDEN","code":403,"message":"Not allowed to access this resource or feature"},"properties":{"classifier":{"enum":["FORBIDDEN"],"type":"string","isRequired":true,"uniqueKey":"classifier","typeLabel":"enum\u003cstring>"},"code":{"enum":[403],"type":"integer","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cinteger>"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["classifier","code","message"],"title":"Forbidden","type":"object","uniqueKey":"","typeLabel":"Forbidden · object"},"examples":{"Example":{"title":"Example","value":{"classifier":"FORBIDDEN","code":403,"message":"Not allowed to access this resource or feature"}}},"exampleType":"generated"}},"description":"Forbidden","exampleType":"generated"},"63a4e162-0562-497f-9729-c4e9230b6339":{"content":{"application/json":{"schema":{"description":"The requested resource does not exist.","example":{"classifier":"NOT_FOUND","code":404,"message":"The requested resource does not exist"},"properties":{"classifier":{"enum":["NOT_FOUND"],"type":"string","isRequired":true,"uniqueKey":"classifier","typeLabel":"enum\u003cstring>"},"code":{"enum":[404],"type":"integer","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cinteger>"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["classifier","code","message"],"title":"NotFound","type":"object","uniqueKey":"","typeLabel":"NotFound · object"},"examples":{"Example":{"title":"Example","value":{"classifier":"NOT_FOUND","code":404,"message":"The requested resource does not exist"}}},"exampleType":"generated"}},"description":"Not found","exampleType":"generated"}},"security":{"a8f55260-0004-45d3-94aa-b0e50a643fff":{"bearerAuth":{"bearerFormat":"JWT","scheme":"bearer","type":"http","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"10dcffcd-6804-4143-a8c6-c178578b781d":{"url":"https://{instance}.{env}.on-hellgate.cloud","description":"Managed instance of Link","variables":{"instance":{"default":"my-instance","description":"Your unique instance slug, provided during onboarding."},"env":{"default":"eu1","description":"Deployment environment (currently eu1)."}}}},"processedSecurityOptions":[{"schemes":[{"scheme":{"bearerFormat":"JWT","scheme":"bearer","type":"http","scopes":[],"schemeName":"bearerAuth"},"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":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"products/link/openapi.yaml"},"subdomain":"starfishgmbhcokg","siteName":"Hellgate Cloud Platform","title":"Get backend - Hellgate Cloud Platform","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-12T12:24:57.079Z","originalFileLocation":"products/link/api-reference/backends/get-backend.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=\"application-name\" content=\"Hellgate Cloud Platform\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/starfishgmbhcokg/ehX6KGXou7_zUBXs/_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/starfishgmbhcokg/ehX6KGXou7_zUBXs/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/starfishgmbhcokg/ehX6KGXou7_zUBXs/_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/starfishgmbhcokg/ehX6KGXou7_zUBXs/_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/starfishgmbhcokg/ehX6KGXou7_zUBXs/_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/starfishgmbhcokg/ehX6KGXou7_zUBXs/_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/starfishgmbhcokg/ehX6KGXou7_zUBXs/_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/starfishgmbhcokg/ehX6KGXou7_zUBXs/_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/starfishgmbhcokg/ehX6KGXou7_zUBXs/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get backend - Hellgate Cloud Platform\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Hellgate Cloud Platform\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developer.hellgate.io/products/link/api-reference/backends/get-backend\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://starfishgmbhcokg.mintlify.site/_mintlify/api/og/v2?division=Backends\u0026amp;title=Get+backend\u0026amp;theme=4a79c05b20e2f91a365b752c\u0026amp;signature=7ae1e3baa7b00e5e1977fd2420fb78a031ba182c6a2db4493996f34764b1b5a2\">\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 backend - Hellgate Cloud Platform\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://starfishgmbhcokg.mintlify.site/_mintlify/api/og/v2?division=Backends\u0026amp;title=Get+backend\u0026amp;theme=4a79c05b20e2f91a365b752c\u0026amp;signature=7ae1e3baa7b00e5e1977fd2420fb78a031ba182c6a2db4493996f34764b1b5a2\">\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/starfishgmbhcokg/ehX6KGXou7_zUBXs/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Hellgate Cloud Platform\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#16A34A\">\u003cmeta data-mint-head name=\"google-site-verification\" content=\"OJ_nWFren-zsecLNqkmvOGrnXjmCZ_fPg5ov1mM8Tno\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developer.hellgate.io/products/link/api-reference/backends/get-backend\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/products/link/api-reference/backends/get-backend.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developer.hellgate.io/#organization\",\"name\":\"Hellgate Cloud Platform\",\"url\":\"https://developer.hellgate.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/starfishgmbhcokg/fao_mR6VDpBCxc3o/logo/light.svg?fit=max\u0026auto=format\u0026n=fao_mR6VDpBCxc3o\u0026q=85\u0026s=1f2caba60febae2b0dcaddf3e196a132\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developer.hellgate.io#website\",\"name\":\"Hellgate Cloud Platform\",\"url\":\"https://developer.hellgate.io\",\"publisher\":{\"@id\":\"https://developer.hellgate.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developer.hellgate.io/products/link/api-reference/backends/get-backend#webpage\",\"url\":\"https://developer.hellgate.io/products/link/api-reference/backends/get-backend\",\"name\":\"Get backend\",\"dateModified\":\"2026-11-12T12:24:57.079Z\",\"isPartOf\":{\"@id\":\"https://developer.hellgate.io#website\"},\"breadcrumb\":{\"@id\":\"https://developer.hellgate.io/products/link/api-reference/backends/get-backend#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developer.hellgate.io/products/link/api-reference/backends/get-backend#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Backends\",\"item\":\"https://developer.hellgate.io/products/link/api-reference/backends/create-backend\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get backend\",\"item\":\"https://developer.hellgate.io/products/link/api-reference/backends/get-backend\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developer.hellgate.io/products/link/api-reference/backends/get-backend#apireference\",\"headline\":\"Get backend\",\"name\":\"Get backend\",\"url\":\"https://developer.hellgate.io/products/link/api-reference/backends/get-backend\",\"mainEntityOfPage\":{\"@id\":\"https://developer.hellgate.io/products/link/api-reference/backends/get-backend#webpage\"},\"dateModified\":\"2026-11-12T12:24:57.079Z\",\"publisher\":{\"@id\":\"https://developer.hellgate.io/#organization\"},\"isPartOf\":{\"@id\":\"https://developer.hellgate.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Hellgate Cloud Platform\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Hellgate Cloud Platform\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/products/link/api-reference/backends/get-backend.md","siteName":"Hellgate Cloud Platform","nav":{"global":null,"products":[{"product":"Cloud Platform","icon":"cloud","pages":[{"title":"Cloud Platform","href":"/platform"}]},{"product":"Guardian","icon":"vault","pages":[{"title":"Guardian","href":"/products/guardian/overview"}]},{"product":"Specter","icon":"shield","pages":[{"title":"Specter","href":"/products/specter/overview"}]},{"product":"Commerce","icon":"cart-shopping","pages":[{"title":"Commerce","href":"/products/commerce/v2/overview"}]},{"product":"Link","icon":"link","tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/products/link/overview"}]},{"tab":"API Reference","groups":[{"group":"Getting Started","pages":[{"title":"Getting Started","href":"/products/link/api-reference/getting-started"}]},{"group":"Invoke","pages":[{"title":"Invoke protocol action","deprecated":null,"version":null,"openapi":"/products/link/openapi.yaml post /api/invoke/{protocol}/{action}","href":"/products/link/api-reference/invoke/invoke-protocol-action"}]},{"group":"Protocols","pages":[{"title":"List protocols","deprecated":null,"version":null,"openapi":"/products/link/openapi.yaml get /api/admin/protocols","href":"/products/link/api-reference/protocols/list-protocols"},{"title":"Get protocol document","deprecated":null,"version":null,"openapi":"/products/link/openapi.yaml get /api/admin/protocols/{id}","href":"/products/link/api-reference/protocols/get-protocol-document"},{"title":"Get generated OpenAPI spec","deprecated":null,"version":null,"sidebarTitle":"Get OpenAPI spec","openapi":"/products/link/openapi.yaml get /api/admin/protocols/{id}/openapi","href":"/products/link/api-reference/protocols/get-generated-openapi-spec"},{"title":"Refresh a protocol from its URL","deprecated":null,"version":null,"openapi":"/products/link/openapi.yaml post /api/admin/protocols/{id}/refresh","href":"/products/link/api-reference/protocols/refresh-a-protocol-from-its-url"},{"title":"Delete protocol","deprecated":null,"version":null,"openapi":"/products/link/openapi.yaml delete /api/admin/protocols/{id}","href":"/products/link/api-reference/protocols/delete-protocol"}]},{"group":"Backends","pages":[{"title":"Create backend","deprecated":null,"version":null,"openapi":"/products/link/openapi.yaml post /api/admin/backends","href":"/products/link/api-reference/backends/create-backend"},{"title":"List backends","description":null,"deprecated":null,"version":null,"openapi":"/products/link/openapi.yaml get /api/admin/backends","href":"/products/link/api-reference/backends/list-backends"},{"title":"Get backend","deprecated":null,"version":null,"openapi":"/products/link/openapi.yaml get /api/admin/backends/{id}","href":"/products/link/api-reference/backends/get-backend"},{"title":"Update backend","description":null,"deprecated":null,"version":null,"openapi":"/products/link/openapi.yaml put /api/admin/backends/{id}","href":"/products/link/api-reference/backends/update-backend"},{"title":"Rotate credentials","deprecated":null,"version":null,"openapi":"/products/link/openapi.yaml post /api/admin/backends/{id}/rotate-credentials","href":"/products/link/api-reference/backends/rotate-credentials"},{"title":"Delete backend","deprecated":null,"version":null,"openapi":"/products/link/openapi.yaml delete /api/admin/backends/{id}","href":"/products/link/api-reference/backends/delete-backend"}]},{"group":"Custom Protocols","tag":"Standalone","pages":[{"title":"Import by URL","deprecated":null,"version":null,"openapi":"/products/link/openapi.yaml post /api/admin/protocols/import","href":"/products/link/api-reference/protocols/import-by-url"},{"title":"Import by spec","deprecated":null,"version":null,"openapi":"/products/link/openapi.yaml post /api/admin/protocols","href":"/products/link/api-reference/protocols/import-by-spec"}]}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/products/link/changelog"}]}]}]},"basePath":"","title":"Get backend - Hellgate Cloud Platform","buildId":"dpl_5tKr6cUUeuVJdEZ9JAEY3h4soMJ8","deploymentId":"dpl_5tKr6cUUeuVJdEZ9JAEY3h4soMJ8","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-DbeN8Wo6.js","utils-CwSb5Doc.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BmREeM3N.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-AYjWerCj.js","snippetPresets-QD4ULQlp.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","Page-CqcDm2To.js","ApiExamples-Digj5cjF.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CiHrzluR.js","shallow-D7h7pFGg.js","getApiPlaygroundDisplay-mlxkpAUf.js","CodeSnippet-D2rH5lZI.js","CodeSnippets-B53ulOaL.js","getPastedJson-DxGeNMih.js","icon-BHbyrebp.js","MethodPill-C7F_KEEJ.js","DuplicateIcon-j3c5-73z.js","createIcon-OvCnyFqD.js","DynamicMarkdown-DpAS3GCb.js","SectionHeading-DMPpdrvW.js","axios-vUo_bRtp.js","Markdown-D7pDRguu.js","clsx-2_c6mSt_.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-Cu7_SikL.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-ydqCcy4b.js"]}