Skip to content

Import org settings.

POST
/backend/v1/admin/import

Restores organization configuration from a previously created backup.

Authorizations

HTTPBearer
Type
HTTP (bearer)

Request Body

application/json
JSON
{
  
"clearExisting": false,
  
"export": {
  
  
"settings": {
  
  
  
"packages": [
  
  
  
  
{
  
  
  
  
  
"availability": {
  
  
  
  
  
  
"global": false,
  
  
  
  
  
  
"projectIds": [
  
  
  
  
  
  
  
[
  
  
  
  
  
  
  
]
  
  
  
  
  
  
]
  
  
  
  
  
},
  
  
  
  
  
"direction": "string",
  
  
  
  
  
"id": "string",
  
  
  
  
  
"name": "string",
  
  
  
  
  
"projectId": "string",
  
  
  
  
  
"scannerCounts": {
  
  
  
  
  
  
"additionalProperties": 0
  
  
  
  
  
},
  
  
  
  
  
"scannerIds": [
  
  
  
  
  
  
"string"
  
  
  
  
  
],
  
  
  
  
  
"source": {
  
  
  
  
  
  
"type": "internal"
  
  
  
  
  
},
  
  
  
  
  
"vendored": true
  
  
  
  
}
  
  
  
],
  
  
  
"projects": [
  
  
  
  
{
  
  
  
  
  
"addedPackagesIds": [
  
  
  
  
  
  
"string"
  
  
  
  
  
],
  
  
  
  
  
"addedProviderIds": [
  
  
  
  
  
  
"string"
  
  
  
  
  
],
  
  
  
  
  
"addedScannerIds": [
  
  
  
  
  
  
"string"
  
  
  
  
  
],
  
  
  
  
  
"project": {
  
  
  
  
  
  
"adminCount": 0,
  
  
  
  
  
  
"adminRoleId": "string",
  
  
  
  
  
  
"agentSessionCount": 0,
  
  
  
  
  
  
"botType": "string",
  
  
  
  
  
  
"chatbotId": "string",
  
  
  
  
  
  
"config": {
  
  
  
  
  
  
  
"packages": [
  
  
  
  
  
  
  
  
{
  
  
  
  
  
  
  
  
  
"blocking": true,
  
  
  
  
  
  
  
  
  
"enabled": true,
  
  
  
  
  
  
  
  
  
"flagMessage": "string",
  
  
  
  
  
  
  
  
  
"force": true,
  
  
  
  
  
  
  
  
  
"id": "string",
  
  
  
  
  
  
  
  
  
"mode": "string",
  
  
  
  
  
  
  
  
  
"version": "string"
  
  
  
  
  
  
  
  
}
  
  
  
  
  
  
  
],
  
  
  
  
  
  
  
"providers": [
  
  
  
  
  
  
  
  
{
  
  
  
  
  
  
  
  
  
"capabilities": [
  
  
  
  
  
  
  
  
  
  
"string"
  
  
  
  
  
  
  
  
  
],
  
  
  
  
  
  
  
  
  
"default": true,
  
  
  
  
  
  
  
  
  
"enabled": true,
  
  
  
  
  
  
  
  
  
"id": "string",
  
  
  
  
  
  
  
  
  
"name": "string",
  
  
  
  
  
  
  
  
  
"type": "string"
  
  
  
  
  
  
  
  
}
  
  
  
  
  
  
  
],
  
  
  
  
  
  
  
"scanners": [
  
  
  
  
  
  
  
  
{
  
  
  
  
  
  
  
  
  
"blocking": true,
  
  
  
  
  
  
  
  
  
"enabled": true,
  
  
  
  
  
  
  
  
  
"flagMessage": "string",
  
  
  
  
  
  
  
  
  
"force": true,
  
  
  
  
  
  
  
  
  
"id": "string",
  
  
  
  
  
  
  
  
  
"mode": "string",
  
  
  
  
  
  
  
  
  
"version": "string"
  
  
  
  
  
  
  
  
}
  
  
  
  
  
  
  
]
  
  
  
  
  
  
},
  
  
  
  
  
  
"createdAt": "string",
  
  
  
  
  
  
"createdBy": "string",
  
  
  
  
  
  
"deploymentStatus": "draft",
  
  
  
  
  
  
"friendlyId": "string",
  
  
  
  
  
  
"id": "string",
  
  
  
  
  
  
"memberCount": 0,
  
  
  
  
  
  
"memberRoleId": "string",
  
  
  
  
  
  
"name": "string",
  
  
  
  
  
  
"providerCount": 0,
  
  
  
  
  
  
"scannerCount": 0,
  
  
  
  
  
  
"tokenCount": 0,
  
  
  
  
  
  
"type": "string",
  
  
  
  
  
  
"updatedAt": "string"
  
  
  
  
  
},
  
  
  
  
  
"roles": [
  
  
  
  
  
  
{
  
  
  
  
  
  
  
"id": "string",
  
  
  
  
  
  
  
"isDefault": false,
  
  
  
  
  
  
  
"memberCount": 0,
  
  
  
  
  
  
  
"name": "string",
  
  
  
  
  
  
  
"permissions": [
  
  
  
  
  
  
  
  
[
  
  
  
  
  
  
  
  
]
  
  
  
  
  
  
  
],
  
  
  
  
  
  
  
"projectId": "string",
  
  
  
  
  
  
  
"system": true
  
  
  
  
  
  
}
  
  
  
  
  
]
  
  
  
  
}
  
  
  
],
  
  
  
"providers": [
  
  
  
  
{
  
  
  
  
  
"authTemplate": null,
  
  
  
  
  
"availability": {
  
  
  
  
  
  
"global": false,
  
  
  
  
  
  
"projectIds": [
  
  
  
  
  
  
  
[
  
  
  
  
  
  
  
]
  
  
  
  
  
  
]
  
  
  
  
  
},
  
  
  
  
  
"capabilities": [
  
  
  
  
  
  
"string"
  
  
  
  
  
],
  
  
  
  
  
"hasLogo": false,
  
  
  
  
  
"id": "string",
  
  
  
  
  
"inputs": {
  
  
  
  
  
  
"additionalProperties": "string"
  
  
  
  
  
},
  
  
  
  
  
"maxRequestsPerSecond": 0,
  
  
  
  
  
"name": "string",
  
  
  
  
  
"projectId": "string",
  
  
  
  
  
"redTeam": false,
  
  
  
  
  
"requestConcurrencyLimit": {
  
  
  
  
  
  
"decayPerSecond": 0,
  
  
  
  
  
  
"requests": 0
  
  
  
  
  
},
  
  
  
  
  
"secrets": {
  
  
  
  
  
  
"additionalProperties": "string"
  
  
  
  
  
},
  
  
  
  
  
"siem": false,
  
  
  
  
  
"systemProviderId": "string",
  
  
  
  
  
"tag": "string",
  
  
  
  
  
"template": {
  
  
  
  
  
  
"awsAuth": {
  
  
  
  
  
  
  
"accessKey": "string",
  
  
  
  
  
  
  
"region": "string",
  
  
  
  
  
  
  
"secretKey": "string",
  
  
  
  
  
  
  
"service": "string",
  
  
  
  
  
  
  
"token": "string"
  
  
  
  
  
  
},
  
  
  
  
  
  
"body": "string",
  
  
  
  
  
  
"headers": {
  
  
  
  
  
  
  
"additionalProperties": "string"
  
  
  
  
  
  
},
  
  
  
  
  
  
"json": "string",
  
  
  
  
  
  
"method": "string",
  
  
  
  
  
  
"ociAuth": {
  
  
  
  
  
  
  
"keyId": "string",
  
  
  
  
  
  
  
"passphrase": "string",
  
  
  
  
  
  
  
"privateKeyPem": "string"
  
  
  
  
  
  
},
  
  
  
  
  
  
"outputs": {
  
  
  
  
  
  
},
  
  
  
  
  
  
"queryParams": {
  
  
  
  
  
  
  
"additionalProperties": "string"
  
  
  
  
  
  
},
  
  
  
  
  
  
"timeout": 20,
  
  
  
  
  
  
"type": "request",
  
  
  
  
  
  
"url": "string"
  
  
  
  
  
},
  
  
  
  
  
"type": "string"
  
  
  
  
}
  
  
  
],
  
  
  
"roles": [
  
  
  
  
{
  
  
  
  
  
"id": "string",
  
  
  
  
  
"isDefault": false,
  
  
  
  
  
"memberCount": 0,
  
  
  
  
  
"name": "string",
  
  
  
  
  
"permissions": [
  
  
  
  
  
  
[
  
  
  
  
  
  
]
  
  
  
  
  
],
  
  
  
  
  
"projectId": "string",
  
  
  
  
  
"system": true
  
  
  
  
}
  
  
  
],
  
  
  
"scanners": [
  
  
  
  
{
  
  
  
  
  
"availability": {
  
  
  
  
  
  
"global": false,
  
  
  
  
  
  
"projectIds": [
  
  
  
  
  
  
  
[
  
  
  
  
  
  
  
]
  
  
  
  
  
  
]
  
  
  
  
  
},
  
  
  
  
  
"config": {
  
  
  
  
  
  
"pattern": "string",
  
  
  
  
  
  
"type": "regex"
  
  
  
  
  
},
  
  
  
  
  
"direction": "request",
  
  
  
  
  
"id": "string",
  
  
  
  
  
"name": "string",
  
  
  
  
  
"packageId": "string",
  
  
  
  
  
"projectId": "string",
  
  
  
  
  
"scannerTemplateId": "string",
  
  
  
  
  
"source": {
  
  
  
  
  
  
"type": "internal"
  
  
  
  
  
},
  
  
  
  
  
"tags": [
  
  
  
  
  
  
[
  
  
  
  
  
  
]
  
  
  
  
  
],
  
  
  
  
  
"vendored": true,
  
  
  
  
  
"versionMeta": {
  
  
  
  
  
  
"description": "string",
  
  
  
  
  
  
"name": "string",
  
  
  
  
  
  
"published": true,
  
  
  
  
  
  
"push": false
  
  
  
  
  
}
  
  
  
  
}
  
  
  
],
  
  
  
"secrets": [
  
  
  
  
{
  
  
  
  
  
"deletedAt": "string",
  
  
  
  
  
"id": "string",
  
  
  
  
  
"name": "string",
  
  
  
  
  
"value": "string"
  
  
  
  
}
  
  
  
]
  
  
},
  
  
"version": 0
  
},
  
"preserveRoles": false,
  
"preserveTokens": false
}

Responses

Successful Response

application/json
JSON
{
  
"message": "string"
}

Playground

Server
Authorization
Body

Samples

Powered by VitePress OpenAPI

Updated at: