Add Secret

Add new secret

curl --request POST \
  --url https://your-syteca-host/SytecaACB/api/secrets \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "login": "<string>",
  "description": "<string>",
  "password": "<string>",
  "parent_folder_id": 1,
  "parent_folder_name": "<string>",
  "domain": "<string>",
  "computer_name": "<string>",
  "url": "<string>",
  "server": "<string>",
  "computers": [
    "<string>"
  ],
  "record_activities": true,
  "permissions": {
    "inherit_users_and_roles": false,
    "inherit_features": false,
    "users": [
      {
        "name": "<string>",
        "features": []
      }
    ],
    "user_groups": [
      {
        "name": "<string>",
        "features": []
      }
    ]
  }
}
'

import requests

url = "https://your-syteca-host/SytecaACB/api/secrets"

payload = {
    "name": "<string>",
    "login": "<string>",
    "description": "<string>",
    "password": "<string>",
    "parent_folder_id": 1,
    "parent_folder_name": "<string>",
    "domain": "<string>",
    "computer_name": "<string>",
    "url": "<string>",
    "server": "<string>",
    "computers": ["<string>"],
    "record_activities": True,
    "permissions": {
        "inherit_users_and_roles": False,
        "inherit_features": False,
        "users": [
            {
                "name": "<string>",
                "features": []
            }
        ],
        "user_groups": [
            {
                "name": "<string>",
                "features": []
            }
        ]
    }
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    login: '<string>',
    description: '<string>',
    password: '<string>',
    parent_folder_id: 1,
    parent_folder_name: '<string>',
    domain: '<string>',
    computer_name: '<string>',
    url: '<string>',
    server: '<string>',
    computers: ['<string>'],
    record_activities: true,
    permissions: {
      inherit_users_and_roles: false,
      inherit_features: false,
      users: [{name: '<string>', features: []}],
      user_groups: [{name: '<string>', features: []}]
    }
  })
};

