Skeddly API
Search
K

CreateCredential Method

Description

Registers a cloud-provider credential to be used.

HTTP Request

POST https://api.skeddly.com/api/Credentials/

Body

The body is a JSON structure with the following properties.

amazonIamAccessKey

Parameters for the Amazon IAM access key credential. Required when credentialType is amazon-access-key.
Required: Conditional

amazonIamRole

Parameters for the Amazon IAM role credential. Required when credentialType is amazon-iam-role.
Required: Conditional

azureCredential

Parameters for the Azure credential. Required when credentialType is azure-credential.
Required: Conditional

cloudProviderSubTypeId

Cloud-provider sub-type ID.
Type: string
Valid Values:
  • amazon-standard
  • amazon-govcloud-us
  • amazon-china
  • azure-global
  • google-standard
Required: Yes

credentialType

Type of credential being registered.
Type: string
Required: Yes
Valid Values:
  • amazon-iam-role
  • amazon-access-key
  • azure-credential
  • google-service-account-key

googleServiceAccountKey

Parameters for the Google Cloud Provider service account key credential. Required when credentialType is google-service-account-key.
Required: Conditional

name

Friendly name for the credential.
Type: string
Required: Yes

projectId

The ID of the project in which to create the credential.
Type: string
Required: Recommended for future compatability
Default Value: The account's default project.

Returns

A Credential object.

Sample Request

HTTP
Bash
POST /api/Credentials HTTP/1.1
Host: api.skeddly.com
Authorization: AccessKey <api key>
Content-Type: application/json
{
"amazonIamRole": {
"externalId": "skeddly-12345678",
"roleArn": "arn:aws:iam::123456789012:role/Skeddly"
},
"cloudProviderSubTypeId": "amazon-standard",
"credentialType": "amazon-iam-role",
"name": "My Credential"
}
curl -X POST "https://api.skeddly.com/api/Credentials" \
-H "Authorization: AccessKey <api key>" \
-d amazonIamRole.externalId=skeddly-12345678 \
-d amazonIamRole.roleArn="arn:aws:iam::123456789012:role/Skeddly" \
-d cloudProviderSubTypeId=amazon-standard \
-d credentialType=amazon-iam-role \
-d name="My Credential"

Sample Response

{
"amazonIamRole": {
"roleArn": "arn:aws:iam::123456789012:role/Skeddly",
"externalId": "skeddly-12345678"
},
"cloudProviderSubTypeId": "amazon-standard",
"createdDate": "2016-06-08T14:42:00Z",
"credentialId": "cred-00000001",
"credentialType": "amazon-iam-role",
"isUsedForSnsNotifications": false,
"lastModifiedDate": "2016-06-08T14:42:00Z",
"lastModifiedBy": "u-00000001",
"name": "My Credential",
"status": "active"
}