buildin_endpoints_get_deploy

Home >> Build-in endpoints >> [GET] /api/deploy

[GET] /api/deploy

Returns all deploy targets.

This endpoint requires extension.deploy.getTargets command, as available in vs-deploy extension, and canDeploy property must be set to (true) for an user or guest in the settings to access the endpoint.

Example

GET /api/deploy

Possible response:

{
    "code": 0,
    "data": [
        {
            "name": "My SFTP target",
            "type": "sftp",
            "description": "A description for this target"
        }
    ]
}

Other responses:

Code	Description
403	User has no right to deploy files.
410	extension.deploy.getTargets command not found. s. vs-deploy