ListCredentials Method

Description

Retrieves the list of credentials.

HTTP Request

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

Query Parameters

filter.credentialIds

A comma-separated list of credential IDs.

Type: string

filter.isIncludeDeleted

Indicates whether to include deleted credentials in the result or not.

Type: boolean

Default: false

filter.projectIds

A comma-separated list of projects to include.

Type: string

Default: All projects

Required: No

Returns

Array of Credential objects.

Sample Request

GET /api/Credentials HTTP/1.1
Host: api.skeddly.com
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"
    }
]

Last updated