API Documentation

A documentation for developer

Deployment Key

GET List users

HTTP Request

GET https://manage.runcloud.io/base-api/servers/<server.id>/deploymentkey

A GET request to this path will gives out System User model data.

Arguments

Parameters Required Description
page NO Page number of the resources
username NO Search string for users you wanted to search

Request

curl -X GET "https://manage.runcloud.io/base-api/servers/yO4VAbX2BkNz/deploymentkey?page=1" \
    -u YOUR_API_KEY:YOUR_API_SECRET \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"

Response

{
    "data": [
        {
            "id": "g704AYp0lmNo",
            "username": "aisyah",
            "sshPublic": null,
            "deleteable": true,
            "_links": {
                "generateDeploymentKey": {
                    "method": "post",
                    "link": "\/api\/servers\/yO4VAbX2BkNz\/deploymentkey\/g704AYp0lmNo\/generate"
                },
                "update": {
                    "method": "patch",
                    "link": "\/api\/servers\/yO4VAbX2BkNz\/users\/g704AYp0lmNo\/update"
                },
                "delete": {
                    "method": "delete",
                    "link": "\/api\/servers\/yO4VAbX2BkNz\/users\/g704AYp0lmNo\/destroy"
                }
            }
        },
        {
            "id": "LR6YA0XA71P8",
            "username": "runcloud",
            "sshPublic": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCbVgJA1M1CLAgqBFz68+2yOIuXyY+yx+YETLJEWju4kxn7\/PyzeIDK3kaKa4Z0FSxga0YF7Y3dQuchtufTedh8LdT8\/PyEspWdC0r9dVfMpfAC7z5hL+er8HsHv2s8Guh52LQHmbW9H17dJBdoeNQyhbzlsJTm12\/9fA04tHMOiZMcPtFwDr9YnXWqotyRf5DB7HO3U8PdrHpna\/IoqH0Hh1nu7v9kOu52iAtV2BAdqOn+9UMKnGNT0VUZAT+AF\/eOiBmZ4V49n1eQOhydkqR82l1BJeL5MwUBtqD+JrJiesRqL0ILj4l3n9zy2VDwD4BhlD0XNxwTZsjmCTBL2xir GIT Deployment Key for user runcloud. Server ARunCloudDev",
            "deleteable": false,
            "_links": {
                "generateDeploymentKey": {
                    "method": "post",
                    "link": "\/api\/servers\/yO4VAbX2BkNz\/deploymentkey\/LR6YA0XA71P8\/generate"
                },
                "update": {
                    "method": "patch",
                    "link": "\/api\/servers\/yO4VAbX2BkNz\/users\/LR6YA0XA71P8\/update"
                },
                "delete": {
                    "method": "delete",
                    "link": "\/api\/servers\/yO4VAbX2BkNz\/users\/LR6YA0XA71P8\/destroy"
                }
            }
        }
    ],
    "meta": {
        "pagination": {
            "total": 2,
            "count": 2,
            "per_page": 20,
            "current_page": 1,
            "total_pages": 1,
            "links": []
        }
    }
}

POST Generate or regenerate deployment key

HTTP Request

POST https://manage.runcloud.io/base-api/servers/<server.id>/deploymentkey/<systemuser.id>

Arguments

Parameters Required Description
page NO Page number of the resources
username NO Search string for users you wanted to search

Request

curl -X POST "https://manage.runcloud.io/base-api/servers/yO4VAbX2BkNz/deploymentkey/g704AYp0lmNo" \
    -u YOUR_API_KEY:YOUR_API_SECRET \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"

Response

{
    "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDB5Wo5f2yClaO1OfhpPINQ3+mRwZ0XJKVe\/7NdF3KGUaJZT0ZZePIgtBuvrPzNdb+ehl917ZQ5ba6\/Z2uD+d2vKnLX7wifvLUdNVpmhVguZ9JME30rOUeEVXroWIeKz4LlVotyzW9Rq8wGlG\/S6c8Mw6LtVvir0vyXaegnaijsmTrASWUpAVKbp2tJUmjWKY3mwmBx6h7Zk0keKMuP8ok5IGtmnti5LehMC2xgX13\/NhOJ+nBlB8hFv0hKI8rn9gDorvR+UHyQQoef61Td5JJ8zC4Uxz149BAVXCsBUZ8x7eeJmjWkC7ipuGihRyux9y4N6r6ACbEbtXs1FbignPcN GIT Deployment Key for user aisyah. Server ARunCloudDev"
}