fetch('https://your-syteca-host/SytecaACB/api/secrets', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://your-syteca-host/SytecaACB/api/secrets",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'login' => '<string>',
    'description' => '<string>',
    'password' => '<string>',
    'parent_folder_id' => 1,
    'parent_folder_name' => '<string>',
    'domain' => '<string>',
    'computer_name' => '<string>',
    'url' => '<string>',
    'server' => '<string>',
    'computers' => [
        '<string>'
    ],
    'record_activities' => true,
    'permissions' => [
        'inherit_users_and_roles' => false,
        'inherit_features' => false,
        'users' => [
                [
                                'name' => '<string>',
                                'features' => [
                                                                
                                ]
                ]
        ],
        'user_groups' => [
                [
                                'name' => '<string>',
                                'features' => [
                                                                
                                ]
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://your-syteca-host/SytecaACB/api/secrets"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"login\": \"<string>\",\n  \"description\": \"<string>\",\n  \"password\": \"<string>\",\n  \"parent_folder_id\": 1,\n  \"parent_folder_name\": \"<string>\",\n  \"domain\": \"<string>\",\n  \"computer_name\": \"<string>\",\n  \"url\": \"<string>\",\n  \"server\": \"<string>\",\n  \"computers\": [\n    \"<string>\"\n  ],\n  \"record_activities\": true,\n  \"permissions\": {\n    \"inherit_users_and_roles\": false,\n    \"inherit_features\": false,\n    \"users\": [\n      {\n        \"name\": \"<string>\",\n        \"features\": []\n      }\n    ],\n    \"user_groups\": [\n      {\n        \"name\": \"<string>\",\n        \"features\": []\n      }\n    ]\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://your-syteca-host/SytecaACB/api/secrets")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"login\": \"<string>\",\n  \"description\": \"<string>\",\n  \"password\": \"<string>\",\n  \"parent_folder_id\": 1,\n  \"parent_folder_name\": \"<string>\",\n  \"domain\": \"<string>\",\n  \"computer_name\": \"<string>\",\n  \"url\": \"<string>\",\n  \"server\": \"<string>\",\n  \"computers\": [\n    \"<string>\"\n  ],\n  \"record_activities\": true,\n  \"permissions\": {\n    \"inherit_users_and_roles\": false,\n    \"inherit_features\": false,\n    \"users\": [\n      {\n        \"name\": \"<string>\",\n        \"features\": []\n      }\n    ],\n    \"user_groups\": [\n      {\n        \"name\": \"<string>\",\n        \"features\": []\n      }\n    ]\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://your-syteca-host/SytecaACB/api/secrets")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"login\": \"<string>\",\n  \"description\": \"<string>\",\n  \"password\": \"<string>\",\n  \"parent_folder_id\": 1,\n  \"parent_folder_name\": \"<string>\",\n  \"domain\": \"<string>\",\n  \"computer_name\": \"<string>\",\n  \"url\": \"<string>\",\n  \"server\": \"<string>\",\n  \"computers\": [\n    \"<string>\"\n  ],\n  \"record_activities\": true,\n  \"permissions\": {\n    \"inherit_users_and_roles\": false,\n    \"inherit_features\": false,\n    \"users\": [\n      {\n        \"name\": \"<string>\",\n        \"features\": []\n      }\n    ],\n    \"user_groups\": [\n      {\n        \"name\": \"<string>\",\n        \"features\": []\n      }\n    ]\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "id": 123,
  "name": "<string>",
  "login": "<string>",
  "description": "<string>",
  "parent_folder_id": 123,
  "domain": "<string>",
  "computer_name": "<string>",
  "url": "<string>",
  "server": "<string>",
  "computers": [
    "<string>"
  ],
  "file_transfer": {
    "port": 22
  },
  "rotation": {
    "enabled": true,
    "rotate_every_min": 2
  },
  "record_activities": true,
  "check_out": {
    "enabled": true,
    "rotate_on_checkin": true,
    "auto_checkin_after_min": 60
  },
  "require_approval": {
    "approver_users": [
      "<string>"
    ],
    "approver_user_groups": [
      "<string>"
    ],
    "require_owners_and_approvers": false,
    "working_dates": {
      "from": "2023-11-07T05:31:56Z",
      "to": "2023-11-07T05:31:56Z"
    },
    "working_hours": {
      "from": "<string>",
      "to": "<string>"
    },
    "working_days": []
  },
  "permissions": {
    "inherit_users_and_roles": false,
    "inherit_features": false,
    "users": [
      {
        "name": "<string>",
        "features": []
      }
    ],
    "user_groups": [
      {
        "name": "<string>",
        "features": []
      }
    ]
  },
  "check_password": {
    "enabled": false,
    "check_every": 30
  },
  "last_password_check_utc": "2023-11-07T05:31:56Z",
  "last_password_rotation_utc": "2023-11-07T05:31:56Z"
}

{
  "status": 123,
  "message": "<string>"
}

{
  "status": 123,
  "message": "<string>"
}

POST

api

secrets

Add new secret

curl --request POST \
  --url https://your-syteca-host/SytecaACB/api/secrets \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "login": "<string>",
  "description": "<string>",
  "password": "<string>",
  "parent_folder_id": 1,
  "parent_folder_name": "<string>",
  "domain": "<string>",
  "computer_name": "<string>",
  "url": "<string>",
  "server": "<string>",
  "computers": [
    "<string>"
  ],
  "record_activities": true,
  "permissions": {
    "inherit_users_and_roles": false,
    "inherit_features": false,
    "users": [
      {
        "name": "<string>",
        "features": []
      }
    ],
    "user_groups": [
      {
        "name": "<string>",
        "features": []
      }
    ]
  }
}
'

import requests

url = "https://your-syteca-host/SytecaACB/api/secrets"

payload = {
    "name": "<string>",
    "login": "<string>",
    "description": "<string>",
    "password": "<string>",
    "parent_folder_id": 1,
    "parent_folder_name": "<string>",
    "domain": "<string>",
    "computer_name": "<string>",
    "url": "<string>",
    "server": "<string>",
    "computers": ["<string>"],
    "record_activities": True,
    "permissions": {
        "inherit_users_and_roles": False,
        "inherit_features": False,
        "users": [
            {
                "name": "<string>",
                "features": []
            }
        ],
        "user_groups": [
            {
                "name": "<string>",
                "features": []
            }
        ]
    }
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    login: '<string>',
    description: '<string>',
    password: '<string>',
    parent_folder_id: 1,
    parent_folder_name: '<string>',
    domain: '<string>',
    computer_name: '<string>',
    url: '<string>',
    server: '<string>',
    computers: ['<string>'],
    record_activities: true,
    permissions: {
      inherit_users_and_roles: false,
      inherit_features: false,
      users: [{name: '<string>', features: []}],
      user_groups: [{name: '<string>', features: []}]
    }
  })
};

