GetCredential Method

Description

Retrieves information for a credential.

HTTP Request

GET https://api.skeddly.com/api/Credentials/<id>

URL Parameters

id

ID of the credential to retrieve.

Type: string

Required: Yes

Query Parameters

filter.isIncludeDeleted

Indicates whether deleted credentials can be returned.

Type: boolean

Required: No

Default: false

Returns

A Credential object.

Sample Request

HTTP

GET /api/Credentials/cred-00000001 HTTP/1.1
Host: api.skeddly.com
Authorization: AccessKey <api key>

Bash

curl "https://api.skeddly.com/api/Credentials/cred-00000001" \
  -H "Authorization: AccessKey <api key>"

Sample Response

{
    "actionIds": [
        "a-00000001"
    ],
    "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",
    "managedInstanceIds": [
        "mi-00000001"
    ],
    "name": "My Credential",
    "projectId": "proj-00000001",
    "status": "active"
}