API Documentation

A documentation for developer

3rd Party Api Key

POST Add a new API Key

HTTP Request

POST https://manage.runcloud.io/base-api/settings/externalapi

Arguments

Parameters Required Description
label YES Name of the API Key
service YES "cloudflare", "linode" or "digitalocean"
username YES if service is "cloudflare" The username or email to authenticate with the secret key
secret YES The secret key

Request

curl -X POST "https://manage.runcloud.io/base-api/settings/externalapi" \
    -u YOUR_API_KEY:YOUR_API_SECRET \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    --data '{
        "label": "My Cloudflare",
        "service": "cloudflare",
        "username": "myemail@gmail.com",
        "secret": "xxxxxxxxxxxxxxxxxxx"
    }'

Response

{
    "api": {
        "id": "LR6YA0XA71P8",
        "label": "My Cloudflare",
        "username": "myemail@gmail.com",
        "secret_hidden": "xxxxxxxxxxxxxxxxxxx",
        "_links": {
            "update": {
                "method": "patch",
                "link": ""
            },
            "delete": {
                "method": "delete",
                "link": "https:\/\/manage.runcloud.io\/api\/settings\/externalapi\/LR6YA0XA71P8"
            }
        },
        "service": {
            "id": "cloudflare",
            "name": "Cloudflare",
            "creation_url": "https:\/\/www.cloudflare.com\/a\/profile"
        }
    },
    "message": "Successfully added new Cloudflare API My Cloudflare",
    "redirect": "\/settings\/externalapi"
}

GET List all 3rd Party API Key

HTTP Request

GET https://manage.runcloud.io/base-api/settings/externalapi

Request

curl -X GET "https://manage.runcloud.io/base-api/settings/externalapi" \
    -u YOUR_API_KEY:YOUR_API_SECRET \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"

Response

{
    "data": [
        {
            "id": "LR6YA0XA71P8",
            "label": "My Cloudflare",
            "username": "myemail@gmail.com",
            "secret_hidden": "xxxxxxxxxxxxxxxxxxx",
            "_links": {
                "update": {
                    "method": "patch",
                    "link": ""
                },
                "delete": {
                    "method": "delete",
                    "link": "https:\/\/manage.runcloud.io\/api\/settings\/externalapi\/LR6YA0XA71P8"
                }
            },
            "service": {
                "id": "cloudflare",
                "name": "Cloudflare",
                "creation_url": "https:\/\/www.cloudflare.com\/a\/profile"
            }
        }
    ]
}

PATCH Update the API Key

HTTP Request

PATCH https://manage.runcloud.io/base-api/settings/externalapi/{3rdpartyapi.id}

Arguments

Parameters Required Description
label YES Name of the API Key
username YES if service is "cloudflare" The username or email to authenticate with the secret key
secret YES if you want to change it The secret key

Request

curl -X PATCH "https://manage.runcloud.io/base-api/settings/externalapi/LR6YA0XA71P8" \
    -u YOUR_API_KEY:YOUR_API_SECRET \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    --data '{
        "label": "Personal Cloudflare",
        "username": "personalemail@gmail.com",
        "secret": "yyyxxyxyxyxyxyxxy"
    }'

Response

{
    "api": {
        "id": "LR6YA0XA71P8",
        "label": "Personal Cloudflare",
        "username": null,
        "secret_hidden": "yyyxxyxyxyxyxyxxy",
        "_links": {
            "update": {
                "method": "patch",
                "link": ""
            },
            "delete": {
                "method": "delete",
                "link": "https:\/\/manage.runcloud.io\/api\/settings\/externalapi\/LR6YA0XA71P8"
            }
        },
        "service": {
            "id": "cloudflare",
            "name": "Cloudflare",
            "creation_url": "https:\/\/www.cloudflare.com\/a\/profile"
        }
    },
    "message": "Successfully updated API Key Personal Cloudflare",
    "redirect": "\/settings\/externalapi"
}

DELETE Delete the API Key

HTTP Request

DELETE https://manage.runcloud.io/base-api/settings/externalapi/{3rdpartyapi.id}

Request

curl -X DELETE "https://manage.runcloud.io/base-api/settings/externalapi/LR6YA0XA71P8" \
    -u YOUR_API_KEY:YOUR_API_SECRET \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"

Response

{
    "message": "Successfully deleted 3rd Party API Key Personal Cloudflare"
}