Jump to Content
Guides
API and SDK Reference
Register
Log in
API and SDK Reference
Register
Log in
Guides
API and SDK Reference
Get Secrets
Search
JUMP TO
Essentials
Structure and Authorization
Change Management
Quick Reference
Status and Error Codes
Pagination, Timeouts, and Date-Time Format
deepset AI Platform
haystack
Get Available Components
get
Get Components Input Output
get
Create Components Dynamic Input Output
post
infrastructure
List OpenSearch credentials
get
Add OpenSearch credentials
post
Delete OpenSearch credentials
delete
List Available S3 Credentials
get
Add S3 Credentials
post
Delete S3 Credentials
delete
user
Read Users Me
get
Get Users
get
Delete User
delete
Get User
get
Update User Permission
patch
Assign Role
post
Remove Role
post
models
Get Model
get
model_registry_token
Remove Token Deprecated
delete
Get Token Deprecated
get
Save Token Deprecated
post
Update Token Deprecated
put
Get Tokens
get
Remove Token
delete
Get Token
get
Save Token
post
Update Token
put
organization
Get Organization
get
Invite User To Organization
post
Create Support Request
post
pipeline_utils
Generate Integrated Pipeline Yaml
post
prompts
List Public Prompt Templates
get
Trigger Prompthub Sync
post
List Prompt Templates
get
Create Prompt Template
post
Delete Prompt Templates
delete
Update Prompt Template
put
api_token
Get Tokens
get
Create Token
post
Remove Token
delete
workspace
List Workspaces
get
Create Workspace
post
Delete Workspace
delete
Get Workspace
get
Search Count
get
Search History
get
Get Workspace Stats
get
datasets
List Datasets
get
Add Files
post
file
Delete Files
delete
List Files
get
Upload File
post
Search Files
post
Update File Meta Bulk
post
Delete File
delete
Get File
get
Get File Meta
get
Update File Meta
patch
document_store
Get Indexes
get
Create Index
post
Delete Index
delete
Get Index By Name
get
Update Index
patch
Deploy Index
post
Count Documents
get
Count Documents Deprecated
post
Query Documents
post
Get All Documents Stream
post
Get Document
get
Get Indexed Files By Status
get
Schedule Single File For Indexing
post
Get Pipeline Index Logs
get
Undeploy Index
post
pipeline_templates
List Pipeline Templates
get
Get Pipeline Template
get
pipeline
Validate Pipeline
post
List Pipelines
get
Create Pipeline
post
Delete Pipeline
delete
Get Pipeline
get
Update Pipeline
patch
Activate Pipeline
post
Chat
post
Chat Stream
post
Set Default Pipeline
post
Deploy Pipeline
post
Get Pipeline Files
get
Get Pipeline Indexing
get
Get Pipeline Issues
get
Get Pipeline Logs
get
Get Pipeline Index Metadata
get
Get Pipeline Metadata Field Values
get
Get Pipeline Min Max Aggregation Metadata
get
Get Prompt
get
Get Prompts
get
Search
post
Search Stream
post
Pipeline Search History
get
Pipeline Search History Archive
get
Get Pipeline Stats
get
Undeploy Pipeline
post
Get Pipeline Yaml Configs
get
Update Pipeline Yaml
put
Delete Pipeline Search History
delete
Pipeline Search History Result
get
search_session
Get Search Sessions
get
Create Search Session
post
Delete Search Session
delete
shared_prototype
List Prototypes
get
Create Prototype
post
Revoke Shared Prototype
delete
Get Shared Prototype
get
Edit Shared Prototype
patch
upload_session
Get Upload Sessions
get
Create Upload Session
post
Get Session Status
get
Close Session
put
Get Session Files
get
custom_components
Get Custom Components
get
Import Custom Components
post
Get Custom Component Logs
get
Get Custom Component
get
secrets
Get Secrets
get
Create Secret
post
Remove Secret
delete
Get Secret
get
debug_tunnel
Start Debug Tunnel
post
health
Health
get
Jobs
jobs
Get Jobs
get
Create Job
post
Delete Job
delete
Get Job
get
Update Job
patch
Get Job Results
get
Get Export Job Results To Csv
get
Start Job
post
shared_job
Create Shared Job
post
Get Shared Jobs
get
Get Shared Job
get
Edit Shared Job
patch
Revoke Shared Job
post
query_sets
Get Query Sets
get
Import Query Set
post
Get Query Set
get
Feedback
feedback
Get Paginated Feedback
get
Create Feedback
post
Export Feedback
get
Get Pipeline Feedback Stats
get
Delete Feedback
delete
Update Feedback
patch
tags
Get Paginated Tags
get
Create Tags
post
Delete Tags
delete
Custom Components
custom_components
Get Custom Components
get
Import Custom Components
post
Get Custom Component Logs
get
Get Custom Component
get
OPEN SOURCE SDK
Data Classes
Asynchronous Client
Synchronous Client
deepset AI Platform CLI
Get Secrets
get
https://api.cloud.deepset.ai/api/v2/secrets
Returns the existing secrets.
Language
Shell
Node
Ruby
PHP
Python
Credentials
Bearer
Bearer
URL
Base URL
https://api.cloud.deepset.ai
/api/v2/secrets
RESPONSE
Click
Try It!
to start a request and see the response here!