RDP · Schema
RDP Connection
Schema describing an RDP (Remote Desktop Protocol) connection profile, modeled after common RDP file (.rdp) configuration parameters.
Financial DataLSEGMicrosoftNetworkingRDPRemote AccessRemote DesktopRefinitiv
Properties
| Name | Type | Description |
|---|---|---|
| name | string | Friendly name for this connection profile. |
| host | string | Hostname or IP address of the RDP server to connect to. |
| port | integer | Network port for the RDP service. Defaults to 3389. |
| username | string | Username used to authenticate with the RDP host. |
| domain | string | Active Directory domain (or workgroup) for the user account. |
| screenWidth | integer | Desktop width in pixels for the remote session. |
| screenHeight | integer | Desktop height in pixels for the remote session. |
| colorDepth | integer | Session color depth in bits per pixel. |
| fullScreen | boolean | Whether to launch the session in full screen mode. |
| audioMode | string | Where to play remote audio: on the local client, on the remote host, or disabled. |
| redirectClipboard | boolean | Whether to share the local clipboard with the remote session. |
| redirectPrinters | boolean | Whether to redirect local printers to the remote session. |
| redirectDrives | boolean | Whether to redirect local drives to the remote session. |
| redirectSmartcards | boolean | Whether to redirect local smart card devices to the remote session. |
| useGateway | boolean | Whether to connect through an RD Gateway server. |
| gatewayHostname | string | Hostname of the RD Gateway when useGateway is true. |
| networkLevelAuthentication | boolean | Whether to require Network Level Authentication (NLA) before the session is established. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/rdp/refs/heads/main/json-schema/rdp-connection.json",
"title": "RDP Connection",
"description": "Schema describing an RDP (Remote Desktop Protocol) connection profile, modeled after common RDP file (.rdp) configuration parameters.",
"type": "object",
"required": ["host"],
"properties": {
"name": {
"type": "string",
"description": "Friendly name for this connection profile."
},
"host": {
"type": "string",
"description": "Hostname or IP address of the RDP server to connect to."
},
"port": {
"type": "integer",
"minimum": 1,
"maximum": 65535,
"default": 3389,
"description": "Network port for the RDP service. Defaults to 3389."
},
"username": {
"type": "string",
"description": "Username used to authenticate with the RDP host."
},
"domain": {
"type": "string",
"description": "Active Directory domain (or workgroup) for the user account."
},
"screenWidth": {
"type": "integer",
"minimum": 200,
"description": "Desktop width in pixels for the remote session."
},
"screenHeight": {
"type": "integer",
"minimum": 200,
"description": "Desktop height in pixels for the remote session."
},
"colorDepth": {
"type": "integer",
"enum": [8, 15, 16, 24, 32],
"description": "Session color depth in bits per pixel."
},
"fullScreen": {
"type": "boolean",
"description": "Whether to launch the session in full screen mode."
},
"audioMode": {
"type": "string",
"enum": ["local", "remote", "none"],
"description": "Where to play remote audio: on the local client, on the remote host, or disabled."
},
"redirectClipboard": {
"type": "boolean",
"description": "Whether to share the local clipboard with the remote session."
},
"redirectPrinters": {
"type": "boolean",
"description": "Whether to redirect local printers to the remote session."
},
"redirectDrives": {
"type": "boolean",
"description": "Whether to redirect local drives to the remote session."
},
"redirectSmartcards": {
"type": "boolean",
"description": "Whether to redirect local smart card devices to the remote session."
},
"useGateway": {
"type": "boolean",
"description": "Whether to connect through an RD Gateway server."
},
"gatewayHostname": {
"type": "string",
"description": "Hostname of the RD Gateway when useGateway is true."
},
"networkLevelAuthentication": {
"type": "boolean",
"description": "Whether to require Network Level Authentication (NLA) before the session is established."
}
},
"additionalProperties": true
}
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.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.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/rdp-connection"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
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.