CloudstackCloudCredentials object

Polymorphism

CloudstackCloudCredentials is a type that implements the CloudCredentials type.

When an object of type CloudCredentials is expected, you can use one of type CloudstackCloudCredentials (or use any other implementation).

Example JSON representation

{
  "apiKey": "string", 
  "apiUrl": "string", 
  "cloudCredentialsType": "CloudstackCloudCredentials", 
  "description": "string", 
  "id": "string", 
  "name": "string", 
  "provider": "cloudstack", 
  "scope": "scalr", 
  "secretKey": "string", 
  "status": "disabled"
}

Properties

property attributes valid values description filter option
apiKey
string
required

The API key.

apiUrl
string
required

The URL like: http(s)://:/client/api.

cloudCredentialsType
string
required
create-only
filterable
"CloudstackCloudCredentials"

The Cloud Platform these credentials allow access to.

?cloudCredentialsType=...
name
string
required
filterable

Unique name of these Cloud Credentials.

?name=...
provider
string
required
create-only
filterable
"cloudstack"
"idcf"

Cloud provider that should be specified for CloudStack based clouds.

?provider=...
secretKey
string
required

The secret key.

id
string
read-only
filterable

Unique identifier for this Cloud Credentials object.

?id=...
scope
string
read-only
filterable
"scalr"
"account"
"environment"
"farm"
"farmrole"
"role"
"server"

The scope in which these Cloud Credentials were added.

?scope=...
status
string
read-only
filterable
"disabled"
"enabled"
"suspended"

The status of these Cloud Credentials.

?status=...
description
string
optional