Get secret credentials
Endpoints
Get Secret Credentials
Syteca ACB REST API endpoint to retrieve a secret’s actual credentials — login, password, and (for SSH secrets) the SSH private key. The most frequently called ACB endpoint.
GET
Get secret credentials
Retrieves a secret’s actual credentials — login, password, and (for SSH-type secrets) the SSH private key. The canonical endpoint that automation consumers call to retrieve credentials at deployment time, runtime, or scheduled-task execution. The most frequently called ACB endpoint.
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 at least PAM User role on the secret.Check-out and approval interactions
- If the secret is configured with check-out enabled, this call checks the secret out — and the next caller is blocked until check-in.
- If the secret requires approval, the call returns 403 until an approver grants access.
Response shape varies by SecretType
The response includes only the fields relevant to the secret’stype — domain for ADAccount, server for Unix/MSSQL, computer_name for WindowsAccount, url for WebAccount, ssh_key for UnixAccountSSH with key auth, etc.
Rate limit
60 requests per minute per Access Token. This is intentionally higher than other endpoints — credential retrieval is the highest-volume API operation.Errors
See Status codes. Common errors:- 403 Forbidden — user lacks PAM User role, OR the secret requires approval and hasn’t been approved.
- 404 Not Found — secret doesn’t exist.
- 409 Conflict — secret is currently checked out by another user (when check-out is enabled).
Related
Get secret
Read metadata without retrieving credentials.
Get secret details (old)
Pre-v1.3 equivalent.
Rotate password
Trigger rotation after retrieval if policy requires.
Force check-in
Release a checked-out secret.
Authorizations
Access token for authentication
Path Parameters
The ID of the secret to retrieve credentials for
Required range:
x >= 1Response
Secret credentials retrieved successfully
Unique identifier of the secret
Name of the secret
Type of secret
Available options:
None, UnixAccountSSH, UnixAccountTelnet, WindowsAccount, ADAccount, WebAccount, MSSQLAccount Login username
Description of the secret
The password value
Domain for AD accounts
Computer name for Windows/Unix accounts
URL for web accounts
Server for database accounts