Skip to main content
POST
/
api
/
admin
/
backends
/
{id}
/
rotate-credentials
Rotate credentials
curl --request POST \
  --url https://{instance}.{env}.on-hellgate.cloud/api/admin/backends/{id}/rotate-credentials \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "credentials": {
    "password": "<string>",
    "username": "<string>"
  }
}
'
{
  "auth_pipeline": {
    "date_header": "<string>",
    "extra_headers": {},
    "header_values": {},
    "method": "<string>",
    "signed_headers": [
      "<string>"
    ],
    "token_prefix": "<string>"
  },
  "connections": {},
  "enabled": true,
  "encryption": {
    "algorithm": "RSA-OAEP-256",
    "encryption_method": "A256GCM",
    "mode": "whole_body",
    "request_key_kid": "<string>",
    "response_key_kids": [
      "<string>"
    ],
    "extra_header_claims": [
      "iat"
    ],
    "request_field": "encryptedRequest",
    "response_field": "encryptedResponse"
  },
  "host": "<string>",
  "id": "<string>",
  "inserted_at": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "protocol": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

Body

application/json

Credential rotation

​
credentials
InlineBasicCredentials · object
required

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

Response

Backend updated

​
auth_pipeline
AuthPipeline · object
​
connections
object

Map of action keys to connection configurations

​
enabled
boolean
​
encryption
EncryptionConfig · object

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
​
id
string
​
inserted_at
string<date-time>
​
name
string
​
protocol
string