Create new API Key
POST /settings/externalapi
Parameters
| label required | String | Name of the API Key |
| service required | String | “cloudflare”, “linode” or “digitalocean” |
| username required is service is “cloudflare” | String | The username or email to authenticate with the secret key |
| secret required | String | The secret key |
HTTP Request
POST https://manage.runcloud.io/api/v2/settings/externalapi
Request
curl --request POST \
--url https://manage.runcloud.io/api/v2/settings/externalapi \
-u YOUR_API_KEY:YOUR_API_SECRET \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data '{
"label": "Testing",
"service": "digitalocean",
"secret": "k2jh35jk2h2k6jh2981"
}'
Response
{
"id": 28,
"label": "Testing",
"username": null,
"secret": "k2jh35jk2h2k6jh2981",
"service": "Digital Ocean",
"created_at": "2019-06-30 20:56:22"
}
List all 3rd Party API Key
GET /settings/externalapi
Query String Parameters
| search optional | String | Searching string if you wanted to search from list of api keys |
HTTP Request
GET https://manage.runcloud.io/api/v2/settings/externalapi
Request
curl --request GET \
--url https://manage.runcloud.io/api/v2/settings/externalapi \
-u YOUR_API_KEY:YOUR_API_SECRET \
--header 'accept: application/json' \
--header 'content-type: application/json'
Response
{
"data": [
{
"id": 2,
"label": "Cloudflare",
"username": "[email protected]",
"secret": "23jk22k98as928923x992x892...",
"service": "Cloudflare",
"created_at": "2019-04-08 14:21:47"
},
{
"id": 1,
"label": "DO8",
"username": null,
"secret": "ksjdfh2k352ls098k...",
"service": "Digital Ocean",
"created_at": "2019-04-06 00:43:43"
},
{
"id": 28,
"label": "Testing",
"username": null,
"secret": "k2jh35jk2h2k6jh2981",
"service": "Digital Ocean",
"created_at": "2019-06-30 20:56:22"
}
]
}
3rd Party API object
GET /settings/externalapi/{apiId}
HTTP Request
GET https://manage.runcloud.io/api/v2/settings/externalapi/{apiId}
Request
curl --request GET \
--url https://manage.runcloud.io/api/v2/settings/externalapi/28 \
-u YOUR_API_KEY:YOUR_API_SECRET \
--header 'accept: application/json' \
--header 'content-type: application/json'
Response
{
"id": 28,
"label": "Testing",
"username": null,
"secret": "k2jh35jk2h2k6jh2981",
"service": "Digital Ocean",
"created_at": "2019-06-30 20:56:22"
}
Update the API Key
PATCH /settings/externalapi/{apiId}
Parameters
| label required | Name of the API Key |
| username required | The username or email to authenticate with the secret key |
| secret required | The secret key |
HTTP Request
PATCH https://manage.runcloud.io/api/v2/settings/externalapi/{apiId}
Request
curl --request PATCH \
--url https://manage.runcloud.io/api/v2/settings/externalapi/28 \
-u YOUR_API_KEY:YOUR_API_SECRET \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data '{
"label": "DO Key Edited",
"secret": "k2jh35jk2h2k6jh2981"
}'
Response
{
"id": 28,
"label": "DO Key Edited",
"username": "[email protected]",
"secret": "k2jh35jk2h2k6jh2981",
"service": "Digital Ocean",
"created_at": "2019-06-30 20:56:22"
}
Delete the API Key
DELETE /settings/externalapi/{apiId}
HTTP Request
DELETE https://manage.runcloud.io/api/v2/settings/externalapi/{apiId}
Request
curl --request DELETE \
--url https://manage.runcloud.io/api/v2/settings/externalapi/28 \
-u YOUR_API_KEY:YOUR_API_SECRET \
--header 'accept: application/json' \
--header 'content-type: application/json'
Response
{
"id": 28,
"label": "DO Key Edited",
"username": null,
"secret": "k2jh35jk2h2k6jh2981",
"service": "Digital Ocean",
"created_at": "2019-06-30 20:56:22"
}