fetch('https://your-syteca-host/SytecaACB/api/secrets', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://your-syteca-host/SytecaACB/api/secrets",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'login' => '<string>',
    'description' => '<string>',
    'password' => '<string>',
    'parent_folder_id' => 1,
    'parent_folder_name' => '<string>',
    'domain' => '<string>',
    'computer_name' => '<string>',
    'url' => '<string>',
    'server' => '<string>',
    'computers' => [
        '<string>'
    ],
    'record_activities' => true,
    'permissions' => [
        'inherit_users_and_roles' => false,
        'inherit_features' => false,
        'users' => [
                [
                                'name' => '<string>',
                                'features' => [
                                                                
                                ]
                ]
        ],
        'user_groups' => [
                [
                                'name' => '<string>',
                                'features' => [
                                                                
                                ]
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://your-syteca-host/SytecaACB/api/secrets"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"login\": \"<string>\",\n  \"description\": \"<string>\",\n  \"password\": \"<string>\",\n  \"parent_folder_id\": 1,\n  \"parent_folder_name\": \"<string>\",\n  \"domain\": \"<string>\",\n  \"computer_name\": \"<string>\",\n  \"url\": \"<string>\",\n  \"server\": \"<string>\",\n  \"computers\": [\n    \"<string>\"\n  ],\n  \"record_activities\": true,\n  \"permissions\": {\n    \"inherit_users_and_roles\": false,\n    \"inherit_features\": false,\n    \"users\": [\n      {\n        \"name\": \"<string>\",\n        \"features\": []\n      }\n    ],\n    \"user_groups\": [\n      {\n        \"name\": \"<string>\",\n        \"features\": []\n      }\n    ]\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://your-syteca-host/SytecaACB/api/secrets")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"login\": \"<string>\",\n  \"description\": \"<string>\",\n  \"password\": \"<string>\",\n  \"parent_folder_id\": 1,\n  \"parent_folder_name\": \"<string>\",\n  \"domain\": \"<string>\",\n  \"computer_name\": \"<string>\",\n  \"url\": \"<string>\",\n  \"server\": \"<string>\",\n  \"computers\": [\n    \"<string>\"\n  ],\n  \"record_activities\": true,\n  \"permissions\": {\n    \"inherit_users_and_roles\": false,\n    \"inherit_features\": false,\n    \"users\": [\n      {\n        \"name\": \"<string>\",\n        \"features\": []\n      }\n    ],\n    \"user_groups\": [\n      {\n        \"name\": \"<string>\",\n        \"features\": []\n      }\n    ]\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://your-syteca-host/SytecaACB/api/secrets")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"login\": \"<string>\",\n  \"description\": \"<string>\",\n  \"password\": \"<string>\",\n  \"parent_folder_id\": 1,\n  \"parent_folder_name\": \"<string>\",\n  \"domain\": \"<string>\",\n  \"computer_name\": \"<string>\",\n  \"url\": \"<string>\",\n  \"server\": \"<string>\",\n  \"computers\": [\n    \"<string>\"\n  ],\n  \"record_activities\": true,\n  \"permissions\": {\n    \"inherit_users_and_roles\": false,\n    \"inherit_features\": false,\n    \"users\": [\n      {\n        \"name\": \"<string>\",\n        \"features\": []\n      }\n    ],\n    \"user_groups\": [\n      {\n        \"name\": \"<string>\",\n        \"features\": []\n      }\n    ]\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "id": 123,
  "name": "<string>",
  "login": "<string>",
  "description": "<string>",
  "parent_folder_id": 123,
  "domain": "<string>",
  "computer_name": "<string>",
  "url": "<string>",
  "server": "<string>",
  "computers": [
    "<string>"
  ],
  "file_transfer": {
    "port": 22
  },
  "rotation": {
    "enabled": true,
    "rotate_every_min": 2
  },
  "record_activities": true,
  "check_out": {
    "enabled": true,
    "rotate_on_checkin": true,
    "auto_checkin_after_min": 60
  },
  "require_approval": {
    "approver_users": [
      "<string>"
    ],
    "approver_user_groups": [
      "<string>"
    ],
    "require_owners_and_approvers": false,
    "working_dates": {
      "from": "2023-11-07T05:31:56Z",
      "to": "2023-11-07T05:31:56Z"
    },
    "working_hours": {
      "from": "<string>",
      "to": "<string>"
    },
    "working_days": []
  },
  "permissions": {
    "inherit_users_and_roles": false,
    "inherit_features": false,
    "users": [
      {
        "name": "<string>",
        "features": []
      }
    ],
    "user_groups": [
      {
        "name": "<string>",
        "features": []
      }
    ]
  },
  "check_password": {
    "enabled": false,
    "check_every": 30
  },
  "last_password_check_utc": "2023-11-07T05:31:56Z",
  "last_password_rotation_utc": "2023-11-07T05:31:56Z"
}

{
  "status": 123,
  "message": "<string>"
}

{
  "status": 123,
  "message": "<string>"
}

Creates a new secret. The required and ignored fields depend on the secret’s type — see Required vs ignored fields by SecretType for the per-type matrix.

For ACB deployments updated from a version prior to 1.2, switch to the https://{hostname}/EkranACB server in the Playground.

Permissions required

The user owning the Access Token must have Editor or Owner role on the target parent folder.

Secret type → required target field

`type`	Required target field
`ADAccount`	`domain`
`WindowsAccount`	`computer_name`
`UnixAccountSSH`, `UnixAccountTelnet`, `MSSQLAccount`	`server`
`WebAccount`	`url`

All types require login. For UnixAccountSSH, the credentials can be either a password (password field) or an SSH key (ssh_key field).

v1.4 changes

rotation.rotate_every_min is now required with minimum 1. To disable rotation, set rotation: { enabled: false, rotate_every_min: 1 }.
New check_password field for configuring heartbeat checks — see CheckPassword.

Errors

See Status codes. Common errors:

400 Bad Request — missing required field for the secret type, or invalid configuration object.
403 Forbidden — user lacks Editor/Owner role on the parent folder.
409 Conflict — secret name already exists in the parent folder.

Data models — fields by SecretType

Per-type field matrix.

Update secret

Modify after creation.

Bulk add

Create many secrets in one call.

Add folder

Organize secrets in folders.

Authorizations

Authorization

string

header

required

Access token for authentication

Body

application/json

name

string

required

Name of the secret

Maximum string length: 512

type

enum<string>

required

Type of secret

Available options:

None,

UnixAccountSSH,

UnixAccountTelnet,

WindowsAccount,

ADAccount,

WebAccount,

MSSQLAccount

Maximum string length: 512

description

string

Description of the secret

Maximum string length: 2000

password

string

The password value

ssh_key

object

Show child attributes

parent_folder_id

integer<int32>

ID of the parent folder

Required range: x >= 0

parent_folder_name

string

Name of the parent folder

Maximum string length: 512

domain

string

Domain for AD accounts

Maximum string length: 512

computer_name

string

Computer name for Windows/Unix accounts

Maximum string length: 512

url

string<uri>

URL for web accounts

Maximum string length: 2000

server

string

Server for database accounts

Maximum string length: 512

computers

string[]

List of computers

file_transfer

object

Show child attributes

rotation

object

Show child attributes

record_activities

boolean

Whether to record activities for this secret

check_out

object

Show child attributes

require_approval

object

Show child attributes

permissions

object

Show child attributes

check_password

object

Show child attributes

Response

Secret created successfully

integer<int32>

required

Unique identifier of the secret

name

string

required

Name of the secret

type

enum<string>

required

Type of secret

Available options:

None,

UnixAccountSSH,

UnixAccountTelnet,

WindowsAccount,

ADAccount,

WebAccount,

MSSQLAccount

description

string

Description of the secret

parent_folder_id

integer<int32>

ID of the parent folder

domain

string

Domain for AD accounts

computer_name

string

Computer name for Windows/Unix accounts

url

string

URL for web accounts

server

string

Server for database accounts

computers

string[]

List of computers

file_transfer

object

Show child attributes

rotation

object

Show child attributes

record_activities

boolean

Whether to record activities for this secret

check_out

object

Show child attributes

require_approval

object

Show child attributes

permissions

object

Show child attributes

check_password

object

Show child attributes

check_password_status

enum<string>

Status of the last password check (heartbeat)

Available options:

None,

Valid,

Invalid,

Failed

last_password_check_utc

string<date-time> | null

UTC timestamp of the last password check

password_rotation_status

enum<string>

Status of password rotation

Available options:

Disabled,

Enabled,

Failed

last_password_rotation_utc

string<date-time> | null

UTC timestamp of the last password rotation

Overview

Application Credentials Broker

Data Connector API

SSO & LDAP

SIEM & Ticketing systems

Permissions required

Secret type → required target field

v1.4 changes

Errors

Data models — fields by SecretType

Update secret

Bulk add

Add folder

Authorizations

Body

Response

​Permissions required

​Secret type → required target field

​v1.4 changes

​Errors

​Related

Data models — fields by SecretType

Update secret

Bulk add

Add folder

Authorizations

Body

Response

Permissions required

Secret type → required target field

v1.4 changes

Errors

Related