Deprecation Notice - RunCloud API Beta is deprecated effective 31 May 2019. New API will be released and it's not backward compatible.

3rd Party Api Key

Create new API Key

Arguments
labelrequiredName of the API Key
servicerequired"cloudflare", "linode" or "digitalocean"
usernamerequiredThe username or email to authenticate with the secret key
secretrequiredThe secret key

POST /settings/externalapi

HTTP Request
POST https://manage.runcloud.io/base-api/settings/externalapi
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"
}

List all 3rd Party API Key

GET /settings/externalapi

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"
			}
		}
	]
}

Update the API Key

Arguments
labelrequiredName of the API Key
usernamerequiredThe username or email to authenticate with the secret key
secretrequiredThe secret key

GET /settings/externalapi

HTTP Request
PATCH https://manage.runcloud.io/base-api/settings/externalapi/{3rdpartyapi.id}
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 the API Key

GET /settings/externalapi

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"
}