{ "opencollection": "1.0.0", "info": { "name": "Secret Manager Secrets Manager API", "version": "v1" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Secrets Manager", "type": "folder" }, "items": [ { "info": { "name": "Rotate vault encryption key", "type": "http" }, "http": { "method": "POST", "url": "https://{tenantURL}/api/v1/secretmanager/keys/rotate" }, "docs": "This operation will rotate key for tenant." }, { "info": { "name": "Get a list of password policies", "type": "http" }, "http": { "method": "GET", "url": "https://{tenantURL}/api/v1/secretmanager/pwdpolicies", "params": [ { "name": "filter", "value": "name%20eq%pwdPolicy", "type": "query", "description": "Filter query" }, { "name": "pageToken", "value": "18CE4C10585F4525BE35801AC7F7EBA4C3", "type": "query", "description": "Page token" } ] }, "docs": "Get a list of password policies" }, { "info": { "name": "Create password policy for alphanumeric password", "type": "http" }, "http": { "method": "POST", "url": "https://{tenantURL}/api/v1/secretmanager/pwdpolicies", "params": [ { "name": "action", "value": "validatePasswordOrPin", "type": "query", "description": "Action" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create password policy for alphanumeric password" }, { "info": { "name": "Get specified password policy's details", "type": "http" }, "http": { "method": "GET", "url": "https://{tenantURL}/api/v1/secretmanager/pwdpolicies/:id", "params": [ { "name": "id", "value": "a6ed82f6-32b5-46d8-a3a3-c36cc574abd9", "type": "path", "description": "Id of password policy" }, { "name": "action", "value": "generatePasswordOrPin", "type": "query", "description": "Action" } ] }, "docs": "Get specified password policy's details" }, { "info": { "name": "Update password policy details", "type": "http" }, "http": { "method": "PATCH", "url": "https://{tenantURL}/api/v1/secretmanager/pwdpolicies/:id", "params": [ { "name": "id", "value": "a6ed82f6-32b5-46d8-a3a3-c36cc574abd9", "type": "path", "description": "Id of password policy" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update password policy details" }, { "info": { "name": "Delete a specified password policy", "type": "http" }, "http": { "method": "DELETE", "url": "https://{tenantURL}/api/v1/secretmanager/pwdpolicies/:id", "params": [ { "name": "id", "value": "a6ed82f6-32b5-46d8-a3a3-c36cc574abd9", "type": "path", "description": "Id of password policy" } ] }, "docs": "Delete a specified password policy" }, { "info": { "name": "Get IDs of all container resources", "type": "http" }, "http": { "method": "GET", "url": "https://{tenantURL}/api/v1/secretmanager/resourceContainers", "params": [ { "name": "path", "value": "/machine/DB", "type": "query", "description": "Secret path" } ] }, "docs": "Get IDs of all container resources" }, { "info": { "name": "Get static secret template", "type": "http" }, "http": { "method": "GET", "url": "https://{tenantURL}/api/v1/secretmanager/secret-templates/static", "params": [ { "name": "filter", "value": "name%20eq%20secretType", "type": "query", "description": "Filter query" }, { "name": "pageToken", "value": "18CE4C10585F4525BE35801AC7F7EBA4C3", "type": "query", "description": "Page token" } ] }, "docs": "Get static secret template" }, { "info": { "name": "Create StaticSecretTemplate for static secret", "type": "http" }, "http": { "method": "POST", "url": "https://{tenantURL}/api/v1/secretmanager/secret-templates/static", "body": { "type": "json", "data": "{}" } }, "docs": "Create StaticSecretTemplate for static secret" }, { "info": { "name": "Get a specified static secret template", "type": "http" }, "http": { "method": "GET", "url": "https://{tenantURL}/api/v1/secretmanager/secret-templates/static/:id", "params": [ { "name": "id", "value": "a6ed82f6-32b5-46d8-a3a3-c36cc574abd9", "type": "path", "description": "Id of static secret template" } ] }, "docs": "Get a specified static secret template" }, { "info": { "name": "Update static secret template parameteres", "type": "http" }, "http": { "method": "PATCH", "url": "https://{tenantURL}/api/v1/secretmanager/secret-templates/static/:id", "params": [ { "name": "id", "value": "a6ed82f6-32b5-46d8-a3a3-c36cc574abd9", "type": "path", "description": "Id of static secret template" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update static secret template parameteres" }, { "info": { "name": "Delete static secret template", "type": "http" }, "http": { "method": "DELETE", "url": "https://{tenantURL}/api/v1/secretmanager/secret-templates/static/:id", "params": [ { "name": "id", "value": "a6ed82f6-32b5-46d8-a3a3-c36cc574abd9", "type": "path", "description": "Id of static secret template" } ] }, "docs": "Delete static secret template" }, { "info": { "name": "Get details of current active vault", "type": "http" }, "http": { "method": "GET", "url": "https://{tenantURL}/api/v1/secretmanager/vault", "params": [ { "name": "searchName", "value": "", "type": "query" }, { "name": "getmetadata", "value": "true", "type": "query", "description": "true/false" } ] }, "docs": "Get details of current active vault" }, { "info": { "name": "Create a vault for the Secrets Manager", "type": "http" }, "http": { "method": "POST", "url": "https://{tenantURL}/api/v1/secretmanager/vault", "body": { "type": "json", "data": "{}" } }, "docs": "This operation should be called only by administrator and only once per tenant." }, { "info": { "name": "Get secret in vault hierarchy", "type": "http" }, "http": { "method": "GET", "url": "https://{tenantURL}/api/v1/secretmanager/vault/secrets", "params": [ { "name": "path", "value": "/machine/DB", "type": "query", "description": "Secret path" } ] }, "docs": "Get secret in vault hierarchy" }, { "info": { "name": "Get a specified secret details", "type": "http" }, "http": { "method": "GET", "url": "https://{tenantURL}/api/v1/secretmanager/vault/secrets/:id", "params": [ { "name": "id", "value": "a6ed82f6-32b5-46d8-a3a3-c36cc574abd9", "type": "path", "description": "resource Id" } ] }, "docs": "Get a specified secret details" }, { "info": { "name": "Get vault details", "type": "http" }, "http": { "method": "GET", "url": "https://{tenantURL}/api/v1/secretmanager/vault/:id", "params": [ { "name": "id", "value": "a6ed82f6-32b5-46d8-a3a3-c36cc574abd9", "type": "path", "description": "vault Id" } ] }, "docs": "Get vault details" }, { "info": { "name": "Update a specified vault's details", "type": "http" }, "http": { "method": "PATCH", "url": "https://{tenantURL}/api/v1/secretmanager/vault/:id", "params": [ { "name": "id", "value": "a6ed82f6-32b5-46d8-a3a3-c36cc574abd9", "type": "path", "description": "vault Id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a specified vault's details" }, { "info": { "name": "Delete a specified vault", "type": "http" }, "http": { "method": "DELETE", "url": "https://{tenantURL}/api/v1/secretmanager/vault/:id", "params": [ { "name": "id", "value": "a6ed82f6-32b5-46d8-a3a3-c36cc574abd9", "type": "path", "description": "vault Id" } ] }, "docs": "Delete a specified vault" }, { "info": { "name": "Get access secrets", "type": "http" }, "http": { "method": "GET", "url": "https://{tenantURL}/api/v1/secretmanager/vault/:vaultId/accesssecrets", "params": [ { "name": "vaultId", "value": "a6ed82f6-32b5-46d8-a3a3-c36cc574abd9", "type": "path", "description": "vault Id" }, { "name": "path", "value": "/machine/DB", "type": "query", "description": "Secret path" } ] }, "docs": "Get access secrets" }, { "info": { "name": "Access secret at a given path", "type": "http" }, "http": { "method": "POST", "url": "https://{tenantURL}/api/v1/secretmanager/vault/:vaultId/accesssecrets", "params": [ { "name": "vaultId", "value": "a6ed82f6-32b5-46d8-a3a3-c36cc574abd9", "type": "path", "description": "vault Id" }, { "name": "path", "value": "/machine/DB", "type": "query", "description": "Secret path" } ] }, "docs": "In case approval is required to access a secret then it sends an approval request with justification. Till the time the request is not approved, it sends the current status of the request in response. For example-\"Pending Approval\", \"Approval Needed\", \"Access Denied\"." }, { "info": { "name": "Download secret file content", "type": "http" }, "http": { "method": "GET", "url": "https://{tenantURL}/api/v1/secretmanager/vault/:vaultId/downloadfile", "params": [ { "name": "vaultId", "value": "a6ed82f6-32b5-46d8-a3a3-c36cc574abd9", "type": "path", "description": "vault Id" }, { "name": "path", "value": "/machine/DB", "type": "query", "description": "Secret path" } ] }, "docs": "Download secret file content" }, { "info": { "name": "Get secret metadata details", "type": "http" }, "http": { "method": "GET", "url": "https://{tenantURL}/api/v1/secretmanager/vault/:vaultId/secret-metadata", "params": [ { "name": "vaultId", "value": "a6ed82f6-32b5-46d8-a3a3-c36cc574abd9", "type": "path", "description": "vault Id" }, { "name": "path", "value": "/machine/DB", "type": "query", "description": "Secret path" } ] }, "docs": "Get secret metadata details" }, { "info": { "name": "Get Nodes/Secrets on one level under given parent", "type": "http" }, "http": { "method": "GET", "url": "https://{tenantURL}/api/v1/secretmanager/vault/:vaultId/secrets", "params": [ { "name": "type", "value": "node", "type": "query", "description": "node or secret" }, { "name": "pageToken", "value": "18CE4C10585F4525BE35801AC7F7EBA4C3", "type": "query", "description": "Page Token" }, { "name": "path", "value": "/machine/DB", "type": "query", "description": "Secret path" }, { "name": "getmetadata", "value": "true", "type": "query", "description": "true or false" }, { "name": "recursiveSecrets", "value": "true", "type": "query", "description": "boolean value" }, { "name": "filter", "value": "name%20eq%20secretType", "type": "query", "description": "Filter query" }, { "name": "vaultId", "value": "a6ed82f6-32b5-46d8-a3a3-c36cc574abd9", "type": "path", "description": "vault Id" } ] }, "docs": "Get Nodes/Secrets on one level under given parent" }, { "info": { "name": "Create a node/secret", "type": "http" }, "http": { "method": "POST", "url": "https://{tenantURL}/api/v1/secretmanager/vault/:vaultId/secrets", "params": [ { "name": "vaultId", "value": "a6ed82f6-32b5-46d8-a3a3-c36cc574abd9", "type": "path", "description": "vault Id" }, { "name": "path", "value": "/machine/DB", "type": "query", "description": "Secret/Node parent path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a node/secret" }, { "info": { "name": "Update / Move Secret", "type": "http" }, "http": { "method": "PATCH", "url": "https://{tenantURL}/api/v1/secretmanager/vault/:vaultId/secrets", "params": [ { "name": "vaultId", "value": "a6ed82f6-32b5-46d8-a3a3-c36cc574abd9", "type": "path", "description": "vault Id" }, { "name": "path", "value": "/machine/DB", "type": "query", "description": "Current vault-relative path of the secret to update" }, { "name": "saveAsVersion", "value": "true", "type": "query", "description": "Archive the existing credential as a new version before applying the update" }, { "name": "syncToTarget", "value": "false", "type": "query", "description": "Push the new credential to all mapped target accounts via the Broker" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a secret in the vault hierarchy. This endpoint handles three distinct operations — field-value update, rename, and move — determined by which fields are present in the request body. Only one operation should be performed per request.\n\n> **Note:** Only secrets (`entityType: secret`) can be moved. Folder nodes (`entityType: node`) cannot be moved using this endpoint.\n\n---\n\n### Update Field Values\nTo update the credential data of a secret, include a `value` map in the request body containin" }, { "info": { "name": "Delete node/secret", "type": "http" }, "http": { "method": "DELETE", "url": "https://{tenantURL}/api/v1/secretmanager/vault/:vaultId/secrets", "params": [ { "name": "vaultId", "value": "a6ed82f6-32b5-46d8-a3a3-c36cc574abd9", "type": "path", "description": "vault Id" }, { "name": "path", "value": "/machine/DB", "type": "query", "description": "Secret path" } ] }, "docs": "Delete node/secret" }, { "info": { "name": "Create a secret file", "type": "http" }, "http": { "method": "POST", "url": "https://{tenantURL}/api/v1/secretmanager/vault/:vaultId/secrets/file", "params": [ { "name": "secretData", "value": "", "type": "query" }, { "name": "vaultId", "value": "a6ed82f6-32b5-46d8-a3a3-c36cc574abd9", "type": "path", "description": "vault Id" }, { "name": "path", "value": "/machine/DB", "type": "query", "description": "Secret/Node parent path" } ], "body": { "type": "multipart-form", "data": [ { "name": "file", "type": "text", "value": "" } ] } }, "docs": "Create a secret file" }, { "info": { "name": "Update secret file", "type": "http" }, "http": { "method": "PATCH", "url": "https://{tenantURL}/api/v1/secretmanager/vault/:vaultId/secrets/file", "params": [ { "name": "secretData", "value": "", "type": "query" }, { "name": "vaultId", "value": "a6ed82f6-32b5-46d8-a3a3-c36cc574abd9", "type": "path", "description": "vault Id" }, { "name": "path", "value": "/machine/DB", "type": "query", "description": "Secret path" } ], "body": { "type": "multipart-form", "data": [ { "name": "file", "type": "text", "value": "" } ] } }, "docs": "Update secret file" }, { "info": { "name": "List Secret Versions", "type": "http" }, "http": { "method": "GET", "url": "https://{tenantURL}/api/v1/secretmanager/vault/:vaultId/secrets/:secretId/versions", "params": [ { "name": "vaultId", "value": "a6ed82f6-32b5-46d8-a3a3-c36cc574abd9", "type": "path", "description": "Vault identifier" }, { "name": "secretId", "value": "secret-123", "type": "path", "description": "Secret identifier" }, { "name": "size", "value": "10", "type": "query", "description": "Page size for pagination" }, { "name": "lastKey", "value": "", "type": "query", "description": "Last evaluated key for pagination" } ] }, "docs": "Lists all versions for a secret, ordered by version number (newest first)." }, { "info": { "name": "Get Secret Data for Version", "type": "http" }, "http": { "method": "GET", "url": "https://{tenantURL}/api/v1/secretmanager/vault/:vaultId/secrets/:secretId/versions/:version", "params": [ { "name": "vaultId", "value": "a6ed82f6-32b5-46d8-a3a3-c36cc574abd9", "type": "path", "description": "Vault identifier" }, { "name": "secretId", "value": "secret-123", "type": "path", "description": "Secret identifier" }, { "name": "version", "value": "1", "type": "path", "description": "Version number" } ] }, "docs": "Returns the decrypted secret data for a specific version number." } ] } ], "bundled": true }