Skip to content

Create org settings backup.

POST
/backend/v1/admin/export

Exports all configuration data for the organization to be used for backup or migration purposes.

Authorizations

HTTPBearer
TypeHTTP (bearer)

Responses

Successful Response
application/json
JSON
{
"export": {
"settings": {
"files": [
{
"content": "string",
"id": "string",
"name": "string"
}
],
"packages": [
{
"availability": {
"global": false,
"projectIds": [
[
]
]
},
"availableUpdate": "string",
"direction": "string",
"id": "string",
"name": "string",
"projectId": "string",
"scannerCounts": {
"additionalProperties": 0
},
"scannerIds": [
"string"
],
"shared": false,
"source": {
"type": "internal"
},
"vendored": false
}
],
"projects": [
{
"addedPackagesIds": [
"string"
],
"addedProviderIds": [
"string"
],
"addedScannerIds": [
"string"
],
"project": {
"adminCount": 0,
"adminRoleId": "string",
"botType": "string",
"chatbotId": "string",
"config": {
"packages": [
{
"blocking": "string",
"enabled": "string",
"flagMessage": "string",
"force": "string",
"id": "string",
"mode": "string",
"version": "string"
}
],
"providerRouting": "string",
"providers": [
{
"default": "string",
"enabled": true,
"id": "string",
"name": "string",
"type": "string"
}
],
"scanners": [
{
"blocking": "string",
"enabled": "string",
"flagMessage": "string",
"force": "string",
"id": "string",
"mode": "string",
"version": "string"
}
]
},
"createdAt": "string",
"createdBy": "string",
"friendlyId": "string",
"id": "string",
"memberCount": 0,
"memberRoleId": "string",
"name": "string",
"type": "bot",
"updatedAt": "string"
},
"roles": [
{
"id": "string",
"memberCount": 0,
"name": "string",
"permissions": [
[
]
],
"projectId": "string",
"system": true
}
]
}
],
"providers": [
{
"availability": {
"global": false,
"projectIds": [
[
]
]
},
"hasLogo": false,
"id": "string",
"inputs": {
},
"maxRequestsPerSecond": "string",
"name": "string",
"projectId": "string",
"redTeam": false,
"requestConcurrencyLimit": "string",
"secrets": {
"additionalProperties": "string"
},
"siem": false,
"systemProviderId": "string",
"tag": "string",
"template": {
"awsAuth": "string",
"body": "string",
"headers": {
},
"json": "string",
"method": "string",
"outputs": {
},
"queryParams": {
"additionalProperties": "string"
},
"timeout": 20,
"type": "request",
"url": "string"
},
"type": "string"
}
],
"roles": [
{
"id": "string",
"memberCount": 0,
"name": "string",
"permissions": [
[
]
],
"projectId": "string",
"system": true
}
],
"scanners": [
],
"secrets": [
{
"deletedAt": "string",
"id": "string",
"name": "string",
"value": "string",
"vendored": false
}
]
},
"version": 0
}
}

Playground

Authorization

Samples

Powered by VitePress OpenAPI

Updated at: