POST
/api/v1/profiles/export
Export profiles as XLSX, CSV, or TXT (reimportable, id/no columns used for updates); passwords require secrets:read
Request#
POSIX shell · curl
curl --fail-with-body --request POST \
"$ADBR_API_URL/api/v1/profiles/export" \
-H "Authorization: Bearer $ADBR_API_TOKEN" \
-H "Content-Type: application/json" \
--data @request.jsonUse the local address and token from API & MCP. Replace path placeholders such as {id} with actual IDs. Create request.json according to the body schema below before running this command.
Authentication and permissions#
Authentication: Bearer token
Scopes: profiles:read
All listed scopes are required; admin satisfies scope checks. Account permissions, request content, vault state and resource permissions can impose additional requirements.
Parameters#
No path or query parameters declared.
Request body#
Required.
| Field | Type | Required | Description |
|---|---|---|---|
ids | array | No | |
all | boolean | No | |
format | union | Yes | |
include_secrets | boolean | No |
Complete body schema
OpenAPI JSON
{
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"format"
],
"properties": {
"ids": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"minItems": 1,
"maxItems": 1000
},
"all": {
"type": "boolean"
},
"format": {
"anyOf": [
{
"type": "string",
"enum": [
"xlsx"
]
},
{
"type": "string",
"enum": [
"csv"
]
},
{
"type": "string",
"enum": [
"txt"
]
}
]
},
"include_secrets": {
"type": "boolean"
}
},
"additionalProperties": false
}
}
}
}Responses#
200 · Default response
OpenAPI JSON
{
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"file_name",
"mime",
"count",
"content_base64"
],
"properties": {
"file_name": {
"type": "string"
},
"mime": {
"type": "string"
},
"count": {
"type": "integer"
},
"content_base64": {
"type": "string"
}
}
}
}
}
}default · HTTP error envelope. The status and error.code identify the failure.
OpenAPI JSON
{
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}General authentication and transport errors may occur in addition to the documented responses.
OpenAPI definition#
Complete operation definition
OpenAPI JSON
{
"summary": "Profile als XLSX, CSV oder TXT exportieren (wieder importierbar, Spalten id/no für Aktualisierung); Passwörter nur mit secrets:read",
"tags": [
"Import/Export"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"format"
],
"properties": {
"ids": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"minItems": 1,
"maxItems": 1000
},
"all": {
"type": "boolean"
},
"format": {
"anyOf": [
{
"type": "string",
"enum": [
"xlsx"
]
},
{
"type": "string",
"enum": [
"csv"
]
},
{
"type": "string",
"enum": [
"txt"
]
}
]
},
"include_secrets": {
"type": "boolean"
}
},
"additionalProperties": false
}
}
}
},
"x-required-scopes": [
"profiles:read"
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"file_name",
"mime",
"count",
"content_base64"
],
"properties": {
"file_name": {
"type": "string"
},
"mime": {
"type": "string"
},
"count": {
"type": "integer"
},
"content_base64": {
"type": "string"
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}