Delinea Proxy API
Retrieve and update SSH and RDP proxy configurations
Retrieve and update SSH and RDP proxy configurations
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/delinea-proxy-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Secret Server Rest Activations Proxy API
description: REST API documentation for Secret Server. This document describes how to use the REST API. All requests require an authentication token; please see the <a href="../OAuth/">authentication document</a> for more information. The <a href="swagger.json">Swagger specification</a> for this API is also available.
termsOfService: https://delinea.com/eula
contact:
name: Support
url: https://delinea.com
version: 11.7.2
servers:
- url: /SecretServer/api
security:
- BearerToken: []
tags:
- name: Proxy
description: Retrieve and update SSH and RDP proxy configurations
paths:
/v1/proxy/ssh/client-overrides/{clientOverrideId}:
delete:
tags:
- Proxy
summary: Deletes SSH Terminal client overrides
description: Deletes SSH Terminal client overrides
operationId: ProxyService_DeleteTerminalClientOverrides
parameters:
- name: clientOverrideId
in: path
description: clientOverrideId
required: true
schema:
type: integer
format: int32
responses:
'200':
description: A list of SSH Terminal client overrides
content:
application/json:
schema:
$ref: '#/components/schemas/DeletedModel'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestResponse'
'403':
description: Authentication failed
content:
application/json:
schema:
$ref: '#/components/schemas/AuthenticationFailedResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorResponse'
deprecated: false
patch:
tags:
- Proxy
summary: Updates SSH Terminal client overrides
description: Updates SSH Terminal client overrides
operationId: ProxyService_UpdateTerminalClientOverrides
parameters:
- name: clientOverrideId
in: path
description: clientOverrideId
required: true
schema:
type: integer
format: int32
requestBody:
$ref: '#/components/requestBodies/ProxyClientOverrideSummary'
responses:
'200':
description: A list of SSH Terminal client overrides
content:
application/json:
schema:
$ref: '#/components/schemas/ProxyClientOverrideSummary'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestResponse'
'403':
description: Authentication failed
content:
application/json:
schema:
$ref: '#/components/schemas/AuthenticationFailedResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorResponse'
deprecated: false
/v1/proxy/ssh/config:
get:
tags:
- Proxy
summary: Get the SSH proxy configuration
description: Get the SSH proxy configuration
operationId: ProxyService_GetSshProxyConfiguration
responses:
'200':
description: SSH Proxy Configuration
content:
application/json:
schema:
$ref: '#/components/schemas/SshProxyConfigurationViewModel'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestResponse'
'403':
description: Authentication failed
content:
application/json:
schema:
$ref: '#/components/schemas/AuthenticationFailedResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorResponse'
deprecated: false
patch:
tags:
- Proxy
summary: Update the SSH proxy configuration
description: Update the SSH proxy configuration
operationId: ProxyService_PatchSshProxyConfiguration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SshProxyConfigurationViewModel'
description: viewModel
responses:
'200':
description: SSH Proxy Configuration
content:
application/json:
schema:
$ref: '#/components/schemas/SshProxyConfigurationViewModel'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestResponse'
'403':
description: Authentication failed
content:
application/json:
schema:
$ref: '#/components/schemas/AuthenticationFailedResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorResponse'
deprecated: false
/v1/proxy/rdp/config:
get:
tags:
- Proxy
summary: Get the RDP proxy configuration
description: Get the RDP proxy configuration
operationId: ProxyService_GetRdpProxyConfiguration
responses:
'200':
description: RDP Proxy Configuration
content:
application/json:
schema:
$ref: '#/components/schemas/RdpProxyConfigurationViewModel'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestResponse'
'403':
description: Authentication failed
content:
application/json:
schema:
$ref: '#/components/schemas/AuthenticationFailedResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorResponse'
deprecated: false
patch:
tags:
- Proxy
summary: Update the RDP proxy configuration
description: Update the RDP proxy configuration
operationId: ProxyService_PatchRdpProxyConfiguration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RdpProxyConfigurationViewModel'
multipart/form-data:
schema:
$ref: '#/components/schemas/RdpProxyConfigurationViewModel'
description: viewModel
responses:
'200':
description: RDP Proxy Configuration
content:
application/json:
schema:
$ref: '#/components/schemas/RdpProxyConfigurationViewModel'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestResponse'
'403':
description: Authentication failed
content:
application/json:
schema:
$ref: '#/components/schemas/AuthenticationFailedResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorResponse'
deprecated: false
/v1/proxy/explanation:
get:
tags:
- Proxy
summary: Get Proxy Explanations
description: Get an explanation of the SSH proxy, SSH terminal, and RDP proxy features
operationId: ProxyService_GetExplanations
responses:
'200':
description: Explanations
content:
application/json:
schema:
$ref: '#/components/schemas/ProxyExplanationsViewModel'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestResponse'
'403':
description: Authentication failed
content:
application/json:
schema:
$ref: '#/components/schemas/AuthenticationFailedResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorResponse'
deprecated: false
/v1/proxy/audit:
get:
tags:
- Proxy
summary: Get the Proxy Audit List
description: Search, filter, sort, and page Proxy Audits.
operationId: ProxyService_GetAudits
parameters:
- name: isExporting
in: query
description: isExporting
required: false
schema:
type: boolean
- name: skip
in: query
description: Number of records to skip before taking results
required: false
schema:
type: integer
format: int32
- name: sortBy[0].direction
in: query
description: Sort direction
required: false
schema:
type: string
- name: sortBy[0].name
in: query
description: Sort field name
required: false
schema:
type: string
- name: sortBy[0].priority
in: query
description: Priority index. Sorts with lower values are executed earlier
required: false
schema:
type: integer
format: int32
- name: take
in: query
description: Maximum number of records to include in results
required: false
schema:
type: integer
format: int32
responses:
'200':
description: A paginated list of Proxy Audits.
content:
application/json:
schema:
$ref: '#/components/schemas/PagingOfProxyAuditModel'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestResponse'
'403':
description: Authentication failed
content:
application/json:
schema:
$ref: '#/components/schemas/AuthenticationFailedResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorResponse'
deprecated: false
/v1/proxy/endpoints:
get:
tags:
- Proxy
summary: Get the proxy endpoints list
description: Get the proxy endpoints list
operationId: ProxyService_GetEndpoints
responses:
'200':
description: A list of nodes, sites, and engines with proxy configurations
content:
application/json:
schema:
$ref: '#/components/schemas/ProxyEndpointsViewModel'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestResponse'
'403':
description: Authentication failed
content:
application/json:
schema:
$ref: '#/components/schemas/AuthenticationFailedResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorResponse'
deprecated: false
/v1/proxy/ssh/notification:
get:
tags:
- Proxy
summary: Get a notification of where the SSH proxy is running
description: Get a notification of where the SSH proxy is running
operationId: ProxyService_GetSshEndpointNotification
responses:
'200':
description: A list of nodes, sites, and engines with proxy configurations
content:
application/json:
schema:
description: String
type: string
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestResponse'
'403':
description: Authentication failed
content:
application/json:
schema:
$ref: '#/components/schemas/AuthenticationFailedResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorResponse'
deprecated: false
/v1/proxy/rdp/notification:
get:
tags:
- Proxy
summary: Get a notification of where the RDP proxy is running
description: Get a notification of where the RDP proxy is running
operationId: ProxyService_GetRdpEndpointNotification
responses:
'200':
description: A list of nodes, sites, and engines with proxy configurations
content:
application/json:
schema:
description: String
type: string
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestResponse'
'403':
description: Authentication failed
content:
application/json:
schema:
$ref: '#/components/schemas/AuthenticationFailedResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorResponse'
deprecated: false
/v1/proxy/endpoints/notification:
get:
tags:
- Proxy
summary: Get endpoint warnings
description: Get endpoint warnings
operationId: ProxyService_GetEndpointNotification
responses:
'200':
description: A list of nodes, sites, and engines with proxy configurations
content:
application/json:
schema:
description: String
type: string
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestResponse'
'403':
description: Authentication failed
content:
application/json:
schema:
$ref: '#/components/schemas/AuthenticationFailedResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorResponse'
deprecated: false
/v1/proxy/ssh/clients:
get:
tags:
- Proxy
summary: Get SSH Terminal clients
description: Get SSH Terminal clients
operationId: ProxyService_GetTerminalClients
parameters:
- name: filter.ipAddress
in: query
description: IpAddress
required: false
schema:
type: string
- name: filter.terminalClientType
in: query
description: TerminalClientType
required: false
x-nullable: true
schema:
type: string
- name: skip
in: query
description: Number of records to skip before taking results
required: false
schema:
type: integer
format: int32
- name: sortBy[0].direction
in: query
description: Sort direction
required: false
schema:
type: string
- name: sortBy[0].name
in: query
description: Sort field name
required: false
schema:
type: string
- name: sortBy[0].priority
in: query
description: Priority index. Sorts with lower values are executed earlier
required: false
schema:
type: integer
format: int32
- name: take
in: query
description: Maximum number of records to include in results
required: false
schema:
type: integer
format: int32
responses:
'200':
description: A list of SSH Terminal clients
content:
application/json:
schema:
$ref: '#/components/schemas/PagingOfProxyClientSummaryAndSshProxyClientsFilterQuery'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestResponse'
'403':
description: Authentication failed
content:
application/json:
schema:
$ref: '#/components/schemas/AuthenticationFailedResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorResponse'
deprecated: false
/v1/proxy/ssh/clienthistory:
get:
tags:
- Proxy
summary: Get SSH Terminal client history
description: Get SSH Terminal client history
operationId: ProxyService_GetTerminalClientHistory
parameters:
- name: filter.authenticateResult
in: query
description: AuthenticateResult
required: false
schema:
type: string
- name: filter.endDate
in: query
description: EndDate
required: false
schema:
type: string
- name: filter.engineIdentityGuid
in: query
description: EngineIdentityGuid
required: false
schema:
type: string
- name: filter.ipAddress
in: query
description: IpAddress
required: false
schema:
type: string
- name: filter.startDate
in: query
description: StartDate
required: false
schema:
type: string
- name: skip
in: query
description: Number of records to skip before taking results
required: false
schema:
type: integer
format: int32
- name: sortBy[0].direction
in: query
description: Sort direction
required: false
schema:
type: string
- name: sortBy[0].name
in: query
description: Sort field name
required: false
schema:
type: string
- name: sortBy[0].priority
in: query
description: Priority index. Sorts with lower values are executed earlier
required: false
schema:
type: integer
format: int32
- name: take
in: query
description: Maximum number of records to include in results
required: false
schema:
type: integer
format: int32
responses:
'200':
description: A list of SSH Terminal client history
content:
application/json:
schema:
$ref: '#/components/schemas/PagingOfProxyClientHistorySummaryAndSshProxyClientHistoryFilterQuery'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestResponse'
'403':
description: Authentication failed
content:
application/json:
schema:
$ref: '#/components/schemas/AuthenticationFailedResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorResponse'
deprecated: false
/v1/proxy/ssh/client-overrides:
get:
tags:
- Proxy
summary: Get SSH Terminal client overrides
description: Get SSH Terminal client overrides
operationId: ProxyService_GetTerminalClientOverrides
responses:
'200':
description: A list of SSH Terminal client overrides
content:
application/json:
schema:
description: A list of SSH Terminal client overrides
items:
$ref: '#/components/schemas/ProxyClientOverrideSummary'
type: array
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestResponse'
'403':
description: Authentication failed
content:
application/json:
schema:
$ref: '#/components/schemas/AuthenticationFailedResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorResponse'
deprecated: false
post:
tags:
- Proxy
summary: Creates SSH Terminal client overrides
description: Creates SSH Terminal client overrides
operationId: ProxyService_CreateTerminalClientOverrides
requestBody:
$ref: '#/components/requestBodies/ProxyClientOverrideSummary'
responses:
'200':
description: A list of SSH Terminal client overrides
content:
application/json:
schema:
$ref: '#/components/schemas/ProxyClientOverrideSummary'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestResponse'
'403':
description: Authentication failed
content:
application/json:
schema:
$ref: '#/components/schemas/AuthenticationFailedResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorResponse'
deprecated: false
/v1/proxy/state:
get:
tags:
- Proxy
summary: Get proxy state
description: Get proxy state
operationId: ProxyService_GetProxyingState
responses:
'200':
description: Proxy state
content:
application/json:
schema:
$ref: '#/components/schemas/ProxyingStateModel'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestResponse'
'403':
description: Authentication failed
content:
application/json:
schema:
$ref: '#/components/schemas/AuthenticationFailedResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorResponse'
deprecated: false
/v1/proxy/endpoints/nodes/{id}:
patch:
tags:
- Proxy
summary: Update a node proxy configuration
description: Update a node proxy configuration
operationId: ProxyService_PatchNode
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ProxyNodeViewModel'
description: node
responses:
'200':
description: A list of nodes, sites, and engines with proxy configurations
content:
application/json:
schema:
$ref: '#/components/schemas/ProxyEndpointsViewModel'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestResponse'
'403':
description: Authentication failed
content:
application/json:
schema:
$ref: '#/components/schemas/AuthenticationFailedResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorResponse'
deprecated: false
/v1/proxy/endpoints/sites/{id}:
patch:
tags:
- Proxy
summary: Update a site proxy configuration
description: Update a site proxy configuration
operationId: ProxyService_PatchSite
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ProxySiteViewModel'
description: site
responses:
'200':
description: A list of nodes, sites, and engines with proxy configurations
content:
application/json:
schema:
$ref: '#/components/schemas/ProxyEndpointsViewModel'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestResponse'
'403':
description: Authentication failed
content:
application/json:
schema:
$ref: '#/components/schemas/AuthenticationFailedResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorResponse'
deprecated: false
/v1/proxy/endpoints/engines/{id}:
patch:
tags:
- Proxy
summary: Update an engine proxy configuration
description: Update an engine proxy configuration
operationId: ProxyService_PatchEngine
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ProxyEngineViewModel'
description: engine
responses:
'200':
description: A list of nodes, sites, and engines with proxy configurations
content:
application/json:
schema:
$ref: '#/components/schemas/ProxyEndpointsViewModel'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestResponse'
'403':
description: Authentication failed
content:
application/json:
schema:
$ref: '#/components/schemas/AuthenticationFailedResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorResponse'
deprecated: false
/v1/proxy/ssh/clients/{clientId}:
patch:
tags:
- Proxy
summary: Updates a SSH Terminal client type
description: Updates a SSH Terminal client type
operationId: ProxyService_UpdateTerminalClientType
parameters:
- name: clientId
in: path
description: clientId
required: true
schema:
type: integer
format: int32
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ProxyClientSummary'
description: client
responses:
'200':
description: A list of SSH Terminal clients
content:
application/json:
schema:
description: Boolean
type: boolean
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestResponse'
'403':
description: Authentication failed
content:
application/json:
schema:
$ref: '#/components/schemas/AuthenticationFailedResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorResponse'
deprecated: false
/v1/proxy/ssh/generate-key:
post:
tags:
- Proxy
summary: Generate SSH Host Key
description: Generates a new SSH host key and returns the SSH configuration with the updated host key
operationId: ProxyService_GenerateSshHostKey
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/GenerateSshHostKeyArgs'
description: args
responses:
'200':
description: SSH Proxy Configuration
content:
application/json:
schema:
$ref: '#/components/schemas/SshProxyConfigurationViewModel'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestResponse'
'403':
description: Authentication failed
content:
application/json:
schema:
$ref: '#/components/schemas/AuthenticationFailedResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorResponse'
deprecated: false
/v1/proxy/rdp/generate-certificate:
post:
tags:
- Proxy
summary: Generate RDP server certificate
description: Generates a new RDP server certificate and returns the RDP configuration with the updated server certificate
operationId: ProxyService_GenerateRdpProxyCertificate
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/GenerateRdpCertificateArgs'
description: args
responses:
'200':
description: RDP Proxy Configuration
content:
application/json:
schema:
$ref: '#/components/schemas/RdpProxyConfigurationViewModel'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestResponse'
'403':
description: Authentication failed
content:
application/json:
schema:
$ref: '#/components/schemas/AuthenticationFailedResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorResponse'
deprecated: false
components:
schemas:
SshProxyClientHistoryFilterQuery:
description: Additional query options
properties:
authenticateResult:
description: AuthenticateResult
type: string
endDate:
description: EndDate
type: string
engineIdentityGuid:
description: EngineIdentityGuid
# --- truncated at 32 KB (55 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/delinea/refs/heads/main/openapi/delinea-proxy-api-openapi.yml