Skip to main content
POST
Create backend

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Backend configuration

auth_pipeline
AuthPipeline · object
required

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:
connections
object
required
Example:
credentials
InlineBasicCredentials · object
required

Credential material for the auth pipeline. Shape is determined by auth_pipeline.source_type and auth_pipeline.credential_type.

id
string
required
Example:

"acme-risk"

name
string
required
Example:

"Acme Risk"

protocol
string
required
Example:

"https://developer.hellgate.io/protocols/specter/v1"

enabled
boolean
default:true
encryption
EncryptionConfig · object | null

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.

host
string
Example:

"api.acme.example"

Response

Backend created

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.

Example:
enabled
boolean
Example:

true

host
string
Example:

"api.acme.example"

id
string
Example:

"acme-risk"

inserted_at
string<date-time>
Example:

"2026-05-12T09:30:00Z"

name
string
Example:

"Acme Risk"

protocol
string
Example:

"https://developer.hellgate.io/protocols/specter/v1"