target_api

Home >> Targets >> api

REST APIs

Deploys to a REST API that is compatible to vs-rest-api.

{
    "deploy": {
        "targets": [
            {
                "type": "api",
                "name": "My REST API",
                "description": "Deploys to a vs-rest-api",

                "host": "vscode.example.com",
                "user": "mkloubert", "password": "P@ssword123!"
            }
        ]
    }
}

Name	Description
host	The host to deploy to. Default: 127.0.0.1
isSecure	Use secure HTTP or not. Default: (false)
password	The password for basic authentication.
port	The TCP of the API host. Default: 1781
promptForPassword	Prompt for a password if not defined. Default: (true)
transformer*	The path to the script that transforms data before it is send / after it has been downloaded.
transformerOptions	Optional data for the transformer script.
user	The username for basic authentication.

^{* supports placeholders}